DeBros/network
4
0
Fork 0
mirror of https://github.com/DeBrosOfficial/network.git synced 2025-10-06 08:19:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation to reflect changes in node startup commands; unify bootstrap and regular node commands to use make run-node for improved clarity and ease of use.

Browse Source
This commit is contained in:
anonpenguin 2025-08-06 20:43:49 +03:00
parent f62b9c6423
commit 9b69aa4432
3 changed files with 19 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
AI_CONTEXT.md
View File

@ -291,7 +291,7 @@ make start-node
``` ```
### Development Workflow ### Development Workflow
1. **Local Development**: Use `make start-bootstrap` + `make start-node` 1. **Local Development**: Use `make run-node` (auto-detects bootstrap vs regular)
2. **Testing**: Run `make test` for unit tests 2. **Testing**: Run `make test` for unit tests
3. **Integration Testing**: Use `scripts/test-multinode.sh` 3. **Integration Testing**: Use `scripts/test-multinode.sh`
4. **Configuration**: Edit `configs/*.yaml` files 4. **Configuration**: Edit `configs/*.yaml` files

34
README.md
View File

@ -216,8 +216,9 @@ make build && make build-anchat
**Terminal 1 - Bootstrap Node:** **Terminal 1 - Bootstrap Node:**
```bash ```bash
make run-bootstrap make run-node
# This starts the bootstrap node on port 4001 # This automatically detects and starts as bootstrap node on port 4001
# if the local machine matches bootstrap peer configuration
``` ```
**Terminal 2 - Regular Node:** **Terminal 2 - Regular Node:**
@ -231,8 +232,8 @@ make run-node
**Terminal 3 - Another Node (optional):** **Terminal 3 - Another Node (optional):**
```bash ```bash
# For additional nodes, use different ports # For additional nodes, use different data directory
go run cmd/node/main.go -data ./data/node2 -port 4003 go run cmd/node/main.go -data ./data/node2
``` ```
### 5. Test with CLI ### 5. Test with CLI
@ -610,10 +611,7 @@ make build-anchat
# Show current bootstrap configuration # Show current bootstrap configuration
make show-bootstrap make show-bootstrap
# Run bootstrap node (uses .env automatically) # Run node (auto-detects bootstrap vs regular based on .env)
make run-bootstrap
# Run regular node (uses .env automatically - no bootstrap flag needed!)
make run-node make run-node
# Clean data directories # Clean data directories
@ -651,8 +649,8 @@ make dev
3. **Start Development Cluster:** 3. **Start Development Cluster:**
```bash ```bash
# Terminal 1: Bootstrap node # Terminal 1: Bootstrap node (auto-detected)
make run-bootstrap make run-node
# Terminal 2: Regular node (auto-connects via .env) # Terminal 2: Regular node (auto-connects via .env)
make run-node make run-node
@ -793,8 +791,8 @@ Anchat is a demonstration application built on the network that provides decentr
3. **Start Network Infrastructure:** 3. **Start Network Infrastructure:**
```bash ```bash
# Terminal 1: Bootstrap node # Terminal 1: Bootstrap node (auto-detected)
make run-bootstrap make run-node
# Terminal 2: Regular node (optional but recommended) # Terminal 2: Regular node (optional but recommended)
make run-node make run-node
@ -860,15 +858,15 @@ The Anchat application also includes hardcoded fallback bootstrap peers in `anch
- Generate a new bootstrap identity: `go run scripts/generate-bootstrap-identity.go` - Generate a new bootstrap identity: `go run scripts/generate-bootstrap-identity.go`
- Update both `.env` and `anchat/.env` with the new peer ID - Update both `.env` and `anchat/.env` with the new peer ID
- Restart the bootstrap node: `make run-bootstrap` - Restart the bootstrap node: `make run-node`
- Check configuration: `make show-bootstrap` - Check configuration: `make show-bootstrap`
**Nodes can't connect:** **Nodes can't connect:**
- Verify `.env` files have the correct bootstrap peer ID - Verify `.env` files have the correct bootstrap peer ID
- Check that the bootstrap node is running: `ps aux | grep bootstrap` - Check that the bootstrap node is running: `ps aux | grep node`
- Verify firewall settings and port availability (4001, 5001, 7001) - Verify firewall settings and port availability (4001, 5001, 7001)
- Try restarting with clean data: `make clean && make run-bootstrap` - Try restarting with clean data: `make clean && make run-node`
**Storage operations fail:** **Storage operations fail:**
@ -903,8 +901,8 @@ cat data/bootstrap/peer.info
# Clean and restart everything # Clean and restart everything
make clean make clean
make run-bootstrap # In one terminal make run-node # In one terminal (auto-detects as bootstrap)
make run-node # In another terminal make run-node # In another terminal (runs as regular node)
``` ```
### Environment-specific Issues ### Environment-specific Issues
@ -913,7 +911,7 @@ make run-node # In another terminal
- Always run `go run scripts/generate-bootstrap-identity.go` first - Always run `go run scripts/generate-bootstrap-identity.go` first
- Update `.env` files with the generated peer ID - Update `.env` files with the generated peer ID
- Use `make run-node` instead of manual bootstrap specification - Use `make run-node` - the system auto-detects if it should run as bootstrap
**Production Environment:** **Production Environment:**

4
WHITEPAPER.md
View File

@ -219,8 +219,8 @@ cp .env.example .env
go run scripts/generate-bootstrap-identity.go go run scripts/generate-bootstrap-identity.go
# Automatic network startup # Automatic network startup
make run-bootstrap # Bootstrap node with auto-config make run-node # Auto-detects bootstrap vs regular based on .env
make run-node # Regular node with .env discovery make run-node # Second node (auto-connects via .env)
# Application deployment # Application deployment
cd anchat && make build && ./bin/anchat cd anchat && make build && ./bin/anchat