archives/snowflake
2
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake.git synced 2025-10-13 20:11:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
snowflake/proxy
History
Cecylia Bocovich 9e22af90c1 Updated webextension translations
2019-10-04 13:52:07 -04:00
..
spec Added check for active pair in onopen 2019-08-26 09:15:38 -04:00
static Use a static label for the button 2019-10-01 14:27:19 -04:00
translation@da8fb4b405 Updated webextension translations 2019-10-04 13:52:07 -04:00
webext Use a static label for the button 2019-10-01 14:27:19 -04:00
.eslintignore Cleanup lints identified by eslint 2019-07-10 10:58:29 +02:00
.eslintrc.json Enforce consistent indentation in js 2019-08-27 18:19:51 -04:00
broker.js Cleanup lints identified by eslint 2019-07-10 10:58:29 +02:00
config.js Increase webextension poll period 2019-08-12 13:14:25 -04:00
init-badge.js Use a static label for the button 2019-10-01 14:27:19 -04:00
init-node.js Cleanup lints identified by eslint 2019-07-10 10:58:29 +02:00
init-testing.js Move more UI code to use specific sites 2019-07-27 12:01:03 -04:00
init-webext.js Reorder enable checks 2019-09-30 18:42:57 -04:00
make.js Enforce consistent indentation in js 2019-08-27 18:19:51 -04:00
package.json Lint with eslint 2019-07-10 10:58:29 +02:00
proxypair.js Enforce consistent indentation in js 2019-08-27 18:19:51 -04:00
README.md Add --chmod ug=rw,D+x --perms to rsync commands. 2019-08-23 22:51:27 -06:00
shims.js Bug 31126: Use URLSearchParams instead of Query.parse. 2019-07-18 18:29:59 -06:00
snowflake.js Added check for active pair in onopen 2019-08-26 09:15:38 -04:00
ui.js Move more UI code to use specific sites 2019-07-27 12:01:03 -04:00
util.js Remove Util.mightBeTBB 2019-07-27 12:01:03 -04:00
websocket.js Move probe to WS class for reuse in the badge 2019-09-30 18:42:57 -04:00

README.md

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

npm run build

Testing

Unit testing with Jasmine are available with:

npm install
npm test

To run locally, start an http server in build/ and navigate to /embed.html.

Preparing to deploy

Background information:

You need to be in LDAP group "snowflake" and have set up an SSH key with your LDAP account. In your ~/.ssh/config file, you should have something like:

Host staticiforme
HostName staticiforme.torproject.org
User <your user name>
ProxyJump people.torproject.org
IdentityFile ~/.ssh/tor

Deploying

npm run build

Do a "dry run" rsync with -n to check that only expected files are being changed. If you don't understand why a file would be updated, you can add the -i option to see the reason.

rsync -n --chmod ug=rw,D+x --perms --delete -crv build/ staticiforme:/srv/snowflake.torproject.org/htdocs/

If it looks good, then repeat the rsync without -n.

rsync --chmod ug=rw,D+x --perms --delete -crv build/ staticiforme:/srv/snowflake.torproject.org/htdocs/

Then run the command to copy the new files to the live web servers:

ssh staticiforme 'static-update-component snowflake.torproject.org'

Parameters

With no parameters, snowflake uses the default relay snowflake.freehaven.net:443 and uses automatic signaling with the default broker at https://snowflake-broker.freehaven.net/.