snowflake/proxy/README.md
2016-02-04 14:57:12 -08:00

28 lines
719 B
Markdown

This is the browser proxy component of Snowflake.
### 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.
```