From d2529704d5d80bb56a020ef4ce763a9fbc8d343d Mon Sep 17 00:00:00 2001 From: Qubasa Date: Thu, 31 Jul 2025 16:58:43 +0700 Subject: [PATCH] docs: Split up getting-started guide in a Physical and Virtual installation, and properly document how to install on non-NixOS machines docs: git add docs --- docs/mkdocs.yml | 10 +- .../guides/getting-started/choose-disk.md | 54 ++++ .../{installer.md => create-installer.md} | 4 +- docs/site/guides/getting-started/deploy.md | 275 ------------------ .../{check.md => flake-check.md} | 0 .../hardware-report-physical.md | 115 ++++++++ .../hardware-report-virtual.md | 29 ++ docs/site/guides/getting-started/index.md | 14 - docs/site/guides/getting-started/update.md | 84 ++++++ 9 files changed, 291 insertions(+), 294 deletions(-) create mode 100644 docs/site/guides/getting-started/choose-disk.md rename docs/site/guides/getting-started/{installer.md => create-installer.md} (95%) delete mode 100644 docs/site/guides/getting-started/deploy.md rename docs/site/guides/getting-started/{check.md => flake-check.md} (100%) create mode 100644 docs/site/guides/getting-started/hardware-report-physical.md create mode 100644 docs/site/guides/getting-started/hardware-report-virtual.md create mode 100644 docs/site/guides/getting-started/update.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index bf54acfd1..bf23c93c3 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -49,12 +49,16 @@ nav: - Guides: - Getting Started: - Creating Your First Clan: guides/getting-started/index.md - - Create USB Installer: guides/getting-started/installer.md - Add Machines: guides/getting-started/add-machines.md - Add User: guides/getting-started/add-user.md - Add Services: guides/getting-started/add-services.md - - Deploy Machine: guides/getting-started/deploy.md - - Continuous Integration: guides/getting-started/check.md + - Deploy to Physical Machine: + - Create USB Installer: guides/getting-started/create-installer.md + - Deploy Physical Machine: guides/getting-started/hardware-report-physical.md + - Deploy to Virtual Machine: guides/getting-started/hardware-report-virtual.md + - Configure Disk Config: guides/getting-started/choose-disk.md + - Update Machine: guides/getting-started/update.md + - Continuous Integration: guides/getting-started/flake-check.md - Using Services: guides/clanServices.md - Backup & Restore: guides/backups.md - Disk Encryption: guides/disk-encryption.md diff --git a/docs/site/guides/getting-started/choose-disk.md b/docs/site/guides/getting-started/choose-disk.md new file mode 100644 index 000000000..a44c19834 --- /dev/null +++ b/docs/site/guides/getting-started/choose-disk.md @@ -0,0 +1,54 @@ +# Configure Disk Config + +By default clan uses [disko](https://github.com/nix-community/disko) which allows for declarative disk partitioning. + +To setup a disk schema for a machine run + +```bash +clan templates apply disk single-disk jon --set mainDisk "" +``` + +Which should fail and give the valid options for the specific hardware: + +```shellSession +Invalid value for placeholder mainDisk - Valid options: +/dev/disk/by-id/nvme-WD_PC_SN740_SDDQNQD-512G-1201_232557804368 +``` + +Re-run the command with the correct disk: + +```bash +clan templates apply disk single-disk jon --set mainDisk "/dev/disk/by-id/nvme-WD_PC_SN740_SDDQNQD-512G-1201_232557804368" +``` + +Should now be successful + +```shellSession +Applied disk template 'single-disk' to machine 'jon' +``` + +A disko.nix file should be created in `machines/jon` +You can have a look and customize it if needed. + +!!! tip + For advanced partitioning, see [Disko templates](https://github.com/nix-community/disko-templates) or [Disko examples](https://github.com/nix-community/disko/tree/master/example). + +!!! Danger + Don't change the `disko.nix` after the machine is installed for the first time. + + Changing disko configuration requires wiping and reinstalling the machine. + + Unless you really know what you are doing. + +## Deploy the machine + +**Finally deployment time!** + +This command is destructive and will format your disk and install NixOS on it! It is equivalent to appending `--phases kexec,disko,install,reboot`. + + +```bash +clan machines install [MACHINE] --target-host root@ +``` + + diff --git a/docs/site/guides/getting-started/installer.md b/docs/site/guides/getting-started/create-installer.md similarity index 95% rename from docs/site/guides/getting-started/installer.md rename to docs/site/guides/getting-started/create-installer.md index 485e750f7..22d8a7ade 100644 --- a/docs/site/guides/getting-started/installer.md +++ b/docs/site/guides/getting-started/create-installer.md @@ -1,9 +1,9 @@ -# USB Installer Image for Physical Machines (optional) +# USB Installer Image for Physical Machines To install Clan on physical machines, you need to use our custom installer image. This is necessary for proper installation and operation. !!! note "Using a Cloud VM?" - If you're using a cloud provider's virtual machine (VM), you can skip this section and go directly to the [Add Machines](add-machines.md) step. In this scenario, we automatically use [nixos-anywhere](https://github.com/nix-community/nixos-anywhere) to replace the kernel during runtime. + If you're using a cloud provider's virtual machine (VM), you can skip this section and go directly to the [Deploy Virtual Machine](./hardware-report-virtual.md) step. In this scenario, we automatically use [nixos-anywhere](https://github.com/nix-community/nixos-anywhere) to replace the kernel during runtime. ??? info "Why nixos-anywhere Doesn't Work on Physical Hardware?" nixos-anywhere relies on [kexec](https://wiki.archlinux.org/title/Kexec) to replace the running kernel with our custom one. This method often has compatibility issues with real hardware, especially systems with dedicated graphics cards like laptops and servers, leading to crashes and black screens. diff --git a/docs/site/guides/getting-started/deploy.md b/docs/site/guides/getting-started/deploy.md deleted file mode 100644 index a400411a4..000000000 --- a/docs/site/guides/getting-started/deploy.md +++ /dev/null @@ -1,275 +0,0 @@ -# Deploy a machine - -Now that you have created a machines, added some services and setup secrets. This guide will walk through how to deploy it. - -## Prerequisites - -!!! important "General Requirements" - - [x] RAM > 2GB - - [x] **Two Computers**: You need one computer that you're getting ready (we'll call this the Target Computer) and another one to set it up from (we'll call this the Setup Computer). Make sure both can talk to each other over the network using SSH. - - [x] **Machine configuration**: See our basic [adding and configuring machine guide](./add-machines.md) - -## Physical Hardware - -!!! note "skip this if using a cloud VM" - -Steps: - -- Create a NixOS installer image and transfer it to a bootable USB drive as described in the [installer](./installer.md). -- Boot the target machine and connect it to a network that makes it reachable from your setup computer. -- Note down a reachable ip address (*ipv4*, *ipv6* or *tor*) - ---- - -The installer will generate a password and local addresses on boot, then run ssh with these preconfigured. -The installer shows it's deployment relevant information in two formats, a text form, as well as a QR code. - -Sample boot screen shows: - -- Root password -- IP address -- Optional Tor and mDNS details - -```{ .bash .annotate .no-copy .nohighlight} -┌─────────────────────────────────────────────────────────────────────────────────────┐ -│ ┌───────────────────────────┐ │ -│ │███████████████████████████│ # This is the QR Code (1) │ -│ │██ ▄▄▄▄▄ █▀▄█▀█▀▄█ ▄▄▄▄▄ ██│ │ -│ │██ █ █ █▀▄▄▄█ ▀█ █ █ ██│ │ -│ │██ █▄▄▄█ █▀▄ ▀▄▄▄█ █▄▄▄█ ██│ │ -│ │██▄▄▄▄▄▄▄█▄▀ ▀▄▀▄█▄▄▄▄▄▄▄██│ │ -│ │███▀▀▀ █▄▄█ ▀▄ ▄▀▄█ ███│ │ -│ │██▄██▄▄█▄▄▀▀██▄▀ ▄▄▄ ▄▀█▀██│ │ -│ │██ ▄▄▄▄▄ █▄▄▄▄ █ █▄█ █▀ ███│ │ -│ │██ █ █ █ █ █ ▄▄▄ ▄▀▀ ██│ │ -│ │██ █▄▄▄█ █ ▄ ▄ ▄ ▀█ ▄███│ │ -│ │██▄▄▄▄▄▄▄█▄▄▄▄▄▄█▄▄▄▄▄█▄███│ │ -│ │███████████████████████████│ │ -│ └───────────────────────────┘ │ -│ ┌─────────────────────────────────────────────────────────────────────────────────┐ │ -│ │Root password: cheesy-capital-unwell # password (2) │ │ -│ │Local network addresses: │ │ -│ │enp1s0 UP 192.168.178.169/24 metric 1024 fe80::21e:6ff:fe45:3c92/64 │ │ -│ │enp2s0 DOWN │ │ -│ │wlan0 DOWN # connect to wlan (3) │ │ -│ │Onion address: 6evxy5yhzytwpnhc2vpscrbti3iktxdhpnf6yim6bbs25p4v6beemzyd.onion │ │ -│ │Multicast DNS: nixos-installer.local │ │ -│ └─────────────────────────────────────────────────────────────────────────────────┘ │ -│ Press 'Ctrl-C' for console access │ -│ │ -└─────────────────────────────────────────────────────────────────────────────────────┘ -``` - -1. This is not an actual QR code, because it is displayed rather poorly on text sites. - This would be the actual content of this specific QR code prettified: - ```json - { - "pass": "cheesy-capital-unwell", - "tor": "6evxy5yhzytwpnhc2vpscrbti3iktxdhpnf6yim6bbs25p4v6beemzyd.onion", - "addrs": [ - "2001:9e8:347:ca00:21e:6ff:fe45:3c92" - ] - } - ``` - - To generate the actual QR code, that would be displayed use: - ```shellSession - echo '{"pass":"cheesy-capital-unwell","tor":"6evxy5yhzytwpnhc2vpscrbti3iktxdhpnf6yim6bbs25p4v6beemzyd.onion","addrs":["2001:9e8:347:ca00:21e:6ff:fe45:3c92"]}' | nix run nixpkgs#qrencode -- -s 2 -m 2 -t utf8 - ``` -2. The root password for the installer medium. - This password is autogenerated and meant to be easily typeable. -3. See [how to connect to wlan](./installer.md#optional-connect-to-wifi-manually). - -!!! tip - Use [KDE Connect](https://apps.kde.org/de/kdeconnect/) for easyily sharing QR codes from phone to desktop - -## Cloud VMs - -!!! note "skip this if using a physical machine" - -Clan supports any cloud machine if it is reachable via SSH and supports `kexec`. - -Steps: - -- Go to the configuration panel and note down how to connect to the machine via ssh. - -!!! tip "NixOS can cause strange issues when booting in certain cloud environments." - If on Linode: Make sure that the system uses "Direct Disk boot kernel" (found in the configuration panel) - -## Setting `targetHost` - -In your nix files set the targetHost (reachable ip) that you retrieved in the previous step. - -```{.nix title="clan.nix" hl_lines="9"} -{ - # Ensure this is unique among all clans you want to use. - meta.name = "my-clan"; - - inventory.machines = { - # Define machines here. - # The machine name will be used as the hostname. - jon = { - deploy.targetHost = "root@192.168.192.4"; # (1) - }; - }; - # ... - # elided -} -``` - -1. Use the ip address of your targetMachine that you want to deploy. If using the [flash-installer](./installer.md) it should display its local ip-address when booted. - -!!! warning - The use of `root@` in the target address implies SSH access as the `root` user. - Ensure that the root login is secured and only used when necessary. - -See also [how to set TargetHost](../target-host.md) for other methods. - -## Retrieve the hardware report - -By default clan uses [nixos-facter](https://github.com/nix-community/nixos-facter) which captures detailed information about the machine or virtual environment. - -To generate the hardware-report (`facter.json`) run: - -```bash -clan machines update-hardware-config -``` - -Example output: - -```shell-session -$ clan machines update-hardware-config jon -[jon] $ nixos-facter -Successfully generated: ./machines/jon/facter.json -``` - -See [update-hardware-config cli reference](../../reference/cli/machines.md#machines-update-hardware-config) for further configuration possibilities if needed. - -## Configure your disk schema - -By default clan uses [disko](https://github.com/nix-community/disko) which allows for declarative disk partitioning. - -To setup a disk schema for a machine run - -```bash -clan templates apply disk single-disk jon --set mainDisk "" -``` - -Which should fail and give the valid options for the specific hardware: - -```shellSession -Invalid value for placeholder mainDisk - Valid options: -/dev/disk/by-id/nvme-WD_PC_SN740_SDDQNQD-512G-1201_232557804368 -``` - -Re-run the command with the correct disk: - -```bash -clan templates apply disk single-disk jon --set mainDisk "/dev/disk/by-id/nvme-WD_PC_SN740_SDDQNQD-512G-1201_232557804368" -``` - -Should now be successful - -```shellSession -Applied disk template 'single-disk' to machine 'jon' -``` - -A disko.nix file should be created in `machines/jon` -You can have a look and customize it if needed. - -!!! tip - For advanced partitioning, see [Disko templates](https://github.com/nix-community/disko-templates) or [Disko examples](https://github.com/nix-community/disko/tree/master/example). - -!!! Danger - Don't change the `disko.nix` after the machine is installed for the first time. - - Changing disko configuration requires wiping and reinstalling the machine. - - Unless you really know what you are doing. - -## Deploy the machine - -**Finally deployment time!** Use one of the following commands to build and deploy the image via SSH onto your machine. - -### Deployment Commands - -#### Using password auth - -```bash -clan machines install [MACHINE] --target-host -``` - -#### Using QR JSON - -```bash -clan machines install [MACHINE] --json "[JSON]" -``` - -#### Using QR image file - -```bash -clan machines install [MACHINE] --png [PATH] -``` - -#### Option B: Cloud VM - -```bash -clan machines install [MACHINE] --target-host -``` - -!!! success - Your machine is all set up. 🎉 🚀 - -## Post-Deployment: Updating Machines - -### Updating - -Update a single machine: - -```bash -clan machines update jon -``` - -Update all machines: - -```bash -clan machines update -``` - -### Build Host Configuration - -If a machine is too resource-limited, use another host. - -If the machine does not have enough resources to run the NixOS evaluation or build itself, -it is also possible to specify a build host. - -During an update, the CLI will SSH into the build host and run `nixos-rebuild` from there. - -```{.nix hl_lines="5" .no-copy} -clan { - # ... - machines = { - "jon" = { - clan.core.networking.buildHost = "root@"; - }; - }; -}; -``` - -### Excluding from Automatic Updates - -To exclude machines from being updated when running `clan machines update` without any machines specified, -one can set the `clan.deployment.requireExplicitUpdate` option to true: - -```{.nix hl_lines="5" .no-copy} -clan { - # ... - machines = { - "jon" = { - clan.deployment.requireExplicitUpdate = true; - }; - }; -}; -``` - -This is useful for machines that are not always online or are not part of the regular update cycle. diff --git a/docs/site/guides/getting-started/check.md b/docs/site/guides/getting-started/flake-check.md similarity index 100% rename from docs/site/guides/getting-started/check.md rename to docs/site/guides/getting-started/flake-check.md diff --git a/docs/site/guides/getting-started/hardware-report-physical.md b/docs/site/guides/getting-started/hardware-report-physical.md new file mode 100644 index 000000000..71fa82867 --- /dev/null +++ b/docs/site/guides/getting-started/hardware-report-physical.md @@ -0,0 +1,115 @@ +# Installing a Physical Machine + +Now that you have created a machines, added some services and setup secrets. This guide will walk through how to deploy it. + +### Step 0. Prerequisites +- [x] RAM > 2GB +- [x] **Two Computers**: You need one computer that you're getting ready (we'll call this the Target Computer) and another one to set it up from (we'll call this the Setup Computer). Make sure both can talk to each other over the network using SSH. +- [x] **Machine configuration**: See our basic [adding and configuring machine guide](./add-machines.md) +- [x] **Initialized secrets**: See [secrets](secrets.md) for how to initialize your secrets. +- [x] **USB Flash Drive**: See [Clan Installer](./create-installer.md) + + +### Image Installer +This method makes use of the [image installers](./create-installer.md). + +The installer will randomly generate a password and local addresses on boot, then run ssh with these preconfigured. +The installer shows it's deployment relevant information in two formats, a text form, as well as a QR code. + + +This is an example of the booted installer. + +```{ .bash .annotate .no-copy .nohighlight} +┌─────────────────────────────────────────────────────────────────────────────────────┐ +│ ┌───────────────────────────┐ │ +│ │███████████████████████████│ # This is the QR Code (1) │ +│ │██ ▄▄▄▄▄ █▀▄█▀█▀▄█ ▄▄▄▄▄ ██│ │ +│ │██ █ █ █▀▄▄▄█ ▀█ █ █ ██│ │ +│ │██ █▄▄▄█ █▀▄ ▀▄▄▄█ █▄▄▄█ ██│ │ +│ │██▄▄▄▄▄▄▄█▄▀ ▀▄▀▄█▄▄▄▄▄▄▄██│ │ +│ │███▀▀▀ █▄▄█ ▀▄ ▄▀▄█ ███│ │ +│ │██▄██▄▄█▄▄▀▀██▄▀ ▄▄▄ ▄▀█▀██│ │ +│ │██ ▄▄▄▄▄ █▄▄▄▄ █ █▄█ █▀ ███│ │ +│ │██ █ █ █ █ █ ▄▄▄ ▄▀▀ ██│ │ +│ │██ █▄▄▄█ █ ▄ ▄ ▄ ▀█ ▄███│ │ +│ │██▄▄▄▄▄▄▄█▄▄▄▄▄▄█▄▄▄▄▄█▄███│ │ +│ │███████████████████████████│ │ +│ └───────────────────────────┘ │ +│ ┌─────────────────────────────────────────────────────────────────────────────────┐ │ +│ │Root password: cheesy-capital-unwell # password (2) │ │ +│ │Local network addresses: │ │ +│ │enp1s0 UP 192.168.178.169/24 metric 1024 fe80::21e:6ff:fe45:3c92/64 │ │ +│ │enp2s0 DOWN │ │ +│ │wlan0 DOWN # connect to wlan (3) │ │ +│ │Onion address: 6evxy5yhzytwpnhc2vpscrbti3iktxdhpnf6yim6bbs25p4v6beemzyd.onion │ │ +│ │Multicast DNS: nixos-installer.local │ │ +│ └─────────────────────────────────────────────────────────────────────────────────┘ │ +│ Press 'Ctrl-C' for console access │ +│ │ +└─────────────────────────────────────────────────────────────────────────────────────┘ +``` + +1. This is not an actual QR code, because it is displayed rather poorly on text sites. + This would be the actual content of this specific QR code prettified: + ```json + { + "pass": "cheesy-capital-unwell", + "tor": "6evxy5yhzytwpnhc2vpscrbti3iktxdhpnf6yim6bbs25p4v6beemzyd.onion", + "addrs": [ + "2001:9e8:347:ca00:21e:6ff:fe45:3c92" + ] + } + ``` + + To generate the actual QR code, that would be displayed use: + ```shellSession + echo '{"pass":"cheesy-capital-unwell","tor":"6evxy5yhzytwpnhc2vpscrbti3iktxdhpnf6yim6bbs25p4v6beemzyd.onion","addrs":["2001:9e8:347:ca00:21e:6ff:fe45:3c92"]}' | nix run nixpkgs#qrencode -- -s 2 -m 2 -t utf8 + ``` +2. The root password for the installer medium. + This password is autogenerated and meant to be easily typeable. +3. See how to connect the installer medium to wlan [here](./installer.md#optional-connect-to-wifi). +4. :man_raising_hand: I'm a code annotation! I can contain `code`, __formatted + text__, images, ... basically anything that can be written in Markdown. + +!!!tip + For easy sharing of deployment information via QR code, we highly recommend using [KDE Connect](https://apps.kde.org/de/kdeconnect/). + +There are two ways to deploy your machine: + + +=== "Password" + ### Generating a Hardware Report + + The following command will generate a hardware report with [nixos-facter](https://github.com/nix-community/nixos-facter) and writes it back into your machine folder. The `--phases kexec` flag makes sure we are not yet formatting anything, instead if the target system is not a NixOS machine it will use [kexec](https://wiki.archlinux.org/title/Kexec) to switch to a NixOS kernel. + + + ```terminal + clan machines install [MACHINE] \ + --update-hardware-config nixos-facter \ + --phases kexec \ + --target-host root@192.168.178.169 + ``` + +=== "QR Code" + ### Generating a Hardware Report + + The following command will generate a hardware report with [nixos-facter](https://github.com/nix-community/nixos-facter) and writes it back into your machine folder. The `--phases kexec` flag makes sure we are not yet formatting anything, instead if the target system is not a NixOS machine it will use [kexec](https://wiki.archlinux.org/title/Kexec) to switch to a NixOS kernel. + + #### Using a JSON String or File Path + Copy the JSON string contained in the QR Code and provide its path or paste it directly: + ```terminal + clan machines install [MACHINE] --json [JSON] \ + --update-hardware-config nixos-facter \ + --phases kexec + ``` + + #### Using an Image Containing the QR Code + Provide the path to an image file containing the QR code displayed by the installer: + ```terminal + clan machines install [MACHINE] --png [PATH] \ + --update-hardware-config nixos-facter \ + --phases kexec + ``` + + +If you are using our template `[MACHINE]` would be `jon` diff --git a/docs/site/guides/getting-started/hardware-report-virtual.md b/docs/site/guides/getting-started/hardware-report-virtual.md new file mode 100644 index 000000000..6eb9af47f --- /dev/null +++ b/docs/site/guides/getting-started/hardware-report-virtual.md @@ -0,0 +1,29 @@ +# Generate a VM Hardware Report + +Now that you have created a machines, added some services and setup secrets. This guide will walk through how to deploy it. + +## Prerequisites +- [x] RAM > 2GB +- [x] **Two Computers**: You need one computer that you're getting ready (we'll call this the Target Computer) and another one to set it up from (we'll call this the Setup Computer). Make sure both can talk to each other over the network using SSH. +- [x] **Machine configuration**: See our basic [adding and configuring machine guide](./add-machines.md) + + +Clan supports any cloud machine if it is reachable via SSH and supports `kexec`. + + +??? tip "NixOS can cause strange issues when booting in certain cloud environments." + If on Linode: Make sure that the system uses "Direct Disk boot kernel" (found in the configuration panel) + + +The following command will generate a hardware report with [nixos-facter](https://github.com/nix-community/nixos-facter) and writes it back into your machine folder. The `--phases kexec` flag makes sure we are not yet formatting anything, instead if the target system is not a NixOS machine it will use [kexec](https://wiki.archlinux.org/title/Kexec) to switch to a NixOS kernel. + + +```terminal +clan machines install [MACHINE] \ + --update-hardware-config nixos-facter \ + --phases kexec \ + --target-host myuser@ +``` + +!!! Warning + After running the above command, be aware that the SSH login user changes from `myuser` to `root`. For subsequent SSH connections to the target machine, use `root` as the login user. This change occurs because the system switches to the NixOS kernel using `kexec`. diff --git a/docs/site/guides/getting-started/index.md b/docs/site/guides/getting-started/index.md index a61a51749..20b123b91 100644 --- a/docs/site/guides/getting-started/index.md +++ b/docs/site/guides/getting-started/index.md @@ -118,17 +118,3 @@ To change the name of your clan edit `meta.name` in the `clan.nix` or `flake.nix } ``` ---- - -## Next Steps - -You can continue with **any** of the following steps at your own pace: - -- [x] [Install Nix & Clan CLI](./index.md) -- [x] [Initialize Clan](./index.md#add-clan-cli-to-your-shell) -- [ ] [Create USB Installer (optional)](./installer.md) -- [ ] [Add Machines](./add-machines.md) -- [ ] [Add a User](./add-user.md) -- [ ] [Add Services](./add-services.md) -- [ ] [Deploy](./deploy.md) - Requires configured secrets -- [ ] [Setup CI (optional)](./check.md) diff --git a/docs/site/guides/getting-started/update.md b/docs/site/guides/getting-started/update.md new file mode 100644 index 000000000..4ce1aacb7 --- /dev/null +++ b/docs/site/guides/getting-started/update.md @@ -0,0 +1,84 @@ + +# Update Your Machines + +Clan CLI enables you to remotely update your machines over SSH. This requires setting up a target address for each target machine. + +### Setting `targetHost` + +In your nix files set the targetHost (reachable ip) that your new machine now has. This removes the need to add `--targetHost` to every command. + + +```{.nix title="clan.nix" hl_lines="9"} +{ +# Ensure this is unique among all clans you want to use. +meta.name = "my-clan"; + +inventory.machines = { + # Define machines here. + # The machine name will be used as the hostname. + jon = { + deploy.targetHost = "root@192.168.192.4"; # (1) + }; +}; +# [...] +} +``` +The use of `root@` in the target address implies SSH access as the `root` user. +Ensure that the root login is secured and only used when necessary. + + +### Setting a Build Host + +If the machine does not have enough resources to run the NixOS evaluation or build itself, +it is also possible to specify a build host instead. +During an update, the cli will ssh into the build host and run `nixos-rebuild` from there. + + +```{.nix hl_lines="5" .no-copy} +buildClan { + # ... + machines = { + "jon" = { + clan.core.networking.buildHost = "root@"; + }; + }; +}; +``` + +!!! Note + Make sure that the CPU architecture is the same for the buildHost as for the targetHost. + Example: + If you want to deploy to a macOS machine, your architecture is an ARM64-Darwin, that means you need a second macOS machine to build it. + +### Updating Machine Configurations + +Execute the following command to update the specified machine: + +```bash +clan machines update jon +``` + +You can also update all configured machines simultaneously by omitting the machine name: + +```bash +clan machines update +``` + + +### Excluding a machine from `clan machine update` + +To exclude machines from being updated when running `clan machines update` without any machines specified, +one can set the `clan.deployment.requireExplicitUpdate` option to true: + +```{.nix hl_lines="5" .no-copy} +buildClan { + # ... + machines = { + "jon" = { + clan.deployment.requireExplicitUpdate = true; + }; + }; +}; +``` + +This is useful for machines that are not always online or are not part of the regular update cycle.