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

begin client sub-readme

Browse source
This commit is contained in:
Serene Han 2016-03-21 23:18:17 -07:00 • committed by Arlo Breault
parent 451edb6dec
commit 2515ddb1fa
1 changed files with 23 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

23
client/README.md Normal file
View file

@ -0,0 +1,23 @@
This is the Tor client component of Snowflake.
It is based on goptlib.
### Flags
The client uses these following `torrc` options by default:
```
ClientTransportPlugin snowflake exec ./client \
-url https://snowflake-reg.appspot.com/ \
-front www.google.com \
-ice stun:stun.l.google.com:19302
```
`-url` should be the URL of a Broker instance. This is required to have
automated signalling (which is desired in most use cases).
When omitted, the client uses copy-paste signalling instead.
`-front` is an optional front domain for the Broker request.
`-ice` is a comma-separated list of ICE servers. These can be STUN or TURN
servers.