2022-09-20 15:46:42 +01:00
|
|
|
|
# Liminix
|
|
|
|
|
|
|
2023-02-16 22:06:50 +00:00
|
|
|
|
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.
|
2022-09-20 15:46:42 +01:00
|
|
|
|
|
|
|
|
|
|
This is not NixOS-on-your-router: it's aimed at devices that are
|
2022-09-20 23:04:08 +01:00
|
|
|
|
underpowered for the full NixOS experience. It uses busybox tools,
|
|
|
|
|
|
musl instead of GNU libc, and s6-rc instead of systemd.
|
|
|
|
|
|
|
2022-09-21 23:01:21 +01:00
|
|
|
|
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.
|
|
|
|
|
|
|
2022-09-25 21:21:27 +01:00
|
|
|
|
|
2023-07-16 17:39:01 +01:00
|
|
|
|
## Current status (does it work yet?)
|
|
|
|
|
|
|
2025-10-28 23:39:57 +00:00
|
|
|
|
Liminix 1.0 was released in April 2025. It works for me and I would
|
|
|
|
|
|
say it has seen lots of use in the particular applications of "home
|
|
|
|
|
|
wifi router" and "wireless extender".
|
|
|
|
|
|
|
|
|
|
|
|
It's not “finished” - we are still finding new and better ways to do
|
|
|
|
|
|
things - but we endeavour to signal future breaking changes through the
|
|
|
|
|
|
version number. This is “semver-adjacent”, in that minor bumps
|
|
|
|
|
|
(1.1, 1.2 …) are used for minor new features and major bumps (2.0 …)
|
|
|
|
|
|
for changes that are likely to break out-of-tree modules or
|
|
|
|
|
|
configurations. It won’t be semver exactly because [every change
|
|
|
|
|
|
breaks someone’s workflow](https://xkcd.com/1172/), but we aspire to
|
|
|
|
|
|
have the magnitude of the version delta correlate with the scale of
|
|
|
|
|
|
the consequences of upgrading.
|
2023-07-16 17:39:01 +01:00
|
|
|
|
|
2023-12-11 20:18:28 +00:00
|
|
|
|
The [NEWS](NEWS) file (available wherever you found this README) is
|
|
|
|
|
|
a high-level overview of breaking changes.
|
2023-07-16 17:39:01 +01:00
|
|
|
|
|
2023-12-11 20:18:28 +00:00
|
|
|
|
Development mostly happens on the `main` branch, which is therefore
|
|
|
|
|
|
not guaranteed to build or to work on every commit. For the latest
|
2026-03-09 11:42:38 +00:00
|
|
|
|
functioning version, see [the CI
|
|
|
|
|
|
system](https://build.liminix.org/jobset/liminix/build) and pick a
|
|
|
|
|
|
revision with all jobs green. Note that Liminix `main` branch is built
|
|
|
|
|
|
against the "unstable" version of nixpkgs/nixos, not against the
|
|
|
|
|
|
yy.mm release versions.
|
2023-07-16 17:39:01 +01:00
|
|
|
|
|
2022-09-25 21:21:27 +01:00
|
|
|
|
|
2023-02-16 22:06:50 +00:00
|
|
|
|
## Documentation
|
2022-09-25 21:21:27 +01:00
|
|
|
|
|
2023-02-16 22:06:50 +00:00
|
|
|
|
Documentation is in the [doc](doc/) directory. You can build it
|
|
|
|
|
|
by running
|
2022-09-25 21:21:27 +01:00
|
|
|
|
|
2025-10-28 23:39:57 +00:00
|
|
|
|
nix-build -I liminix=`pwd` ci.nix -A doc
|
2023-02-21 17:34:09 +00:00
|
|
|
|
|
2023-07-16 17:39:01 +01:00
|
|
|
|
Rendered documentation corresponding to the latest commit on `main`
|
|
|
|
|
|
is published to [https://www.liminix.org/doc/](https://www.liminix.org/doc/)
|
|
|
|
|
|
|
2023-02-21 17:34:09 +00:00
|
|
|
|
|
|
|
|
|
|
## Extremely online
|
|
|
|
|
|
|
|
|
|
|
|
There is a #liminix IRC channel on the [OFTC](https://www.oftc.net/)
|
|
|
|
|
|
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](CODE-OF-CONDUCT.md).
|
