hosts: add README
This commit is contained in:
parent
1474053f43
commit
3ae586c272
1 changed files with 25 additions and 0 deletions
25
hosts/README.md
Normal file
25
hosts/README.md
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
# 💻 Hosts
|
||||||
|
|
||||||
|
This directory contains the entry points for different NixOS system configurations. Each host represents a complete system configuration, combining NixOS system settings and Home Manager configurations.
|
||||||
|
|
||||||
|
## Components
|
||||||
|
|
||||||
|
### default.nix
|
||||||
|
|
||||||
|
The `default.nix` file in each host directory serves as the main entry point for the system configuration. It:
|
||||||
|
|
||||||
|
- Sets up NixOS configurations
|
||||||
|
- Sets up Home Manager configurations
|
||||||
|
- References host-specific module declarations
|
||||||
|
|
||||||
|
### modules/
|
||||||
|
|
||||||
|
The `modules/` directory contains host-specific declarations for custom modules that are defined in the flake's `nixosModules` output. This so far only includes global theme / style related declarations.
|
||||||
|
|
||||||
|
## Adding a New Host
|
||||||
|
|
||||||
|
1. Create a new directory for the host
|
||||||
|
2. Add a `hardware-configuration.nix` generated with `nixos-generate-config`
|
||||||
|
3. Add a `default.nix` that imports the desired configurations
|
||||||
|
4. Create host-specific module declarations in the `modules/` subdirectory to customize the global modules as needed
|
||||||
|
5. Reference the new host in `hosts/default.nix`
|
Loading…
Reference in a new issue