Apply conversion script to all *.md files. authored by Alexander Hansen Færøy's avatar Alexander Hansen Færøy
== Relay Setup Guide for Windows 10 == ## Relay Setup Guide for Windows 10
Setting up a Windows system as a relay requires performing a few simple steps. To begin you must download the expert bundle, implement a torrc configuration file and finish by starting Tor from the command line. Below are detailed instructions on how to perform these steps - please ensure you follow them very carefully, and make any of the necessary modifications outlined along the way. Setting up a Windows system as a relay requires performing a few simple steps. To begin you must download the expert bundle, implement a torrc configuration file and finish by starting Tor from the command line. Below are detailed instructions on how to perform these steps - please ensure you follow them very carefully, and make any of the necessary modifications outlined along the way.
'''Important note:'' Running an exit relay from a Windows machine is '''highly discouraged''' unless you are an experienced Windows system administrator who is comfortable setting up DNS resolvers and performing other complex configuration tasks. As always, never run an exit relay from your home. **Important note:_ Running an exit relay from a Windows machine is **highly discouraged_' unless you are an experienced Windows system administrator who is comfortable setting up DNS resolvers and performing other complex configuration tasks. As always, never run an exit relay from your home.
=== Downloading and configuring the Tor Expert bundle === ### Downloading and configuring the Tor Expert bundle
1. Head over to [https://www.torproject.org/download/download.html.en the official Tor download page] and select the 'Windows' drop-down menu. The second option should be the expert bundle - download it, and verify the checksum if desired. 1. Head over to [the official Tor download page](https://www.torproject.org/download/download.html.en) and select the 'Windows' drop-down menu. The second option should be the expert bundle - download it, and verify the checksum if desired.
2. Head to your C:\ directory. Create a folder called {{{tor}}}. 2. Head to your C:\ directory. Create a folder called `tor`.
* (Optional. A custom path can be used, though you will have to make necessary modifications in the following steps.) * (Optional. A custom path can be used, though you will have to make necessary modifications in the following steps.)
3. Unpack the zipped Expert bundle into your newly created Tor directory. Two files will be placed there; one called {{{Tor}}}, and the other {{{Data}}}. 3. Unpack the zipped Expert bundle into your newly created Tor directory. Two files will be placed there; one called `Tor`, and the other `Data`.
4. You will now need to create a {{{torrc}}} file to define the ruleset of your relay. The default directory path for this file is {{{C:\Users\YOURUSERNAME\AppData\Roaming\tor\torrc}}}, though you can specify a custom location at startup with the {{{-f}}} flag. (More below) 4. You will now need to create a `torrc` file to define the ruleset of your relay. The default directory path for this file is `C:\Users\YOURUSERNAME\AppData\Roaming\tor\torrc`, though you can specify a custom location at startup with the `-f` flag. (More below)
5. Open up your newly created {{{torrc}}} file in your text editor and populate it with the following contents: 5. Open up your newly created `torrc` file in your text editor and populate it with the following contents:
{{{ ```
# Change the nickname "myNiceRelay" to a name that you like # Change the nickname "myNiceRelay" to a name that you like
Nickname myNiceRelay Nickname myNiceRelay
...@@ -33,16 +33,16 @@ GeoIPv6File C:\tor\Data\Tor\geoip6 ...@@ -33,16 +33,16 @@ GeoIPv6File C:\tor\Data\Tor\geoip6
# Put your email below - Note that it will be published on the metrics page # Put your email below - Note that it will be published on the metrics page
ContactInfo tor-operator@your-emailaddress-domain ContactInfo tor-operator@your-emailaddress-domain
}}} ```
6. Make sure everything is filled in correctly, then save and exit. 6. Make sure everything is filled in correctly, then save and exit.
=== Starting up your relay === ### Starting up your relay
1. Open your command prompt. Navigate to C:\tor\Tor with the command {{{cd C:\tor\Tor}}} 1. Open your command prompt. Navigate to C:\tor\Tor with the command `cd C:\tor\Tor`
2. Type {{{tor.exe}}} and press enter. If you have your {{{torrc}}} file somewhere other than the default location (Like the C:\tor\Data\Tor folder), specify the path with the {{{-f}}} flag. 2. Type `tor.exe` and press enter. If you have your `torrc` file somewhere other than the default location (Like the C:\tor\Data\Tor folder), specify the path with the `-f` flag.
* Example: {{{tor.exe -f C:\tor\Data\Tor\torrc}}} * Example: `tor.exe -f C:\tor\Data\Tor\torrc`
3. You should now see Tor starting up in your terminal. Wait until its finished bootstrapping. After a short period it should publish its OrPort, and you will be successfully relaying traffic for the Tor Network. 3. You should now see Tor starting up in your terminal. Wait until its finished bootstrapping. After a short period it should publish its OrPort, and you will be successfully relaying traffic for the Tor Network.
* '''Note:''' Depending on your systems settings, Tor may fail to start and produce an error indicating it is unable to create files. If this occurs, simply open the Windows Defender Security Centre and select "App & browser control". Add the {{{tor.exe}}} file to the permissions list, then rerun {{{tor.exe}}}. Tor should start up normally. * **Note:** Depending on your systems settings, Tor may fail to start and produce an error indicating it is unable to create files. If this occurs, simply open the Windows Defender Security Centre and select "App & browser control". Add the `tor.exe` file to the permissions list, then rerun `tor.exe`. Tor should start up normally.
\ No newline at end of file \ No newline at end of file