hosts: document the directory structure

This commit is contained in:
Colin 2023-05-14 08:56:38 +00:00
parent 7c31407ead
commit bf56200345
1 changed files with 7 additions and 0 deletions

7
hosts/README.md Normal file
View File

@ -0,0 +1,7 @@
## directory structure
- by-name/<hostname>: configuration which is evaluated _only_ for the given hostname
- common/: configuration which applies to all hosts
- modules/: nixpkgs-style modules which may be used by multiple hosts, but configured separately per host.
- ideally no module here has effect unless `enable`d
- however, `enable` may default to true
- and in practice some of these modules surely aren't fully "disableable"