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
David Fifield 0c7ddeb1d0 Parse.ipFromSDP function.
2017-10-14 15:06:36 -04:00
..
spec Parse.ipFromSDP function. 2017-10-14 15:06:36 -04:00
static Have embed.html refresh itself once a day. 2017-07-15 14:38:01 -07:00
broker.coffee move disable check to snowflakeIsDisabled 2017-03-01 18:51:24 -08:00
Cakefile Pass on exit code from spawned task so CI fails 2017-01-18 17:20:13 -08:00
coffeelint.json use coffeelint 2016-01-15 08:47:06 -08:00
modernizr-config.json Feature detect with Modernizr 2016-04-05 10:30:45 -07:00
package.json Standalone snowflake 2016-12-20 10:36:42 -08:00
proxypair.coffee default to wss and some documentation updates, #40 2017-02-28 22:46:39 -08:00
README.md Use https links for keroserene.net. 2017-07-14 18:36:44 -07:00
shims.coffee Standalone snowflake 2016-12-20 10:36:42 -08:00
snowflake.coffee disable for TBB user agents. closes #37 2017-03-01 19:09:24 -08:00
ui.coffee Standalone snowflake 2016-12-20 10:36:42 -08:00
util.coffee Parse.ipFromSDP function. 2017-10-14 15:06:36 -04:00
websocket.coffee default to wss and some documentation updates, #40 2017-02-28 22:46:39 -08:00

README.md

This is the browser proxy component of Snowflake.

Embedding

See keroserene.net/snowflake for more info:

<iframe src="https://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:9902 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.