Essential Parameters & Variables
Our documentation often refer to syntax annotated in <> brackets. We use this expression for variables that are unique to each user (like path, local moniker, versions etcetra). Any syntax in <> brackets needs to be substituted with your correct name or version, without the <> brackets.
Below is a table listing the most essential variables and parameters which they may come along with, together with description and syntax example. It should help operators and developers to familiarise themselves with the convention of parameters and variables we use across the documentation.
To prevent over-flooding of our documentation we cannot provide with every single command syntax as there is a large combination of possibilities. Remember that you can always print the options using a --help flag together with any binary command.
| Flag (Option) | Variable | Description | Syntax example |
|---|---|---|---|
--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 | --accept-operator-terms-and-conditions |
--write-changes | none | Specify whether to write new changes - the values of other flags in the given command - to the config file | --write-changes |
<ACCOUNT_ADDRESS> | The address of a Nyx account | n1... | |
<AMOUNT> | An amount in unyx (1 NYX is 1,000,000 unyx) | 1000000 | |
--announce-wss-port | <ANNOUNCE_WSS_PORT> | Port listening to Web Secure Socket, default and recommended 9001 | 9001 |
<ARGUMENTS> | Replace with all flags used to run the binary with a given command | --id alice_super_node –accept-operator-terms-and-conditions | |
<BINARY_TYPE> | The directory of a binary kind under ~/.nym/ | nym-nodes | |
<BINARY> | A name of a binary | nym-node | |
<COMMAND> | A command: a command of the binary, or a shell command | run | |
<CORES> | The number of CPU cores of a VPS plan | 4 | |
<CPU_MHZ> | The CPU clock speed that the VM reports, in MHz (lscpu) | 2400 | |
<CPU_MODEL> | The CPU model name that the VM reports (lscpu) | QEMU Virtual CPU version 2.5+ | |
<DATACENTER> | The data centre or region of a VPS, as the provider names it | fsn1 | |
<DESCRIPTION> | A short description of the node | ||
<EMAIL> | An email address of the operator | ||
--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 |
--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 |
<FAMILY_NAME> | The name of a node family | ||
<FILE_NAME> | The name of a file | ||
--hostname | <HOSTNAME> | A registered DNS domain of the server, which points at its IP address. Use it without a prefix like http:// or https:// | exit-gateway1.squad.nsl |
--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 |
<ID_1> | The local id of a first instance, in an example directory tree | ||
<ID_2> | The local id of a second instance, in an example directory tree | ||
<ID_KEY> | Node public identity key, exposed on the network | GQvHcg61viyN9brWn1hficjD66Q9TorsLN2CMGJewVfo | |
--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 |
<IDENTITY> | The Keybase identity of a Nyx validator | ||
<INTERFACE> | A network interface of the server, as ip link show lists it | eth0 | |
<INVENTORY_HOST> | The name of a host in the Ansible inventory, for example node1 | ||
<IPINFO_API_KEY> | An API token of ipinfo.io | ||
<ISP_IPV4_GATEWAY> | The IPv4 default gateway of the server, which the provider gives (in its control panel, or from ip -4 route | grep default) | ||
<ISP_IPV6_GATEWAY> | The IPv6 default gateway of the server, which the provider gives (in its control panel, or from ip -6 route | grep default) | ||
<JAIL> | The name of a fail2ban jail, for example sshd | ||
<JURISDICTION_NAME> | The name of a jurisdiction, which is also the file name of its page | ||
<KEY_NAME> | The file name of a generated key pair | ||
<KEY> | The file name of an SSH host key in /etc/ssh/ | ssh_host_ed25519_key | |
<KEYRING_NAME> | The name of a key in the nyxd keyring | ||
--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 |
<LINK> | The download URL of a binary, from its release page | ||
--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 |
<LOG_FILE> | The path of a log file | ||
--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 |
<MNEMONIC> | The mnemonic of a Nyx account | ||
--mode | <MODE> | A functionality of your nym-node in the mixnet - mandatory! Chose from entry-gateway, mixnode or exit-gateway | --mode exit-gateway |
<MONIKER> | The moniker (name) of a Nyx validator | ||
<N> | The number of hosts that Ansible updates at the same time (maintenance_serial) | 1 | |
<NEW_BRANCH_NAME> | The name of a new git branch | ||
<NODE_ID> | The node id of a bonded node on the chain, a number (not the local --id) | ||
<NODE> | The kind of node a command runs: nym-node or validator | ||
<NS_AGENT_MNEMONIC> | The mnemonic of the Nyx account of a node status agent | ||
<NS_AGENT_PRIVATE_KEY> | The private key of a node status agent | ||
<NS_AGENT_PUBLIC_KEY> | The public key of a node status agent, which the node status API accepts | H4z8kx5Kkf5JNQHfxaE1MwRndjDCD1C7HsVhHTFfBZ4J | |
<NUMBER_OF_VIRTUAL_CPUS> | The number of virtual CPUs of a VM | ||
<NUMBER_OF_WORKERS> | The number of probe workers that the script starts | ||
<NYM_API_CONFIG_DATA> | The configuration files of a nym-api instance | ||
<NYM_API_DATA> | The data files of a nym-api instance | ||
<NYM_API_HOSTNAME> | The DNS name of the nym-api of a Nyx validator, for example nym-api.nyx.yourdomain.tld | ||
<NYM_MONOREPO_PATH> | The path of a clone of the Nym monorepo | ||
<NYM> | An amount in NYM | ||
<NYMVISOR_INSTANCE_ID> | The id of a Nymvisor instance | ||
<NYX_API_HOSTNAME> | The DNS name of the REST API of a Nyx validator, for example api.nyx.yourdomain.tld | ||
<NYX_GRPC_HOSTNAME> | The DNS name of the gRPC endpoint of a Nyx validator, for example grpc.nyx.yourdomain.tld | ||
<NYX_RPC_HOSTNAME> | The DNS name of the RPC endpoint of a Nyx validator, for example rpc.nyx.yourdomain.tld | ||
<NYXD_VERSION> | Version of validator binaries | v0.43.0 | |
<OS_NAME> | The OS id that virt-install --osinfo takes | ubuntu24.04 | |
<PASSWORD> | A password the operator chooses | ||
<PATH_TO_BINARIES> | The directory of the binaries | ||
<PATH_TO_EXECUTABLE> | The path of the binary of a Nymvisor upgrade | ||
<PATH_TO_LOCAL_NGINX_CONFIGURATION_BACKUP> | The local copy of the nginx configuration of the server | ||
<PATH_TO_LOCAL_NODE_CONFIGURATION_FOLDER> | The local copy of the node configuration directory | ||
<PATH_TO_LOCAL_WWW_CONFIGURATION_BACKUP> | The local copy of /var/www/ of the server | ||
<PATH_TO_TARGET_DIRECTORY> | The directory that a copy goes to | ||
<PATH_TO> | Specify a full path to the given file, directory or binary behind this variable | /root/src/nym/target/release/ | |
<PAYLOAD_GENERATED_BY_THE_WALLET> | The contract message that the wallet shows when you bond a node | ||
<PEER_HOST> | The host of a persistent peer of a Nyx node | ||
<PEER_NODE_ID> | The CometBFT node id of a persistent peer | ||
<PEER_PORT> | The P2P port of a persistent peer | 26656 | |
<PLAN_OR_CONTRACT_REF> | The plan name or contract number of a VPS, as the provider names it | CX32 | |
<PLAYBOOK> | The name of an Ansible playbook | ||
<PORT> | A port number | ||
<PUBLIC_IP> | The public IPv4 address of the server (one address; <PUBLIC_IPS> is the list value of --public-ips) | ||
--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)" |
<PUBLIC_IPV6> | The public IPv6 address of the node | ||
<RAM> | The memory of a VPS plan, in GB | 8 | |
<RELEASE_TAG> | The git tag of a release | ||
<REMOTE_SUBNET> | The first three octets of a subnet that is not the VM network | ||
<ROTATION_ID> | The id of a Sphinx key rotation, in the file name of its replay detection filter | 1234 | |
<SCRIPT_NAME> | The name of a script | ||
<SERVER_ID> | The id of a server in the account of a VPS provider | 12345678 | |
<SERVICE> | The name of a systemd service | ||
<SHA_HASH> | The SHA-256 hash of a binary, from its release page | ||
<SIZE_IN_GB> | A size in gigabytes | ||
<SIZE_IN_MB> | A size in megabytes | ||
<SNAPSHOT_URL> | The URL of a current chain snapshot | ||
<SOURCE_HOST_ADDRESS> | The address of the server that a copy comes from | ||
<SOURCE_ID> | The local id of the node that a copy comes from | ||
<SOURCE_PATH> | The path that a copy comes from | ||
<SOURCE_USER_NAME> | The Unix user on the server that a copy comes from | ||
<SSH_KEY_ENV_VAR> | The name of the environment variable that holds the path of the SSH key for Ansible | ||
<SSH_KEY> | The file name of an SSH key in ~/.ssh/ | ||
<STEAL_PERCENT> | The CPU steal time of an idle VM, in percent (%st in top) | 12 | |
<TARGET_HOST_ADDRESS> | The address of the server that a copy goes to | ||
<TARGET_PATH> | The path that a copy goes to | ||
<TARGET_USER_NAME> | The Unix user on the server that a copy goes to | ||
<UPGRADE_NAME> | The name of a Nymvisor upgrade | ||
<USER> | The Unix user on the server | ||
<VALOPER_ADDRESS> | The operator address of a Nyx validator | nvaloper1... | |
<VERSION> | Version of the binary that the service runs, as its release shows it | ||
<VM_ID_OR_HOSTNAME> | The id or the hostname of a VM, as the provider names it | vps-1234 | |
<VM_IPv4> | The IPv4 address of a VM | ||
<VM_IPv6> | The IPv6 address of a VM | ||
<VM_NAME> | The name of a VM in libvirt | ||
<VM_SUBNET> | The first three octets of the VM network (virbr0) | 192.168.122 | |
<WELCOME_TEXT> | Any text you want to show on the landing page | Welcome to Nym Node, operator contact is example@email.me | |
<WG_PEER_STRING_END> | The end of a WireGuard peer string | ||
--wireguard-enabled | <WIREGUARD_ENABLED> | Specifies whether the wireguard service is enabled, possible values: true or false - true is recommended | --wireguard-enabled true |
--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 |
<YOUR_NAME> | The name of the operator, to sign a message | Alice |
Last updated on