2022-09-20 16:46:42 +02:00
|
|
|
# Liminix
|
|
|
|
|
|
2023-02-16 23:06:50 +01: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 16:46:42 +02:00
|
|
|
|
|
|
|
|
This is not NixOS-on-your-router: it's aimed at devices that are
|
2022-09-21 00:04:08 +02:00
|
|
|
underpowered for the full NixOS experience. It uses busybox tools,
|
|
|
|
|
musl instead of GNU libc, and s6-rc instead of systemd.
|
|
|
|
|
|
2022-09-22 00:01:21 +02: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 22:21:27 +02:00
|
|
|
|
2023-07-16 18:39:01 +02:00
|
|
|
## 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
|
2023-12-11 21:18:28 +01:00
|
|
|
ways.
|
2023-07-16 18:39:01 +02:00
|
|
|
|
2023-12-11 21:18:28 +01:00
|
|
|
The [NEWS](NEWS) file (available wherever you found this README) is
|
|
|
|
|
a high-level overview of breaking changes.
|
2023-07-16 18:39:01 +02:00
|
|
|
|
2023-12-11 21:18:28 +01:00
|
|
|
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](https://build.liminix.org/jobset/liminix/build) and pick a revision with all jobs green.
|
2023-07-16 18:39:01 +02:00
|
|
|
|
2022-09-20 19:24:27 +02:00
|
|
|
|
2023-02-16 23:06:50 +01:00
|
|
|
## Documentation
|
2022-09-25 12:54:31 +02:00
|
|
|
|
2023-02-16 23:06:50 +01:00
|
|
|
Documentation is in the [doc](doc/) directory. You can build it
|
|
|
|
|
by running
|
2022-10-03 00:04:15 +02:00
|
|
|
|
2023-02-16 23:06:50 +01:00
|
|
|
nix-shell -p sphinx --run "make -C doc html"
|
2023-02-21 18:34:09 +01:00
|
|
|
|
2023-07-16 18:39:01 +02: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 18:34:09 +01: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).
|
