mirror of
https://github.com/keroserene/snowflake.git
synced 2026-08-15 12:50:40 +02:00
a762becbaa
I'm intuiting that the purpose of linking to github was to show the README, not to link to the source code per se, so I changed the link to point to the wiki page rather than gitweb.torproject.org/.... https://bugs.torproject.org/23947#comment:15 |
||
|---|---|---|
| .. | ||
| spec | ||
| static | ||
| broker.coffee | ||
| Cakefile | ||
| coffeelint.json | ||
| modernizr-config.json | ||
| package.json | ||
| proxypair.coffee | ||
| README.md | ||
| shims.coffee | ||
| snowflake.coffee | ||
| ui.coffee | ||
| util.coffee | ||
| websocket.coffee | ||
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>
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-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.