You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Daniel Barlow 119d6ad379 pkgconfig is now pkg-config 2 days ago
devices bootable aarch64 liminux with qemu 3 days ago
doc fix CI doc error 3 days ago
examples add example with real hardware 6 days ago
modules bootable aarch64 liminux with qemu 3 days ago
pkgs pkgconfig is now pkg-config 2 days ago
tests rename mips-vm as run-liminix-vm 3 days ago
.gitignore static leases for rotuer 3 weeks ago
CODE-OF-CONDUCT.md link to CoC, mention IRC 7 months ago
CONTRIBUTING.md fix spelling, remove dead file 8 months ago
LICENSE licence: remove accidental punctuation, update copyright year 8 months ago
README.md markup 2 months ago
STYLE.md explain package/module distinction, add notes on side tracks 1 year ago
THOUGHTS.txt think 6 days ago
bordervm-configuration.nix bordervm: add sshd, usbutils 4 months ago
bordervm.conf-example.nix support USB ethernet in bordervm 5 months ago
ci.nix add aarch64 to CI 3 days ago
default.nix rename mips-vm as run-liminix-vm 3 days ago
nat.nft example config for ppoe router 7 months ago
overlay.nix kludge fix openssl build 2 weeks ago
shell.nix set FENNEL_PATH using absolute paths 2 weeks ago
vanilla-configuration-hw.nix fix CI flashimage error 3 days ago
vanilla-configuration.nix add service to enable packet forwarding 3 weeks ago

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.

Current status (does it work yet?)

Liminix is pre-1.0. We are still finding new and better ways to do things, and there is no attempt to maintain backward compatibility with the old ways. This will change when it settles down.

In general: development mostly happens on the main branch, which is therefore not guaranteed to build or to work on every commit. For the latest functioning version, see the CI system and pick a revision with all jobs green.

In particular: as of July 2023, a significant re-arrangement of modules and services is ongoing:

  • if you are using out-of-tree configurations created before commit 2e50368, especially if they reference things under pkgs.liminix, they will need updating. Look at changes to examples/rotuer.nix for guidance

  • the same is intermittently true for examples/{extensino,arhcive}.nix where I've updated rotuer and not updated them to match.

Documentation

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

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

Rendered documentation corresponding to the latest commit on main is published to https://www.liminix.org/doc/

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.