routerd documentation
routerd turns typed YAML resources into a working, observable router on a Linux, NixOS, or FreeBSD host. Pick the section that matches what you are trying to do.
By goal
| If you want to… | Start here |
|---|---|
| Understand what routerd is and why it exists | Concepts → What is routerd |
| Stand up a router for the first time | Tutorials → Getting started |
| Solve a specific deployment problem | How-to guides |
| Look up a resource kind or field | Reference → Resource API |
| Operate a running router | Operations → Reconcile |
| Read background notes on hard cases | Knowledge base |
| Catch up on what changed | Releases → Changelog |
All sections
- Concepts — vision, design philosophy, resource model, ownership semantics
- Tutorials — install, first router, WAN/LAN services, basic firewall, NixOS quickstart
- How-to — multi-WAN, FLET'S setup, PVE overlay, OpenTelemetry export, troubleshooting
- Knowledge base — field notes from real deployments (DHCPv6-PD clients, NTT NGN PD acquisition)
- Reference — Resource API, control API, plugin protocol, supported platforms, ownership rules
- Operations — reconcile and removal, state database, host inventory
- Design notes — open architectural questions and design rationales
- Releases — changelog