commit 2515ddb1fa4fa744cc86d9a72468ba53a1dfc7dd Author: Serene Han keroserene+git@gmail.com Date: Mon Mar 21 23:18:17 2016 -0700
begin client sub-readme --- client/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+)
diff --git a/client/README.md b/client/README.md new file mode 100644 index 0000000..294d9ee --- /dev/null +++ b/client/README.md @@ -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. +