mfahampshire
a70e68c7bd
* Smolmix documentation * Add smolmix docs: landing page, tutorials, and developer page links * Add Exit Gateway services page (NR vs IPR) and link from existing docs * Update auto-generated command and API outputs * Reorg of tutorials and architecture pages * License information + remove TODO from docs.rs visibile comment + reorg readme * Add versions file for doc-wide versioning * Relative -> absolute links * Relative -> absolute links * Update license + add old tutorial code as examples * Streamline smolmix docs * Clippy * Clean up doc comments * Last pass * Add larger file download to list * set new versions * Clippy * Remove blake pin from docs + add version range to root Cargo.toml * Format example logging * Remove crate blocked component * Loose whitespace * Add doc verification script for inline mdx * Formatting * Components regen * Reorg + tighten text * Voicing cohesion pass + remove bloated examples * Voicing cont. * Reduce max download size * Small suggested clarifications * Max/docs voicing consistency (#6769) * Reduce max download size * voicing consistency across docs * New landing order w smolmix * Tweaks * Final tweaks
40 lines
2.0 KiB
Markdown
40 lines
2.0 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] [--env KEY=VALUE]
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-V, --version show program's version number and exit
|
|
-d, --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
|
|
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
|
|
```
|