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

docs: reorder listeners -- deepest chain on default port

Browse Source 
:1080 = Tor + 2 pool hops, :1081 = Tor + 1, :1082 = Tor only.
This commit is contained in:
user
2026-02-17 22:06:40 +01:00
parent 7dc3926f48
commit 28c9830f56
4 changed files with 22 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -77,16 +77,16 @@ api_listen: 127.0.0.1:1081 # control API (disabled by default)
listeners: listeners:
- listen: 0.0.0.0:1080 - listen: 0.0.0.0:1080
chain: chain:
- socks5://127.0.0.1:9050 # Tor only - socks5://127.0.0.1:9050
- pool # Tor + 2 pool proxies
- pool
- listen: 0.0.0.0:1081 - listen: 0.0.0.0:1081
chain: chain:
- socks5://127.0.0.1:9050 - socks5://127.0.0.1:9050
- pool # Tor + 1 pool proxy - pool # Tor + 1 pool proxy
- listen: 0.0.0.0:1082 - listen: 0.0.0.0:1082
chain: chain:
- socks5://127.0.0.1:9050 - socks5://127.0.0.1:9050 # Tor only
- pool # Tor + 2 pool proxies
- pool
# Old single-listener format still works: # Old single-listener format still works:
# listen: 127.0.0.1:1080 # listen: 127.0.0.1:1080
@@ -134,9 +134,9 @@ Options:
## How Chaining Works ## How Chaining Works
``` ```
:1080 Client -> s5p -> Tor -> Destination (0 pool hops) :1080 Client -> s5p -> Tor -> [pool] -> [pool] -> Destination (2 pool hops)
:1081 Client -> s5p -> Tor -> [pool proxy] -> Destination (1 pool hop) :1081 Client -> s5p -> Tor -> [pool] -> Destination (1 pool hop)
:1082 Client -> s5p -> Tor -> [pool proxy] -> [pool proxy] -> Dest (2 pool hops) :1082 Client -> s5p -> Tor -> Destination (0 pool hops)
``` ```
s5p connects to Hop1 via TCP, negotiates the hop protocol (SOCKS5/4/HTTP), s5p connects to Hop1 via TCP, negotiates the hop protocol (SOCKS5/4/HTTP),

8
config/example.yaml
View File

@@ -57,7 +57,9 @@ chain:
# listeners: # listeners:
# - listen: 0.0.0.0:1080 # - listen: 0.0.0.0:1080
# chain: # chain:
# - socks5://127.0.0.1:9050 # Tor only (no pool hops) # - socks5://127.0.0.1:9050
# - pool # Tor + 2 random pool proxies
# - pool
# #
# - listen: 0.0.0.0:1081 # - listen: 0.0.0.0:1081
# chain: # chain:
@@ -66,9 +68,7 @@ chain:
# #
# - listen: 0.0.0.0:1082 # - listen: 0.0.0.0:1082
# chain: # chain:
# - socks5://127.0.0.1:9050 # - socks5://127.0.0.1:9050 # Tor only (no pool hops)
# - pool # Tor + 2 random pool proxies
# - pool
# #
# When using "listeners:", the top-level "listen" and "chain" keys are ignored. # When using "listeners:", the top-level "listen" and "chain" keys are ignored.
# If "listeners:" is absent, the old format is used (single listener). # If "listeners:" is absent, the old format is used (single listener).

8
docs/CHEATSHEET.md
View File

@@ -44,16 +44,16 @@ cp config/example.yaml config/s5p.yaml # create live config (gitignored)
listeners: listeners:
- listen: 0.0.0.0:1080 - listen: 0.0.0.0:1080
chain: chain:
- socks5://127.0.0.1:9050 # Tor only - socks5://127.0.0.1:9050
- pool # Tor + 2 pool hops
- pool
- listen: 0.0.0.0:1081 - listen: 0.0.0.0:1081
chain: chain:
- socks5://127.0.0.1:9050 - socks5://127.0.0.1:9050
- pool # Tor + 1 pool hop - pool # Tor + 1 pool hop
- listen: 0.0.0.0:1082 - listen: 0.0.0.0:1082
chain: chain:
- socks5://127.0.0.1:9050 - socks5://127.0.0.1:9050 # Tor only
- pool # Tor + 2 pool hops
- pool
``` ```
## Performance Tuning (config) ## Performance Tuning (config)

12
docs/USAGE.md
View File

@@ -51,7 +51,9 @@ api_listen: "" # control API bind address (empty = disabled)
listeners: listeners:
- listen: 0.0.0.0:1080 - listen: 0.0.0.0:1080
chain: chain:
- socks5://127.0.0.1:9050 # Tor only - socks5://127.0.0.1:9050
- pool # Tor + 2 pool proxies
- pool
- listen: 0.0.0.0:1081 - listen: 0.0.0.0:1081
chain: chain:
- socks5://127.0.0.1:9050 - socks5://127.0.0.1:9050
@@ -89,7 +91,9 @@ of proxy hops after the static chain. Config-file only (not available via CLI).
listeners: listeners:
- listen: 0.0.0.0:1080 - listen: 0.0.0.0:1080
chain: chain:
- socks5://10.200.1.13:9050 # Tor only - socks5://10.200.1.13:9050
- pool # Tor + 2 pool proxies
- pool
- listen: 0.0.0.0:1081 - listen: 0.0.0.0:1081
chain: chain:
@@ -98,9 +102,7 @@ listeners:
- listen: 0.0.0.0:1082 - listen: 0.0.0.0:1082
chain: chain:
- socks5://10.200.1.13:9050 - socks5://10.200.1.13:9050 # Tor only
- pool # Tor + 2 pool proxies
- pool
proxy_pool: proxy_pool:
sources: sources: