Operators
Operator Guides

Nym Nodes Operator Guides

Welcome to the section containing setup guides for operators of Nym Nodes and Nym Validators. To setup, configure, run, bond and maintain a nym-node is not a difficult process, but it takes dedication. Before you start, please check out minimum requirements and then follow the Steps for Nym Node Operators below.

Minimum Requirements

Operating a nym-node is not a set-and-forget endeavor. To prevent operators committing their time and money into a sub-optimal server, resulting in frustration of never seeing their node active, we composed this list of prerequisites. Please read below about expectations regarding operators skill set, time dedication and minimum hardware specs.

Knowledge base

All nodes are run remotely from operators shell, using SSH (opens in a new tab) and Bash (opens in a new tab) commands. Node operators need to be experienced super users or sys-admins. If you never used terminal before, maybe start with some tutorial of basic Linux administration (opens in a new tab) before committing to run a node.

VPS Hardware Specs

You will need to rent a VPS to run your node on. One key reason for this is that your node must be able to send TCP data using both IPv4 and IPv6 (as other nodes you talk to may use either protocol). Therefore you will need a server with static IPv4 and IPv6!

Tor community created a very helpful table called Good Bad ISPs (opens in a new tab), you can use that one as a guideline for your choice of ISP for your VPS.

Update: Nym community started an ISP table called Where to host your nym node?, check it out and add your findings!

Time

Last but not least, managing a Nym Node is work. More skilled an operator is, less time it takes to run and maintain a node (and search extra details), but just like any other work, it takes effort.

Reserve 45-120 minutes for the initial setup and configuration (depends on your skills). Then count on a few minutes once in 2-4 weeks to upgrade node version binaries. Patches don't always come out regularly, operators need to keep their eyes on Matrix announcement channel (opens in a new tab).

Outdated nodes are never selected for routing/mixing packets, resulting in not receiving any rewards. You can read more on our Tokenomics page to understand the selection and rewards logic.

Terms & Conditions

ℹ️

From nym-node version 1.1.3 onward is required to accept Operators Terms & Conditions (opens in a new tab) in order to be part of the active set. Make sure to read them before you add the flag.

There has been a long ongoing discussion whether and how to apply Terms and Conditions for Nym network operators, with an aim to stay aligned with the philosophy of Free Software and provide legal defense for both node operators and Nym developers. To understand better the reasoning behind this decision, you can listen to the first Nym Operator Town Hall (opens in a new tab) introducing the T&Cs or to Operator AMA with CEO Harry Halpin (opens in a new tab) from June 4th, 2024, explaining pros and cons of T&Cs implementation.

Accepting T&Cs is done via a flag --accept-operator-terms-and-conditions added explicitly to nym-node run command every time. Detailed info and proper syntax is provided on the setup page.

Steps for Nym Node Operators

This is a summary of all needed steps for node operators to setup and configure a nym-node and register it to Nym Network:

  1. Start with Preliminary Steps, preparing:

  1. Setup the node

  2. Configure the node and (optionally) automation, Wireguard, WSS, reverse proxy ...

  3. Run the node or the service

  4. Bond the node to the Nym API, using Nym wallet

Make sure to follow the steps thoroughly, in case you find any point difficult don't hesitate to ask in our Operators channel (opens in a new tab).

Building from SourcePreliminary Steps