c939101a73
Add API section to README (features, CLI, config), PROJECT (architecture), USAGE (full endpoint reference with examples), CHEATSHEET (curl one-liners). Update TASKS and ROADMAP. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
51 lines
2.2 KiB
Markdown
51 lines
2.2 KiB
Markdown
# s5p -- Tasks
|
|
|
|
## Current
|
|
|
|
- [x] Scaffold project structure
|
|
- [x] Implement SOCKS5 server
|
|
- [x] Implement protocol handshakes (SOCKS5, SOCKS4/4a, HTTP CONNECT)
|
|
- [x] Implement chain builder
|
|
- [x] CLI and config loading
|
|
- [x] Unit tests (config, proto)
|
|
- [x] Documentation
|
|
- [x] Smoke test with Tor
|
|
- [x] Containerfile + compose.yaml (Alpine)
|
|
- [x] Graceful SIGTERM shutdown
|
|
- [x] cProfile support (`--cprofile`)
|
|
- [x] Config split (example.yaml tracked, s5p.yaml gitignored)
|
|
|
|
- [x] Dynamic proxy source API integration
|
|
- [x] Connection retry with proxy rotation
|
|
- [x] Connection metrics (periodic + shutdown logging)
|
|
- [x] Managed proxy pool (multi-source, health-tested, persistent)
|
|
- [x] Weighted proxy selection (prefer recently-tested proxies)
|
|
- [x] Per-proxy backoff (60s cooldown after connection failure)
|
|
- [x] Stale proxy expiry (evict dead proxies not seen for 3 refresh cycles)
|
|
- [x] Pool stats in periodic metrics log (`pool=alive/total`)
|
|
- [x] Fast warm start (trust cached state, defer all health tests)
|
|
- [x] Static chain health check (skip pool tests if chain unreachable)
|
|
- [x] SIGHUP hot config reload (timeout, retries, log_level, pool config)
|
|
- [x] Dead proxy reporting (`report_url` POST evicted proxies to API)
|
|
- [x] Concurrent connection semaphore (`max_connections`, CLI `-m`)
|
|
- [x] Async HTTP client (replace blocking urllib, parallel source fetch)
|
|
- [x] First-hop TCP connection pool (`pool_size`, `pool_max_idle`)
|
|
|
|
- [x] Codebase consolidation (refactor/codebase-consolidation)
|
|
- [x] Extract shared proxy parsing and constants to config.py
|
|
- [x] Consolidate health-check HTTP logic in pool
|
|
- [x] Remove threading from metrics (pure asyncio, no lock needed)
|
|
- [x] Replace `ensure_future` with `create_task`
|
|
- [x] Rename ambiguous variables in config loader
|
|
- [x] Remove legacy ProxySource layer (source.py deleted)
|
|
- [x] Add tests for extracted `parse_api_proxies`
|
|
- [x] Instant warm start (trust cached state, defer all health tests)
|
|
- [x] Register signal handlers before startup (fix SIGKILL on stop)
|
|
- [x] Use k8s-file logging driver with rotation
|
|
- [x] Built-in control API (`api.py`, `--api`, `api_listen`)
|
|
|
|
## Next
|
|
- [ ] Integration tests with mock proxy server
|
|
- [ ] SOCKS5 server-side authentication
|
|
- [ ] Tor control port integration
|