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

Run formatter

Browse Source
This commit is contained in:
pinpox
2025-08-25 18:40:51 +02:00
parent a9c53b8b1e
commit 41c52197ea
71 changed files with 2118 additions and 1379 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
docs/site/guides/mesh-vpn.md
View File

@@ -1,12 +1,12 @@
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
include a new machine into the VPN.
[ZeroTier VPN](https://zerotier.com) within Clan. Follow the outlined steps to
set up a machine as a VPN controller (`<CONTROLLER>`) and to include a new
machine into the VPN.
## Concept
By default all machines within one clan are connected via a chosen network technology.
By default all machines within one clan are connected via a chosen network
technology.
```{.no-copy}
Clan
@@ -15,19 +15,22 @@ Clan
Node B
```
This guide shows you how to configure `zerotier` through clan's `Inventory` System.
This guide shows you how to configure `zerotier` through clan's `Inventory`
System.
## The Controller
The controller is the initial entrypoint for new machines into the vpn.
It will sign the id's of new machines.
Once id's are signed, the controller's continuous operation is not essential.
A good controller choice is nevertheless a machine that can always be reached for updates - so that new peers can be added to the network.
The controller is the initial entrypoint for new machines into the vpn. It will
sign the id's of new machines. Once id's are signed, the controller's continuous
operation is not essential. A good controller choice is nevertheless a machine
that can always be reached for updates - so that new peers can be added to the
network.
For the purpose of this guide we have two machines:
- The `controller` machine, which will be the zerotier controller.
- The `new_machine` machine, which is the machine we want to add to the vpn network.
- The `new_machine` machine, which is the machine we want to add to the vpn
network.
## Configure the Service
@@ -99,12 +102,15 @@ The status should be "ONLINE":
## Further
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.
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.
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.
We chose zerotier because in our tests it was a straight forwards 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.
## Debugging
@@ -134,16 +140,20 @@ $ sudo zerotier-cli info
=== "with ZerotierIP"
```bash
$ sudo zerotier-members allow --member-ip <IP>
```
````
```bash
$ sudo zerotier-members allow --member-ip <IP>
```
Substitute `<IP>` with the ZeroTier IP obtained previously.
Substitute `<IP>` with the ZeroTier IP obtained previously.
````
=== "with ZerotierID"
```bash
$ sudo zerotier-members allow <ID>
```
````
```bash
$ sudo zerotier-members allow <ID>
```
Substitute `<ID>` with the ZeroTier ID obtained previously.
Substitute `<ID>` with the ZeroTier ID obtained previously.
````