[tor-commits] [snowflake/master] keep readme up to date

arlo at torproject.org arlo at torproject.org
Wed Mar 9 21:08:54 UTC 2016


commit d61534b3a01597ce2f9da701a9248e3215f48f05
Author: Serene Han <keroserene+git at gmail.com>
Date:   Tue Mar 8 18:23:28 2016 -0800

    keep readme up to date
---
 README.md    | 26 +++++++++++++++-----------
 client/torrc |  2 +-
 2 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 425a07d..1316003 100644
--- a/README.md
+++ b/README.md
@@ -51,8 +51,9 @@ Proxy:
 The client uses the following `torrc` options:
 ```
 ClientTransportPlugin snowflake exec ./client \
---url https://snowflake-reg.appspot.com/ \
---front www.google.com
+-url https://snowflake-reg.appspot.com/ \
+-front www.google.com \
+-ice stun:stun.l.google.com:19302
 ```
 
 Which allows it to speak to the Broker,
@@ -93,18 +94,21 @@ cd build/
 python -m http.server
 ```
 
-Open a browser tab to `0.0.0.0:8000/snowflake.html`.
-
-TODO: Turn the snowflake proxy into a more deployable badge.
+Then, open a browser tab to `0.0.0.0:8000/snowflake.html`,
+which causes you to act as an ephemeral Tor bridge.
 
 ### Appendix
 
 ##### -- Testing directly via WebRTC Server --
 
-Using the server plugin uses an HTTP server that simulates the interaction
-that a client would have with a broker.
-Using the browser proxy (which will soon be the only way) requires copy and
-pasting between 3 terminals and a browser tab.
+Ordinarily, the WebrTC client plugin speaks with a Broker which helps
+match and signal with a browser proxy, which ultimately speaks with a default
+websocket server.
+
+
+However, there is a WebRTC server plugin which uses an HTTP server that
+simulates the interaction that a client would have with the broker, for
+direct testing.
 
 Edit server/torrc and add "-http 127.0.0.1:8080" to the end of the
 ServerTransportPlugin line:
@@ -124,11 +128,11 @@ ClientTransportPlugin line:
 ClientTransportPlugin snowflake exec ./client -url http://127.0.0.1:8080/
 ```
 
-##### -- Via Browser Proxy --
+##### -- Testing Copy-Paste Via Browser Proxy --
 
 Open up three terminals for the **client:**
 
-A: `tor -f torrc SOCKSPort auto`
+A: `tor -f torrc-manual SOCKSPort auto`
 
 B: `cat > signal`
 
diff --git a/client/torrc b/client/torrc
index b6d0f61..c4af61f 100644
--- a/client/torrc
+++ b/client/torrc
@@ -4,6 +4,6 @@ DataDirectory datadir
 ClientTransportPlugin snowflake exec ./client \
 -url https://snowflake-reg.appspot.com/ \
 -front www.google.com \
--ice stun:stun.l.google.com:19302,stun:s1.taraba.net
+-ice stun:stun.l.google.com:19302
 
 Bridge snowflake 0.0.3.0:1





More information about the tor-commits mailing list