Home Lab

A set of NixOS modules for building your own on-premise cloud (according to a hobbyist).

Project Status

🚧 Under Construction 🚧

This is undergoing a rewrite to incorporate learnings from a few years of working with NixOS. See ye-olden-days for a more elaborate, albiet messy example.

Components

Router

The router module configures a router (nat, dhcp, dns, ...) and manages the network for everything else in the lab.

File Server

The file storage module manages ZFS pools and datasets. A host profile attaches Syncthing and adds snapshotting.

Project Structure

• platforms/nixos/modules/lab: Unopinionated "library" modules for building a home lab.
• platforms/nixos/tests: Virtual machine tests for services in modules/lab.
• platforms/nixos/modules/lab/profiles: Opinionated configurations.
• hosts: Per-host configurations. They are thin wrappers around profiles.

Tests can be executed by entering a dev shell and running project test <drv_path>:

# Example:
project test filesystems.zfs

To cripple your machine by running all tests, do:

nix build --verbose '.#tests'

Inspiration

The Nix Tradition is reading source code until you figure it out. Here are resources that helped me.

• bitte
• hlissner's dotfiles
• ideas for a NixOS router