This is my Nix / NixOS configuration for all of my systems. See nixos-unified—specifically nixos-unified-template—if you wish to create your own configuration from scratch.

Setup

If you are using this repository as a starting template for your own configuration, perform these initial steps:

1. Edit config.nix in the repository root to set your primary user information (username, fullname, email, sshKey).
2. Replace the SSH keys in secrets/secrets.nix with your own, or delete the file if you do not use agenix.
3. Delete any files in configurations/ that you do not need, and create/rename files to match your hostnames.

After preparing your template, to install on a new machine running:

NixOS Linux

Tip

For a general tutorial, see https://nixos.asia/en/nixos-install-flake

• Install NixOS
  • Hetzner dedicated from Linux Rescue system: https://github.com/numtide/nixos-anywhere (see blog post; example PR: https://github.com/srid/nixos-config/pull/35 where I had to configure networking manually)
    • Copy from existing configuration (eg: ax41.nix)
    • Make networking configuration changes.
    • Run nixos-anywhere from a Linux system, targetting root@<ip>
    • Wait for reboot; ssh srid@<ip>; profit!
  • Digital Ocean
    • Legacy/manual approach: nixos-infect
    • Modern/automate approach: Custom image + colerama; cf. Zulip and example
  • X1 Carbon: https://srid.ca/x1c7-install
  • Windows (via WSL): https://github.com/nix-community/NixOS-WSL
• Clone this repo anywhere
• Run nix run. That's it. Re-open your terminal.

macOS

• Install Nix
• Clone this repo anywhere
• Run nix run.¹ That's it. Re-open your terminal.

Architecture

Start from flake.nix (see Flakes). flake-parts is used as the module system.

Directory layout

Tip

See flake-module.nix for autowiring of flake outputs based on this directory structure.

Path	Corresponding flake output
./configurations/{nixos,darwin,home}/foo.nix	{nixos,darwin,home}Configurations.foo
./mdules/{nixos,darwin,home,flake-parts}/foo.nix	{nixos,darwin,home,flake}Modules.foo
./overlays/foo.nix	overlays.foo
./packages	N/A (Nix packages)
./secrets	N/A (agenix data)

Tips

• To update NixOS (and other inputs) run nix flake update
  • You may also update only primary inputs:

    # nix run .#update
    

• To free up disk space,

  sudo nix-env -p /nix/var/nix/profiles/system --delete-generations +2
  sudo nixos-rebuild boot
  

• To autoformat the project tree using nixpkgs-fmt, run just lint in Nix devShell.
• To build all flake outputs (locally or in CI), run nix run nixpkgs#omnix ci
• For secrets management, I use agenix, because it works with SSH keys, and functions well on macOS and NixOS.

Discussion

https://github.com/srid/nixos-config/discussions

---

1. You might have to rm -rf /etc/nix/nix.conf, so our flake.nix can do its thing. ↩︎