forked from clan/clan-core
docs: improve docs
This commit is contained in:
parent
6a484fef66
commit
152a908dc9
@ -148,3 +148,12 @@ Adding or configuring a new machine requires two simple steps:
|
|||||||
**All facts are automatically initialized.**
|
**All facts are automatically initialized.**
|
||||||
|
|
||||||
If you need additional help see our [facts chapter](./secrets.md)
|
If you need additional help see our [facts chapter](./secrets.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Whats next?
|
||||||
|
|
||||||
|
- [Deploying](machines.md): Deploying a Machine configuration
|
||||||
|
- [Secrets](secrets.md): Learn about secrets and facts
|
||||||
|
|
||||||
|
---
|
||||||
|
@ -62,10 +62,7 @@ clan machines install my-machine <target_host>
|
|||||||
## What's next ?
|
## What's next ?
|
||||||
|
|
||||||
- [**Update a Machine**](#update-your-machines): Learn how to update an existing machine?
|
- [**Update a Machine**](#update-your-machines): Learn how to update an existing machine?
|
||||||
|
- [**Configure a Private Network**](./networking.md): Configuring a secure mesh network.
|
||||||
Coming Soon:
|
|
||||||
|
|
||||||
- **Join Your Machines in a Private Network:**: Stay tuned for steps on linking all your machines into a secure mesh network with Clan.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -5,13 +5,25 @@ This guide provides detailed instructions for configuring
|
|||||||
outlined steps to set up a machine as a VPN controller (`<CONTROLLER>`) and to
|
outlined steps to set up a machine as a VPN controller (`<CONTROLLER>`) and to
|
||||||
include a new machine into the VPN.
|
include a new machine into the VPN.
|
||||||
|
|
||||||
## 1. Setting Up the VPN Controller
|
## Concept
|
||||||
|
|
||||||
|
By default all machines within one clan are connected via a chosen network technology.
|
||||||
|
|
||||||
|
```
|
||||||
|
Clan
|
||||||
|
Node A
|
||||||
|
<-> (zerotier / mycelium / ...)
|
||||||
|
Node B
|
||||||
|
```
|
||||||
|
|
||||||
|
If you select multiple network technologies at the same time. e.g. (zerotier + yggdrassil)
|
||||||
|
You must choose one of them as primary network and the machines are always connected via the primary network.
|
||||||
|
|
||||||
|
## 1. Set-Up the VPN Controller
|
||||||
|
|
||||||
The VPN controller is initially essential for providing configuration to new
|
The VPN controller is initially essential for providing configuration to new
|
||||||
peers. Once addresses are allocated, the controller's continuous operation is not essential.
|
peers. Once addresses are allocated, the controller's continuous operation is not essential.
|
||||||
|
|
||||||
### Instructions
|
|
||||||
|
|
||||||
1. **Designate a Machine**: Label a machine as the VPN controller in the clan,
|
1. **Designate a Machine**: Label a machine as the VPN controller in the clan,
|
||||||
referred to as `<CONTROLLER>` henceforth in this guide.
|
referred to as `<CONTROLLER>` henceforth in this guide.
|
||||||
1. **Add Configuration**: Input the following configuration to the NixOS
|
1. **Add Configuration**: Input the following configuration to the NixOS
|
||||||
@ -28,12 +40,10 @@ peers. Once addresses are allocated, the controller's continuous operation is no
|
|||||||
```
|
```
|
||||||
Your machine is now operational as the VPN controller.
|
Your machine is now operational as the VPN controller.
|
||||||
|
|
||||||
## 2. Integrating a New Machine to the VPN
|
## 2. Add Machines to the VPN
|
||||||
|
|
||||||
To introduce a new machine to the VPN, adhere to the following steps:
|
To introduce a new machine to the VPN, adhere to the following steps:
|
||||||
|
|
||||||
### Instructions:
|
|
||||||
|
|
||||||
1. **Update Configuration**: On the new machine, incorporate the following to its
|
1. **Update Configuration**: On the new machine, incorporate the following to its
|
||||||
configuration, substituting `<CONTROLLER>` with the controller machine name:
|
configuration, substituting `<CONTROLLER>` with the controller machine name:
|
||||||
```nix
|
```nix
|
||||||
@ -74,22 +84,11 @@ To introduce a new machine to the VPN, adhere to the following steps:
|
|||||||
The new machine is now part of the VPN, and the ZeroTier
|
The new machine is now part of the VPN, and the ZeroTier
|
||||||
configuration on NixOS within the Clan project is complete.
|
configuration on NixOS within the Clan project is complete.
|
||||||
|
|
||||||
## Decision
|
## Further
|
||||||
|
|
||||||
We chose zerotier because in our tests it was the easiest solution to bootstrap. You can selfhost a controller and the controller doesn't need to be globally reachable.
|
|
||||||
|
|
||||||
|
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.
|
In the future we plan to add additional network technologies like tinc, head/tailscale, yggdrassil and mycelium.
|
||||||
|
|
||||||
## Specification
|
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.
|
||||||
By default all machines within one clan are connected via the chosen network technology.
|
Which made it a good fit for starting the project.
|
||||||
|
|
||||||
```
|
|
||||||
Clan
|
|
||||||
Node A
|
|
||||||
<-> (zerotier / mycelium / ...)
|
|
||||||
Node B
|
|
||||||
```
|
|
||||||
|
|
||||||
If you select multiple network technologies at the same time. e.g. (zerotier + yggdrassil)
|
|
||||||
One of them is the primary network and the above statement holds for the primary network.
|
|
||||||
|
Loading…
Reference in New Issue
Block a user