username/ppf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README and ROADMAP for playbook deployment

Browse Source
This commit is contained in:
Username
2026-02-17 23:19:59 +01:00
parent b1de91a969
commit 9eff4496d6
2 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -238,16 +238,18 @@ Note: `--network=host` required for Tor access at 127.0.0.1:9050.
### Operations Toolkit ### Operations Toolkit
The `tools/` directory provides CLI wrappers for multi-node operations: The `tools/` directory provides CLI wrappers for multi-node operations.
Deployment uses an Ansible playbook over WireGuard for parallel execution
and handler-based restarts.
```sh ```sh
ppf-deploy [targets...] # deploy code + restart containers ppf-deploy [targets...] # validate + deploy + restart (playbook)
ppf-deploy --check # dry run with diff
ppf-logs [node] # view container logs (-f to follow) ppf-logs [node] # view container logs (-f to follow)
ppf-service <cmd> [nodes...] # status / start / stop / restart ppf-service <cmd> [nodes...] # status / start / stop / restart
``` ```
Handles syntax validation, role-aware file syncing (odin vs workers), See `--help` on each tool.
ownership fixes, and dynamic UID discovery. See `--help` on each tool.
## Troubleshooting ## Troubleshooting

4
ROADMAP.md
View File

@@ -90,6 +90,8 @@ PPF (Proxy Fetcher) is a Python 2 proxy scraping and validation framework design
| static/dashboard.js | Dashboard frontend logic | | static/dashboard.js | Dashboard frontend logic |
| static/dashboard.html | Dashboard HTML template | | static/dashboard.html | Dashboard HTML template |
| tools/lib/ppf-common.sh | Shared ops library (hosts, wrappers, colors) | | tools/lib/ppf-common.sh | Shared ops library (hosts, wrappers, colors) |
| tools/ppf-deploy | Deploy code to nodes | | tools/ppf-deploy | Deploy wrapper (validation + playbook) |
| tools/ppf-logs | View container logs | | tools/ppf-logs | View container logs |
| tools/ppf-service | Container lifecycle management | | tools/ppf-service | Container lifecycle management |
| tools/playbooks/deploy.yml | Ansible deploy playbook |
| tools/playbooks/inventory.ini | Host inventory (WireGuard IPs) |