/docs
Documentation
Adapted from the docs in the two repositories, which are the canonical version. If you're new, start with The first hour.
01Start here
- The first hourWhat to do right after installing.ephemeral-nixos-config/docs/first-hour.md
- Rebuilding, updating and the helper commandsephemeral-update, ephemeral-doctor and the rest, and how releases reach a machine.ephemeral-nixos-config/README.md
- Try it in a VMBoot the config in a throwaway QEMU window, without installing anything.ephemeral-nixos-config/docs/vm.md
02Using it
- settings.jsonEvery setting, what it does, and how unfree packages are allowed.ephemeral-nixos-config/docs/settings.md
- CustomizingYour own modules, the shared modules you can add to, and how the config is organized.ephemeral-nixos-config/docs/customizing.md
- Optional featuresControl D, SMB, NVIDIA, Tailscale, Proton Pass, the app picker, VMs and the rest.ephemeral-nixos-config/docs/features.md
- Dotfiles and appearanceThe Home Manager dotfiles, the Catppuccin theme through Stylix, Plasma, the wallpaper.ephemeral-nixos-config/docs/appearance.md
03When something breaks
- When something breaksRolling back, recovering a broken boot or a damaged LUKS header, and reporting a bug.ephemeral-nixos-config/docs/troubleshooting.md
- Backups and snapshotsWhat to copy off the machine, hourly snapshots, the LUKS header, and restoring after a reinstall.ephemeral-nixos-config/docs/backup.md
- Install problemsErrors the installer can stop with, what they mean, and where to report a failed install.ephemeral-nixos/docs/troubleshooting.md
04Installing
- HardwareWhat's required, what's been tested, and what the installer detects.ephemeral-nixos/docs/hardware.md
- Unattended installsEvery installer question answered ahead of time with environment variables.ephemeral-nixos/docs/unattended.md
- Manual installThe installer's steps by hand, without the scripts.ephemeral-nixos/docs/manual-install.md
→Internals
How it's built, and the rules every change is checked against, are in the repositories: the config's ARCHITECTURE.md, the installer's, Working on the config and Working on the installer.