Comment on page

How to setup a relay family in your relay configuration file.

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 activating as well as setting up your relay family.
This tutorial is essential for anyone running more than 1 relay. If you fail to disclose your relay family, you put yourself, as well as others using the network at risk, and can become blacklisted from participating as a relay operator in the future.
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 assumes you have downloaded and installed: a virtual machine, Fedora OS, as well as configured your onion router, as well as currently have more than 1 relay configured and operational.

Step 1: Open Fedora in your virtual machine

Open the Virtual Box application and start the Fedora Operating system.
Starting Fedora in Virtual Box

Step 2: Open a terminal and acquire root permissions

Open the terminal application inside of fedora and apply the following command:
sudo -i
You will then be prompted to enter your password. Once password is entered you will have root permissions.

Step 3: Open the Configuration file

To open the configuration file you will use the following command:
sudo nano /etc/tor/torrc

Step 4: Locate #MyFamily Setting

Within the Tor configuration file, you need to add the necessary settings for enabling and setting up the "MyFamily" feature. Look for the section labelled #MyFamily, located just above ExitRelay 0, which we enabled in the original configuration.
MyFamily setting within the configuration file
#MyFamily $keyid,$keyid,...

Step 5: Enable MyFamily Setting

Once you locate #MyFamily, you can remove the #, enabling the line, as well as remove the placeholder text labelled $keyid1,$keyid2,..., or alternatively, create a new line below the original line of code starting with MyFamily.

Step 6: Restart your relay

Replace $keyid1,$keyid2,... with the fingerprints of the relays you want to include in your family. Separate each fingerprint with a comma. You can find the fingerprints of your relays in the NYX console of each relay.
If you run two relays and they have fingerprints AAAAAAAAAA and BBBBBBBB, you would add the following configuration to set MyFamily, to both relays:
Save the changes to the configuration file by pressing Ctrl+X, to exit, and then Y to confirm changes, and enter to close.

Step 7: Restart Your Relay

Restart the Tor service to apply the new configuration by executing the following command:
systemctl restart tor

Step 8: Rinse and Repeat

Repeat these steps for each additional relay you are in control of. Make sure that your ContactInfo has a valid email address, and is the same in any additional relays configuration file. The "@ ator:" wallet string should also be the same in each config file.

Step 9: Verification of Family

Verify that your middle relay is running and successfully included in your family by checking the relay metrics dashboard after a few hours. If successful you will see your family of relays displayed in the relays profile.

You did it! 🎉

You have now enabled and set up the "MyFamily" setting for your middle relay in the Tor configuration file on Fedora OS. Make sure to periodically check the log file and monitor the performance of your relay to ensure it is running smoothly.
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!