commit 4ef2beae3f6cb2c48f7026082f770b5a016224ef Author: emma peel <emma.peel@riseup.net> Date: Mon Dec 2 19:14:10 2019 +0100 one sentence per line, needed for localization --- .../bridge/debian-ubuntu/contents.lr | 13 +++---- .../technical-setup/bridge/docker/contents.lr | 45 ++++++++-------------- 2 files changed, 22 insertions(+), 36 deletions(-) diff --git a/content/relay-operations/technical-setup/bridge/debian-ubuntu/contents.lr b/content/relay-operations/technical-setup/bridge/debian-ubuntu/contents.lr index 7f302c6..b6c57cd 100644 --- a/content/relay-operations/technical-setup/bridge/debian-ubuntu/contents.lr +++ b/content/relay-operations/technical-setup/bridge/debian-ubuntu/contents.lr @@ -25,17 +25,16 @@ If not, you can [build it from source](https://gitlab.com/yawning/obfs4#installa ``` BridgeRelay 1 -# Replace "TODO1" with a Tor port of your choice. This port must be externally -# reachable. Avoid port 9001 because it's commonly associated with Tor and -# censors may be scanning the Internet for this port. +# Replace "TODO1" with a Tor port of your choice. +# This port must be externally reachable. +# Avoid port 9001 because it's commonly associated with Tor and censors may be scanning the Internet for this port. ORPort TODO1 ServerTransportPlugin obfs4 exec /usr/bin/obfs4proxy -# Replace "TODO2" with an obfs4 port of your choice. This port must be -# externally reachable and must be different from the one specified for ORPort. -# Avoid port 9001 because it's commonly associated with -# Tor and censors may be scanning the Internet for this port. +# Replace "TODO2" with an obfs4 port of your choice. +# This port must be externally reachable and must be different from the one specified for ORPort. +# Avoid port 9001 because it's commonly associated with Tor and censors may be scanning the Internet for this port. ServerTransportListenAddr obfs4 0.0.0.0:TODO2 # Local communication port between Tor and obfs4. Always set this to "auto". diff --git a/content/relay-operations/technical-setup/bridge/docker/contents.lr b/content/relay-operations/technical-setup/bridge/docker/contents.lr index 272afcf..4f88a69 100644 --- a/content/relay-operations/technical-setup/bridge/docker/contents.lr +++ b/content/relay-operations/technical-setup/bridge/docker/contents.lr @@ -8,8 +8,8 @@ body: ### 1. Pull the image -We are maintaining a docker image that runs an obfs4 bridge. First, -download the image: +We are maintaining a docker image that runs an obfs4 bridge. +First, download the image: ``` docker pull phwinter/obfs4-bridge:latest @@ -17,10 +17,9 @@ docker pull phwinter/obfs4-bridge:latest ### 2. Deploy a container -We provide a Makefile that helps you deploy the container. First, -[download the Makefile](https://dip.torproject.org/torproject/anti-censorship/docker-obfs4-bridge/ra...), -and then write your bridge configuration to a new file, bridge.sh. Here's a -template: +We provide a Makefile that helps you deploy the container. +First, [download the Makefile](https://dip.torproject.org/torproject/anti-censorship/docker-obfs4-bridge/ra...), and then write your bridge configuration to a new file, bridge.sh. +Here's a template: ``` # Your bridge's Tor port. @@ -31,9 +30,7 @@ export PT_PORT=Y export EMAIL=Z ``` -Replace `X` with your desired OR port, `Y` with your obfs4 port (make sure that -**both** ports are forwarded in your firewall), and `Z` with your email address, -which allows us to get in touch with you if there are problems with your bridge. +Replace `X` with your desired OR port, `Y` with your obfs4 port (make sure that **both** ports are forwarded in your firewall), and `Z` with your email address, which allows us to get in touch with you if there are problems with your bridge. With your bridge configuration in place, you can now deploy the container: ``` @@ -47,12 +44,9 @@ You should now see output similar to the following: Make sure that port X and Y are forwarded in your firewall. ``` -That's it! Your container (identified by the first line of output) is now -bootstrapping your new obfs4 bridge. +That's it! Your container (identified by the first line of output) is now bootstrapping your new obfs4 bridge. -If you want to run multiple bridges on your machine, you need to create more -bridge configuration files with different sets of ports, and run `make deploy` -again, like so: +If you want to run multiple bridges on your machine, you need to create more bridge configuration files with different sets of ports, and run `make deploy` again, like so: ``` source bridge-1.sh && make deploy @@ -62,8 +56,7 @@ source bridge-2.sh && make deploy ### 3. Upgrade your container -To upgrade to the latest version of our image, you need to stop your existing -container, delete it, pull the latest image, and finally deploy it again: +To upgrade to the latest version of our image, you need to stop your existing container, delete it, pull the latest image, and finally deploy it again: ``` docker stop CONTAINER_ID @@ -72,13 +65,9 @@ docker pull phwinter/obfs4-bridge:latest source bridge.sh && make deploy ``` -Note that your bridge's data directory (which includes its key material) is -stored in a docker volume, so you won't lose your bridge's identity when -upgrading to the latest docker image. If you are running multiple bridges on -your computer, you need to repeat this step for each bridge. We will announce -new image versions on the -[tor-dev](https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev) mailing -list. +Note that your bridge's data directory (which includes its key material) is stored in a docker volume, so you won't lose your bridge's identity when upgrading to the latest docker image. +If you are running multiple bridges on your computer, you need to repeat this step for each bridge. +We will announce new image versions on the [tor-dev](https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev) mailing list. ### 4. Monitor your logs @@ -88,8 +77,8 @@ You can inspect your bridge's logs by running: docker logs CONTAINER_ID ``` -To use your new bridge in Tor Browser, you need its "bridge line". Here's how -you can get your bridge line: +To use your new bridge in Tor Browser, you need its "bridge line". +Here's how you can get your bridge line: ``` docker exec CONTAINER_ID get-bridge-line @@ -101,10 +90,8 @@ This will return a string similar to the following: obfs4 1.2.3.4:1234 B0E566C9031657EA7ED3FC9D248E8AC4F37635A4 cert=OYWq67L7MDApdJCctUAF7rX8LHvMxvIBPHOoAp0+YXzlQdsxhw6EapaMNwbbGICkpY8CPQ iat-mode=0 ``` -Make sure to check out the [post-install -notes](https://community.torproject.org/relay/setup/bridge/post-install/). If -you are having troubles setting up your bridge, have a look at [our help -section](https://community.torproject.org/relay/getting-help/). +Make sure to check out the [post-install notes](https://community.torproject.org/relay/setup/bridge/post-install/). +If you are having troubles setting up your bridge, have a look at [our help section](https://community.torproject.org/relay/getting-help/). --- html: two-columns-page.html