update nym-node-cli guide

This commit is contained in:
serinko
2025-11-25 10:02:28 +01:00
parent 9262e24892
commit 4b292ca142
6 changed files with 96 additions and 3 deletions
@@ -1 +1 @@
Thursday, November 20th 2025, 12:33:19 UTC
Tuesday, November 25th 2025, 08:49:55 UTC
@@ -11,7 +11,7 @@ options:
--no_routing_history Display node stats without routing history
--no_verloc_metrics Display node stats without verloc metrics
-m, --markdown Display results in markdown format
-o, --output [OUTPUT]
-o [OUTPUT], --output [OUTPUT]
Save results to file (in current dir or supply with
path without filename)
```
@@ -0,0 +1,37 @@
```sh
usage: nym-node-cli install [-h] [-V] [-d BRANCH] [-v]
[--mode {mixnode,entry-gateway,exit-gateway}]
[--wireguard-enabled {true,false}]
[--hostname HOSTNAME] [--location LOCATION]
[--email EMAIL] [--moniker MONIKER]
[--description DESCRIPTION]
[--public-ip PUBLIC_IP]
[--nym-node-binary NYM_NODE_BINARY]
[--uplink-dev UPLINK_DEV] [--env KEY=VALUE]
options:
-h, --help show this help message and exit
-V, --version show program's version number and exit
-d BRANCH, --dev BRANCH
Define github branch (default: develop)
-v, --verbose Show full error tracebacks
--mode {mixnode,entry-gateway,exit-gateway}
Node mode: 'mixnode', 'entry-gateway', or 'exit-
gateway'
--wireguard-enabled {true,false}
WireGuard functionality switch: true / false
--hostname HOSTNAME Node domain / hostname
--location LOCATION Node location (country code or name)
--email EMAIL Contact email for the node operator
--moniker MONIKER Public moniker displayed in explorer & NymVPN app
--description DESCRIPTION
Short public description of the node
--public-ip PUBLIC_IP
External IPv4 address (autodetected if omitted)
--nym-node-binary NYM_NODE_BINARY
URL for nym-node binary (autodetected if omitted)
--uplink-dev UPLINK_DEV
Override uplink interface used for NAT/FORWARD (e.g.,
'eth0'; autodetected if omitted)
--env KEY=VALUE (Optional) Extra ENV VARS, e.g. --env CUSTOM_KEY=value
```
+47 -1
View File
@@ -5,7 +5,13 @@ import { RunTabs } from 'components/operators/nodes/node-run-command-tabs';
import { VarInfo } from 'components/variable-info.tsx';
import { AccordionTemplate } from 'components/accordion-template.tsx';
import { Steps } from 'nextra/components';
import NymNodeCliInstallHelp from 'components/outputs/command-outputs/nym-node-cli-install-help.md';
export const NymNodeCliCommand = () => (
<div>
Arguments and options: <code>./nym-node-cli.py install --help</code>
</div>
);
# Tools
@@ -45,10 +51,50 @@ chmod +x ./nym-node-cli.py
```
###### 3. Run the program
There are two ways how to run the program. fully interactive or with provided arguments. The former has a shorter initial command but then operators must fill the values on the go, the latter requires more complex command, but then there is a minimum prompts during the process.
1. Fully interactive mode - just run:
```
./nym-node-cli.py
./nym-node-cli.py install
```
2. Use arguments - this command to see all options:
```sh
./nym-node-cli.py install --help
```
<AccordionTemplate name={<NymNodeCliCommand/>}>
<NymNodeCliInstallHelp />
</ AccordionTemplate>
- An example can look like this:
```sh
# substitute with your real values:
./nym-node-cli.py install
--hostname node-install.devrel.nymte.ch
--moniker MainnetGW-DE
--description "This node is installed with nym-node-cli v1.2.0"
--wireguard-enabled true
--location DE
--mode exit-gateway
--email kawa_hesinkar@example.ku
```
###### 4. Read and follow the prompts
There will be a few needed confirmations and in caser of running the program without the arguments, you will be prompted for values neccessary to setup a `nym-node` and configure your server.
**Read these prompts carefully!**
###### 5. Setup finished
Congratulation, your node is installed.
This version of the program does not prompt an operator for the local node moniker (`--id <ID>`) therefore it asigns your node an automatic one `default-nym-node`.
All configuration and data of your node can be found in this location:
```sh
ls $HOME/.nym/nym-nodes/default-nym-node/
```
</ Steps>
## CMD Reward Tracker
@@ -59,4 +59,14 @@ echo '```sh' > ../../documentation/docs/components/outputs/command-outputs/nym-a
./nym-api --help >> ../../documentation/docs/components/outputs/command-outputs/nym-api-help.md &&
echo '```' >> ../../documentation/docs/components/outputs/command-outputs/nym-api-help.md &&
cd ../../scripts/nym-node-setup
echo '```sh' > ../../documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md &&
python ./nym-node-cli.py install --help >> ../../documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md &&
echo '```' >> ../../documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md &&
echo '```sh' > ../../documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md &&
python ./nym-node-cli.py install --help >> ../../documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md &&
echo '```' >> ../../documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md &&
echo "prebuild finished"
View File