From b9126dfc0eb8550b59f3f860141308f3d01af18f Mon Sep 17 00:00:00 2001 From: serinko <97586125+serinko@users.noreply.github.com> Date: Fri, 3 May 2024 13:19:59 +0200 Subject: [PATCH] add troubleshooting for IPv6 & install dependencies --- .../operators/src/nodes/vps-setup.md | 32 ++++++++++++++----- .../operators/src/troubleshooting/vps-isp.md | 21 ++++++++++-- 2 files changed, 42 insertions(+), 11 deletions(-) diff --git a/documentation/operators/src/nodes/vps-setup.md b/documentation/operators/src/nodes/vps-setup.md index 3f25edc3b5..aaeecc8346 100644 --- a/documentation/operators/src/nodes/vps-setup.md +++ b/documentation/operators/src/nodes/vps-setup.md @@ -58,6 +58,22 @@ To install a full node from scratch, refer to the [validator setup guide](valida Before node or validator setup, the VPS needs to be configured and tested, to verify your connectivity and make sure that your provider wasn't dishonest with the offered services. +### Install Dependencies + +SSH to your server as `root` or become one running `sudo -i` or `su`. If you prefer to administrate your VPS from a user environment, supply the commands with prefix `sudo`. + +Start with setting up the essential tools on your server. +```sh +# get your system up to date +apt update -y && apt --fix-broken install + +# install dependencies +apt -y install ca-certificates jq curl wget ufw jq tmux pkg-config build-essential libssl-dev git + +# double check ufw is installed correctly +apt install ufw --fix-missing +``` + ### Configure your Firewall For a `nym-node` or Nyx validator to recieve traffic, you need to open ports on the server. The following commands will allow you to set up a firewall using `ufw`. @@ -68,33 +84,33 @@ For a `nym-node` or Nyx validator to recieve traffic, you need to open ports on ufw version # if it is not installed, install with -sudo apt install ufw -y +apt install ufw -y # enable ufw -sudo ufw enable +ufw enable # check the status of the firewall -sudo ufw status +ufw status ``` 2. Open all needed ports to have your firewall working correctly: ```sh # for nym-node -sudo ufw allow 1789,1790,8000,9000,9001,22/tcp +ufw allow 1789,1790,8000,9000,9001,22/tcp # in case of planning to setup a WSS (for Gateway functionality) -sudo ufw allow 9001/tcp +ufw allow 9001/tcp # in case of reverse proxy for the swagger page (for Gateway optionality) -sudo ufw allow 8080,80,443 +ufw allow 8080,80,443 # for validator -sudo ufw allow 1317,26656,26660,22,80,443/tcp +ufw allow 1317,26656,26660,22,80,443/tcp ``` 3. Check the status of the firewall: ```sh -sudo ufw status +ufw status ``` For more information about your node's port configuration, check the [port reference table](#ports-reference-table) below. diff --git a/documentation/operators/src/troubleshooting/vps-isp.md b/documentation/operators/src/troubleshooting/vps-isp.md index 5a58f92cab..21bcaabb7f 100644 --- a/documentation/operators/src/troubleshooting/vps-isp.md +++ b/documentation/operators/src/troubleshooting/vps-isp.md @@ -1,8 +1,16 @@ # Troubleshooting VPS Setup -## Incorrect Gateway Network Check +```admonish info +To monitor the connectivity of your Exit Gateway, use results of probe testing displayed in [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net). +``` -If you followed all the steps listed in [Connectivity Test and Configuration](../nodes/vps-setup.md#connectivity-test-and-configuration) chapter of VPS Setup and you still have a problem with a correct connectivity for page in +## IPv6 troubleshooting + +### Incorrect Gateway Network Check + +Nym operators community is working on a Nym version of tors [good bad ISP table](https://community.torproject.org/relay/community-resources/good-bad-isps/). There is no one solution fits all when it comes to connectivity setup. The operation of `nym-node` will vary depending on your ISP and chosen system/distribution. While few machines will work out of the box, most will work after uisng our connectivity configuration guide, some need more adjustments. + +If you followed all the steps listed in [Connectivity Test and Configuration](../nodes/vps-setup.md#connectivity-test-and-configuration) chapter of VPS Setup and you still have a problem with a correct connectivity try these steps. 1. Tor community created a helpful [table of ISPs](https://community.torproject.org/relay/community-resources/good-bad-isps/). Make sure your one is listed there as a *"good ISP"*. If not, consider migrating! 2. Checkout your VPS dashboard and make sure your IPv6-public enabled. @@ -10,8 +18,15 @@ If you followed all the steps listed in [Connectivity Test and Configuration](.. ![](../images/ipv6_64.png) +4. Search or ask your ISP for additional documentation related to IPv6 routing and ask them to provide you with `IPv6 IP address` and `IPv6 IP gateway address` +- For example Digital Ocean setup isn't the most straight forward, but it's [well documented](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) and it works. -## Virtual IPs and hosting via Google & AWS +5. Search for guides regarding your particular system and distribution. For Debian based distributions using systemd, some generic guides such as [this one](https://cloudzy.com/blog/configure-ipv6-on-ubuntu/) work as well. + + +## Other VPS troubleshooting + +### Virtual IPs and hosting via Google & AWS For true internet decentralization we encourage operators to use diverse VPS providers instead of the largest companies offering such services. If for some reasons you have already running AWS or Google and want to setup a `` there, please read the following.