archives/snowflake
2
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake.git synced 2025-10-14 05:11:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
snowflake/proxy/README.md
David Fifield 947636ae81 Change to standalone broker. 
https://snowflake-reg-test.appspot.com/ for the client (needs domain fronting)
https://snowflake-broker.bamsoftware.com/ for the proxies (no fronting)

Note that fronting to App Engine doesn't currently actually work because
of https://bugs.torproject.org/25804; this commit doesn't change that.
2018-04-16 10:24:00 -07:00

983 B
Raw Blame History

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.