Skip to content

Commit

Permalink
[docs] Mentioned ZeroTier in the Quickstart Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Aryamanz29 committed Aug 10, 2023
1 parent 5061312 commit 0a0f2dd
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 0a0f2dd

Please sign in to comment.