[tor-commits] [community/develop] Update instructions to match new docker workflow.
hiro at torproject.org
hiro at torproject.org
Thu Jan 23 16:44:42 UTC 2020
Author: Philipp Winter <phw at nymity.ch>
Date: Wed Nov 20 13:23:30 2019 -0800
Update instructions to match new docker workflow.
.../technical-setup/bridge/docker/contents.lr | 47 ++++++++++++----------
1 file changed, 26 insertions(+), 21 deletions(-)
diff --git a/content/relay-operations/technical-setup/bridge/docker/contents.lr b/content/relay-operations/technical-setup/bridge/docker/contents.lr
index f401b1e..ebc4b97 100644
@@ -6,37 +6,42 @@ title: Docker
-We are maintaining a docker container that runs an obfs4 bridge. This guide
-walks you through setting up this container. First, download the container:
+### 1. Install the container
+We are maintaining a docker container that runs an obfs4 bridge. First,
+download the container:
docker pull phwinter/obfs4-bridge:latest
-Now, it's time to run the container. You can choose between two options:
+### 2. Deploy the container
+We provide a Makefile that makes it easy to deploy the container. First,
+and then run:
-1. We maintain a script that determines a free OR and obfs4 port for you, and
- then runs the docker container.
- [Download the script here](https://dip.torproject.org/torproject/anti-censorship/docker-obfs4-bridge/raw/master/deploy-container.sh).
- When running this script, provide your email address as argument:
- bash deploy-container.sh address at email.com
- The script will tell you what ports it chose, and your container ID. Make
- sure that **both** ports are forwarded in your firewall.
+make deploy OR_PORT=X PT_PORT=Y EMAIL=Z
-2. If you would rather provide your own ports, run the following command and
- replace `XXX` with your OR port, `YYY` with your obfs4 port, and
- `admin at example.com` with your email address.
+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.
+If everything worked fine, you should see output similar to the following:
+Make sure that port X and Y are forwarded in your firewall.
- OR_PORT=XXX PT_PORT=YYY EMAIL=admin at example.com; docker run -d -e OR_PORT=$OR_PORT -e PT_PORT=$PT_PORT -e EMAIL=$EMAIL -p $OR_PORT:$OR_PORT -p $PT_PORT:$PT_PORT phwinter/obfs4-bridge:latest
+That's it! Your container (identified by the first line of output) is now
+bootstrapping your new obfs4 bridge.
- Again, make sure that **both** ports are forwarded by your firewall.
+### 3. Monitor your logs
-That's it! Your container should now be bootstrapping your new obfs4 bridge.
-You can inspect its logs by running:
+You can inspect your bridge's logs by running:
docker logs CONTAINER_ID
More information about the tor-commits