yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request 'zerotier: Add a usage example to the documentation' (#3867) from kenji/clan-core:ke-zerotier-documentation into main

Browse Source 
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3867
This commit is contained in:
kenji
2025-06-05 13:47:25 +00:00
parent 801b90025d 9f1c660a4f
commit 3d39ab91bc
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
clanServices/zerotier/README.md
View File

@@ -1,3 +1,24 @@
## Example Usage
```
inventory.instances = {
zerotier = {
module = {
name = "zerotier";
input = "clan";
};
roles.peer.tags.all = { };
roles.controller.machines.jon = { };
roles.moon.machines.sara.settings.stableEndpoints = [ "77.52.165.46" ];
};
```
The input should be named according to your flake input.
All machines will be peers and connected to the zerotier network.
Jon is the controller machine, which will will accept other machines into the network.
Sara is a moon and sets the `stableEndpoint` setting with a publically reachable IP.
## 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.