March 2021 - tor-commits - lists.torproject.org

[community/staging] Fix relay post-install link
by hiro＠torproject.org 21 Mar '21

21 Mar '21

commit 110c22f798f167661ca4b209949349814b7a81be Author: Gustavo Gus <gusgustavo(a)users.noreply.github.com> Date: Wed Nov 13 20:22:22 2019 +0000 Fix relay post-install link --- content/relay-operations/technical-setup/contents.lr | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/relay-operations/technical-setup/contents.lr b/content/relay-operations/technical-setup/contents.lr index 6ce43c8..cbd5812 100644 --- a/content/relay-operations/technical-setup/contents.lr +++ b/content/relay-operations/technical-setup/contents.lr @@ -40,6 +40,6 @@ If you are looking to run a relay with minimal effort, we recommend you stick to The installation commands are shown in code blocks and must be executed with root privileges. -Click below in which type of relay do you want to host and don't forget to read [Relay post-install and good practices](relays-post-install-and-good-practices). +Click below in which type of relay do you want to host and don't forget to read [Relay post-install and good practices](/relay/setup/post-install/). --- _slug: {{setup}}

1 0

[community/staging] Rephrase Debian-specific note to general note.
by hiro＠torproject.org 21 Mar '21

21 Mar '21

commit 4b3df13c6d26ec9c4b928ce8dd7c7d66c2af75ae Author: Philipp Winter <phw(a)nymity.ch> Date: Tue Nov 26 09:27:02 2019 -0800 Rephrase Debian-specific note to general note. It doesn't just apply to Debian. It applies to Ubuntu as well. Thanks to Micah for pointing this out! --- .../relay-operations/technical-setup/bridge/debian-ubuntu/contents.lr | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 9596a38..7f302c6 100644 --- a/content/relay-operations/technical-setup/bridge/debian-ubuntu/contents.lr +++ b/content/relay-operations/technical-setup/bridge/debian-ubuntu/contents.lr @@ -60,7 +60,7 @@ Don't forget to change the `ORPort`, `ServerTransportListenAddr`, `ContactInfo`, If your bridge is behind a firewall or NAT, make sure to open both ports. You can use [our reachability test](https://bridges.torproject.org/scan/) to see if your obfs4 port is reachable from the Internet. -Under Debian, you will also need to set `NoNewPrivileges=no` in `/lib/systemd/system/tor(a)default.service` and `/lib/systemd/system/tor@.service` and then run `systemctl daemon-reload`. (see [bug #18356](https://trac.torproject.org/projects/tor/ticket/18356)) +You will also need to set `NoNewPrivileges=no` in `/lib/systemd/system/tor(a)default.service` and `/lib/systemd/system/tor@.service` and then run `systemctl daemon-reload`. (see [bug #18356](https://trac.torproject.org/projects/tor/ticket/18356)) ### 4. Restart tor

1 0

[community/staging] Update instructions to match new docker workflow.
by hiro＠torproject.org 21 Mar '21

21 Mar '21

commit 5d8c76860a2aa2de29d054cfc29a520a73b7f9fc Author: Philipp Winter <phw(a)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 --- a/content/relay-operations/technical-setup/bridge/docker/contents.lr +++ b/content/relay-operations/technical-setup/bridge/docker/contents.lr @@ -6,37 +6,42 @@ title: Docker --- body: -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, +[download the +Makefile](https://dip.torproject.org/torproject/anti-censorship/docker-obfs4-bridge/raw/master/Makefile), +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-br…. - When running this script, provide your email address as argument: - ``` - bash deploy-container.sh address(a)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(a)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: + +``` +201fbd2b4d28e6f226978f27547edd79272871c5949bf8aab3872c983156a108 +Make sure that port X and Y are forwarded in your firewall. +``` - ``` - OR_PORT=XXX PT_PORT=YYY EMAIL=admin(a)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

1 0

[community/staging] Update lego
by hiro＠torproject.org 21 Mar '21

21 Mar '21

commit c3ea4bb0980d1c30d7674359771ecab54b9c1a7d Author: hiro <hiro(a)torproject.org> Date: Mon Nov 25 18:32:48 2019 +0100 Update lego --- lego | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lego b/lego index 7f196bc..3409e3e 160000 --- a/lego +++ b/lego @@ -1 +1 @@ -Subproject commit 7f196bc35e6bc2555e9a13ee024f322840433954 +Subproject commit 3409e3eebc2ffca079bf890b5ecb5add6fceccbc

1 0

[community/staging] Add instructions on how to upgrade a container.
by hiro＠torproject.org 21 Mar '21

21 Mar '21

commit 17bb36d926b9ad67af4dc7a504c8c36367d4a608 Author: Philipp Winter <phw(a)nymity.ch> Date: Tue Nov 26 09:25:21 2019 -0800 Add instructions on how to upgrade a container. --- .../technical-setup/bridge/docker/contents.lr | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/content/relay-operations/technical-setup/bridge/docker/contents.lr b/content/relay-operations/technical-setup/bridge/docker/contents.lr index aff4cf2..9c7cf44 100644 --- a/content/relay-operations/technical-setup/bridge/docker/contents.lr +++ b/content/relay-operations/technical-setup/bridge/docker/contents.lr @@ -40,7 +40,19 @@ That's it! Your container (identified by the first line of output) is now bootstrapping your new obfs4 bridge. If you want to run more than one bridge on a single machine, run `make deploy` again, but with a different set of ports. -### 3. Monitor your logs +### 3. Upgrade a 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: + +``` +docker stop CONTAINER_ID +docker rm CONTAINER_ID +docker pull phwinter/obfs4-bridge:latest +make deploy OR_PORT=X PT_PORT=Y EMAIL=Z +``` + +### 4. Monitor your logs You can inspect your bridge's logs by running:

1 0

[community/staging] Refactor docker installation instructions.
by hiro＠torproject.org 21 Mar '21

21 Mar '21

commit d654c53eca0e179ef145c25a36f4917e62c154e7 Author: Philipp Winter <phw(a)nymity.ch> Date: Tue Nov 26 15:45:42 2019 -0800 Refactor docker installation instructions. --- .../technical-setup/bridge/docker/contents.lr | 50 +++++++++++++++++----- 1 file changed, 39 insertions(+), 11 deletions(-) diff --git a/content/relay-operations/technical-setup/bridge/docker/contents.lr b/content/relay-operations/technical-setup/bridge/docker/contents.lr index 9c7cf44..272afcf 100644 --- a/content/relay-operations/technical-setup/bridge/docker/contents.lr +++ b/content/relay-operations/technical-setup/bridge/docker/contents.lr @@ -17,19 +17,30 @@ docker pull phwinter/obfs4-bridge:latest ### 2. Deploy a container -We provide a Makefile that makes it easy to deploy a container. First, -[download the -Makefile](https://dip.torproject.org/torproject/anti-censorship/docker-obfs4-bridge/raw/master/Makefile), -and then run: +We provide a Makefile that helps you deploy the container. First, +[download the Makefile](https://dip.torproject.org/torproject/anti-censorship/docker-obfs…, +and then write your bridge configuration to a new file, bridge.sh. Here's a +template: ``` -make deploy OR_PORT=X PT_PORT=Y EMAIL=Z +# Your bridge's Tor port. +export OR_PORT=X +# Your bridge's obfs4 port. +export PT_PORT=Y +# Your email address. +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. -If everything worked fine, you should see output similar to the following: +With your bridge configuration in place, you can now deploy the container: + +``` +source bridge.sh && make deploy +``` + +You should now see output similar to the following: ``` 201fbd2b4d28e6f226978f27547edd79272871c5949bf8aab3872c983156a108 @@ -37,21 +48,38 @@ 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. If you want to run more than one bridge on -a single machine, run `make deploy` again, but with a different set of ports. +bootstrapping your new obfs4 bridge. -### 3. Upgrade a container +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 +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: +container, delete it, pull the latest image, and finally deploy it again: ``` docker stop CONTAINER_ID docker rm CONTAINER_ID docker pull phwinter/obfs4-bridge:latest -make deploy OR_PORT=X PT_PORT=Y EMAIL=Z +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. + ### 4. Monitor your logs You can inspect your bridge's logs by running:

1 0

[community/staging] Update lego
by hiro＠torproject.org 21 Mar '21

21 Mar '21

commit 6e38bca0a62530ed137e8d93c2d54704103a852e Author: hiro <hiro(a)torproject.org> Date: Wed Nov 27 14:32:44 2019 +0100 Update lego --- lego | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lego b/lego index 7c0e9ee..d892ab1 160000 --- a/lego +++ b/lego @@ -1 +1 @@ -Subproject commit 7c0e9ee42a4cdef87ebb8eefa7dde2df89403c94 +Subproject commit d892ab188dbc30f5827c93fc851506e383b48715

1 0

[community/staging] Explain how to run multiple containers.
by hiro＠torproject.org 21 Mar '21

21 Mar '21

commit a5aebc83ddcccf46e6478b73f9f819516e532780 Author: Philipp Winter <phw(a)nymity.ch> Date: Mon Nov 25 15:28:32 2019 -0800 Explain how to run multiple containers. --- content/relay-operations/technical-setup/bridge/docker/contents.lr | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/relay-operations/technical-setup/bridge/docker/contents.lr b/content/relay-operations/technical-setup/bridge/docker/contents.lr index 994453c..aff4cf2 100644 --- a/content/relay-operations/technical-setup/bridge/docker/contents.lr +++ b/content/relay-operations/technical-setup/bridge/docker/contents.lr @@ -37,7 +37,8 @@ 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. +bootstrapping your new obfs4 bridge. If you want to run more than one bridge on +a single machine, run `make deploy` again, but with a different set of ports. ### 3. Monitor your logs

1 0

[community/staging] Update lego
by hiro＠torproject.org 21 Mar '21

21 Mar '21

commit cfb123cf39a4712e7b6f9663abc3176a080c9a03 Author: hiro <hiro(a)torproject.org> Date: Wed Nov 27 15:24:40 2019 +0100 Update lego --- lego | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lego b/lego index ab20d49..c722b34 160000 --- a/lego +++ b/lego @@ -1 +1 @@ -Subproject commit ab20d4988902e4dd228e15c9fbd51d7041ba8323 +Subproject commit c722b346e16884df3bedc93cffba8887cfcb65e1

1 0

[community/staging] Distinguish between a docker image and container.
by hiro＠torproject.org 21 Mar '21

21 Mar '21

commit d32c17df40f1bc0a22d2a452b381c19d30fa2491 Author: Philipp Winter <phw(a)nymity.ch> Date: Mon Nov 25 15:28:03 2019 -0800 Distinguish between a docker image and container. --- .../relay-operations/technical-setup/bridge/docker/contents.lr | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/relay-operations/technical-setup/bridge/docker/contents.lr b/content/relay-operations/technical-setup/bridge/docker/contents.lr index ebc4b97..994453c 100644 --- a/content/relay-operations/technical-setup/bridge/docker/contents.lr +++ b/content/relay-operations/technical-setup/bridge/docker/contents.lr @@ -6,18 +6,18 @@ title: Docker --- body: -### 1. Install the container +### 1. Pull the image -We are maintaining a docker container that runs an obfs4 bridge. First, -download the container: +We are maintaining a docker image that runs an obfs4 bridge. First, +download the image: ``` docker pull phwinter/obfs4-bridge:latest ``` -### 2. Deploy the container +### 2. Deploy a container -We provide a Makefile that makes it easy to deploy the container. First, +We provide a Makefile that makes it easy to deploy a container. First, [download the Makefile](https://dip.torproject.org/torproject/anti-censorship/docker-obfs…, and then run:

1 0