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
snowflake/proxy
History
Arlo Breault 422717f36f Update proxy readme for npm
2016-03-14 20:46:52 -07:00
..
lib successful bootstrap through browser proxy! (closes #5) 2016-01-12 11:14:28 -08:00
spec prepare for multiplexed snowflake (#11) 2016-03-12 22:29:56 -08:00
static Update Snowflake embed, and add info page about it (close #16) 2016-02-10 14:03:13 -08:00
broker.coffee prepare for multiplexed snowflake (#11) 2016-03-12 22:29:56 -08:00
Cakefile Begin spec for proxy-side broker interaction 2016-02-08 19:27:28 -08:00
coffee-snowflake.html split and organize coffee files, improve Cake build tasks 2016-01-14 16:28:32 -08:00
coffeelint.json use coffeelint 2016-01-15 08:47:06 -08:00
package.json Run client tests in travis too 2016-03-14 19:38:59 -07:00
proxypair.coffee simplify proxypair relay onclose 2016-03-13 23:25:47 -07:00
README.md Update proxy readme for npm 2016-03-14 20:46:52 -07:00
shims.coffee split and organize coffee files, improve Cake build tasks 2016-01-14 16:28:32 -08:00
snowflake.coffee simplify proxypair relay onclose 2016-03-13 23:25:47 -07:00
ui.coffee more jasmine specs for proxypair, ui, and snowflake coffee files 2016-02-07 08:35:01 -08:00
util.coffee Query string params available in the snowflake proxy for manual mode, broker url, and target relay address 2016-01-23 09:27:26 -08:00
websocket.coffee better ProxyPair jasmine specs, ensure travis using more recent npm 2016-02-05 12:06:37 -08:00

README.md

This is the browser proxy component of Snowflake.

Embedding

See keroserene.net/snowflake for more info:

<iframe src="http://keroserene.net/snowflake/embed.html" width="88" height="16" frameborder="0" scrolling="no"></iframe>

Testing

Unit testing with Jasmine are available with:

npm install
npm test

To run locally, either:

  • Navigate to proxy/build/embed.html
  • For a more fully featured "debug" version, start a webserver and navigate to snowflake.html.

Parameters

With no parameters, snowflake uses the default relay 192.81.135.242:9901 and uses automatic signaling with the default broker at https://snowflake-reg.appspot.com/.

Here are optional parameters to include in the query string.

manual - enables copy-paste signalling mode.
relay=<address> - use a custom target relay.
broker=<url> - use a custom broker.