docs: add proxy source API documentation

2026-02-15 04:20:17 +01:00
parent ddad839fca
commit 9b18a59df9
6 changed files with 62 additions and 9 deletions
--- a/docs/CHEATSHEET.md
+++ b/docs/CHEATSHEET.md
@@ -11,6 +11,7 @@ s5p -l 0.0.0.0:9999                         # custom listen address
 s5p -t 30                                   # 30s per-hop timeout
 s5p -v                                      # debug logging
 s5p -q                                      # errors only
+s5p -S http://api:8081/proxies              # proxy source API
 s5p --cprofile                              # profile to s5p.prof
 s5p --cprofile out.prof                     # profile to custom file
 ```
@@ -30,6 +31,16 @@ make down    # podman-compose down
 cp config/example.yaml config/s5p.yaml     # create live config (gitignored)
 ```

+## Proxy Source (config)
+
+```yaml
+proxy_source:
+  url: http://10.200.1.250:8081/proxies
+  proto: socks5    # optional filter
+  limit: 1000
+  refresh: 300     # seconds
+```
+
 ## Proxy URLs

 ```