Go to file
Daniel Barlow c9f55ba177 delete unused file 2023-03-03 21:38:43 +00:00
devices add outputs.flashable - flashable firmware.bin 2023-03-02 23:01:26 +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 add module for device-specific config 2023-03-03 20:04:39 +00:00
pkgs WIP push to see what passes 2023-03-01 22:24:58 +00:00
tests WIP push to see what passes 2023-03-01 22:24:58 +00:00
.gitignore convert docs to restructuredText 2023-02-16 22:06:50 +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 spew for this week 2023-02-25 20:35:29 +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 add module for device-specific config 2023-03-03 20:04:39 +00:00
nat.nft example config for ppoe router 2023-02-25 23:12:55 +00:00
overlay.nix replace waitup with more generally useful ifwait 2023-03-01 18:16:01 +00:00
rotuer-secrets.nix rename phram -> tftpboot and flash.scr to boot.scr 2023-03-02 15:11:12 +00:00
rotuer.nix note to self: check if these kconfig options still needed 2023-03-03 20:08:12 +00:00
shell.nix simplify calling buildEnv 2023-02-17 20:41:55 +00:00
vanilla-configuration.nix rename phram -> tftpboot and flash.scr to boot.scr 2023-03-02 15:11:12 +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.