import this
937be101d2
* initialise operators guides v2 * new introduction page * add variables csv and page * add baseurl to allow short path * add sandbox page * added building from source page * add binary pages * add preliminary steps * clean preliminary steps dir * syntax edit * syntax edit * add configuration page * create new proxy configuration page * create new proxy configuration page * create bonding.mdx page * correct images path * syntax edit * add new validator setup page * add api setup page * add nyx configuration page * add nym node and maintenance pages * finish maintenance and add nymvisor conf page * add manual upgrade page * add nymvisor upgrade page * add performance testing page and dir * add node api check page * add explore nym scripts page * add testing pages * fix menu issue by moving snippets to coomponents * add all troubleshooting pages * add general faq page * add nym node faq page * add nyx faq page * revamp legal forum to community counsel and add all pages * rewire relative paths to new structure * simplify setup and remove lock file * syntax fix * rm package.json * re add package.json, rm package-lock.json * removed old books from commit * address review comments --------- Co-authored-by: mfahampshire <maxhampshire@pm.me> Co-authored-by: mx <33262279+mfahampshire@users.noreply.github.com>
23 lines
6.3 KiB
CSV
23 lines
6.3 KiB
CSV
**Flag (Option)** ,**Variable** ,**Description** ,**Syntax example**
|
||
`--mode` ,`<MODE>` ,"A functionality of your `nym-node` in the mixnet - mandatory! Chose from `entry-gateway`, `mixnode` or `exit-gateway` ",`--mode exit-gateway`
|
||
`--id` ,`<ID>` ,"A local only `nym-node` identifier, specified by flag `--id`. Not mandatory as it defaults to `default-nym-node` if not specified. ",`--id alice_super_node`
|
||
`-w` or `--write-changes` ,*none* ,Specify whether to write new changes - the values of other flags in the given command - to the config file ,`--write-changes`
|
||
`--accept-operator-terms-and-conditions` ,*none* ,"A flag added explicitly to `nym-node run` command every time, showing that the operator agreed with [T&Cs](#terms--conditions) ",`--accept-operator-terms-and-conditions`
|
||
`--public-ips` ,`<PUBLIC_IPS>` ,IPv4 of the `nym-node` server - mandatory! Use this address as a `host` value for bonding.Use this address as a `host` value for bonding. ,"`--public-ips ""$(curl -4 https://ifconfig.me)""` "
|
||
`--mixnet-bind-address` ,`<MIXNET_BIND_ADDRESS>` ,Address to bind to for listening for mixnet packets - mandatory! Must be on port `1789`! ,`--mixnet-bind-address 0.0.0.0:1789`
|
||
`--http-bind-address` ,`<HTTP_BIND_ADDRESS>` ,Socket address this node will use for binding its http API - mandatory! Must be on port `8080`! ,`--http-bind-address 0.0.0.0:8080`
|
||
`--hostname` ,`<HOSTNAME>` ,"Your registered DNS domain, asigned to the VPS with `nym-node`. Use without prefix like `http://` or `https://` ",`exit-gateway1.squad.nsl`
|
||
`--location` ,`<LOCATION>` ,"Location of your node. Formats like 'Jamaica', or two-letter alpha2 (e.g. 'JM'), three-letter alpha3 (e.g. 'JAM') or three-digit numeric-3 (e.g. '388') can be provided. ",`--location JAM`
|
||
`--wireguard-private-ip` ,`<WIREGUARD_PRIVATE_IP>` ,"Private IP address of the wireguard gateway. This mandatory field is set to a correct default: `10.1.0.1`, operators upgrading from older versions must overwrite it. ",`--wireguard-private-ip 10.1.0.1`
|
||
`--wireguard-enabled` ,`<WIREGUARD_ENABLED>` ,"Specifies whether the wireguard service is enabled, possible values: `true` or `false` - `true` is recommended ",`--wireguard-enabled true`
|
||
`--expose-system-info` ,`<EXPOSE_SYSTEM_INFO>` ,"Specify whether basic system information should be exposed. default: `true`, possible values: `true` or `false` ",`--expose-system-info false`
|
||
`--expose-system-hardware` ,`<EXPOSE_SYSTEM_HARDWARE>` ,"Specify whether basic system hardware information should be exposed. default: `true`, possible values: `true` or `false` ",`--expose-system-hardware false`
|
||
*not a flag* ,`<PATH_TO>` ,"Specify a full path to the given file, directory or binary behind this variable ",`/root/src/nym/target/release/`
|
||
`--announce-wss-port`,`<ANNOUNCE_WSS_PORT>`,"Port listening to Web Secure Socket, default and recommended `9001`",`9001`
|
||
`--landing-page-assets-path`,`<LANDING_PAGE_ASSETS_PATH>`,A sub-directory located at `/var/www/<HOSTNAME>` containing html configuration files,`/var/www/exit-gateway1.squad.nsl`
|
||
,`<BINARY> `,A name of a binary,`nym-node`
|
||
,`<ARGUMENTS>`,Replace with all flags used to run the binary with a given command,`--id alice_super_node –accept-operator-terms-and-conditions`
|
||
,`<WELCOME_TEXT>`,Any text you want to show on the landing page ,"Welcome to Nym Node, operator contact is example@email.me"
|
||
,`<NYXD_VERSION>`,Version of validator binaries,`v0.43.0`
|
||
,`<ID_KEY>`,"Node public identity key, exposed on the network",`GQvHcg61viyN9brWn1hficjD66Q9TorsLN2CMGJewVfo`
|