From 531a899817331cec939800e8fae585b62cba1bbe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Tue, 6 Feb 2024 17:26:32 +0100 Subject: [PATCH] document build host option --- docs/admins/machines.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/admins/machines.md b/docs/admins/machines.md index 004d7efd..601ab465 100644 --- a/docs/admins/machines.md +++ b/docs/admins/machines.md @@ -101,6 +101,16 @@ $ clan config --machine my-machine clan.networking.targetHost root@host_or_ip _Note: 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 the 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. + +```shellSession +$ clan config --machine my-machine clan.networking.buildHost root@host_or_ip +``` + ### Updating Machine Configurations Execute the following command to update the specified machine: