HackENS/liminix-fork
5
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
859 commits 2 branches 0 tags 1.2 MiB
Nix 78%
Fennel 6.4%
Lua 6.1%
Shell 3.2%
Python 3.2%
Other 3%
Find a file
Daniel Barlow de51bfe13d default root device in recovery to sda1 
It will probably work fine for USB-stick boot (except in the case
where there is > 1 usb device plugged in, so maybe don't do that)

It doesn't matter for TFTP boot because boot.scr overrides the root=
param anyway
2024-01-26 22:46:36 +00:00
devices add usb storage for turris omnia 2024-01-26 22:46:36 +00:00
doc rename flashimage to mtdimage 2023-12-11 19:09:18 +00:00
examples default root device in recovery to sda1 2024-01-26 22:46:36 +00:00
modules add usb storage for turris omnia 2024-01-26 22:46:36 +00:00
pkgs openwrt: update to v23.05.2 2024-01-25 12:29:03 +01:00
tests tftpboot: don't rely on hostname being set 2024-01-03 19:40:00 +00:00
.gitignore static leases for rotuer 2023-09-04 23:07:13 +01:00
bordervm-configuration.nix bordervm: build wireshark without qt 2024-01-03 17:02:31 +00:00
bordervm.conf-example.nix support USB ethernet in bordervm 2023-05-09 22:58:56 +01:00
ci.nix rename flashimage to mtdimage 2023-12-11 19:09:18 +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
default.nix add lzma to buildenv 2024-01-26 22:46:36 +00:00
LICENSE licence: remove accidental punctuation, update copyright year 2023-01-29 16:39:50 +00:00
nat.nft example config for ppoe router 2023-02-25 23:12:55 +00:00
NEWS NEWS: we now expect Liminix 23.11 2024-01-03 19:44:49 +00:00
overlay.nix add btrfs-progs 2024-01-04 09:33:44 +00:00
README.md link to NEWS file 2023-12-11 20:18:28 +00:00
shell.nix set FENNEL_PATH using absolute paths 2023-09-08 21:01:39 +01:00
STYLE.md explain package/module distinction, add notes on side tracks 2022-09-27 14:11:23 +01:00
THOUGHTS.txt omnia releng 2024-01-07 16:54:44 +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.

The NEWS file (available wherever you found this README) is a high-level overview of breaking changes.

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.

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.