mirror of
https://github.com/foo-dogsquared/nixos-config.git
synced 2025-02-07 06:19:00 +00:00
docs/site: keep the book up-to-date with info
This commit is contained in:
parent
436bfacf00
commit
f5189c4cf7
@ -20,21 +20,12 @@ nixos-config
|
|||||||
├── pkgs/
|
├── pkgs/
|
||||||
├── shells/
|
├── shells/
|
||||||
├── templates/
|
├── templates/
|
||||||
├── users/
|
|
||||||
├── default.nix
|
├── default.nix
|
||||||
├── flake.lock
|
├── flake.lock
|
||||||
├── flake.nix
|
├── flake.nix
|
||||||
└── README.adoc
|
└── README.adoc
|
||||||
----
|
----
|
||||||
|
|
||||||
One of the more notable files here when first start looking is the `./images.toml` file where it contains a description of the images.
|
|
||||||
For more details, see xref:../../03-project-specific-setup/01-declarative-host-management/index.adoc[Declarative host management].
|
|
||||||
|
|
||||||
A similar file, `./users.toml`, contains the description for the home-manager users to be exported from this flake.
|
|
||||||
For more details, see xref:../../03-project-specific-setup/02-declarative-user-management/index.adoc[Declarative user management].
|
|
||||||
|
|
||||||
Most of the said folders are related to a flake output attribute, see xref:../03-whats-in-my-flake/index.adoc[What's in my flake?] for more details.
|
|
||||||
|
|
||||||
* `./docs/` contain the source code for the website.
|
* `./docs/` contain the source code for the website.
|
||||||
Currently, it uses link:https://gohugo.io/[Hugo] for statically generating the website.
|
Currently, it uses link:https://gohugo.io/[Hugo] for statically generating the website.
|
||||||
|
|
||||||
|
@ -22,6 +22,3 @@ An example would be the github:{github-repo}[Borg backup task, path=./modules/ni
|
|||||||
- Certain components will be missing.
|
- Certain components will be missing.
|
||||||
Most notably, the associated SSH key for the hosts.
|
Most notably, the associated SSH key for the hosts.
|
||||||
You won't be able to connect to the host if you don't have the private key.
|
You won't be able to connect to the host if you don't have the private key.
|
||||||
|
|
||||||
- Not to mention not all modules listed committed here are up-to-date.
|
|
||||||
Though this only applies to non-critical services like the github:{github-repo}[multimedia archiving service, path=./modules/nixos/tasks/multimedia-archive, rev=master].
|
|
||||||
|
@ -8,7 +8,7 @@ It is a custom github:hercules-ci/flake-parts[opts=repo] module that allows you
|
|||||||
|
|
||||||
This custom flake-parts modules integrates the following projects:
|
This custom flake-parts modules integrates the following projects:
|
||||||
|
|
||||||
* It automatically adds github:serokell/deploy-rs[opts=repo] nodes ready to be deployed with `deploy` CLI tool.
|
* It automatically adds github:serokell/deploy-rs[opts=repo] nodes ready to be deployed with `deploy` CLI tool when given the right parameters.
|
||||||
* Mandatory inclusion of github:nix-community/home-manager[opts=repo].
|
* Mandatory inclusion of github:nix-community/home-manager[opts=repo].
|
||||||
* Image output generation made easy with github:nix-community/nixos-generators[opts=repo].
|
* Image output generation made easy with github:nix-community/nixos-generators[opts=repo].
|
||||||
|
|
||||||
@ -18,11 +18,11 @@ For example, you can build my personalized NixOS installer ISO with the followin
|
|||||||
|
|
||||||
[source, shell, subs=attributes]
|
[source, shell, subs=attributes]
|
||||||
----
|
----
|
||||||
nix build {canonical-flake-url}#images.x86_64-linux.bootstrap-iso
|
nix build {canonical-flake-url}#images.x86_64-linux.bootstrap-install-iso
|
||||||
----
|
----
|
||||||
|
|
||||||
This is an example of a declarative NixOS setup.
|
The following code listing is an example of a declarative NixOS setup.
|
||||||
The following configuration should have the following effects in the flake output:
|
It should have the following effects in the flake output:
|
||||||
|
|
||||||
* Two additional NixOS configurations to be deployed at `nixosConfigurations.plover-{x86_64-linux,aarch64-linux}`.
|
* Two additional NixOS configurations to be deployed at `nixosConfigurations.plover-{x86_64-linux,aarch64-linux}`.
|
||||||
By default, declarative NixOS setups are not added automatically to `nixosConfigurations` output unless we have `configs.<config>.formats = null;` but we did configure `configs.<config>.deploy` so that makes it even.
|
By default, declarative NixOS setups are not added automatically to `nixosConfigurations` output unless we have `configs.<config>.formats = null;` but we did configure `configs.<config>.deploy` so that makes it even.
|
||||||
@ -37,8 +37,8 @@ By default, declarative NixOS setups are not added automatically to `nixosConfig
|
|||||||
systems = [ "x86_64-linux" "aarch64-linux" ];
|
systems = [ "x86_64-linux" "aarch64-linux" ];
|
||||||
formats = [ "do" "gce" ];
|
formats = [ "do" "gce" ];
|
||||||
domain = "foodogsquared.one";
|
domain = "foodogsquared.one";
|
||||||
nixpkgs-branch = "nixos-unstable-small";
|
nixpkgsBranch = "nixos-unstable-small";
|
||||||
home-manager-branch = "home-manager-unstable";
|
homeManagerBranch = "home-manager-unstable";
|
||||||
modules = [
|
modules = [
|
||||||
({ config, lib, ... }: {
|
({ config, lib, ... }: {
|
||||||
services.foo.enable = true;
|
services.foo.enable = true;
|
||||||
|
@ -21,9 +21,9 @@ Here's an example user with complete schema.
|
|||||||
# Here is the meat, what you're likely going to do.
|
# Here is the meat, what you're likely going to do.
|
||||||
setups.home-manager.configs.foo-dogsquared = {
|
setups.home-manager.configs.foo-dogsquared = {
|
||||||
systems = [ "x86_64-linux" "aarch64-linux" ];
|
systems = [ "x86_64-linux" "aarch64-linux" ];
|
||||||
nixpkgs-branch = "nixos-stable";
|
nixpkgsBranch = "nixos-stable";
|
||||||
home-manager-branch = "home-manager-23.05";
|
homeManagerBranch = "home-manager-23.05";
|
||||||
home-directory = "/home/foo-dogsquared";
|
homeDirectory = "/home/foo-dogsquared";
|
||||||
username = "foodogsquared";
|
username = "foodogsquared";
|
||||||
modules = [
|
modules = [
|
||||||
({ config, lib, ... }: {
|
({ config, lib, ... }: {
|
||||||
|
Loading…
Reference in New Issue
Block a user