dan/liminix
1
0
Fork 5
Code
1,490 Commits 15 Branches 0 Tags 6.7 MiB
Nix 72.1%
Fennel 15.4%
Lua 4%
C 3.6%
Shell 2.7%
Other 2.2%
main
Go to file
Daniel Barlow 4e51977ae0 provide properties attr to services 
properties are similar to outputs, but are different in that they are
fixed values (do not change) and are present even when the service is
down

if the attribute is present and an attrset, this will write the
equivalent recursive directory structure to $out/.properties/
2025-03-12 23:35:56 +00:00
devices nixfmt-rfc-style 2025-02-10 21:55:08 +00:00
doc nixfmt-rfc-style 2025-02-10 21:55:08 +00:00
examples nixfmt-rfc-style 2025-02-10 21:55:08 +00:00
modules svc.open accepts a /nix/store folder not an outputs folder 2025-03-11 00:21:44 +00:00
pkgs provide properties attr to services 2025-03-12 23:35:56 +00:00
tests min-copy-clocure test: ensure sshd up before starting 2025-03-09 21:37:13 +00:00
.gitignore docs: add hardware recommendation 2024-01-04 14:35:00 +01:00
boot.expect boot.expect: sleep more, for gl-ar750 2025-02-05 20:35:04 +00:00
bordervm-configuration.nix nixfmt-rfc-style 2025-02-10 21:55:08 +00:00
bordervm.conf-example.nix cleanup whitespace and commas 2024-06-30 17:16:28 +01:00
ci.nix doc: filter src attribute to not rebuild as much 2025-03-10 23:08:37 +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 nixfmt-rfc-style 2025-02-10 21:55:08 +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 svc.open accepts a /nix/store folder not an outputs folder 2025-03-11 00:21:44 +00:00
overlay.nix nixfmt-rfc-style 2025-02-10 21:55:08 +00:00
README.md docs: add hardware recommendation 2024-01-04 14:35:00 +01:00
shell.nix nixfmt-rfc-style 2025-02-10 21:55:08 +00:00
STYLE.md explain package/module distinction, add notes on side tracks 2022-09-27 14:11:23 +01:00
THOUGHTS.txt think 2025-03-02 21:21:45 +00:00
vanilla-configuration.nix nixfmt-rfc-style 2025-02-10 21:55:08 +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.