commit ff5d23b08c7d6301f06c478052cb7f8fea3f2f5b Author: David Fifield <david@bamsoftware.com> Date: Mon Jan 18 23:07:22 2016 -0800 Simpler instructions now for connecting directly to WebRTC server. --- README.md | 48 ++++++++++++++++++++++++++---------------------- 1 file changed, 26 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index b1b35b4..7b6ca9f 100644 --- a/README.md +++ b/README.md @@ -14,48 +14,52 @@ There are currently two ways to try this: - Directly to the go-webrtc server plugin. - Through a browser snowflake proxy. -Using the server plugin requires copy and pasting between 6 terminals. +Using the server plugin uses an HTTP server that simulates the interaction +that a client would have with a facilitator. Using the browser proxy (which will soon be the only way) requires copy and pasting between 3 terminals and a browser tab. Once a signalling facilitator is implemented ([issue #1](https://github.com/keroserene/snowflake/issues/1)) this will become much simpler to use. -Setting up the client is the same in both cases. -Open up three terminals for the **client:** +##### -- Via WebRTC Server -- +Edit server/torrc and add "-http 127.0.0.1:8080" to the end of the +ServerTransportPlugin line: ``` -cd client/ -go build +ServerTransportPlugin snowflake exec ./server -http 127.0.0.1:8080 ``` -A: `tor -f torrc SOCKSPort auto` - -B: `cat > signal` - -C: `tail -F snowflake.log` - -##### -- Via WebRTC Server -- +``` +cd server/ +go build +tor -f torrc +``` -To connect directly to a server plugin, -open up another three terminals for the **server:** +Edit client/torrc and add "-url http://127.0.0.1:8080" to the end of the +ClientTransportPlugin line: +``` +ClientTransportPlugin snowflake exec ./client -url http://127.0.0.1:8080/ +``` ``` -cd server/ +cd client/ go build +tor -f torrc ``` -D: `tor -f torrc` +At this point the tor client should bootstrap to 100%. -E: `cat > signal` +##### -- Via Browser Proxy -- -F: `tail -F snowflake.log` +Open up three terminals for the **client:** -- Look for the offer in terminal C; copy and paste it into terminal E. -- Copy and paste the answer in terminal F to terminal B. -- At this point the tor client should bootstrap to 100%. +A: `tor -f torrc SOCKSPort auto` + +B: `cat > signal` + +C: `tail -F snowflake.log` -##### -- Via Browser Proxy -- To connect through the WebRTC browser proxy, first make sure coffeescript is installed. Then, build with: