aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormeskio <meskio@torproject.org>2024-04-04 12:27:14 +0200
committermeskio <meskio@torproject.org>2024-04-04 12:27:14 +0200
commit01588d99db5164ae45d8331f5c0d1a39cc184b9d (patch)
tree8a40ce812e4c2be4f918571a0202b854f573ce6b
parentd439f89536279af125b9f90cdd4417b533aec3ee (diff)
parentcec3c2df21c860433c0f54fa8baae2cac1fc8060 (diff)
downloadsnowflake-01588d99db5164ae45d8331f5c0d1a39cc184b9d.tar.gz
snowflake-01588d99db5164ae45d8331f5c0d1a39cc184b9d.zip
Merge remote-tracking branches 'gitlab/mr/289' and 'gitlab/mr/293'
-rw-r--r--proxy/README.md10
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