Go to file
Daniel Barlow fec77a44b5 DRY loopback interface, it's the same everywhere 2023-03-07 22:36:48 +00:00
devices move regulatory.db to wlan module 2023-03-07 21:32:21 +00:00
doc rename phram -> tftpboot and flash.scr to boot.scr 2023-03-02 15:11:12 +00:00
kernel delete unused file 2023-03-03 21:38:43 +00:00
modules DRY loopback interface, it's the same everywhere 2023-03-07 22:36:48 +00:00
pkgs remove hostapd debugging flag 2023-03-07 19:11:25 +00:00
tests DRY loopback interface, it's the same everywhere 2023-03-07 22:36:48 +00:00
.gitignore oops 2023-03-04 00:35:40 +00:00
CODE-OF-CONDUCT.md link to CoC, mention IRC 2023-02-22 18:14:40 +00:00
CONTRIBUTING.md fix spelling, remove dead file 2023-02-05 22:42:41 +00:00
LICENSE licence: remove accidental punctuation, update copyright year 2023-01-29 16:39:50 +00:00
README.md link to CoC, mention IRC 2023-02-22 18:14:40 +00:00
STYLE.md explain package/module distinction, add notes on side tracks 2022-09-27 14:11:23 +01:00
THOUGHTS.txt wibble 2023-03-07 19:11:46 +00:00
bordervm-configuration.nix fix bordervm in hydra 2023-02-22 18:14:40 +00:00
bordervm.conf-example.nix bordervm: make configurable 2023-02-17 16:49:44 +00:00
ci.nix fix bordervm in hydra 2023-02-22 18:14:40 +00:00
default.nix rename "device" config tree as "hardware" 2023-03-03 22:52:33 +00:00
extneder.nix DRY loopback interface, it's the same everywhere 2023-03-07 22:36:48 +00:00
nat.nft example config for ppoe router 2023-02-25 23:12:55 +00:00
overlay.nix build smaller versions of hostap and nftables 2023-03-06 17:49:59 +00:00
rotuer.nix DRY loopback interface, it's the same everywhere 2023-03-07 22:36:48 +00:00
shell.nix simplify calling buildEnv 2023-02-17 20:41:55 +00:00
vanilla-configuration.nix DRY loopback interface, it's the same everywhere 2023-03-07 22:36:48 +00:00

README.md

Liminix

A Nix-based system for configuring consumer wifi routers 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.

The Liminix name comes from Liminis, in Latin the genitive declension of "limen", or "of the threshold". Your router stands at the threshold of your (online) home and everything you send to/receive from the outside word goes across it.

What about NixWRT?

This is an in-progress rewrite of NixWRT, incorporating Lessons Learned.

Documentation

Documentation is in the doc directory. You can build it by running

nix-shell -p sphinx --run "make -C doc html"

Extremely online

There is a #liminix IRC channel on the OFTC network in which you are welcome. You can also connect with a Matrix client by joining the room #_oftc_#liminix:matrix.org.

In the IRC channel, as in all Liminix project venues, please conduct yourself according to the Liminix Code of Conduct.