foodogsquared/nixos-config
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-01-31 04:58:01 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs/site: update descriptions

Browse Source
This commit is contained in:
Gabriel Arazas 2023-12-18 18:03:18 +08:00
parent 0e4b30655e
commit 79b6ada1aa
No known key found for this signature in database
GPG Key ID: ADE0C41DAB221FCC
3 changed files with 2 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/content/en-US/02-lay-of-the-land/02-project-structure/index.adoc
View File

@ -18,8 +18,6 @@ nixos-config
├── modules/ ├── modules/
├── overlays/ ├── overlays/
├── pkgs/ ├── pkgs/
├── scripts/
├── secrets/
├── shells/ ├── shells/
├── templates/ ├── templates/
├── users/ ├── users/
@ -55,13 +53,6 @@ This is typically used exclusively for the project and advised to not use it if
* `./pkgs/` contains my custom packages. * `./pkgs/` contains my custom packages.
It is exported in the flakes at `outputs.packages` compiled through various systems. It is exported in the flakes at `outputs.packages` compiled through various systems.
* `./scripts/` contains various scripts for various purposes.
Should be self-explanatory.
* `./secrets/` contains my cluster-wide secrets managed with github:mozilla/sops[opts=repo] and github:Mic92/sops-nix[opts=repo].
Take note, each component (e.g., hosts, modules, users) could have their own specific secrets.
For more information, see xref:../../03-project-specific-setup/03-secrets-management/index.adoc[Secrets management].
* `./shells/` contains my development shells for interacting with the usual type of projects. * `./shells/` contains my development shells for interacting with the usual type of projects.
Setting this up can bring benefits outside of NixOS (unless you're interacting with projects with any OpenGL-related stuff). Setting this up can bring benefits outside of NixOS (unless you're interacting with projects with any OpenGL-related stuff).
footnote:[Since packages brought from Nix shells can only work with the store, a container might be better at some situations.] footnote:[Since packages brought from Nix shells can only work with the store, a container might be better at some situations.]

7
docs/content/en-US/03-project-specific-setup/01-declarative-host-management/index.adoc
View File

@ -67,12 +67,7 @@ By default, it uses `home-manager` flake input which follows the `home-manager-u
- `deploy` is a table containing arguments from github:serokell/deploy-rs[opts=repo]. - `deploy` is a table containing arguments from github:serokell/deploy-rs[opts=repo].
Only a few arguments are accepted (i.e., `hostname`, `fast-connection`, `remote-build`, `magic-rollback`, and `auto-rollback`). Only a few arguments are accepted (i.e., `hostname`, `fast-connection`, `remote-build`, `magic-rollback`, and `auto-rollback`).
Take note only certain hosts can be considered as a NixOS configuration (e.g., `nixosConfigurations`). Those imported NixOS configurations are also exported as part of the deploy nodes for deploy-rs with the `nixos` prefix.
Specifically, those images with a format of `iso` and those without (since they fall back to `iso` anyways).
Otherwise, most images are intended to be built.
footnote:[Though, one could create a custom activation and deployment script with deploy-rs.]
Furthermore, those imported NixOS configurations are also exported as part of the deploy nodes for deploy-rs with the `nixos` prefix.
For example, here's the command to deploy my Plover server. For example, here's the command to deploy my Plover server.
[source, shell, subs=attributes] [source, shell, subs=attributes]

2
docs/content/en-US/03-project-specific-setup/02-declarative-user-management/index.adoc
View File

@ -3,7 +3,7 @@ title: Declarative user management
--- ---
= Declarative user management = Declarative user management
Similarly to xref:../02-declarative-host-management/index.adoc[Declarative host management], this project also provides a way to declare home-manager users. Similarly to xref:../01-declarative-host-management/index.adoc[Declarative host management], this project also provides a way to declare home-manager users.
The `users.toml` sits in the project root expecting certain data. The `users.toml` sits in the project root expecting certain data.
Similar to `images.toml`, it expects a table of users with each representing one of the users from github:{github-repo}[`./users/home-manager/`, path=./users/home-manager/, rev=master]. Similar to `images.toml`, it expects a table of users with each representing one of the users from github:{github-repo}[`./users/home-manager/`, path=./users/home-manager/, rev=master].
These are then included as part of `homeConfigurations` for easier installation with the standalone home-manager tool. These are then included as part of `homeConfigurations` for easier installation with the standalone home-manager tool.