s5p/docs/CHEATSHEET.md

s5p -- Cheatsheet

CLI

s5p                                         # direct, listen :1080
s5p -C socks5://127.0.0.1:9050             # through Tor
s5p -C socks5://tor:9050,http://px:8080    # Tor + HTTP proxy
s5p -c config/s5p.yaml                      # from config file
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 --cprofile                              # profile to s5p.prof
s5p --cprofile out.prof                     # profile to custom file

Container

make build   # podman-compose build
make up      # podman-compose up -d
make logs    # podman-compose logs -f
make down    # podman-compose down

Config

cp config/example.yaml config/s5p.yaml     # create live config (gitignored)

Proxy URLs

socks5://host:port
socks5://user:pass@host:port
socks4://host:port
http://host:port
http://user:pass@host:port

Testing

# Check exit IP
curl -x socks5h://127.0.0.1:1080 https://httpbin.org/ip

# Tor check
curl -x socks5h://127.0.0.1:1080 https://check.torproject.org/api/ip

# Verbose curl
curl -v -x socks5h://127.0.0.1:1080 https://example.com

# With timeout
curl --max-time 30 -x socks5h://127.0.0.1:1080 https://example.com

Profiling

python -m pstats s5p.prof                   # interactive stats viewer

Troubleshooting

Symptom	Check
Connection refused	Is Tor running? ss -tlnp | grep 9050
Timeout	Increase -t, check proxy reachability
DNS leak	Use socks5h:// (not socks5://) in client
Auth failed	Verify credentials in proxy URL
Port in use	fuser -k 1080/tcp to free the port
Container slow stop	Rebuild image after SIGTERM fix