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 261ef8f5bc Remove duplicate ProxyPair tests from util.spec.coffee.
2018-12-04 15:09:53 -07:00
..
spec Remove duplicate ProxyPair tests from util.spec.coffee. 2018-12-04 15:09:53 -07:00
static Fix text-shadow CSS. 2018-04-17 17:21:46 -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 Downgrade coffeelint line lengths to a "warning" 2017-10-18 11:39:17 -04:00
modernizr-config.json Feature detect with Modernizr 2016-04-05 10:30:45 -07:00
package.json Freeze jasmine until tests are updated for newer version 2018-03-05 20:40:47 -05:00
proxypair.coffee Bug 18628: Pass the client_ip parameter in the JavaScript proxy as well. 2017-10-14 15:06:36 -04:00
README.md Change to standalone broker. 2018-04-16 10:24:00 -07:00
shims.coffee Standalone snowflake 2016-12-20 10:36:42 -08:00
snowflake.coffee Change to standalone broker. 2018-04-16 10:24:00 -07: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 Bug 18628: Pass the client_ip parameter in the JavaScript proxy as well. 2017-10-14 15:06:36 -04:00

README.md

This is the browser proxy component of Snowflake.

Embedding

See https://snowflake.torproject.org/ for more info:

<iframe src="https://snowflake.torproject.org/embed.html" width="88" height="16" frameborder="0" scrolling="no"></iframe>

Building

cake build

(Type cake by itself to see possible commands)

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 snowflake.bamsoftware.com:443 and uses automatic signaling with the default broker at https://snowflake-broker.bamsoftware.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.