Skip to content

Commit

Permalink
[DOCs/operators]: smooth operators (#5311)
Browse files Browse the repository at this point in the history
* smooth minimum expectation

* simplify simplify

* quick fix

* feedback edits

* feedback edits

* feedback edits
  • Loading branch information
serinko authored Jan 6, 2025
1 parent 5d9b5a0 commit 72a4a26
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Tor community created a very helpful table called [*Good Bad ISPs*](https://comm
#### `nym-node`
Before we conclude the testing with exact results, these are the rough specs:

| **Hardware** | **Minimum Specification** w
| **Hardware** | **Minimum Specification** |
| :--- | ---: |
| CPU Cores | 4 |
| Memory | 8 GB RAM |
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
804_560_131
805_903_308
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1_020_023
1_022_821
Original file line number Diff line number Diff line change
@@ -1 +1 @@
402_280_065
402_951_654
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
| **Item** | **Description** | **Amount in NYM** |
|:-------------------|:------------------------------------------------------|--------------------:|
| Total Supply | Maximum amount of NYM token in existence | 1_000_000_000 |
| Mixmining Reserve | Tokens releasing for operators rewards | 195_439_368 |
| Mixmining Reserve | Tokens releasing for operators rewards | 194_096_191 |
| Vesting Tokens | Tokens locked outside of cicrulation for future claim | 500 |
| Circulating Supply | Amount of unlocked tokens | 804_560_131 |
| Stake Saturation | Optimal size of node self-bond + delegation | 1_020_023 |
| Circulating Supply | Amount of unlocked tokens | 805_903_308 |
| Stake Saturation | Optimal size of node self-bond + delegation | 1_022_821 |
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Monday, December 23rd 2024, 17:41:13 UTC
Monday, January 6th 2025, 11:03:09 UTC
10 changes: 5 additions & 5 deletions documentation/docs/pages/operators/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is **Nym's Operators guide**, containing information and setup guides for the various components of Nym network and Nyx blockchain validators.

Nym network (also known as mixnet) routes and mixes packets through Gateways and Mixnodes, all run from the same binary called `nym-node`.
Nym network (also known as Nym mixnet) routes and mixes packets through Gateways and Mixnodes, all run from the same binary called `nym-node`.

```ascii
┌─►mix──┐ mix mix
Expand All @@ -14,13 +14,13 @@ client ───► Gateway ──┘ mix │ mix ┌─►mix ───►
mix └─►mix──┘ mix
```

If you are new to Nym and want to learn about the Mixnet, explore kickstart options and demos, learn how to integrate with the network, and follow developer tutorials check out the [Developer Portal](https://nymtech.net/docs/developers/).
If you want to dive deeper into Nym Network architecture, clients and nodes visit the [Network docs](https://nymtech.net/docs/network).

If you want to dive deeper into Nym's architecture, clients, nodes, and SDK examples visit the [technical docs](https://nymtech.net/docs/network).
If you want to explore kickstart options and examples, learn how to integrate with the network, and follow developer tutorials check out the [Developer Portal](https://nymtech.net/docs/developers/).

## 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).**
**If you are an operator and want to join the journey of starting and mantaining a Nym Node, begin with visiting [Minimum requirements page](nodes.mdx).**

## Popular pages

Expand Down Expand Up @@ -55,4 +55,4 @@ If you want to dive deeper into Nym's architecture, clients, nodes, and SDK exam

**Archive**

*[FAQ: Project Smoosh](archive/faq/smoosh-faq.mdx)
* [FAQ: Project Smoosh](archive/faq/smoosh-faq.mdx)
10 changes: 7 additions & 3 deletions documentation/docs/pages/operators/nodes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,21 @@ Welcome to the section containing setup guides for operators of Nym Nodes and Ny

## 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.
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](#knowledge-base), [time dedication](#time) and [minimum hardware specs](#vps-hardware-specs).

### 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.
**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 experienced super users or 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.
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](release-cycle.mdx), operators need to keep their eyes on [Matrix announcement channel](https://matrix.to/#/#node-ops-announcements:nymtech.chat).

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

Expand Down

0 comments on commit 72a4a26

Please sign in to comment.