From 6f05e7bf9ff3d623f0ff8a895728494cb20132c5 Mon Sep 17 00:00:00 2001 From: preland <89992615+preland@users.noreply.github.com> Date: Tue, 29 Oct 2024 11:50:56 -0500 Subject: [PATCH] Update external-tor-usage.md --- docs/external-tor-usage.md | 35 ++++++++++++++++------------------- 1 file changed, 16 insertions(+), 19 deletions(-) diff --git a/docs/external-tor-usage.md b/docs/external-tor-usage.md index 21ad06b5df..69f417d8f1 100644 --- a/docs/external-tor-usage.md +++ b/docs/external-tor-usage.md @@ -3,47 +3,44 @@ ## Setting up Tor: ### 1. Download and Install Tor -#### Linux -You can install Tor through your system's package manager (on Debian/Ubuntu: ```apt install tor```; see note 1. below), or directly by going to torproject.org. Note that your package manager's version of tor might be outdated or non-GNU (see note 2. below). -#### MacOS -You can install Tor through Homebrew (```brew install tor```), or directly by going to torproject.org. Note that the Homebrew version of tor might be outdated or non-GNU (see note 2. below). -#### Windows -You can install Tor directly by going to torproject.org. ->1. Tor recommends using their own repository on Debian/Ubuntu, see [here](https://support.torproject.org/apt/tor-deb-repo/). ->2. For best results, ensure that your version of tor matches the one currently used by Haveno. To improve loading times, it is highly recommended to use the GNU build, as it has support for POW. You can check if your build is GNU by running tor --version and looking for a response mentioning GNU. +> If you already have Tor, you can skip this step; ensure it has POW support before proceeding. + +Regardless of platform, the recommended way to download and install Tor is by going to [the Tor Project's website](https://www.torproject.org/download/) and following their instructions. +> For best results, ensure that your version of tor matches the one currently used by Haveno. To improve loading times, it is highly recommended to use the GNU build, as it has support for POW. You can check if your build is GNU by running tor --version and looking for a response mentioning GNU. ### 2. Add the following lines to your torrc file: ``` controlPort=9051 CookieAuthentication 1 -CookieAuthFile +CookieAuthFile /control_auth_cookie ``` -> The "CookieAuthFile" will not exist until after Tor is ran, so running Tor once will create it if it does not exist. The file's location, while technically arbitrary, should be in a relatively stable and safe place. For example, on Linux it could be placed at ```/etc/tor/control_auth_cookie```, or next to your torrc file. -#### The location of your torrc file varies depending on your system: +> The "CookieAuthFile" will not exist until after Tor is ran, so running Tor once should create it if it does not exist. +#### Your torrc file is within your tor config path, which varies depending on your system: -#### Linux +##### Linux ```/etc/tor/torrc``` -#### MacOS +##### MacOS ```/usr/local/etc/tor/torrc``` -#### Windows +##### Windows ```\Browser\TorBrowser\Data\Tor\torrc``` (when using the Tor Browser Bundle) -> The above locations are best guesses, and may be incorrect depending on your installation method or platform distribution. In the case that you cannot find the correct directory to place your torrc, tor can be ran in the following format to use a custom torrc: ```tor -f ``` +> The above locations are best guesses, and may be incorrect depending on your installation method or platform distribution. In the case that you cannot find the correct directory to place your torrc or you suspect the desired directory is not being used, tor can be ran with a custom torrc: ```tor -f ``` ### 3. Stop any currently running tor processes #### Linux/MacOS ```killall tor``` #### Windows ```Stop-Process -Name tor``` +>on Linux/MacOS, it may be wise to also run ```sudo killall tor``` in case the process is owned by root on accident. On systems with multiple concurrent users, properly killing tor might require running ```killall tor``` on all relevant users. ### 4. Start Tor -```tor``` +To start tor, simply run ```tor```, or ```tor -f ``` for a custom configuration. >On Linux/MacOS, the user running tor must be a member of the "tor" usergroup. ## Using External Tor with Haveno: Run the Haveno binary with the following extra flags: ``` ---torControlPort=9051 --torControlCookieFile= --torControlUseSafeCookieAuth=true +--torControlPort=9051 --torControlCookieFile=/control_auth_cookie --torControlUseSafeCookieAuth=true ``` -> Replace the `````` with the location you specified in step 2. +> Replace the `````` with the location specified in step 2. -> Depending on how your version of Haveno was distributed, you may not have direct access to the Haveno binary. In this case, you should look inside your Haveno distribution for the binary, and then run the binary using the above flags. For example, on MacOS the binary will be located within the app at Haveno.app/Contents/MacOS/Haveno, or something similar. +> Depending on how your version of Haveno was distributed, you may not have direct access to the Haveno binary. In this case, you should look inside your Haveno distribution for the binary, and then run the binary using the above flags. For example, on MacOS the binary will be located within the app at Haveno.app/Contents/MacOS/Haveno, or something similar.