dan
/
liminix
1
0
Fork 5
Code Issues 3 Pull Requests 1 Projects Releases Wiki Activity
1,129 Commits 10 Branches 0 Tags 8.8 MiB
Nix 74.6%
Fennel 11.3%
Lua 5.2%
Shell 3.1%
C 3%
Other 2.8%
Go to file
Daniel Barlow 50bad5c604 libusb needs udev on build 
this is a workaround to make CI work again, but what we really need to
do is completely separate the nixpkgs used for nixos build-system
tools from the nixpkgs we use for liminix host binaries
 		2024-06-12 18:55:30 +01:00
devices gl-ar750 appendDTB 2024-05-22 18:47:16 +01:00
doc docs: add hardware recommendation 2024-01-04 14:35:00 +01:00
examples wwan gets address from ppp ipcp not dhcp 2024-06-12 12:51:07 +01:00
modules remove debug 2024-06-12 13:03:26 +01:00
pkgs store derivations not just names for service deps 2024-06-11 14:01:06 +01:00
tests inout: test hotplug and coldplug 2024-04-27 22:41:30 +01:00
.gitignore docs: add hardware recommendation 2024-01-04 14:35:00 +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
NEWS pass entire config fragment to levitate, not just services 2024-04-29 20:07:01 +01:00
README.md docs: add hardware recommendation 2024-01-04 14:35:00 +01:00
STYLE.md explain package/module distinction, add notes on side tracks 2022-09-27 14:11:23 +01:00
THOUGHTS.txt think 2024-06-12 12:52:52 +01:00
boot.expect semi-automate tftpbooting with minicom 2024-05-26 18:03:32 +01:00
bordervm-configuration.nix bodervm: remove usbutils until we can fix the udev dep 2024-06-12 13:07:29 +01:00
bordervm.conf-example.nix support USB ethernet in bordervm 2023-05-09 22:58:56 +01:00
ci.nix ci.nix: alphabetise systems 2024-02-21 19:49:14 +00:00
default.nix list pkgs we need in bordervm build 2024-05-22 18:45:35 +01:00
nat.nft example config for ppoe router 2023-02-25 23:12:55 +00:00
overlay.nix libusb needs udev on build 2024-06-12 18:55:30 +01:00
shell.nix set FENNEL_PATH using absolute paths 2023-09-08 21:01:39 +01:00
vanilla-configuration.nix fix vanilla-configuration defaultroute 2024-03-28 22:13:21 +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 hardware.rst 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.