docs: add operations toolkit to README.md
This commit is contained in:
23
README.md
23
README.md
@@ -220,24 +220,35 @@ WantedBy=multi-user.target
|
|||||||
|
|
||||||
### Container Deployment
|
### Container Deployment
|
||||||
|
|
||||||
|
All nodes use `podman-compose` with role-specific compose files.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Build
|
# Build image
|
||||||
podman build -t ppf:latest .
|
podman build -t ppf:latest .
|
||||||
|
|
||||||
# Run with persistent storage
|
# Run standalone (single node)
|
||||||
# IMPORTANT: Use ppf.py as entry point (runs both harvester + validator)
|
|
||||||
podman run -d --name ppf \
|
podman run -d --name ppf \
|
||||||
--network=host \
|
--network=host \
|
||||||
-v ./data:/app/data:Z \
|
-v ./data:/app/data:Z \
|
||||||
-v ./config.ini:/app/config.ini:ro \
|
-v ./config.ini:/app/config.ini:ro \
|
||||||
ppf:latest python ppf.py
|
ppf:latest python ppf.py
|
||||||
|
|
||||||
# Generate systemd unit
|
|
||||||
podman generate systemd --name ppf --files --new
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Note: `--network=host` required for Tor access at 127.0.0.1:9050.
|
Note: `--network=host` required for Tor access at 127.0.0.1:9050.
|
||||||
|
|
||||||
|
### Operations Toolkit
|
||||||
|
|
||||||
|
The `tools/` directory provides CLI wrappers for multi-node operations:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
ppf-deploy [targets...] # deploy code + restart containers
|
||||||
|
ppf-logs [node] # view container logs (-f to follow)
|
||||||
|
ppf-service <cmd> [nodes...] # status / start / stop / restart
|
||||||
|
```
|
||||||
|
|
||||||
|
Handles syntax validation, role-aware file syncing (odin vs workers),
|
||||||
|
ownership fixes, and dynamic UID discovery. See `--help` on each tool.
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### Low Success Rate
|
### Low Success Rate
|
||||||
|
|||||||
Reference in New Issue
Block a user