jackos1998
a7ea91f529
Add a top-level `README.md` mapping the boxes and per-machine docs under `docs/boxes/` (grouped `colony/`, `home/`, `misc/`), one file per host, VM and container documenting role, services and networking with source pointers. Also point `AGENTS.md` at the new docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
home
The home network. A VM host (palace), a redundant pair of routers, a storage
server, Home Assistant, and personal desktops.
- Domain:
h.nul.ie - Source:
nixos/boxes/home/
Shape
palace (physical VM host)
├── river ──── home router (HA pair with stream)
├── cellar ── NVMe-oF storage server (SPDK)
└── sfh ───── NixOS container host ──┬── hass (Home Assistant)
└── unifi (UniFi controller — defined, currently disabled)
stream ── standalone home router (HA pair with river)
castle ── desktop workstation (boots its disks over NVMe-oF from cellar)
The two routers river (a VM on palace) and stream (standalone hardware)
share the routing-common config and
form a keepalived/VRRP high-availability pair: DHCP (kea), router
advertisements (radvd), DNS with blocklists, NAT, and the AS211024 L2 mesh link
back to colony.
Machines
| Machine | Role | Docs |
|---|---|---|
palace |
Physical VM host | palace.md |
river |
Home router (VM; VRRP pair with stream) |
river.md |
cellar |
NVMe-oF storage server (SPDK) | cellar.md |
sfh |
NixOS container host | sfh.md |
stream |
Home router (standalone hardware; VRRP pair with river) |
stream.md |
castle |
Desktop workstation | castle.md |
sfh containers
| Container | Role | Docs |
|---|---|---|
hass |
Home Assistant | hass.md |
unifi |
UniFi network controller (defined, currently not imported) | unifi.md |