docs/site: update description for systems on declarative users and images

This commit is contained in:
Gabriel Arazas 2023-08-01 13:32:27 +08:00
parent b97cc4415a
commit 6cbd1c972b
No known key found for this signature in database
GPG Key ID: ADE0C41DAB221FCC
2 changed files with 9 additions and 4 deletions

View File

@ -22,7 +22,10 @@ The data is then used for certain functions in the flake definition file (i.e.,
[source, toml]
----
[plover]
system = "x86_64-linux"
systems = [
"aarch64-linux",
"x86_64-linux",
]
format = "iso"
hostname = "ploverrific"
domain = "foodogsquared.one"
@ -39,8 +42,9 @@ remote-build = true
For a complete reference, here are the expected attributes.
- `system` contains the platform of the host system.
- `systems` contains a list of platforms of the host system.
This is mainly used to indicate the platform used for the nixpkgs repository.
Take note if `systems` contains more than one platform, the NixOS configurations will be renamed as `$NAME-$SYSTEM` (e.g., `plover` to `plover-x86_64-linux`, `plover-aarch64-linux`).
- `format` is the image output format for the host.
It expects an accepted value from github:nix-community/nixos-generators[opts=repo] project.

View File

@ -15,7 +15,7 @@ Here's an example user with complete schema.
[source, toml]
----
[foo-dogsquared]
system = "x86_64-linux"
systems = [ "x86_64-linux" ]
home-manager-channel = "home-manager-23.05"
home-directory = "/home/foo-dogsquared"
username = "foodogsquared"
@ -30,8 +30,9 @@ magic-rollback = true
remote-build = true
----
- `system` contains the platform of the home-manager user.
- `systems` contains a list of platforms of the home-manager user.
This is mainly used to indicate the platform used for the nixpkgs repository.
Take note if there's more than one platforms specified the home environment attribute name will change from `$HOSTNAME` to `$HOSTNAME-$SYSTEM` (e.g., `foo-dogsquared` to `foo-dogsquared-x86_64-linux`).
- `home-manager-channel` contains the home-manager channel to be used.
The value should be one of the home-manager channel that is imported into this flake.