mirror of
https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake.git
synced 2025-10-13 11:11:30 -04:00
Add man pages for proxy and client commands
To be used by the debian package (#19409)
This commit is contained in:
parent
270eb21803
commit
c5ca41f138
2 changed files with 84 additions and 0 deletions
38
doc/snowflake-proxy.1
Normal file
38
doc/snowflake-proxy.1
Normal file
|
@ -0,0 +1,38 @@
|
|||
.TH SNOWFLAKE-PROXY "1" "June 2021" "swnoflake-proxy" "User Commands"
|
||||
.SH NAME
|
||||
snowflake-proxy \- WebRTC pluggable transport proxy for Tor
|
||||
.SH DESCRIPTION
|
||||
Snowflake helps users circumvent censorship by making a WebRTC
|
||||
connection to volunteer proxies. These proxies relay Tor traffic to a
|
||||
Snowflake bridge and then through the Tor network.
|
||||
.SS "Usage of snowflake-proxy:"
|
||||
.HP
|
||||
\fB\-broker\fR string
|
||||
.IP
|
||||
broker URL (default "https://snowflake\-broker.bamsoftware.com/")
|
||||
.HP
|
||||
\fB\-capacity\fR uint
|
||||
.IP
|
||||
maximum concurrent clients (default 10)
|
||||
.HP
|
||||
\fB\-keep\-local\-addresses\fR
|
||||
.IP
|
||||
keep local LAN address ICE candidates
|
||||
.HP
|
||||
\fB\-log\fR string
|
||||
.IP
|
||||
log filename
|
||||
.HP
|
||||
\fB\-relay\fR string
|
||||
.IP
|
||||
websocket relay URL (default "wss://snowflake.bamsoftware.com/")
|
||||
.HP
|
||||
\fB\-stun\fR string
|
||||
.IP
|
||||
stun URL (default "stun:stun.stunprotocol.org:3478")
|
||||
.HP
|
||||
\fB\-unsafe\-logging\fR
|
||||
.IP
|
||||
prevent logs from being scrubbed
|
||||
.SH "SEE ALSO"
|
||||
https://snowflake.torproject.org
|
Loading…
Add table
Add a link
Reference in a new issue