snowflake/proxy/README.md
David Fifield 57c0724491 Use 192.81.135.242:9902 as the default relay.
This is the relay that reports using the transport name "snowflake".
https://bugs.torproject.org/18627
2016-03-27 12:49:20 -07:00

35 lines
908 B
Markdown

This is the browser proxy component of Snowflake.
### Embedding
See [keroserene.net/snowflake](http://keroserene.net/snowflake) for more info:
```
<iframe src="http://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.
```