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