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 help output, fix #40232

Browse source
This commit is contained in:
Flo418 2022-11-23 21:23:04 +01:00 • committed by itchyonion
parent cebe4a0af6
commit cbc50592d8
No known key found for this signature in database
GPG key ID: 4B87B720348500EA
1 changed files with 17 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

20
proxy/README.md
View file

@ -29,20 +29,34 @@ go build
The Snowflake proxy can be run with the following options: The Snowflake proxy can be run with the following options:
``` ```
Usage of ./proxy: Usage of ./proxy:
-allow-non-tls-relay
allow relay without tls encryption
-allowed-relay-hostname-pattern string
a pattern to specify allowed hostname pattern for relay URL. (default "snowflake.torproject.net$")
-broker string -broker string
broker URL (default "https://snowflake-broker.torproject.net/") broker URL (default "https://snowflake-broker.torproject.net/")
-capacity uint -capacity uint
maximum concurrent clients maximum concurrent clients (default is to accept an unlimited number of clients)
-ephemeral-ports-range string
ICE UDP ephemeral ports range (format:"<min>:<max>")
-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
-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 -relay string
websocket relay URL (default "wss://snowflake.torproject.net/") websocket relay URL (default "wss://snowflake.bamsoftware.com/")
-stun string -stun string
stun URL (default "stun:stun.stunprotocol.org:3478") STUN URL (default "stun:stun.stunprotocol.org:3478")
-summary-interval duration
the time interval to output summary, 0s disables summaries. Valid time units are "s", "m", "h". (default 1h0m0s)
-unsafe-logging -unsafe-logging
prevent logs from being scrubbed prevent logs from being scrubbed
-verbose
increase log verbosity
-version
display version info to stderr and quit
``` ```
For more information on how to run a Snowflake proxy in deployment, see our [community documentation](https://community.torproject.org/relay/setup/snowflake/standalone/). For more information on how to run a Snowflake proxy in deployment, see our [community documentation](https://community.torproject.org/relay/setup/snowflake/standalone/).