-
Notifications
You must be signed in to change notification settings - Fork 235
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
initialise minimum requirements page
- Loading branch information
Showing
6 changed files
with
105 additions
and
60 deletions.
There are no files selected for viewing
56 changes: 56 additions & 0 deletions
56
documentation/docs/components/operators/snippets/nym-node-specs.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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! | ||
|
|
||
| <div> | ||
| <Tabs items={[ | ||
| <code>nym-node</code>, | ||
| <code>validator</code>, | ||
| ]} defaultIndex="0"> | ||
| <MyTab> | ||
| #### `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 | | ||
|
|
||
| </MyTab> | ||
| <MyTab> | ||
| #### 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 | | ||
|
|
||
| </MyTab> | ||
| </Tabs> | ||
| </div> |
2 changes: 1 addition & 1 deletion
2
documentation/docs/components/outputs/api-scraping-outputs/time-now.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| Monday, December 23rd 2024, 11:36:26 UTC | ||
| Monday, December 23rd 2024, 17:41:13 UTC |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|
|
||
| <NymNodeSpecs /> | ||
|
|
||
| ### 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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters