DGNum/liminix
13
0
Fork 2
Code Issues 15 Pull requests 7 Projects Releases Packages Wiki Activity Actions
DGNum's fork of Liminix, tailored for our infrastructure.
1109 commits 9 branches 0 tags 1.5 MiB
Nix 76.6%
Fennel 9.9%
Lua 4.8%
C 3.5%
Shell 2.7%
Other 2.5%
Find a file
Raito Bezarius c8ee9b6d5a feat(entrypoint): expose evalModules for external interop 
e.g. colmena can make use of it to declare an heterogeneous set of
systems, mixing Liminix and NixOS systems.

Signed-off-by: Raito Bezarius <masterancpp@gmail.com>
2024-05-24 17:34:01 +02:00
devices gl-ar750 appendDTB 2024-05-24 17:23:27 +02:00
doc docs: add hardware recommendation 2024-01-04 14:35:00 +01:00
examples make a serviceDefn for wwan 2024-05-24 17:23:27 +02:00
lib feat(entrypoint): expose evalModules for external interop 2024-05-24 17:34:01 +02:00
modules make a serviceDefn for wwan 2024-05-24 17:23:27 +02:00
pkgs barebones usb_modeswitch package 2024-05-24 17:23:27 +02:00
tests inout: test hotplug and coldplug 2024-04-27 22:41:30 +01:00
.gitignore chore(git): ignore ccls LSP cache for C source code in the tree 2024-05-13 01:46:20 +02:00
bordervm-configuration.nix bordervm enable nat 2024-05-24 17:23:27 +02: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
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 feat(entrypoint): expose evalModules for external interop 2024-05-24 17:34:01 +02: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 pass entire config fragment to levitate, not just services 2024-04-29 20:07:01 +01:00
overlay.nix barebones usb_modeswitch package 2024-05-24 17:23:27 +02:00
README.md docs: add hardware recommendation 2024-01-04 14:35:00 +01: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 think (foreshadowing) 2024-05-24 17:23:27 +02: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.