1. Nickname and ContactInfo
Enter the desired Nickname and Contact information for your Anon Relay.
**Example:**
```
- Enter the desired Nickname and Contact information for your Anon Relay
1/7 Nickname (1-19 characters, only [a-zA-Z0-9] and no spaces): nickname
1/7 Contact Information (leave empty to skip):
```
*Sources:* [*Nickname*](/sdk/native-sdk/manual#nickname-name) *and* [*ContactInfo*](/sdk/native-sdk/manual#contactinfo-email_address)
2. MyFamily setup (Optional)
If you're setting up more than one relay, fingerprints have to be specified in MyFamily.
**Example:**
```
- Enter a comma-separated list of fingerprints for your relay's family
2/7 MyFamily fingerprints (leave empty to skip): AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB,CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
```
*Source:* [*MyFamily*](/sdk/native-sdk/manual#myfamily-fingerprint-fingerprint)
3. BandwidthRate and BandwidthBurst (Optional)
Enter a number in Mbit if you want to specify a bandwidth rate and burst.
**Example:**
```
- Enter BandwidthRate and BandwidthBurst in Mbit (e.g., 100 for 100 Mbit)
3/7 BandwidthRate (leave empty to skip): 100
3/7 BandwidthBurst (leave empty to skip): 120
```
*Sources:* [*BandwidthRate*](/sdk/native-sdk/manual#bandwidthrate-n-bytes-or-kbytes-or-mbytes-or-gbytes-or-tbytes-or-kbits-or-mbits-or-gbits-or-tbits-1) *and* [*BandwidthBurst*](/sdk/native-sdk/manual#bandwidthburst-n-bytes-or-kbytes-or-mbytes-or-gbytes-or-tbytes-or-kbits-or-mbits-or-gbits-or-tbits-1)
4. Customise ORPort (Optional)
Specify a custom OR port if you don't want to use the default port 9001.
**Example:**
```
- Enter ORPort
4/7 ORPort [Default: 9001]: 9004
ORPort set to: 9004
```
*Source:* [*ORPort*](/sdk/native-sdk/manual#orport-address-port-or-auto-flags)
5. Ethereum Wallet Configuration (Optional)
Provide an Ethereum EVM address to register for contribution rewards.
**Example**
```
- Do you want to enter an Ethereum EVM address for contribution rewards
5/7 (yes/no): yes
5/7 Enter your Ethereum wallet address: 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
```
*Source:* [*Rewards Program Registration*](/dashboard/register)
6. Disable or Enable the Controlport (Optional)
Choose if you want the Controlport to be enabled on port 9051. [Default: no]
**Example:**
```
- Should the anon.service ControlPort be enabled?
6/7 Enable ControlPort? [Default: no]: yes
```
*Source:* [*Controlport*](/sdk/native-sdk/manual#controlport-address-port-or-unix-path-or-auto-flags)
*Hint: It's necessary to enable this (yes) if you want to monitor your Relay through the ControlPort.*\
\
*See* [*Additional monitoring...*](/relay/start/install-anon-on-linux#monitor-anon-service-log)
7. *UncomplicatedFirewall installation (Optional)
Select if you want to install 'UFW' and explicitly allow the necessary ports for operation.
**Example**
```
- Would you like to install UncomplicatedFirewall and allow incoming traffic on:
- ORPort 9004
- SSH port 22
7/7 Configure and enable ufw (yes/no): yes
```
*External sources:* [*Ubuntu Wiki*](https://wiki.ubuntu.com/UncomplicatedFirewall) and [Ubuntu Community Documentation on UFW](https://help.ubuntu.com/community/UFW)
sudo tail -f /var/log/anon/notices.log
sudo mkdir /opt/compose-files/
sudo mkdir -p /opt/anon/etc/anon/
sudo mkdir -p /opt/anon/run/anon/
sudo mkdir -p /root/.nyx/
sudo chmod -R 700 /opt/anon/run/anon/
sudo chown -R 100:101 /opt/anon/run/anon/
sudo touch /opt/anon/etc/anon/notices.log
sudo chown 100:101 /opt/anon/etc/anon/notices.log
sudo useradd -M anond
sudo wget -O /opt/compose-files/relay.yaml https://raw.githubusercontent.com/anyone-protocol/anon-install/refs/heads/main/docker/anon-relay/relay.yaml
sudo wget -O /opt/anon/etc/anon/anonrc https://raw.githubusercontent.com/anyone-protocol/anon-install/refs/heads/main/docker/anon-relay/anonrc
sudo wget -O /root/.nyx/config https://raw.githubusercontent.com/anyone-protocol/anon-install/refs/heads/main/docker/anon-relay/config
{% hint style="warning" %} DNS changes can take between 24 and 48 hours to fully propagate across the internet. However, it can sometimes be much quicker for simple DNS changes, or longer, especially for complex DNS configurations or in specific regions. {% endhint %} # Anon Options See all anon options on the Manual page. {% content-ref url="/pages/u2rzmJTz21NEQcXIkJ4b" %} [Manual](/sdk/native-sdk/manual) {% endcontent-ref %} # Multi-mining with Taofu TPN This page will guide you through the procedure to setup multi-mining by installing a Anyone Relay with a Tao TPN worker in parallel. This installation is a fork of [https://github.com/taofu-labs/tpn-subnet](https://github.com/taofu-labs/tpn-subnet/), you can read more about mining with Taofu TPN at [https://www.taofu.xyz](https://www.taofu.xyz/). 1. Clone the repo {% code fullWidth="false" %} ```bash cd ~ git clone https://github.com/rA3ka/tpn-subnet cd tpn-subnet ``` {% endcode %} 2. Edit the `anonrc` configuration in the file docker-compose.yml and replace `ContactInfo` and `Nickname` with your own. ```bash nano ~/tpn-subnet/federated-container/docker-compose.yml ``` 3. Run the TPN install script to set install a worker. Follow the install procedure and input the requested values. ```bash bash ~/tpn-subnet/refs/heads/main/scripts/install_worker.sh ``` # Network & Firewall {% content-ref url="/pages/352O1wCzbYjlXzDmReKT" %} [Router Port Forwarding](/relay/network/port-forward) {% endcontent-ref %} {% content-ref url="/pages/LEvkDQVUc3vmtrzRP0fu" %} [Firewall Setup & Rules](/relay/network/firewall) {% endcontent-ref %} {% content-ref url="/pages/c5stPAkM8bbN3a0aNtJH" %} [Configure IPv4 and IPv6](/relay/network/configure-ipv4-and-ipv6) {% endcontent-ref %} {% content-ref url="/pages/7kpKoQ93vF7PNz6Hlu1o" %} [SOCKS Proxy Setup](/relay/network/socks) {% endcontent-ref %} # Router Port Forwarding Port forwarding is a necessary step in setting up a Anyone Relay, allowing external connections to reach your relay's designated port (default: 9001). This universal guide covers the port forwarding process applicable to most routers. It's important to note that while the default port is 9001, you can optionally choose another port. ### 1. Access Your Router's Settings In this step we provide examples for different Operating System's on how to get your routers IP-address to access its settings. The IP-address of a router may differ but is typically something like: `192.168.x.x` or `10.x.x.x`. **If you already know how to access your router's settings then you can skip to** [**next step**](#id-2.-locate-the-port-forwarding-section-in-your-routers-control-panel)**.** {% tabs %} {% tab title="Windows" %} 1. **Open Command Prompt** Press `Win + R`, type `cmd`, and press Enter to open the Command Prompt. 2. **Run `ipconfig`** Type `ipconfig` and press Enter. Look for the "Default Gateway" entry under the active network connection. **Identify Router IP** ``` Default Gateway . . . . . . . . . : 192.168.1.1 ``` {% endtab %} {% tab title="macOS" %} 1. **Search for and open the 'terminal.app' application.** 2. **Copy and paste the below commands in full in the terminal.** {% code fullWidth="false" %} ```sh route -n get 'default' | grep 'gateway' ``` {% endcode %}
sudo nyx
Self-testing indicates your ORPort <public IP> is reachable from the outside.
Your server has not managed to confirm reachability..
| Service | Purpose |
|---|---|
| Service | Purpose |
packagekit.service | Manages automatic updates graphically; not needed for headless CLI-based VPS. |
snapd.service | Snap uses additional background daemons and mounts. It’s often unwanted bloat on servers. (Remember to sudo apt purge snapd) |
snap.canonical-livepatch.canonical-livepatchd.service | Livepatching isn’t typically used on minimal or ephemeral servers. (It's usually removed by purging snapd) |
multipathd.service | Multipath is for SAN and storage setups. Not needed on cloud VPS or simple disk configs. |
| Service | Purpose |
dbus.service | Required by some utilities and desktop components. Harmless and often needed by other services. |
getty@tty1.service | Provides login on local TTY; not harmful, but optional to disable in headless environments. |
networkd-dispatcher.service | Helps with DHCP Netplan events; required on Netplan-managed systems. |
polkit.service | Used for user privilege escalation. Needed if you use desktop tools or sudo based GUI operations; may be safe to disable on hardened CLI-only systems. |
ssh.service | Keep for remote access. |
systemd-networkd.service | Manages network interfaces; critical for connectivity on minimal systems. |
systemd-resolved.service | Handles DNS; often required unless using custom resolvers or DNS tools. |
systemd-timesyncd.service | Keeps system clock accurate (important for anon). |
systemd-journald.service | System logging; required! |
systemd-logind.service | Handles user logins and sessions; usually fine to leave. |
systemd-udevd.service | Manages device nodes; needed. |
user@1000.service | Your user session; leave it alone. |
#### Secondary WiFi Support If the option appears grayed out, you can click **Yes** to learn more about it. In this case, the device is missing a USB WiFi adapter needed to enable the second WLAN interface, but Ethernet is available. The latest batches of the hardware device come with an adapter.\ \  Currently, the device supports only one model for enabling WiFi-to-WiFi router functionality. To enable this feature, acquire a **TP-Link (TL-WN725N) USB WiFi Adapter**, plug it in, and restart the device. Alternatively, you can select **Ethernet** as your Wide Area Network (WAN) connection to enable the option. Click **Yes** to proceed if your device has all the necessary equipment plugged in.
WiFi enabled
Ethernet enabled
2. Download both **default.cfg** and **update.zip** and place on the USB drive, make sure the files are **NOT** renamed or unpacked, the files names must be exactly **default.cfg** and **update.zip** even after download. {% hint style="warning" %} Only if you have changed the default password for the Relay Control Panel, then open the file **default.cfg** with any editor and change the first line "**`01_user_password=MyPassword`**" to include your password. {% endhint %} {% file src="/files/kifEKn0iyoR34T0sFSva" %} {% file src="/files/FFYBitjJ1GPWxjbgSrtv" %} 3. Plug in the USB to your Relay and unplug when the LED's are **flashing in green**, the relay will restart when USB is unplugged. Wait for the Relay to start up again. {% hint style="warning" %} * If the lights of the relay flashes in **Red**, it means the password is wrong in default.cfg, readd default.cfg and correct the password. * If the lights of the relay flashes in **Blue**, it means the files have not been placed properly, delete all files from the USB and re-add them again. {% endhint %} 4. When relay has restarted you can login to the [Relay Control Panel](http://relayup.local) and verify that you see the latest version as shown below, located in the **Versions** and **Identification** section on the **Home** page.
Follow steps .. 6, 7, 8, 9
| Cover image | ||
|---|---|---|
| /pages/HOIqKCSwQda5LU1TR66Q | Follow the steps to make sure your relays are correctly registered. | /files/MhEiaT6OK6GWByulceKb |
| /pages/rhCcL6zm8kH4vyJeYwR7 | Learn how to connect and navigate the decentralized dashboard. | /files/1gJUEi9zRNDcly6wzXNX |
| Cover image | ||
|---|---|---|
| /pages/rzaj1EhYJapqiHCfVmPD | Understand how to monitor rewards, claim tokens, and manage your relay operations. | /files/hPHti7rs98DgEs6uIhw3 |
| /pages/cLvDXm1lonrFoKmllU5T | Understand how rewards are currently emitted and on what criteria. | /files/EI1shrUnfyn28Gb7K8xV |
:link: [Relay Setup](/relay) > :link: [Installation and Usage](/relay/start) > :link: [Setting up Your Environment](/relay/start/prep) \ If you already have a relay running, continue reading! {% endhint %} ## **Adding Ethereum Wallet Address** 2. **Add your wallet address** to the anonrc file to link it with your relay for rewards. Debian example: Open the anonrc file in a text editor: ```bash sudo nano /etc/anon/anonrc ``` Find the `ContactInfo` line, and add your wallet address with the prefix `@anon:` . {% code title="Example" %} ``` ContactInfo @anon: 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF ``` {% endcode %} 3. Restart the Anon service to apply the changes: ```bash sudo systemctl restart anon.service ``` *** {% hint style="info" %} ### **Optionally Verify the Changes in anonrc** `sudo /usr/bin/anon -f /etc/anon/anonrc --verify-config` {% endhint %} ## Using the Dashboard to Claim and Manage Your Relays Once your machine is set up, follow these steps to connect your wallet, lock tokens (if necessary), and claim your relay via the **Anyone Protocol Dashboard**. {% content-ref url="/pages/rzaj1EhYJapqiHCfVmPD" %} [Using Dashboard](/dashboard/use) {% endcontent-ref %} (Note that it can take a few hours for the device to show up on the dashboard after registering the address in the configuration of your relay) {% hint style="info" %} See :link: [Resources](broken://pages/qwk6iHoeoj4H46mnPjyE) & :link: [Community and Customer Support](/resources/support) for help and updates. {% endhint %} {% hint style="success" %}  ### [See full video tutorial on the Rewards Dashboard page.](/dashboard) {% endhint %} # Accessing Dashboard *** ### Loading the Dashboard The decentralized nature of the Anyone Dashboard means that **there is no server** providing data to the dashboard. Instead, the most up-to-date state is calculated on the client side (on the users' computer) using a local 'worker'. This worker aggregates the newest set of Arweave distribution data for the relays to calculate the latest scores. This means that there is a slightly longer loading time when opening the dashboard for the first time or when a wallet has many relays. This also means that it is recommended to interact with the Anyone dashboard from a laptop or desktop, as opposed to a mobile browser. Censorship resistance is more than a buzzword for the protocol - we are proud to host the most censorship resistant and decentralized dashboard in all of DePIN! ### The only official URL to the Anyone Protocol & Staking Dashboard is: #### [**https://dashboard.anyone.io**](https://dashboard.anyone.io/)
{% hint style="success" %}
Connect EVM wallet to the dashboard
Locking $ANYONE tokens
Claim Anyone Hardware Relay
Claim Regular Relay
Redeem $ANYONE tokens
{% tabs %} {% tab title="Metamask" %} {% endtab %} {% tab title="Rabby" %} An interaction with a Relay and Rewards Dashboard that requires a token approval will call up a screen that reads "Spending cap request". you'll see a pencil icon allowing you to edit the spending cap:
Creating file hello.js within the project directory
import { Anon } from "@anyone-protocol/anyone-client";
const anon = new Anon();
anon.start();
I get an error!
Make sure that you have npm and anyone-client installed. Check out [Installation and CLI usage](/sdk/npm/install)import { AnonSocksClient } from "@anyone-protocol/anyone-client";
What are SOCKS? 🧦
These SOCKS aren't for your feet! SOCKS is an acronym for Socket Secure - an internet protocol that allows you to route your traffic to a 'proxy server' (i.e., a server that sits in between you and your eventual, varied list of destinations). Importantly, a SOCKS proxy server can run locally, listening to any requests made on a specific port (known as 'binding' to that port). In this case, the anon SOCKS process listens to any request made to the specified socksPort, forwards this through a circuit in the Anon network, and returns the result to whichever process makes the request.[{
"circuitId": 1,
"state": "BUILT",
"relays": [
{
"fingerprint": "54849A361F8CED0D1B70B722CB8B33E9071E5561",
"nickname": "ATORDAuselive"
}
],
"buildFlags": [
"ONEHOP_TUNNEL",
"IS_INTERNAL",
"NEED_CAPACITY"
],
"purpose": "GENERAL",
"timeCreated": "2024-11-08T12:10:46.596Z"
},
...
Aside: Relay Fingerprints and Circuits
**Fingerprints**\ All relays have a unique identifier known as a fingerprint. Within the clients, authorities and even on-chain, the fingerprint is a relay's foremost identifier (even ahead of it's IP address). When selecting relays to build a circuit through, the fingerprint is how you specify them. {% code title="Example Fingerprint" %} ``` 41B78C1198702625B30FB225AE37AAC0B2FA4ED ``` {% endcode %} **Circuits**\ A chain of relays that continually decrypt packets between an Anyone client and its destination (website or hidden service) is called a circuit. The default onion routing circuit in the Anyone Network is 3 hops- an Entry relay, Middle relay and Exit relay. This model provides a certain level of defence against malicious relays, as a single relay does not have enough information to deanonymize a user. However, circuits of any length can be constructed, including just one relay. However, if used to visit public websites, one of the relays must be an Exit.| Linux | /files/U51XpOMEY7jUIfYVbjVv | /pages/2OOyxBxxNWfHULaLY2z2 |
| macOS | /files/2OeVM5FzwDjJcoSwBWNe | /pages/3lQweBeXESObsDuxOswF |
| Windows | /files/baOsz6yUUnPX4ICsDu1S | /pages/G9iP6SEzVyBpVWq3n5pc |
| Cover image | ||
|---|---|---|
| Android | /files/Ku2ud4jw2Y8isZZkOign | /pages/DLbgxWkQl4VruYOaX9u8 |
| iOS | /files/vwA5IMImKb3MrbkFC38A | /pages/cXrpddgP16as2sjI2ElQ |
| Cover image | ||
|---|---|---|
| Through Hardware | /files/xAGQSTO4hAzgwQTHKzND | /pages/rSyrCAXYLiUbEJSkqcMa |
| Public Proxies | /files/Uzp8WgoHM0KGGrBY4DTC | /pages/NO0K3B5t9PfctDEcRYUh |
Installing npm
You can install easily by following the macOS guide on the [Node.js ](https://nodejs.org/en/download/package-manager)website. The steps are replicated here, to be pasted and run on the **Terminal** app on your Mac. 1. Install nvm ``` curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash ``` 2. Use nvm to install Node.js 20 ``` nvm install 20 ``` 3. Verify that you have installed Node.js and npm by ensuring you get a version code for each of these commands ``` node -v npm -v ```Optional: Changing from the default configuration
If you have a specific use-case, or have issues with connecting in the subsequent steps, you can set `-s` Set the SocksPort (default: 9050) `-c` Set the ControlPort (default: 9051, use 0 to disable) `-o` Set the OrPort (default: 9001) `-v` Enable verbose mode for full client logs `-f` Set the path to custom anonrc config file `-b` Set the path to custom anon binary (To use preinstalled one)Download and run the `anon.exe` from Github packages. Select the latest version, download the zip, unpack and start the application from a terminal with option parameters or by running the executable as is with default settings. 1. Navigate to the settings app and ensure your windows system is up to date and all critical updates have been installed
Firefox Connection Settings
Proxy Settings
Edit Proxy