From 0a0f2dda1d74c34079a06480201f8edc2a2c8ca3 Mon Sep 17 00:00:00 2001 From: Aryamanz29 Date: Thu, 10 Aug 2023 19:21:22 +0530 Subject: [PATCH] [docs] Mentioned ZeroTier in the Quickstart Guide --- README.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 82a0412e..2cc87253 100644 --- a/README.rst +++ b/README.rst @@ -298,11 +298,12 @@ Sending data for topology with RECEIVE strategy **Note:** The topology receive URL is shown only after the topology object is created. -2. Create a script (eg: ``/opt/send-topology.sh``) which sends the topology - data using ``POST``, in the example script below we are sending the - status log data of OpenVPN but the same code can be applied to other +2. Create a script (e.g: ``/opt/send-topology.sh``) to send the topology + data using a ``POST`` request. In the example script below, we demonstrate sending the + status log data of **OpenVPN**. However, you can adapt the same code for other formats by replacing ``cat /var/log/openvpn/tun0.stats`` with the - actual command which returns the network topology output: + appropriate command that returns the network topology output. For instance, + use ``wg show all dump`` for **Wireguard**, and ``zerotier-cli peers -j`` for **ZeroTier**. .. code-block:: shell @@ -333,6 +334,9 @@ Sending data for topology with RECEIVE strategy echo */5 * * * * /opt/send-topology.sh +**Note:** When using **ZeroTier**, ensure that you use ``sudo crontab -e`` to edit the **root's crontab**. +This is necessary because the `zerotier-cli peers` command requires root privileges to interact with the kernel. + 4. Once the steps above are completed, you should see nodes and links being created automatically, you can see the network topology graph from the admin page of the topology change page