Comment on page

Setting Bandwidth Allowance for your Relay

This is a supplementary tutorial in the ATOR Relay Education Series.
Hello and welcome to a supplementary tutorial in the Ator Relay Education Series. This tutorial will guide you through the steps in resolving ORPort reachability errors related to port forwarding.
For a more detailed guide, there will be a YouTube link at the end of this article, as well as a link to the ATOR discord server where the team, or other relay operators will be happy to assist you if you run into any issues!
This tutorial requires access to your router or modems settings.
An imagined image of an ATOR node

Step 1: Open the VM Settings

Navigate to your terminal in fedora and acquire root permissions:
sudo -i
Enter the configuration file:
sudo nano /etc/tor/torrc
Fedora Settings

Step 2: Network Settings

Create 2 new lines below the #RelayBandwidthRate and #RelayBandwidthBurst lines labelled: RelayBandwidthRate RelayBandwidthBurst Rate is the avg rate you wish to allow in terms of bandwidth, and burst is the maximum bandwidth it will use for short durations (bursts). If you have very limited bandwidth, you can go with the default, or if you have more to offer you can increase it. The measurment unit can be KBytes or MBytes: Default Bandwidth Throttle: RelayBandwidthRate 100 KBytes RelayBandwidthBurst 200 KBytes If you have more bandwidth to spare feel free to use the MBytes unit. Example: RelayBandwidthRate 10 MBytes RelayBandwidthBurst 20 MBytes
Drop down menu selecting Bridged Adapter

Step 3: Obtain IP Address

Once the settings have been changed, open the Fedora OS in your VM. Once you have logged into Fedora, navigate to the bottom right corner of the window and locate the icon referenced in the picture below. Hover over the icon with your mouse, revealing an IP Address. Take note of the IP Address somewhere for the next step.
Hovering over the icon revealing the IP Address

Step 4: Port Forwarding

Log into your router or modems settings. Most modems provide the login credentials on the physical modem, however sometimes it can be located elsewhere. The login process varies depending on your ISP.
Once logged in, located "port forwarding" from within the menu options. Within the port forwarding menu of your modem or router, create a new rule, and set the protocol to "both" or "TCP/UDP". If this is not an option in your settings, you will need to create 2 individual rules for both TCP and UDP.
Set the internal and external ports to 9001.
Locate the IP Address we wrote down in the previous step and input it into the local IP Address prompt.
Once you have completed all of these steps, save the rule.
Port Forwarding within modem settings

Step 5: Restart Onion Router Service

Once you have completed the port forwarding steps, open up your Fedora virtual machine and open up a terminal.
Obtain root permissions by using the command:
sudo -i
After obtaining root permissions, restart the onion router service to allow the changes to take place. You can do this by using the command:
systemctl restart tor
Wait a moment for the service to restart. Once the service has finished restarting, open up the nyx console by using the command:
If your port forwarding was successful, you will see a message in your logs confirming reachability of the port. This can take anywhere from 1 to 20 minutes, but usually happens within 5 minutes.

You did it! 🎉

Thanks for following along! For a more detailed explanation, feel free to check out the YouTube video in the links below!
If you run into any issues in the process, please feel free to reach out in the ATOR discord server where a team member or a member of the community will be happy to lend you a hand!
Thanks for following along, and I’ll see you in the next tutorial!