Installing Anon

This guide walks you through the process of installing and configuring the Anyone Relay on a Debian based x86 or arm64 Linux systems and support for more distributions will follow in a near future.

The Anyone Relay is a critical component of the Anyone Protocol, which ensures anonymity and privacy in network and internet communications.

Whether you followed the instructions in Step 1: Setting up Your Environment or want to install the anon software directly using our provided methods, continue reading..


Debian and Ubuntu

"I am running a Debian based Operating System and want to install the anon binary!"

To kickstart the installation process, execute the following command in your terminal or visit our APT Repository instructions for a more hands-on experience:

This command initiates the download and execution of the installation script directly from our GitHub repository. Throughout the installation, you'll be prompted to provide necessary configurations for setting up the Anon Relay on your system, ensuring a tailored and secure deployment.

You can restart the script at any time to reconfigure the relay if you made a mistake during the process or want to change anything.

Upon successful installation, you'll receive a congratulatory message, indicating that the Anon Relay has been installed and configured successfully.

To make sure the Relay is reachable, refer to: Confirm ORPort Reachability for instructions.


Anon Relay Configuration Wizard

During the installation you will be prompted to read and accept the Terms and Conditions.

The installation script will guide you through a step-by-step configuration process.

Allowing you to configure the following:

1. Nickname and ContactInfo Enter the desired Nickname and Contact information for your Anon Relay.

Example:

Sources: Nickname and ContactInfo

2. MyFamily setup (Optional) If you're setting up more than one relay, fingerprints have to be specified in MyFamily.

Example:

Source: MyFamily

3. BandwidthRate and BandwidthBurst (Optional) Enter a number in Mbit if you want to specify a bandwidth rate and burst.

Example:

Sources: BandwidthRate and BandwidthBurst

4. Customise ORPort (Optional) Specify a custom OR port if you don't want to use the default port 9001.

Example:

Source: ORPort

5. Ethereum Wallet Configuration (Optional) Provide an Ethereum EVM address to register for contribution rewards.
6. Disable or Enable the Controlport (Optional) Choose if you want the Controlport to be enabled on port 9051. [Default: no]

Example:

Source: Controlport

Hint: It's necessary to enable this (yes) if you want to monitor your Relay through the ControlPort. See Additional monitoring...

7. *UncomplicatedFirewall installation (Optional) Select if you want to install 'UFW' and explicitly allow the necessary ports for operation.

Visit the Rewards Dashboard section to read more about how to sign up!

Sources and Example

REPOSITORY: https://github.com/anyone-protocol/anon-install BASH SCRIPT: https://github.com/anyone-protocol/anon-install/blob/main/install.sh README: https://github.com/anyone-protocol/anon-install/blob/main/README.md


Maintenance and Monitoring

Additionally, you'll find some handy Linux Terminal commands for managing and maintaining your Anyone Relay instance. You can use SSH for remote management (Powershell) of the Linux Operating System and anon if you are on Windows. Otherwise use a regular SSH connection from another bash prompt or terminal window on on a remote machine.

Check status for anon service

Start, stop and restart anon service

Update Anon to the latest version

Keep your Anyone Relay up-to-date with the latest enhancements and security patches by running

Monitor anon service log

Stay informed about the operation of your Anyone Relay by monitoring the service log with.

Additional monitoring can be done with a third-party application called Nyx. Read more about Nyx in our FAQ.

Edit relay configuration

Verify relay configuration

Extra User Permissions

To simplify future operations and grant monitoring permissions, it's recommended to add your user to the 'debian-anon' group. This eliminates the need for sudo privileges when running monitoring tools like Nyx.