Go to file
Daniel Barlow 0173a9ced9 set PATH correctly in ssh sessions
for a non=interactive shell ("ssh linminix foo") ash does not source
*any* startup files, so we need to set this to something more useful
than /bin:usr/bin
2023-05-21 17:07:19 +01:00
devices specify root device as /dev/mtdblockn 2023-04-26 22:16:15 +01:00
doc Document jffs2, min-copy-closure, liminix-rebuild 2023-05-17 15:38:22 +01:00
examples set PATH correctly in ssh sessions 2023-05-21 17:07:19 +01:00
kernel delete unused file 2023-03-03 21:38:43 +00:00
modules keep dropbear host keys in /persist if it exists 2023-05-21 12:01:42 +01:00
pkgs liminix-rebuild: test if nix-build succeeds 2023-05-20 22:30:22 +01:00
tests cruft 2023-05-20 22:48:30 +01:00
.gitignore extract secrets for extneder 2023-03-08 20:37:08 +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 min-collect-garbage and next steps 2023-05-20 22:48:05 +01:00
bordervm-configuration.nix bordervm: add sshd, usbutils 2023-05-17 15:38:22 +01:00
bordervm.conf-example.nix support USB ethernet in bordervm 2023-05-09 22:58:56 +01:00
ci.nix move noise sources around in tests 2023-03-10 18:41:43 +00:00
default.nix add min-copy-closure to buildEnv 2023-05-11 23:53:25 +01:00
nat.nft example config for ppoe router 2023-02-25 23:12:55 +00:00
overlay.nix rotuer; run chronyd for accurate time 2023-04-23 20:56:20 +01:00
shell.nix simplify calling buildEnv 2023-02-17 20:41:55 +00:00
vanilla-configuration.nix remove standard.nix modues from qemu test 2023-05-17 21:51:54 +01: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.