add probe guide, clean FnF pages

documentation/operators/src/SUMMARY.md

@@ -27,13 +27,15 @@
 - [Maintenance](nodes/maintenance.md)
   - [Manual Node Upgrade](nodes/manual-upgrade.md)
   - [Automatic Node Upgrade: Nymvisor Setup and Usage](nodes/nymvisor-upgrade.md)
-- [Performance Testing](testing/performance.md)
-  - [Node Setup](testing/node-setup.md)
-- [Metrics Monitoring](testing/templates.md)
+- [Performance Monitoring & Testing](testing/performance.md)
+  <!--- [Node Setup](testing/node-setup.md)-->
+  - [Gateway Probe](testing/gateway-probe.md)
   - [Prometheus & Grafana](testing/prometheus-grafana.md)
     - [ExploreNYM scripts](testing/explorenym-scripts.md)
 <!--    - [Run in a Docker](testing/docker-monitor.md) -->
 
+
+
 # Troubleshooting
 
 - [VPS Setup](troubleshooting/vps-isp.md)
@@ -56,7 +58,7 @@
 
 - [Exit Gateway](legal/exit-gateway.md)
 - [Community Counsel](legal/community-counsel.md)
-    - [ISP list](legal/isp-list.md)
+    - [ISP List](legal/isp-list.md)
     - [Jurisdictions](legal/jurisdictions.md)
         - [Switzerland](legal/swiss.md)
         - [United States](legal/united-states.md)

documentation/operators/src/data/isp-sheet.csv

@@ -1,7 +1,8 @@
 **ISP**,**Locations**,**Public IPv6**,**Crypto Payments**,**Comments**,**Last Updated**
