mirror of
https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake.git
synced 2025-10-14 14:11:23 -04:00
35 lines
942 B
Markdown
35 lines
942 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:
|
|
```
|
|
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.
|
|
```
|