archives/snowflake
2
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake.git synced 2025-10-13 20:11:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md to include all available CLI options

Browse source
This commit is contained in:
Sky 2024-04-04 08:18:18 +00:00
parent debd473977
commit cec3c2df21
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
proxy/README.md
View file

@ -37,18 +37,28 @@ Usage of ./proxy:
broker URL (default "https://snowflake-broker.torproject.net/") broker URL (default "https://snowflake-broker.torproject.net/")
-capacity uint -capacity uint
maximum concurrent clients (default is to accept an unlimited number of clients) maximum concurrent clients (default is to accept an unlimited number of clients)
-disableStatsLogger
disable the exposing mechanism for stats using logs
-ephemeral-ports-range string -ephemeral-ports-range string
ICE UDP ephemeral ports range (format:"<min>:<max>") ICE UDP ephemeral ports range (format:"<min>:<max>")
-enableMetrics
enable the exposing mechanism for stats using metrics at "/internal/metrics"
-keep-local-addresses -keep-local-addresses
keep local LAN address ICE candidates keep local LAN address ICE candidates
-log string -log string
log filename log filename
-metricsAddress string
set listening address for metrics service by either hostname or ip-address (default localhost)
-metricsPort
set port for the metrics service (default 9999)
-nat-retest-interval duration -nat-retest-interval duration
the time interval in second before NAT type is retested, 0s disables retest. Valid time units are "s", "m", "h". (default 24h0m0s) the time interval in second before NAT type is retested, 0s disables retest. Valid time units are "s", "m", "h". (default 24h0m0s)
-relay string -relay string
websocket relay URL (default "wss://snowflake.torproject.net/") websocket relay URL (default "wss://snowflake.torproject.net/")
-outbound-address string -outbound-address string
bind a specific outbound address. Replace all host candidates with this address without validation. bind a specific outbound address. Replace all host candidates with this address without validation.
-probeURL string
NAT check probe server URL (default "https://snowflake-broker.torproject.net:8443/probe")
-stun string -stun string
stun URL (default "stun:stun.l.google.com:19302") stun URL (default "stun:stun.l.google.com:19302")
-summary-interval duration -summary-interval duration