ecoppens/liminix
1
0
Fork 0
forked from DGNum/liminix
Code Pull requests Activity
DGNum's fork of Liminix, tailored for our infrastructure.
9 commits 9 branches 0 tags 1.5 MiB
Nix 76.3%
Fennel 10%
Lua 4.8%
C 3.6%
Shell 2.7%
Other 2.6%
Find a file
Daniel Barlow 6be5b90c96 boots to userland and runs busybox init
2022-09-20 23:04:08 +01:00
devices boots to userland and runs busybox init 2022-09-20 23:04:08 +01:00
tests build a kernel, using malta_kvm_defconfig 2022-09-20 18:54:27 +01:00
tools generate a mips squashfs with some s6-rc services 2022-09-19 23:51:38 +01:00
.gitignore placeholder readme 2022-09-20 15:46:42 +01:00
default.nix boots to userland and runs busybox init 2022-09-20 23:04:08 +01:00
make-image.nix boots to userland and runs busybox init 2022-09-20 23:04:08 +01:00
make-kernel.nix boots to userland and runs busybox init 2022-09-20 23:04:08 +01:00
make-vmlinux.nix build a kernel, using malta_kvm_defconfig 2022-09-20 18:54:27 +01:00
overlay.nix generate a mips squashfs with some s6-rc services 2022-09-19 23:51:38 +01:00
README.md boots to userland and runs busybox init 2022-09-20 23:04:08 +01:00
run-qemu.sh boots to userland and runs busybox init 2022-09-20 23:04:08 +01:00
run-tests.sh build a kernel, using malta_kvm_defconfig 2022-09-20 18:54:27 +01:00

README.md

Liminix

Līminis + Nix

  • Līminis : Latin, genitive declension of limen. "Of the threshold"
  • Nix : a tool for reproducible and declarative configuration management
  • Liminix : a Nix-based system for configuring consumer wifi routers

What is this?

This is a Nix-based collection of software tailored for domestic wifi router or IoT device devices, of the kind that OpenWrt or DD-WRT or Gargoyle or Tomato run on. It's a reboot/restart/rewrite of NixWRT.

This is not NixOS-on-your-router: it's aimed at devices that are underpowered for the full NixOS experience. It uses busybox tools, musl instead of GNU libc, and s6-rc instead of systemd.

Building

These instructions assume you have nixpkgs checked out in a peer directory of this one.

You need a configuration.nix file pointed to by <liminix-config>, a hardware device definition as argument device, and to choose an appropriate output attribute depending on what your device is and how you plan to install onto it. For example:

NIX_PATH=nixpkgs=../nixpkgs:$NIX_PATH NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM=1 nix-build -I liminix-config=./tests/smoke/configuration.nix --arg device "import ./devices/qemu.nix" -A outputs.default

outputs.default is intended to do something appropriate for the device, whatever that is. For the qemu device, it creates a directory containing a squashfs root image and a kernel, with which you could then run

./run-qemu.sh result/vmlinux result/squashfs

Running tests

Assuming you have nixpkgs checked out in a peer directory of this one,

NIX_PATH=nixpkgs=../nixpkgs:$NIX_PATH ./run-tests.sh

Articles of interest

  • Build Safety of Software in 28 Popular Home Routers: "of the access points and routers we reviewed, not a single one took full advantage of the basic application armoring features provided by the operating system. Indeed, only one or two models even came close, and no brand did well consistently across all models tested"