-[Flokinet](https://flokinet.is),"Netherlands, Iceland, Romania,  ","Yes, needs a ticket and custom setup","yes, including XMR",Very slow customer support,"05/2024"
-[BitLaunch](https://bitlaunch.io),"Canada, USA, UK",No,Yes,Digial Ocean through BitLanch has IPv6,"05/2024"
-[Hostinger](https://hostinger.com),"France, Lithuania, India, USA, Brazil","Yes, out of the box",Yes,Crypto payments must be done each month per each server.,"05/2024"
-[Linode](https://linode.com),"USA, Canada, Japan, India, Indonesia, Sweden, Netherlands, Germany, Brazil, France, UK, Australia, Italy",Yes out of the box,No,"IPv6 sometimes need to be re-added in Networking tab, no reboot needed","05/2024"
-[Cherry Servers](https://www.cherryservers.com),"Lithuania, Netherlands, USA, Singapore",No,Yes,Issued IP doesn’t match the location offered by the provider.,"05/2024"
-[Njalla](https://nja.la),Sweden,Yes,Yes,"The biggest VPS 45 is 3 cores only, but it works better than many “larger” servers on the market.","05/2024"
+[Flokinet](https://flokinet.is),"Netherlands, Iceland, Romania,France","Yes, needs a ticket and custom setup","yes, including XMR","Very slow customer support","05/2024"
+[BitLaunch](https://bitlaunch.io),"Canada, USA, UK","No","Yes","Expensive. Digial Ocean through BitLanch has IPv6","05/2024"
+[Hostinger](https://hostinger.com),"France, Lithuania, India, USA, Brazil","Yes, out of the box","Yes","Crypto payments must be done per each server monthly or annually.","05/2024"
+[Linode](https://linode.com),"USA, Canada, Japan, India, Indonesia, Sweden, Netherlands, Germany, Brazil, France, UK, Australia, Italy","Yes out of the box","No, only through [BitLAunch](https://bitlaunch.io)","IPv6 sometimes need to be re-added in Networking tab, no reboot needed","05/2024"
+[Cherry Servers](https://www.cherryservers.com),"Lithuania, Netherlands, USA, Singapore","No","Yes","Issued IP doesn’t match the location offered by the provider.","05/2024"
+[Njalla](https://nja.la),"Sweden","Yes","Yes","Privacy vandguards! The biggest VPS 45 is 3 cores only, but it works better than many “larger” servers on the market.","05/2024"
+[HostSailor](https://hostsailor.com),"USA","Yes, based on ticket","Yes","The IPv6 setup needs custom research and is not documented","05/2024"

documentation/operators/src/legal/isp-list.md

@@ -1,4 +1,4 @@
-# List of ISPs
+# Where to host your `nym-node`?
 
 ```admonish info
 The entire content of this page is under [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/).

documentation/operators/src/nodes/vps-setup.md

@@ -10,9 +10,9 @@ A suboptimally configured VPS often results in a non-functional node. To follow
 
 You will need to rent a VPS to run your node on. One key reason for this is that your node **must be able to send TCP data using both IPv4 and IPv6** (as other nodes you talk to may use either protocol).
 
-Tor community created a very helpful table called [*Good Bad ISPs*](https://community.torproject.org/relay/community-resources/good-bad-isps/), use that one as a guideline for your choice of ISP for your VPS.
+Tor community created a very helpful table called [*Good Bad ISPs*](https://community.torproject.org/relay/community-resources/good-bad-isps/), you can use that one as a guideline for your choice of ISP for your VPS.
 
-Currently we run [performance testing](../testing/performance.md) events to find out the best optimization. Sphinx packet decryption is CPU-bound, so more fast cores the better throughput.
+**Update:** Nym community started an ISP table called [*Where to host your nym node?*](../legal/isp-list.md), check it out and add your findings!
 
 ### `nym-node`
 

documentation/operators/src/testing/gateway-probe.md

@@ -0,0 +1,79 @@
+# Nym Gateway Probe
+
+Nym Node operators running Gateway functionality are already familiar with the monitoring tool [Harbourmaster.nymtech.net](https://harbourmaster.nymtech.net). Under the hood of Nym Harbourmaster runs iterations of `nym-gateway-probe` doing various checks and displaying the results on the interface. Operators don't have operators rely on the probe run by Nym and wait for the data refresh. With `nym-gateway-probe` everyone can check any Gateway on the network. In one command the client queries data from:
+
+- [`nym-api`](https://validator.nymtech.net/api/)
+- [`explorer-api`](https://explorer.nymtech.net/api/)
+- [`harbour-master`](https://harbourmaster.nymtech.net/)
+
+
+## Preparation
+
+We recommend to have install all [the prerequisites](../binaries/building-nym.md#prerequisites) needed to build `nym-node` from source including latest [Rust Toolchain](https://www.rust-lang.org/tools/install).
+
+## Installation
+
+`nym-gateway-probe` source code is in [`nym-vpn-client`](https://github.com/nymtech/nym-vpn-client) repository. The client needs to be build from source.
+
+1. Clone the repository:
+
+```sh
+git clone https://github.com/nymtech/nym-vpn-client.git
+```
+
+2. Build `nym-gateway-probe`:
+
+```sh
+cd nym-vpn-client
+
+cargo build --release -p nym-gateway-probe
+```
+
+## Running the client
+
+```sh
+./target/release/nym-gateway-probe --help
+```
+~~~admonish collapsible=true
+```
+Usage: nym-gateway-probe [OPTIONS]
+
+Options:
+  -c, --config-env-file <CONFIG_ENV_FILE>  Path pointing to an env file describing the network
+  -g, --gateway <GATEWAY>
+  -n, --no-log
+  -h, --help                               Print help
+  -V, --version                            Print version
+
+```
+~~~
+
+To run the client, simply add a flag `--gateway` with a targeted gateway identity key. 
+
+```sh
+./target/release/nym-gateway-probe --gateway <GATEWAY_IDENTITY_KEY>
+```
+
+For any `nym-node --mode exit-gateway` the aim is to have this outcome:
+```sh
+{
+  "gateway": "<GATEWAY_IDENTITY_KEY>",
+  "outcome": {
+    "as_entry": {
+      "can_connect": true,
+      "can_route": true
+    },
+    "as_exit": {
+      "can_connect": true,
+      "can_route_ip_v4": true,
+      "can_route_ip_external_v4": true,
+      "can_route_ip_v6": true,
+      "can_route_ip_external_v6": true
+    }
+  }
+}
+```
+
+If you don't provide a `--gateway` flag it will pick a random one to test.
+
+

documentation/operators/src/testing/node-setup.md

@@ -1,10 +1,14 @@
 # Node Setup for Performance Testing Event
 
+```admonish info
+For the moment we paused Fast and Furious `perf` environment. Nym Mainnet environment will be used for future tests, please wait for further instructions. 
+```
+
 To join the [Performance testing event]({{performance_testing_webpage}}) node operators need to do proceed with the following tasks:
 
 1. **[Sign their node]({{performance_testing_webpage}}) into the testing environment**
 2. **[Configure their node](#node-configuration) for the test**
-3. (*Not mandatory*) [Setup metric monitoring system](templates.md) to observe node performance at any time
+3. (*Not mandatory*) [Setup metric monitoring system](performance.md#monitoring) to observe node performance at any time
 
 ## Node Configuration
 

documentation/operators/src/testing/performance.md

@@ -1,8 +1,34 @@
-# Performance Testing
+# Performance Monitoring & Testing
 
-> To configure your node for a testing event, visit [node setup page](node-setup.md).
+Nym Mixnet has been running on mainnet for quite some time. There is still work to be done in order for the network to meet its full potential - mass adoption of privacy through fully distributed Mixnet.
 
-Nym Mixnet has been running on mainnet for quite some time. There is still work to be done in order for the network to meet its full potential - mass adoption of privacy through fully distributed Mixnet. 
+As developers we need to be constantly improving the software. Operators have as much important role, keep their nodes up to date, monitor their performance and share their feedback with the rest of the community and core developers.
+
+Therefore [monitoring](#monitoring) and [testing](#testing) are essential pieces of our common work. We call out all Nym operators to join the efforts! 
+
+## Monitoring
+
+There are multiple ways to monitor performance of nodes and the machines on which they run. For the purpose of maximal privacy and decentralisation of the data - preventing Nym Mixnet from any global adversary takeover - we created these pages as a source of mutual empowerment, a place where operators can share and learn new skills to **setup metrics monitors on their own infrastructure**.
+
+### Guides to Setup Own Metrics
+
+A list of different scripts, templates and guides for easier navigation:
+
+* [`nym-gateway-probe`](gateway-probe.md) - a useful tool used under the hood of [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net)
+* [Prometheus and Grafana](prometheus-grafana.md) self-hosted setup
+* [Nym-node CPU cron service](https://gist.github.com/tommyv1987/97e939a7adf491333d686a8eaa68d4bd) - an easy bash script by Nym core developer [@tommy1987](https://gist.github.com/tommyv1987), designed to monitor a CPU usage of your node, running locally
+* Nym's script [`prom_targets.py`](https://github.com/nymtech/nym/blob/develop/scripts/prom_targets.py) - a useful python program to request data from API and can be run on its own or plugged to more sophisticated flows
+
+### Collecting Testing Metrics
+
+For the purpose of the performance testing Nym core developers plan to run instances of Prometheus and Grafana connected to Node explorer in the house. The network overall key insights we seek from these tests are primarily internal. We're focused on pinpointing bottlenecks, capacity loads, and monitoring cpu usage on the nodes' machines.
+
+
+## Testing 
+
+```admonish info
+For the moment we paused Fast and Furious `perf` environment. Nym Mainnet environment will be used for future tests, please wait for further instructions. 
+```
 
 Nym asks its decentralised community of operators to join a series of performance testing events in order to **increase the overall quality of the Mixnet**. The main takeaways of such event are:
 
@@ -21,7 +47,7 @@ Visit [Fast and Furious web page]({{performance_testing_webpage}}) and [Nym Harb
 
 * Nym runs a paralel network environment [validator.performance.nymte.ch]({{performance_validator}}) with a chain ID `perf`
 * Operators of Nym Nodes join by following easy steps on [performance testing web page]({{performance_testing_webpage}}), including simplified node authentication signature (while keep running their nodes on the mainnet)
-* Once signed in, operators will be asked to swap their binary for the modified version with metrics endpoint to be able to connect their own [monitoring system](templates.md)
+* Once signed in, operators will be asked to swap their binary for the modified version with metrics endpoint to be able to connect their own [monitoring system](#monitoring)
 * Core node data will be fed to a unique mixnet contract for the `perf` side chain
 * Nym starts a new API and start packet transition in high load through these nodes in both settings
 * Nym tracks packet flow using Prometheus and Grafana
@@ -31,4 +57,5 @@ Visit [Fast and Furious web page]({{performance_testing_webpage}}) and [Nym Harb
 ## More Information
 
 * What happens after the test or what operators get for participating is shared up to date on the [performance testing web page]({{performance_testing_webpage}})
-* Visit our guides to [setup metrics template](templates.md) and learn how to operate them in self-custodial way
+
+

documentation/operators/src/troubleshooting/vps-isp.md

@@ -16,6 +16,8 @@ Begin with the steps listed in [*Connectivity Test and Configuration*](../nodes/
 2. Checkout your VPS dashboard and make sure your IPv6-public enabled.
 3. If you are able to add IPv6 address `/64` range, do it.
 
+**Update:** Nym community started an ISP table called [*Where to host your nym node?*](../legal/isp-list.md), check it out and add your findings!
+
 ![](../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`