Files

T

jackos1998 cdc5d9c1db openwrt: Build fergal's firmware in the flake

fergal is an 8-port SFP+ switch on a Realtek RTL9303, running OpenWrt
rather than RouterOS or UniFi. It is not part of the fabric yet, but
its firmware is now built here via astro's nix-openwrt-imagebuilder.
Packages are baked into the image: OpenWrt's package server keeps only
the current build of each feed, so installing at runtime stops working
as soon as the feed moves past the running firmware.

Those feed indexes rotate constantly, and upstream pins only the
indexes -- a mismatch drops evaluation into import-from-derivation,
putting this flake's eval on the network. The openwrt-feeds input pins
expanded per-package hashes instead, in a repository of its own
because they run to hundreds of thousands of generated lines.

Flashing gets a procedure doc and a thin skill pointing at it, the
same split as the box installation and nixpkgs upgrade procedures.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

2026-08-22 01:16:53 +01:00

5.2 KiB

Raw Blame History

Deployment documentation

Note: these pages are a work in progress and were agent-generated from the repository. They may be incomplete or out of date — treat the Nix configuration as the source of truth.

This directory documents the boxes managed by this flake: their roles, network assignments, hierarchy, and the services they run. For the mechanics of the repo itself (conventions, module system internals for contributors, agent guidance), see AGENTS.md.

The two big sites follow the pattern:

physical host (VM host)
└── VM (for things impractical to containerise)
    └── container host VM
        └── NixOS containers (one per application group)

Not every box fits this pattern, but colony and home are organised this way.

General

architecture.md — the custom module system, my.* namespace, multiple nixpkgs channels, shared module inventory.
networking.md — network assignments, domains, site topologies, router HA, the AS211024 L2 mesh, BGP, WireGuard, Tailscale.
deployment.md — deploy-rs, devshell commands, secrets workflow, CI.
nixpkgs-upgrade.md — guided procedure for the periodic upgrade of the four nixpkgs channels and home-manager (fork rebase, stable bumps, input review).
install-box.md — guided procedure for installing a new box, from the booted installer through partitioning, the box config, do-install and documentation.
openwrt-flash.md — guided procedure for flashing a flake-built image onto an OpenWrt box, from the build through pre-flight, sysupgrade and verification.
reference/dns.md — generated forward and reverse DNS record reference.
reference/nixos-options.md — generated per-option reference for the custom my.* NixOS modules.

Site: colony (Amsterdam)

Physical host and public-infrastructure hub — see sites/colony/README.md.

colony (physical VM host, ams1)
├── estuary ── edge router: WAN, firewall/NAT, DNS, BGP (AS211024), WireGuard
├── shill ──── NixOS container host ──┬── middleman    (reverse proxy, ACME, nginx-sso, librespeed)
│                                     ├── vaultwarden  (password manager)
│                                     ├── colony-psql  (shared PostgreSQL)
│                                     ├── chatterbox   (Matrix Synapse + bridges)
│                                     ├── jackflix     (media stack)
│                                     ├── object       (MinIO, Harmonia Nix cache, Sharry, HedgeDoc, wastebin)
│                                     ├── toot         (Bluesky PDS; Mastodon disabled)
│                                     ├── waffletail   (Tailscale subnet router / exit node)
│                                     ├── qclk         (WireGuard management appliance)
│                                     ├── gam          (Terraria server)
│                                     └── jam          (raw nspawn customer container)
├── whale2 ─── podman/OCI host for game servers
├── git ────── Gitea + Gitea Actions runner
├── mail ───── Debian VM running mailcow (not NixOS)
└── darts ──── third-party/customer VM (opaque, not NixOS)

portcullis (bare-metal edge box for Nikhef — staged, not yet in service)

Site: home

Redundant routers, VM host, storage, IoT containers and the workstation — see sites/home/README.md. The hand-configured switch fabric (jim/dave/brian) and the Digiweb WAN path are documented in sites/home/switches.md; the 5G modem being evaluated as a replacement for stream's WAN is in sites/home/wwan.md.

h.nul.ie
├── palace (physical VM host — AMD, 100G, SR-IOV)
│   ├── river ── primary router VM (PPPoE / Digiweb WAN)
│   ├── cellar ─ NVMe-oF / SPDK storage target VM
│   └── sfh ──── container host VM ("shill from home")
│       ├── hass ── Home Assistant + Frigate + MQTT (container)
│       └── unifi ─ UniFi controller (container)
├── stream (physical secondary router — Virgin Media WAN)
└── castle (workstation / gaming desktop — netboot, NVMe-oF root)

Remote boxes

The edge VPSes and remote kelder site are indexed in remote/README.md.

Mobile boxes

The laptop is indexed in mobile/README.md.

Misc

misc/installer.md — the custom NixOS installer image.

A note on the assignment tables

The consolidated Box assignments tables in networking.md (one per site, between  markers) are generated from the flake (nixos.allAssignments) by nix run .#update-docs-assignments — CI refreshes them on push. Individual box pages link to that section rather than carrying their own table. Only the Notes column is hand-written; don't hand-edit the other cells.

5.2 KiB Raw Blame History