Open source · NixOS
nixos-router
A small-business router you configure in a browser and rebuild like code.
- License MIT
- Platform NixOS
Start here
- Get startedGet startedWhat nixos-router is, how Cockpit, the settings file and NixOS generations fit together, and the hardware it runs on.
- Get startedInstall a routerInstall nixos-router over SSH with local/deploy.sh or from an installer USB stick, set up the host flake, and finish the first-boot checklist.
- Get startedThe web UISign in to Cockpit, find your way around the router pages, save and apply changes, and follow rebuilds.
- Get startedThe settings fileWhat /etc/nixos/router-settings.json holds, how Nix reads it, where secrets and the effective config live, and how old settings are upgraded.
- Get startedUpgrades and rollbackHow the router upgrades itself every night, how to upgrade or roll back by hand, how long old generations are kept, and how to recover from the boot menu.
- NetworkingNetworks and VLANsHow the router's WAN, LAN and guest networks work, how guest isolation is enforced, and how to carry networks as VLANs over trunk ports.
nixos-router is part of Avunu's open-source work: tools we build for our own client projects and share with everyone.
See every project