Files
s5p/ROADMAP.md
user a741c0a017
All checks were successful
ci / secrets (push) Successful in 9s
ci / test (push) Successful in 20s
ci / build (push) Successful in 15s
feat: v0.3.0 stabilization -- systemd, tests, API docs
- Bump version 0.1.0 -> 0.3.0
- Add systemd service unit (config/s5p.service) and install-service
  Makefile target
- Add CLI argument parsing tests (tests/test_cli.py, 27 tests)
- Expand protocol tests with SOCKS5/4/HTTP handshake, error, and auth
  coverage (tests/test_proto.py, 30 tests)
- Add full API reference to docs/USAGE.md with response schemas for
  all GET/POST endpoints
- Update INSTALL.md, CHEATSHEET.md with systemd section
- Update ROADMAP.md, TASKS.md for v0.3.0
2026-02-21 18:35:51 +01:00

1.7 KiB

s5p -- Roadmap

v0.1.0

  • SOCKS5 server (CONNECT command)
  • Proxy chaining (SOCKS5, SOCKS4/4a, HTTP CONNECT)
  • Per-hop authentication
  • YAML config + CLI flags
  • DNS leak prevention
  • Container deployment (Alpine + podman-compose)
  • Graceful SIGTERM/SIGINT shutdown
  • cProfile support
  • Dynamic proxy source API integration
  • Weighted proxy selection (recency-based)
  • Per-proxy backoff (connection failure cooldown)
  • Stale proxy expiry (last_seen TTL)
  • Pool stats in periodic metrics log
  • Instant warm start (trust cached state, defer all health tests)
  • Static chain health check (pre-flight before pool tests)
  • SIGHUP hot config reload
  • Dead proxy reporting to source API

v0.2.0

  • Built-in control API (runtime metrics, pool state, config reload)
  • Tor control port integration (circuit renewal via NEWNYM)
  • Metrics (connections/sec, bytes relayed, hop latency)
  • Multi-listener with per-port chain depth
  • Per-listener latency tracking
  • Dynamic health test concurrency (auto-scales to ~10% of pool)
  • Multi-Tor round-robin (tor_nodes)
  • Named proxy pools with per-listener assignment (proxy_pools:)
  • MITM source filter (mitm: true/false on pool sources)

v0.3.0 (current)

  • SOCKS5 server authentication (username/password)
  • Systemd service unit
  • CLI test coverage
  • Protocol test coverage (SOCKS5/4/HTTP handshakes)
  • API documentation (full response schemas)
  • UDP ASSOCIATE support (SOCKS5 UDP relay)
  • BIND support
  • Chain randomization (random order, random subset)

v1.0.0

  • Stable API and config format
  • Performance benchmarks