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
Serene Han e38bed8be3 convert all coffeescript tests to jasmine
2016-02-04 14:57:12 -08:00
..
lib successful bootstrap through browser proxy! (closes #5) 2016-01-12 11:14:28 -08:00
static Snowflake badge works, and animates when serving client (issue #16) and some logging cleanups 2016-02-03 21:37:21 -08:00
broker.coffee Snowflake badge works, and animates when serving client (issue #16) and some logging cleanups 2016-02-03 21:37:21 -08:00
Cakefile convert all coffeescript tests to jasmine 2016-02-04 14:57:12 -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
proxypair.coffee Snowflake badge works, and animates when serving client (issue #16) and some logging cleanups 2016-02-03 21:37:21 -08:00
README.md convert all coffeescript tests to jasmine 2016-02-04 14:57:12 -08:00
shims.coffee split and organize coffee files, improve Cake build tasks 2016-01-14 16:28:32 -08:00
snowflake.coffee convert all coffeescript tests to jasmine 2016-02-04 14:57:12 -08:00
spec.coffee convert all coffeescript tests to jasmine 2016-02-04 14:57:12 -08:00
ui.coffee Snowflake badge works, and animates when serving client (issue #16) and some logging cleanups 2016-02-03 21:37:21 -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 convert all coffeescript tests to jasmine 2016-02-04 14:57:12 -08:00

README.md

This is the browser proxy component of Snowflake.

Testing:

Unit testing with Jasmine are available with:

cake test

Requires jasmine. (npm install -g jasmine)

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.