Merge pull request 'docs: Update zerotier documentation' (#5335) from ke-docs-update-zerotier into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/5335
This commit is contained in:
Luis Hebendanz
2025-10-01 10:25:52 +00:00

View File

@@ -1,4 +1,3 @@
This guide provides detailed instructions for configuring
[ZeroTier VPN](https://zerotier.com) within Clan. Follow the
outlined steps to set up a machine as a VPN controller (`<CONTROLLER>`) and to
@@ -98,11 +97,12 @@ The status should be "ONLINE":
```
## Further
Currently **Zerotier** is the only mesh-vpn that is fully integrated into clan.
In the future we plan to add additional network technologies like tinc, head/tailscale
Currently we support yggdrassil and mycelium through usage of the inventory,
though it is not yet integrated into the networking module.
Currently you can only use **Zerotier** as networking technology because this is the first network stack we aim to support.
In the future we plan to add additional network technologies like tinc, head/tailscale, yggdrassil and mycelium.
We chose zerotier because in our tests it was a straight forwards solution to bootstrap.
We chose ZeroTier because in our tests it was a straight forward solution to bootstrap.
It allows you to selfhost a controller and the controller doesn't need to be globally reachable.
Which made it a good fit for starting the project.
@@ -132,7 +132,7 @@ $ sudo zerotier-cli info
#### Manually Authorize a Machine on the Controller
=== "with ZerotierIP"
=== "with ZeroTierIP"
```bash
$ sudo zerotier-members allow --member-ip <IP>
@@ -140,7 +140,7 @@ $ sudo zerotier-cli info
Substitute `<IP>` with the ZeroTier IP obtained previously.
=== "with ZerotierID"
=== "with ZeroTierID"
```bash
$ sudo zerotier-members allow <ID>