import this
26538f5a40
* add guide component * add mitigate kernel playbook * add to troubleshooting * remove redundant * remove redundant * FIX ISSUES * fix * fix url to raw * update docs and add new playbook * update and simplify docs and ansible * create ntm explanation component and import it * rm mistaken empty file * rm crap * rm crap * rm all crap * try to fix nextra screaming seagul * try to fix nextra screaming seagul * try to fix nextra screaming seagul * UX improvement by logic refactoring * UX improvement by logic refactoring * UX improvement by logic refactoring * UX improvement by logic refactoring * fix header urls * fix command syntax * fix indentation * update auto-stats * resolve review comments * resolve review comments in docs * fix remove kernel book * soften warning * address comments * address comments * update stats
49 lines
2.4 KiB
Markdown
49 lines
2.4 KiB
Markdown
```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]
|
|
[--host-ssh-port HOST_SSH_PORT]
|
|
[--nym-node-binary NYM_NODE_BINARY]
|
|
[--uplink-dev UPLINK_DEV]
|
|
[--uplink-dev-v4 UPLINK_DEV_V4]
|
|
[--uplink-dev-v6 UPLINK_DEV_V6] [--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)
|
|
--host-ssh-port HOST_SSH_PORT
|
|
Host SSH port to allow in the firewall (default: 22)
|
|
--nym-node-binary NYM_NODE_BINARY
|
|
URL for nym-node binary (autodetected if omitted)
|
|
--uplink-dev UPLINK_DEV
|
|
Backward-compatible override for both IPv4 and IPv6
|
|
uplinks, e.g. 'eth0'
|
|
--uplink-dev-v4 UPLINK_DEV_V4
|
|
Override IPv4 uplink interface used for NAT/FORWARD,
|
|
e.g. 'eth0'
|
|
--uplink-dev-v6 UPLINK_DEV_V6
|
|
Override IPv6 uplink interface used for NAT/FORWARD,
|
|
e.g. 'eth1'
|
|
--env KEY=VALUE (Optional) Extra ENV VARS, e.g. --env CUSTOM_KEY=value
|
|
```
|