From a2cb4a06a2158a09eba583a5825561a4ad04890e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Fri, 8 Nov 2024 12:38:36 +0100 Subject: [PATCH] clanModules/zerotier: add documentation --- clanModules/zerotier/README.md | 37 +++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/clanModules/zerotier/README.md b/clanModules/zerotier/README.md index 40a58b512..0572addb4 100644 --- a/clanModules/zerotier/README.md +++ b/clanModules/zerotier/README.md @@ -1,7 +1,38 @@ --- -description = "Statically configure the `zerotier` peers of a clan network." +description = "Configures [Zerotier VPN](https://zerotier.com) secure and efficient networking within a Clan.." features = [ "inventory" ] --- -Statically configure the `zerotier` peers of a clan network. -Requires a machine, that is the zerotier controller configured in the network. +## Overview + +This guide explains how to set up and manage a [ZeroTier VPN](https://zerotier.com) for a clan network. Each VPN requires a single controller and can support multiple peers and optional moons for better connectivity. + +## Roles + +### 1. Controller + +The [Controller](https://docs.zerotier.com/controller/) manages network membership and is responsible for admitting new peers. +When a new node is added to the clan, the controller must be updated to ensure it has the latest member list. + +- **Key Points:** + - Must be online to admit new machines to the VPN. + - Existing nodes can continue to communicate even when the controller is offline. + +### 2. Moons + +[Moons](https://docs.zerotier.com/roots) act as relay nodes, +providing direct connectivity to peers via their public IP addresses. +They enable devices that are not publicly reachable to join the VPN by routing through these nodes. + +- **Configuration Notes:** + - Each moon must define its public IP address. + - Ensures connectivity for devices behind NAT or restrictive firewalls. + +### 3. Peers + +Peers are standard nodes in the VPN. +They connect to other peers, moons, and the controller as needed. + +- **Purpose:** + - General role for all machines that are neither controllers nor moons. + - Ideal for most clan members' devices.