docs: fix nixos modules doc

This commit is contained in:
zimbatm 2023-02-15 11:11:17 +01:00
parent 7db80eca6c
commit 541ff88a1b
No known key found for this signature in database
GPG Key ID: 71BAF6D40C1D63D7
8 changed files with 48 additions and 52 deletions

View File

@ -1 +1,25 @@
# General
## General
Used to define the type of machine.
- `server`:
- Use this for headless systems that are remotely managed via ssh
- Includes everything from common
- Disables desktop features like sound
- Defaults to UTC
- Enables ssh
- Configures watchdog for reboot
- Sets up sudo without password
- ...
- `desktop`:
- Mostly based on common but also includes some optimization for useful for interactive usage
- `common`:
- Use if you are unsure if your nixos 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 well-known ssh git ssh keys to the git configuration

View File

@ -1 +1,8 @@
# Hardware
## Hardware
NixOS hardware configurations that we know about.
- `hardware-amazon`: Amazon AWS virtual machines
- `hardware-hetzner-cloud`: Hardware and network defaults for Hetzner virtual machine
- `hardware-hetzner-amd`: Hardware and network defaults for Hetzner bare-metal servers for AMD and Intel cpus.
- `hardware-hetzner-intel`: "

View File

@ -1 +1,10 @@
# Mixins
## Mixins
Config extensions for a given machine.
- `mixins-cloud-init` enables [cloud-init](https://cloud-init.io)
- `mixins-systemd-boot` configure systemd-boot as bootloader
- `mixins-telegraf` enables a generic telegraf configuration. See [Mic's dotfiles](https://github.com/Mic92/dotfiles/blob/master/nixos/eva/modules/prometheus/alert-rules.nix)
for monitoring rules targeting this telegraf configuration.
- `mixins-nginx` recommended nginx settings
- `mixins-trusted-nix-caches` list of trust-worthy public binary caches

View File

@ -1,25 +0,0 @@
## General
Used to define the type of machine.
- `server`:
- Use this for headless systems that are remotely managed via ssh
- Includes everything from common
- Disables desktop features like sound
- Defaults to UTC
- Enables ssh
- Configures watchdog for reboot
- Sets up sudo without password
- ...
- `desktop`:
- Mostly based on common but also includes some optimization for useful for interactive usage
- `common`:
- Use if you are unsure if your nixos 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 well-known ssh git ssh keys to the git configuration

View File

@ -1,8 +0,0 @@
## Hardware
NixOS hardware configurations that we know about.
- `hardware-amazon`: Amazon AWS virtual machines
- `hardware-hetzner-cloud`: Hardware and network defaults for Hetzner virtual machine
- `hardware-hetzner-amd`: Hardware and network defaults for Hetzner bare-metal servers for AMD and Intel cpus.
- `hardware-hetzner-intel`: "

View File

@ -1,10 +0,0 @@
## Mixins
Config extensions for a given machine.
- `mixins-cloud-init` enables [cloud-init](https://cloud-init.io)
- `mixins-systemd-boot` configure systemd-boot as bootloader
- `mixins-telegraf` enables a generic telegraf configuration. See [Mic's dotfiles](https://github.com/Mic92/dotfiles/blob/master/nixos/eva/modules/prometheus/alert-rules.nix)
for monitoring rules targeting this telegraf configuration.
- `mixins-nginx` recommended nginx settings
- `mixins-trusted-nix-caches` list of trust-worthy public binary caches

View File

@ -1,5 +0,0 @@
## Roles
Designed to take over a machine with the given role.
- `roles-github-actions-runner` configures GitHub actions runner on a machine

View File

@ -1 +1,5 @@
# Roles
## Roles
Designed to take over a machine with the given role.
- `roles-github-actions-runner` configures GitHub actions runner on a machine