From 949d54dee28dd88b299b9d8d6b00a2da57792d62 Mon Sep 17 00:00:00 2001 From: serinko <97586125+serinko@users.noreply.github.com> Date: Mon, 23 Dec 2024 22:20:12 +0100 Subject: [PATCH] initialise minimum requirements page --- .../operators/snippets/nym-node-specs.mdx | 56 +++++++++++++++++++ .../outputs/api-scraping-outputs/time-now.md | 2 +- .../docs/pages/operators/introduction.mdx | 3 + documentation/docs/pages/operators/nodes.mdx | 41 ++++++++++++++ .../docs/pages/operators/nodes/nym-node.mdx | 16 +----- .../nodes/preliminary-steps/vps-setup.mdx | 47 +--------------- 6 files changed, 105 insertions(+), 60 deletions(-) create mode 100644 documentation/docs/components/operators/snippets/nym-node-specs.mdx create mode 100644 documentation/docs/pages/operators/nodes.mdx diff --git a/documentation/docs/components/operators/snippets/nym-node-specs.mdx b/documentation/docs/components/operators/snippets/nym-node-specs.mdx new file mode 100644 index 00000000000..d6b12aa1493 --- /dev/null +++ b/documentation/docs/components/operators/snippets/nym-node-specs.mdx @@ -0,0 +1,56 @@ +import { MyTab } from 'components/generic-tabs.tsx'; +import { Tabs } from 'nextra/components'; + +### 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*](https://community.torproject.org/relay/community-resources/good-bad-isps/), 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?*](../../community-counsel/isp-list.mdx), check it out and add your findings! + +
+ nym-node, + validator, + ]} defaultIndex="0"> + +#### `nym-node` +Before we conclude the testing with exact results, these are the rough specs: + +| **Hardware** | **Minimum Specification** w +| :--- | ---: | +| CPU Cores | 4 | +| Memory | 8 GB RAM | +| Storage | 80 GB | +| Connectivity | IPv4, IPv6, TCP/IP, UDP | +| Bandwidth | > 1Tb | +| Port speed | 1Gbps | + + + +#### Nyx validator + +The specification mentioned below is for running a full node alongside the nym-api. It is recommended to run `nym-api` and a full Nyx node on the same machine for optimum performance. + +Bear in mind that credential signing is primarily CPU-bound, so choose the fastest CPU available to you. + +##### Minimum Requirements + +| Hardware | **Minimum Specification** | +|----------|--------------------------------------------| +| CPU | 8-cores, 2.8GHz base clock speed or higher | +| RAM | 16GB DDR4+ | +| Disk | 500 GiB+ NVMe SSD | + +##### Recommended Requirements + +| Hardware | **Minimum Specification** | +|----------|---------------------------------------------| +| CPU | 16-cores, 2.8GHz base clock speed or higher | +| RAM | 32GB DDR4+ | +| Disk | 1 TiB+ NVMe SSD | + + + +
diff --git a/documentation/docs/components/outputs/api-scraping-outputs/time-now.md b/documentation/docs/components/outputs/api-scraping-outputs/time-now.md index f6b75163808..71c0ce06df7 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/time-now.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/time-now.md @@ -1 +1 @@ -Monday, December 23rd 2024, 11:36:26 UTC +Monday, December 23rd 2024, 17:41:13 UTC diff --git a/documentation/docs/pages/operators/introduction.mdx b/documentation/docs/pages/operators/introduction.mdx index 82afe0998f0..ab2eaa5b40e 100644 --- a/documentation/docs/pages/operators/introduction.mdx +++ b/documentation/docs/pages/operators/introduction.mdx @@ -18,6 +18,9 @@ If you are new to Nym and want to learn about the Mixnet, explore kickstart opti If you want to dive deeper into Nym's architecture, clients, nodes, and SDK examples visit the [technical docs](https://nymtech.net/docs/network). +## Minimum Requirements + +**If you are a new operator and want to join the journey of starting and mantaining a Nym Node, begin with visiting [Minimum Requirements page](nodes.mdx).** ## Popular pages diff --git a/documentation/docs/pages/operators/nodes.mdx b/documentation/docs/pages/operators/nodes.mdx new file mode 100644 index 00000000000..2c0b11c6971 --- /dev/null +++ b/documentation/docs/pages/operators/nodes.mdx @@ -0,0 +1,41 @@ +import { Callout } from 'nextra/components'; +import { Steps } from 'nextra/components'; +import { Tabs } from 'nextra/components'; +import NymNodeSpecs from 'components/operators/snippets/nym-node-specs.mdx'; + +# 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](#minimum-requirements) and then follow the [Steps for Nym Node Operators](#steps-for-nym-node-operators) below. + +## Minimum Requirements + +Operating a `nym-node` is not a set-and-forget endeavor. To prevent operators frustration and investment of time or money for sub-optimal server, we composed this list of prerequisites. + +### Knowledge base + +All nodes are run remotely from operators shell, using [SSH](https://www.ssh.com/academy/ssh) and [Bash](https://www.gnu.org/software/bash/) commands. Node operators need to be an experienced super users or preferably sys-admins. If you never used terminal before, maybe start with some tutorial of [basic Linux administration](https://www.linode.com/docs/guides/linux-system-administration-basics/) before committing to run a node. + + + +### Time + +Last but not least, managing a Nym Node is work. More skilled an operator is, less time it takes run a node (and search extra details), but just like any other work, it takes time. 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. Outdated nodes are never selected for routing/mixing packets, resulting in not receiving any rewards. You can read more on our [Tokenomics page](tokenomics/mixnet-rewards.mdx) to understand the selection and rewards logic. + +## 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](preliminary-steps.mdx), preparing:** +- [VPS](preliminary-steps/vps-setup.mdx) +- [Nym wallet](preliminary-steps/wallet-preparation/mdx) + +2. **[Setup](nym-node/setup.mdx) the node** + +3. **[Configure](nym-node/configuration.mdx) the node and (optionally) automation, Wireguard, WSS, reverse proxy ...** + +4. **[Run](nym-node/setup.mdx#initialise--run) the node or [the service](nym-node/configuration.md#systemd)** + +5. **[Bond](nym-node/bonding.mdx) 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](https://matrix.to/#/#operators:nymtech.chat). diff --git a/documentation/docs/pages/operators/nodes/nym-node.mdx b/documentation/docs/pages/operators/nodes/nym-node.mdx index 33ef5ad2e74..77082f7b505 100644 --- a/documentation/docs/pages/operators/nodes/nym-node.mdx +++ b/documentation/docs/pages/operators/nodes/nym-node.mdx @@ -7,18 +7,4 @@ NYM NODE is a tool for running a node within the Nym network. Nym Nodes containi To setup any type of Nym Node, start with either building [Nym's platform](../binaries/building-nym.mdx) from source or download [pre-compiled binaries](../binaries/pre-built-binaries.mdx) on the [configured server (VPS)](preliminary-steps/vps-setup.mdx) where you want to run the node. Your Nym Node will need to be bonded before it can be run. We recommend most users use the [Nym desktop wallet](preliminary-steps/wallet-preparation.mdx) for this. -**Follow [preliminary steps](preliminary-steps.mdx) page before you configure and run a `nym-node`!** - -## Steps for Nym Node Operators - -Once [VPS and Nym wallet are configured](preliminary-steps.mdx), binaries ready, the operators of `nym-node` need to: - -1. **[Setup](nym-node/setup.mdx) the node** - -2. **[Configure](nym-node/configuration.mdx) the node and optionally automation, Wireguard, WSS, reversed proxy ...** - -3. **[Run](nym-node/setup.mdx#initialise--run) the node or [the service](nym-node/configuration.md#systemd)** - -4. **[Bond](nym-node/bonding.mdx) 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](https://matrix.to/#/#operators:nymtech.chat). +**Read thoroughly [Minimum Requirement page](../nodes.mdx) before you configure and run a `nym-node`!** diff --git a/documentation/docs/pages/operators/nodes/preliminary-steps/vps-setup.mdx b/documentation/docs/pages/operators/nodes/preliminary-steps/vps-setup.mdx index 5864d3129de..34882956293 100644 --- a/documentation/docs/pages/operators/nodes/preliminary-steps/vps-setup.mdx +++ b/documentation/docs/pages/operators/nodes/preliminary-steps/vps-setup.mdx @@ -4,6 +4,7 @@ import { Steps } from 'nextra/components';import { Tabs } from 'nextra/component import { MyTab } from 'components/generic-tabs.tsx'; import PortsNymNode from 'components/operators/snippets/ports-nym-node.mdx'; import PortsValidator from 'components/operators/snippets/ports-validator.mdx' +import NymNodeSpecs from 'components/operators/snippets/nym-node-specs.mdx' # VPS Setup & Configuration @@ -13,51 +14,9 @@ We aim for Nym Network to be reliable and quality base layer of privacy accross A sub-optimally configured VPS often results in a non-functional node. To follow these steps carefully will save you time and money later on. -## 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). - -Tor community created a very helpful table called [*Good Bad ISPs*](https://community.torproject.org/relay/community-resources/good-bad-isps/), 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?*](../../community-counsel/isp-list.mdx), check it out and add your findings! - -### `nym-node` - -Before we conclude the testing with exact results, these are the rough specs: - -| **Hardware** | **Minimum Specification** w -| :--- | ---: | -| CPU Cores | 4 | -| Memory | 4 GB RAM | -| Storage | 40 GB | -| Connectivity | IPv4, IPv6, TCP/IP, UDP | -| Bandwidth | 1Tb | -| Port speed | 1Gbps | - -### Nyx validator - -The specification mentioned below is for running a full node alongside the nym-api. It is recommended to run `nym-api` and a full Nyx node on the same machine for optimum performance. - -Bear in mind that credential signing is primarily CPU-bound, so choose the fastest CPU available to you. - -#### Minimum Requirements - -| Hardware | **Minimum Specification** | -|----------|--------------------------------------------| -| CPU | 8-cores, 2.8GHz base clock speed or higher | -| RAM | 16GB DDR4+ | -| Disk | 500 GiB+ NVMe SSD | - -#### Recommended Requirements - -| Hardware | **Minimum Specification** | -|----------|---------------------------------------------| -| CPU | 16-cores, 2.8GHz base clock speed or higher | -| RAM | 32GB DDR4+ | -| Disk | 1 TiB+ NVMe SSD | - - -#### Full node configuration (validator) +## Full node configuration (validator) To install a full node from scratch, refer to the [validator setup guide](../validator-setup.mdx) and follow the steps outlined there.