From cffb8d98af3a5dc7dfbe14614d52aa0a9fd3ef84 Mon Sep 17 00:00:00 2001 From: import this <97586125+serinko@users.noreply.github.com> Date: Mon, 3 Jun 2024 14:16:30 +0000 Subject: [PATCH] [DOCs/operators]: fix wireguard syntax (#4628) * fix wireguard syntax * simplify syntax * clean --- documentation/operators/src/changelog.md | 2 +- documentation/operators/src/nodes/setup.md | 90 ++----------------- .../operators/src/troubleshooting/nodes.md | 7 +- 3 files changed, 12 insertions(+), 87 deletions(-) diff --git a/documentation/operators/src/changelog.md b/documentation/operators/src/changelog.md index 669f1fd8df..e56a305b12 100644 --- a/documentation/operators/src/changelog.md +++ b/documentation/operators/src/changelog.md @@ -151,7 +151,7 @@ called Result::unwrap() on an Err value: ClientCoreError(ValidatorClientError(Ny - [`nym-gateway-probe`](testing/gateway-probe.md): A CLI tool to check in-real-time networking status of any Gateway locally. - [Where to host your `nym-node`?](legal/isp-list.md): A list of Internet Service Providers (ISPs) by Nym Operators community. We invite all operators to add their experiences with different ISPs to strengthen the community knowledge and Nym mixnet performance. -- Make sure you run `nym-node` with `--wireguard_enabled false` and add a location description to your `config.toml`, both documented in [`nym-node` setup manual](nodes/setup.md#mode-exit-gateway). +- Make sure you run `nym-node` with `--wireguard-enabled false` and add a location description to your `config.toml`, both documented in [`nym-node` setup manual](nodes/setup.md#mode-exit-gateway). --- diff --git a/documentation/operators/src/nodes/setup.md b/documentation/operators/src/nodes/setup.md index 23863e36d3..55fcaf146b 100644 --- a/documentation/operators/src/nodes/setup.md +++ b/documentation/operators/src/nodes/setup.md @@ -54,10 +54,10 @@ https:///api/v1/swagger/#/ ### Help Command -There are a few changes from the individual binaries used in the past. For example by default `run` command does `init` function as well, local node `--id` will be set by default unless specified otherwise etcetera. +There are a few changes from the individual binaries used in the past. For example by default `run` command does `init` function as well, local node `--id` will be set by default unless specified otherwise etcetera. ```admonish info -You can always use `--help` flag to see the commands or arguments associated with a given command. +You can always use `--help` flag to see the commands or arguments associated with a given command. ``` Run `./nym-node --help` to see all available commands: @@ -76,89 +76,17 @@ To list all available flags for each command, run `./nym-node --help` ``` ~~~ - - -The Wireguard flags currently have limited functionality, with `--wireguard-enabled` being the most relevant, enabling or disabling wireguard functionality. +**Keep Wireguard disabled for the time being!** +``` #### Flags Summary Some of the most useful flags and their explanation: +~~~admonish example collapsible=true title="Flags explanation:" - `--id `: Local identifier of your node. This `` determines your config path located at `~/.nym/nym-nodes//config/config.toml`, default value is `default-nym-node` - `--config-file `: Used for the migrate command to indicate the location of the existing node config file. Default path is `~/.nym/nym-nodes/default-nym-node/config/config.toml` - `--deny-init`: Use this flag to prevent a new node from being initialized. It's recommended to use this after the first run to avoid accidental spinning up of a second node. @@ -169,9 +97,7 @@ Some of the most useful flags and their explanation: - `--expose-system-info `: Sets your system info visibility on the network. - `--expose-system-hardware `: Sets your system hardware info visibility on the network. - `--expose-crypto-hardware `: Sets your crypto hardware info visibility on the network. - - -## Usage +~~~ ### Commands & Examples diff --git a/documentation/operators/src/troubleshooting/nodes.md b/documentation/operators/src/troubleshooting/nodes.md index 9731617769..9fee78f3b7 100644 --- a/documentation/operators/src/troubleshooting/nodes.md +++ b/documentation/operators/src/troubleshooting/nodes.md @@ -307,8 +307,7 @@ What to do: 4. [Check Gateway Connectivity](#check-gateway-connectivity) 5. See logs of your Gateway and search [for errors](#nym-node-errors) - if you find any unusual one, you can ask in the [Element Node Operators](https://matrix.to/#/#operators:nymtech.chat) channel - If your logs show that your Node has `cover down: 0.00` that means that the embedded IPR and NR is not sending any cover traffic. -6. -7. When all problems addressed:Wait until your node gets above 50% of performance (average of last 24h) - this will likely take several hours, up to a day. During this time your node is tested by `nym-api` and every positive response picks up your Gateway's routing score. +6. When all problems addressed:Wait until your node gets above 50% of performance (average of last 24h) - this will likely take several hours, up to a day. During this time your node is tested by `nym-api` and every positive response picks up your Gateway's routing score. **Do not restart your Nym Node without reason, your routing score will only get worse!** @@ -347,12 +346,12 @@ https:///api/v1/swagger/#/ ```sh telnet -``` +``` - [Websocket wcat](https://github.com/websockets/wscat): - Install on your local machine: ```sh -sudo apt install node-ws +sudo apt install node-ws ``` - Run `wscat` pointing to the IP of your VPS with port `9000`: ```