document build host option
All checks were successful
checks-impure / test (pull_request) Successful in 1m43s
checks / test (pull_request) Successful in 2m27s

This commit is contained in:
Jörg Thalheim 2024-02-06 17:26:32 +01:00
parent 614d1aecfd
commit 531a899817

View File

@ -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: