mirror of
https://github.com/nix-community/srvos.git
synced 2024-10-03 18:47:28 +03:00
docs/darwin: document current modules
This commit is contained in:
parent
86591a3954
commit
12697bf38a
13
docs/darwin/mixins.md
Normal file
13
docs/darwin/mixins.md
Normal file
@ -0,0 +1,13 @@
|
||||
Config extensions for a given machine.
|
||||
|
||||
One or more can be included per Darwin configuration.
|
||||
|
||||
### `darwiModules.mixins-telegraf`
|
||||
|
||||
Enables a generic telegraf configuration. `nixosModules.mixins-prometheus` for monitoring rules targeting this telegraf configuration.
|
||||
|
||||
### `darwinModules.mixins-terminfo`
|
||||
|
||||
Extends the terminfo database with often used terminal emulators.
|
||||
Terminfo is used by terminal applications to interfere supported features in the terminal.
|
||||
This is useful when connecting to a server via SSH.
|
32
docs/darwin/type.md
Normal file
32
docs/darwin/type.md
Normal file
@ -0,0 +1,32 @@
|
||||
Those high-level modules are used to define the type of machine.
|
||||
|
||||
We expect only one of those to be imported per Darwin configuration.
|
||||
|
||||
### Common (`darwinModules.common`)
|
||||
|
||||
Use this module if you are unsure if your darwin module will be used on server or desktop.
|
||||
|
||||
- Better nix-daemon defaults
|
||||
- Better serial console support
|
||||
- Colored package diffs on nixos-rebuild
|
||||
- Use systemd in initrd by default and networkd as a backend for the
|
||||
Networking module
|
||||
- Do not block on networkd/networkmanager's online target
|
||||
- Better zfs defaults
|
||||
- Add ssh host keys to well-known Git servers (eg: github)
|
||||
- Enable sudo for @wheel users.
|
||||
- ...
|
||||
|
||||
### Server (`darwinModules.server`)
|
||||
|
||||
Use this for headless systems that are remotely managed via ssh.
|
||||
|
||||
- Includes everything from common
|
||||
- So far nothing else, but this might change over time
|
||||
|
||||
### Desktop (`darwinModules.desktop`)
|
||||
|
||||
Despite this project being about servers, we wanted to dogfood the common module.
|
||||
|
||||
- Includes everything from common
|
||||
- So far nothing else, but this might change over time
|
25
mkdocs.yml
25
mkdocs.yml
@ -20,14 +20,19 @@ nav:
|
||||
- Darwin: darwin/getting_started.md
|
||||
- User guide:
|
||||
- Intro: user_guide.md
|
||||
- NixOS modules:
|
||||
- Machine type: nixos/type.md
|
||||
- Machine hardware: nixos/hardware.md
|
||||
- Machine role: nixos/role.md
|
||||
- Configuration mixins: nixos/mixins.md
|
||||
- Roles:
|
||||
- GitHub Action Runner: github_actions_runner.md
|
||||
- Installation:
|
||||
- Hetzner Cloud: installation/hetzner_cloud.md
|
||||
- NixOS:
|
||||
- Modules:
|
||||
- Machine type: nixos/type.md
|
||||
- Machine hardware: nixos/hardware.md
|
||||
- Machine role: nixos/role.md
|
||||
- Configuration mixins: nixos/mixins.md
|
||||
- Roles:
|
||||
- GitHub Action Runner: github_actions_runner.md
|
||||
- Installation:
|
||||
- Hetzner Cloud: installation/hetzner_cloud.md
|
||||
- Nix-darwin:
|
||||
- Modules:
|
||||
- Machine type: darwin/type.md
|
||||
- Configuration mixins: darwin/mixins.md
|
||||
- FAQ: faq.md
|
||||
- Getting help: help.md
|
||||
- Getting help: help.md
|
||||
|
Loading…
Reference in New Issue
Block a user