diff --git a/docs/site/getting-started/networking.md b/docs/site/getting-started/networking.md index e1a4dfcc..0b579cc9 100644 --- a/docs/site/getting-started/networking.md +++ b/docs/site/getting-started/networking.md @@ -8,14 +8,13 @@ include a new machine into the VPN. ## 1. Setting Up the VPN Controller The VPN controller is initially essential for providing configuration to new -peers. Post the address allocation, the controller's continuous operation is not -crucial. +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, referred to as `` henceforth in this guide. -2. **Add Configuration**: Input the below configuration to the NixOS +1. **Add Configuration**: Input the following configuration to the NixOS configuration of the controller machine: ```nix clan.networking.zerotier.controller = { @@ -23,7 +22,7 @@ crucial. public = true; }; ``` -3. **Update the Controller Machine**: Execute the following: +1. **Update the Controller Machine**: Execute the following: ```bash $ clan machines update ``` @@ -35,35 +34,43 @@ To introduce a new machine to the VPN, adhere to the following steps: ### Instructions: -1. **Update Configuration**: On the new machine, incorporate the below to its +1. **Update Configuration**: On the new machine, incorporate the following to its configuration, substituting `` with the controller machine name: ```nix { config, ... }: { clan.networking.zerotier.networkId = builtins.readFile (config.clanCore.clanDir + "/machines//facts/zerotier-network-id"); } ``` -2. **Update the New Machine**: Execute: +1. **Update the New Machine**: Execute: ```bash $ clan machines update ``` Replace `` with the designated new machine name. -3. **Retrieve the ZeroTier ID**: On the `new_machine`, execute: +1. **Retrieve the ZeroTier ID**: On the `new_machine`, execute: ```bash $ sudo zerotier-cli info ``` - Example Output: `200 info d2c71971db 1.12.1 OFFLINE`, where `d2c71971db` is - the ZeroTier ID. -4. **Authorize the New Machine on Controller**: On the controller machine, + Example Output: + ```{.console, .no-copy} + 200 info d2c71971db 1.12.1 OFFLINE + ``` + , where `d2c71971db` is the ZeroTier ID. +1. **Authorize the New Machine on the Controller**: On the controller machine, execute: ```bash $ sudo zerotier-members allow ``` Substitute `` with the ZeroTier ID obtained previously. -5. **Verify Connection**: On the `new_machine`, re-execute: +1. **Verify Connection**: On the `new_machine`, re-execute: ```bash $ sudo zerotier-cli info ``` - The status should now be "ONLINE" e.g., `200 info 47303517ef 1.12.1 ONLINE`. + The status should now be "ONLINE": + ```{.console, .no-copy} + 200 info d2c71971db 1.12.1 ONLINE + ``` + +!!! success + Congratulations! The new machine is now part of the VPN, and the ZeroTier + configuration on NixOS within the Clan project is complete. -Congratulations! The new machine is now part of the VPN, and the ZeroTier -configuration on NixOS within the Clan project is complete.