diff options
| author | Sky <tor-gitlab@codestorm.net> | 2024-04-04 08:18:18 +0000 |
|---|---|---|
| committer | Sky <tor-gitlab@codestorm.net> | 2024-04-04 08:21:56 +0000 |
| commit | cec3c2df21c860433c0f54fa8baae2cac1fc8060 (patch) | |
| tree | 687330421345ab9087d9e1ce262fa4007607f0ef | |
| parent | debd473977d33c03886b2cbfd01e904b03b9eb08 (diff) | |
| download | snowflake-cec3c2df21c860433c0f54fa8baae2cac1fc8060.tar.gz snowflake-cec3c2df21c860433c0f54fa8baae2cac1fc8060.zip | |
Update README.md to include all available CLI options
| -rw-r--r-- | proxy/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/proxy/README.md b/proxy/README.md index ac8d115..bda8f93 100644 --- a/proxy/README.md +++ b/proxy/README.md @@ -37,18 +37,28 @@ Usage of ./proxy: broker URL (default "https://snowflake-broker.torproject.net/") -capacity uint 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 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 LAN address ICE candidates -log string 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 the time interval in second before NAT type is retested, 0s disables retest. Valid time units are "s", "m", "h". (default 24h0m0s) -relay string websocket relay URL (default "wss://snowflake.torproject.net/") -outbound-address string 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 URL (default "stun:stun.l.google.com:19302") -summary-interval duration |