nixos-config/README.md

This repository contains the Nix / NixOS configuration for all of my systems. See nixos-flake if you wish to create your own configuration from scratch.

Setup

To use this repository as base configuration for your 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
• Rename ./modules/nixos/??.nix to match your current system hostname
• Edit config.nix to set your primary user information
• Run nix run. That's it. Re-open your terminal.

macOS

• Install Nix
• Clone this repo anywhere
• Rename ./modules/darwin/??.nix to match your current system hostname
• Edit config.nix to set your primary user information
• 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.

• configurations: top-level flake.{}Configurations for various systems (nixos, darwin, home)
• modules: top-level flake.{}Modiules for various systems (nixos, darwin, home, flake-parts)
• overlays: Overlays
• packages: Packages
• secrets: agenix secrets configuration

Tips

• To update NixOS (and other inputs) run nix flake update
  • You may also update a subset of inputs, e.g.

    nix flake lock --update-input nixpkgs --update-input darwin --update-input home-manager
    # Or, `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 nix fmt.
• To build all flake outputs (locally or in CI), run nix --accept-flake-config run github:juspay/omnix ci build
• For secrets management, I use ragenix.

Discussion

If you wish to discuss about this config, join the Zulip.

---

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