From f53e5fe8ddf62468ff0f0a20a7163eb2bc5bac8f Mon Sep 17 00:00:00 2001 From: serinko <97586125+serinko@users.noreply.github.com> Date: Sun, 5 Oct 2025 11:48:49 +0200 Subject: [PATCH] add a quick start message --- .../components/operators/snippets/quick-start.mdx | 3 +++ .../outputs/api-scraping-outputs/time-now.md | 2 +- documentation/docs/pages/operators/introduction.mdx | 4 ++++ documentation/docs/pages/operators/nodes.mdx | 12 +++++++++--- .../docs/pages/operators/nodes/nym-node/setup.mdx | 4 ++++ 5 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 documentation/docs/components/operators/snippets/quick-start.mdx diff --git a/documentation/docs/components/operators/snippets/quick-start.mdx b/documentation/docs/components/operators/snippets/quick-start.mdx new file mode 100644 index 0000000000..622db5ec5e --- /dev/null +++ b/documentation/docs/components/operators/snippets/quick-start.mdx @@ -0,0 +1,3 @@ +## Quick Start + +**To install, configure, bond and run a `nym-node` you can use our interactive command-line-based tool [Nym Node CLI](https://nym.com/docs/operators/tools#nym-node-cli).** 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 e639f79661..f520e7ffee 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 @@ -Wednesday, October 1st 2025, 11:16:15 UTC +Sunday, October 5th 2025, 09:29:02 UTC diff --git a/documentation/docs/pages/operators/introduction.mdx b/documentation/docs/pages/operators/introduction.mdx index 5109ea78f6..4292e39a73 100644 --- a/documentation/docs/pages/operators/introduction.mdx +++ b/documentation/docs/pages/operators/introduction.mdx @@ -1,3 +1,5 @@ +import QuickStart from 'components/operators/snippets/quick-start.mdx' + # Introduction This is **Nym's Operators guide**, containing information and setup guides for the various components of Nym network and Nyx blockchain validators. @@ -22,6 +24,8 @@ If you want to explore kickstart options and examples, learn how to integrate wi **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 **Binary Information** diff --git a/documentation/docs/pages/operators/nodes.mdx b/documentation/docs/pages/operators/nodes.mdx index 9de49f6b00..5deb625aea 100644 --- a/documentation/docs/pages/operators/nodes.mdx +++ b/documentation/docs/pages/operators/nodes.mdx @@ -2,7 +2,8 @@ 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'; -import TermsConditions from 'components/operators/snippets/tc-info.mdx' +import TermsConditions from 'components/operators/snippets/tc-info.mdx'; +import QuickStart from 'components/operators/snippets/quick-start.mdx' # Nym Nodes Operator Guides @@ -10,7 +11,7 @@ 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 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). +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), [minimum hardware specs](#vps-hardware-specs) and [Nym Wallet](nodes/preliminary-steps/wallet-preparation) with at least 101 NYM tokens. ### Knowledge base @@ -18,6 +19,10 @@ Operating a `nym-node` is not a set-and-forget endeavor. To prevent operators co +### Nym Wallet + +To [register (bond)](nodes/nym-node/bonding) `nym-node` to the network, you need a Nyx blockchain account and at least 101 NYM tokens. Follow the steps on [this page](nodes/preliminary-steps/wallet-preparation). + ### 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. @@ -30,11 +35,12 @@ Outdated nodes are never selected for routing/mixing packets, resulting in not r 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](nodes/nym-node/setup#terms--conditions). + + ## 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](nodes/preliminary-steps.mdx), preparing [VPS](nodes/preliminary-steps/vps-setup.mdx) and [Nym wallet](nodes/preliminary-steps/wallet-preparation)** 2. **[Setup](nodes/nym-node/setup.mdx) the node** diff --git a/documentation/docs/pages/operators/nodes/nym-node/setup.mdx b/documentation/docs/pages/operators/nodes/nym-node/setup.mdx index a1177a35fa..70930a3d43 100644 --- a/documentation/docs/pages/operators/nodes/nym-node/setup.mdx +++ b/documentation/docs/pages/operators/nodes/nym-node/setup.mdx @@ -8,6 +8,7 @@ import NymNodeHelp from 'components/outputs/command-outputs/nym-node-help.md'; import NymNodeRunHelp from 'components/outputs/command-outputs/nym-node-run-help.md'; import { AccordionTemplate } from 'components/accordion-template.tsx'; import TermsConditions from 'components/operators/snippets/tc-info.mdx'; +import QuickStart from 'components/operators/snippets/quick-start.mdx' # Nym Node Setup & Run @@ -36,6 +37,7 @@ Detailed version archive and release notes is documented [here](../../changelog. */} + ## Functionality (mode) @@ -76,6 +78,8 @@ Everything essential for each mode exists on `nym-node` by default. For instance Note that every `exit-gateway` mode is basically an `entry-gateway` with NR (Network Requester) and IPR (IP Packet Router) enabled. This means that every `exit-gateway` can work as an `entry-gateway` but not the opposite. + + ## Command & Examples **`nym-node` introduces a default human readible ID (local only) `default-nym-node`, which is used if there is not an explicit custom `--id ` specified. All configuration is stored in `~/.nym/nym-nodes/default-nym-node/config/config.toml` or `~/.nym/nym-nodes//config/config.toml` respectively.**