clan/clan-core
12
4
Fork 19
Code Issues 101 Pull Requests 1 Actions Packages Projects 1 Releases Wiki Activity

docs: improve docs #1273

Merged
clan-bot merged 1 commits from hsjobeki-main into main 2024-04-26 09:27:24 +00:00
Conversation 0 Commits 1 Files Changed 1 +21 -18
1 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/site/getting-started/networking.md
View File

@ -26,7 +26,7 @@ peers. Once addresses are allocated, the controller's continuous operation is no
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 2. **Add Configuration**: Input the following configuration to the NixOS
configuration of the controller machine: configuration of the controller machine:
```nix ```nix
clan.networking.zerotier.controller = { clan.networking.zerotier.controller = {
@ -34,7 +34,7 @@ peers. Once addresses are allocated, the controller's continuous operation is no
public = true; public = true;
}; };
``` ```
1. **Update the Controller Machine**: Execute the following: 3. **Update the Controller Machine**: Execute the following:
```bash ```bash
$ clan machines update <CONTROLLER> $ clan machines update <CONTROLLER>
``` ```
@ -56,7 +56,9 @@ To introduce a new machine to the VPN, adhere to the following steps:
$ clan machines update <NEW_MACHINE> $ clan machines update <NEW_MACHINE>
``` ```
Replace `<NEW_MACHINE>` with the designated new machine name. Replace `<NEW_MACHINE>` with the designated new machine name.
1. **Retrieve the ZeroTier ID**: On the `new_machine`, execute:
!!! Note "For Private Networks"
1. **Retrieve the ZeroTier ID**: On the `new_machine`, execute:
```bash ```bash
$ sudo zerotier-cli info $ sudo zerotier-cli info
``` ```
@ -65,13 +67,14 @@ To introduce a new machine to the VPN, adhere to the following steps:
200 info d2c71971db 1.12.1 OFFLINE 200 info d2c71971db 1.12.1 OFFLINE
``` ```
, where `d2c71971db` is the ZeroTier ID. , where `d2c71971db` is the ZeroTier ID.
1. **Authorize the New Machine on the Controller**: On the controller machine, 2. **Authorize the New Machine on the Controller**: On the controller machine,
execute: execute:
```bash ```bash
$ sudo zerotier-members allow <ID> $ sudo zerotier-members allow <ID>
``` ```
Substitute `<ID>` with the ZeroTier ID obtained previously. Substitute `<ID>` with the ZeroTier ID obtained previously.
1. **Verify Connection**: On the `new_machine`, re-execute:
2. **Verify Connection**: On the `new_machine`, re-execute:
```bash ```bash
$ sudo zerotier-cli info $ sudo zerotier-cli info
``` ```