Go to file

Daniel Barlow 5eeb277564 move output module imports example -> device The outputs available are a characteristic of the device, not the example.		2023-12-10 16:38:53 +00:00
devices	move output module imports example -> device	2023-12-10 16:38:53 +00:00
doc	ignore devices/families when extracting docs	2023-12-09 17:10:41 +00:00
examples	move output module imports example -> device	2023-12-10 16:38:53 +00:00
modules	move output module imports example -> device	2023-12-10 16:38:53 +00:00
pkgs	unbreak fennel test	2023-12-09 17:10:41 +00:00
tests	move output module imports example -> device	2023-12-10 16:38:53 +00:00
.gitignore	static leases for rotuer	2023-09-04 23:07:13 +01: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	markup	2023-07-20 12:07:09 +01:00
STYLE.md	explain package/module distinction, add notes on side tracks	2022-09-27 14:11:23 +01:00
THOUGHTS.txt	hard thinking or hardly thinking	2023-12-09 17:10:41 +00: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	doc: put all the u-boot/serial stuff in one place to link from	2023-11-12 17:14:33 +00:00
default.nix	project: Python 2.7 had an upgrade… !	2023-12-09 17:10:41 +00:00
nat.nft	example config for ppoe router	2023-02-25 23:12:55 +00:00
overlay.nix	WIP generate bootable disk image with partition table	2023-12-05 23:54:09 +00:00
shell.nix	set FENNEL_PATH using absolute paths	2023-09-08 21:01:39 +01:00
vanilla-configuration-hw.nix	move output module imports example -> device	2023-12-10 16:38:53 +00:00
vanilla-configuration.nix	move output module imports example -> device	2023-12-10 16:38:53 +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.

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.