import this
2b83442a6d
* replace dead token page with live dashboard * add dev release notes * fix urls * add IPv6 KVM guide * simplify node setup command * add operator updates * PR finished: add WG exit policy steps andfinish changelog * PR finished: fix typo * add components to the branch * fix styling
36 lines
2.2 KiB
Plaintext
36 lines
2.2 KiB
Plaintext
<>
|
|
If you run a `nym-node` for the first time, you will need to specify a few parameters, please read the section [Essential Parameters & Variables](#essential-paramteters--varibles) before you start and make sure that your `nym-node` is up to date with the [latest version](https://github.com/nymtech/nym/releases/).
|
|
|
|
**Initialise and Run**
|
|
|
|
To initialise and test run your node, use this command:
|
|
```sh
|
|
./nym-node run --id <ID> --mode exit-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname "<HOSTNAME>" --location <LOCATION> --accept-operator-terms-and-conditions --wireguard-enabled true
|
|
```
|
|
If you prefer to have a generic local identifier set to `default-nym-node`, skip `--id` option.
|
|
|
|
We highly recommend to setup [reverse proxy and WSS](proxy-configuration.md) for `nym-node`. If you haven't configured any of that, skip `--hostname` flag.
|
|
|
|
In any case `--public-ips` is a necessity for your node to bond to API and communicate with the internet.
|
|
|
|
|
|
**Initialise only** without running the node with `--init-only` command:
|
|
|
|
Adding `--init-only` option results in `nym-node` initialising a configuration file `config.toml` without running - a good option for an initial node setup. Remember that if you using this flag on a node which already has a config file, this will not over-write the values, unless used with a specified flag `--write-changes` (`-w`) - a good option for introducing changes to your `config.toml` file.
|
|
|
|
```sh
|
|
./nym-node run --id <ID> --init-only --mode exit-gateway --public-ips "$(curl -4 https://ifconfig.me)" --hostname "<HOSTNAME>" --location <LOCATION> --wireguard-enabled true
|
|
```
|
|
|
|
In the example above we dropped `--accept-operator-terms-and-conditions` as the flag must be added to a running command explicitly and it is not stored in the config, `--init-only` will not run the node.
|
|
|
|
**Deny init**
|
|
|
|
`--deny-init` was introduced as an additional safety for migration from legacy binaries to `nym-node` to prevent operators initialise over existing nodes. For most of the operators, this flag is not needed.
|
|
|
|
In this example we run the node with custom `--id` without initialising, using `--deny-init` command:
|
|
```sh
|
|
./nym-node run --id <ID> --deny-init --mode exit-gateway --accept-operator-terms-and-conditions
|
|
```
|
|
</>
|