syntax fix

nymtech · Jun 26, 2024 · faccbe8 · faccbe8
1 parent 54d78e5
commit faccbe8
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 24 deletions.
diff --git a/documentation/operators/src/nodes/setup.md b/documentation/operators/src/nodes/setup.md
@@ -31,23 +31,29 @@ Every `exit-gateway` mode is basically an `entry-gateway` with NR (Network Reque
 Gateway operators can check out the node performance, connectivity and much more in our new tool [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net/).
 
 To determine which mode your node is running, you can check the `:8080/api/v1/roles` endpoint. For example:
-```
+```sh
+# sustitude <NODE_IP_ADDRESS> or <NODE_DOMAIN> with a real one
 # for http
-http://<IP_ADDRESS>:8080/api/v1/roles
+http://<NODE_IP_ADDRESS>:8080/api/v1/roles
+# or
+http://<NODE_IP_ADDRESS>/api/v1/roles
 
-# for https reversed proxy
-https://<DOMAIN>/api/v1/roles
+# for reversed proxy/WSS
+https://<NODE_DOMAIN>/api/v1/roles
 ```
 
 Everything necessary will exist on your node by default. For instance, if you're running a mixnode, you'll find that a NR (Network Requester) and IPR (IP Packet Router) address exist, but they will be ignored in `mixnode` mode.
 
 For more information about available endpoints and their status, you can refer to:
-```
+```sh
+# sustitude <NODE_IP_ADDRESS> or <NODE_DOMAIN> with a real one
 # for http
-http://<IP>:8080/api/v1/swagger/#/
+http://<NODE_IP_ADDRESS>:8080/api/v1/swagger/#/
+# or
+http://<NODE_IP_ADDRESS>/api/v1/swagger/#/
 
-# for https reversed proxy
-https://<DOMAIN>/api/v1/swagger/#/
+# for reversed proxy/WSS
+https://<NODE_DOMAIN>/api/v1/swagger/#/
 ```
 
 ## Usage
@@ -112,9 +118,9 @@ Accepting T&Cs is done via an explicit flag `--accept-operator-terms-and-conditi
 
 To check whether any node has T&Cs accepted or not can be done by querying Swagger API endpoint `/auxiliary_details` via one of these ports (depending on node setup):
 ```sh
-# sustitude <NODE_IP_ADDRESS> with a real one
+# sustitude <NODE_IP_ADDRESS> or <NODE_DOMAIN> with a real one
 http://<NODE_IP_ADDRESS>:8080/api/v1/auxiliary_details
-https://<NODE_IP_ADDRESS>/api/v1/auxiliary_details
+https://<NODE_DOMAIN>/api/v1/auxiliary_details
 http://<NODE_IP_ADDRESS>/api/v1/auxiliary_details
 ```
 

diff --git a/documentation/operators/src/sandbox.md b/documentation/operators/src/sandbox.md
@@ -8,7 +8,7 @@ Below are steps to [setup your environment](#sandbox-environment-setup) and an i
 This page is for Nym node operators. If you want to run NymVPN CLI over Sandbox testnet, visit our [developers portal](https://nymtech.net/developers/nymvpn/cli.html#testnet-environment).
 ```
 
-## Sanbox Environment Setup
+## Sandbox Environment Setup
 
 > Any syntax in `<>` brackets is a user's unique variable. Exchange with a corresponding name without the `<>` brackets.
 
@@ -40,9 +40,9 @@ curl -o sandbox.env -L https://raw.githubusercontent.com/nymtech/nym/develop/env
 ![](images/sandbox.png)
 
 ~~~admonish tip
-1. If you [built Nym from source](building-nym.md), you already have `sanbox.env` as a part of the monorepo (`nym/envs/sandbox.env`). Giving that you are likely to run `nym-node` from `nym/target/release`, the flag will look like this `--config-env-file ../../envs/sandbox.env`
+1. If you [built Nym from source](building-nym.md), you already have `sandbox.env` as a part of the monorepo (`nym/envs/sandbox.env`). Giving that you are likely to run `nym-node` from `nym/target/release`, the flag will look like this `--config-env-file ../../envs/sandbox.env`
 
-2. You can export the path to `sanbox.env` to your enviromental variables:
+2. You can export the path to `sandbox.env` to your enviromental variables:
 ```sh
 export NYMNODE_CONFIG_ENV_FILE_ARG=<PATH/TO/sandbox.env>
 ```

diff --git a/documentation/operators/src/troubleshooting/nodes.md b/documentation/operators/src/troubleshooting/nodes.md
@@ -300,14 +300,16 @@ In case your Gateway appeared on the [blacklist](https://validator.nymtech.net/a
 - Outdated version of `nym-node`
 - Bonding before starting the node/service
 - Bonding before opening [needed ports](../nodes/vps-setup.md#configure-your-firewall)
-- VPS restarted without operator having a [systemd automation](../nodes/configuration.md#systemd) or some alert notification flow setup
-- IP address or host is incorrectly setup
+- VPS restarted without operator having a [systemd automation](../nodes/configuration.md#systemd) or some alert notification flow setup (so the operator doesn't know the node was stopped)
+- IP address or host is incorrectly configured
 - Process logs grew too big
 - Node is wrapped in [systemd service](../nodes/configuration.md#systemd) and the operator forgot to run `systemctl daemon-reload` after last changes
 
 **What to do**
 
-Begin with a sanity check by opening [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net) and check your node there. To query all API endpoints of your node at once, you run [Node API Check CLI](../testing/node-api-check.md). To see routing in real time (harbourmaster can have a cache up to 90 min), run [Gateway Probe CLI](../testing/gateway-probe.md). Then follow these steps:
+Begin with a sanity check by opening [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net) and check your node there. To query all API endpoints of your node at once, you can run [Node API Check CLI](../testing/node-api-check.md). To see IPv4 and IPv6 routing in real time (harbourmaster can have a cache up to 90 min), run [Gateway Probe CLI](../testing/gateway-probe.md). 
+
+Then follow these steps:
 
 1. Make sure your node is on the [latest version](../changelog.md) and it's running . Do *not* stop it if there is no need!
 2. Open all [needed ports](../nodes/vps-setup.md#configure-your-firewall)
@@ -316,7 +318,7 @@ Begin with a sanity check by opening [harbourmaster.nymtech.net](https://harbour
 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. [Check out if your `syslog`s](vps-isp.md#logs-pruning) aren't eating all your disk space and prune them
-7. When all problems addressed: Restart the node/service (don't forget `systemctl daemon-reload`) and wait until your node gets above 50% of performance (average of last 24h) - this will likely take 24-48 hours. During this time your node is tested by `nym-api` and every positive response picks up your routing score.
+7. When all problems are addressed: Restart the node/service (don't forget `systemctl daemon-reload`) and wait until your node gets above 50% of performance (average of last 24h) - this will likely take 24-48 hours. During this time your node is tested by `nym-api` and every positive response picks up your routing score.
 8. If your node doesn't pick up the routing score within 24h at all and it was running in `--mode exit-gateway`, run it as `--mode entry-gateway`. When your node is above 75% performance (past 24h), switch back to `--mode exit-gateway`.
 
 **Do not repeatedly restart your Nym Node without reason, your routing score will only get worse!**
@@ -326,25 +328,32 @@ Begin with a sanity check by opening [harbourmaster.nymtech.net](https://harbour
 **1. Check out the API endpoints**
 
 Start with checking if your Gateway IPR and NR is active. To determine which mode your node is running, you can check the `:8080/api/v1/roles` endpoint. For example:
-```
+```sh
+# sustitude <NODE_IP_ADDRESS> or <NODE_DOMAIN> with a real one
 # for http
-http://<IP_ADDRESS>:8080/api/v1/roles
+http://<NODE_IP_ADDRESS>:8080/api/v1/roles
+# or
+http://<NODE_IP_ADDRESS>/api/v1/roles
 
-# for https reversed proxy
-https://<DOMAIN>/api/v1/roles
+# for reversed proxy/WSS
+https://<NODE_DOMAIN>/api/v1/roles
 ```
 
 Everything necessary will exist on your node by default. For instance, if you're running a mixnode, you'll find that a NR (Network Requester) and IPR (IP Packet Router) address exist, but they will be ignored in `mixnode` mode.
 
 For more information about available endpoints and their status, you can refer to:
 ```sh
+# sustitude <NODE_IP_ADDRESS> or <NODE_DOMAIN> with a real one
 # for http
-http://<IP>:8080/api/v1/swagger/#/
+http://<NODE_IP_ADDRESS>:8080/api/v1/swagger/#/
+# or
+http://<NODE_IP_ADDRESS>/api/v1/swagger/#/
 
-# for https reversed proxy
-https://<DOMAIN>/api/v1/swagger/#/
+# for reversed proxy/WSS
+https://<NODE_DOMAIN>/api/v1/swagger/#/
 ```
 
+
 **2. Configure IPv4 and IPv6 tables and rules**
 
 - In case you haven't, follow the steps in the node [configuration](../nodes/configuration.md) chapter [connectivity test and configurastion](../nodes/configuration.md#connectivity-test-and-configuration).