add a quick start message

2025-10-05 11:48:49 +02:00
parent fc98c497b4
commit f53e5fe8dd
5 changed files with 21 additions and 4 deletions
@@ -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).**
@@ -1 +1 @@
-Wednesday, October 1st 2025, 11:16:15 UTC
+Sunday, October 5th 2025, 09:29:02 UTC
@@ -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).**

+<QuickStart />
+
 ## Popular pages

 **Binary Information**
@@ -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

 <NymNodeSpecs />

+### 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).

+<QuickStart />
+
 ## 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**
@@ -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.
 <BuildInfo />
 */}

+
 ## Functionality (mode)

 <Callout type="info">
@@ -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.

+<QuickStart />
+
 ## 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 <ID>` specified. All configuration is stored in `~/.nym/nym-nodes/default-nym-node/config/config.toml` or `~/.nym/nym-nodes/<ID>/config/config.toml` respectively.**