lbailly/liminix
1
0
Fork 0
forked from DGNum/liminix
Code Pull requests 2 Activity Actions
DGNum's fork of Liminix, tailored for our infrastructure.
458 commits 8 branches 0 tags 1.5 MiB
Nix 75.9%
Fennel 10.2%
Lua 5.1%
C 3.3%
Shell 2.8%
Other 2.7%
Find a file
Daniel Barlow 69e6eb5a89 accept attr args to pppoe service, and typecheck them 
We use (abuse, arguably) the nixos module system for typechecking.  Un
the plus side, it gives us documentation of the options and their
expected types. On the downside, the error message doesn't tell us
the file in which the error was encountered.

(This is subject to change, if I can find a better way)
2023-07-14 16:53:36 +01:00
devices rename config.outputs to config.system.outputs 2023-07-13 19:24:59 +01:00
doc fix section order 2023-07-09 15:18:19 +01:00
examples accept attr args to pppoe service, and typecheck them 2023-07-14 16:53:36 +01:00
kernel delete unused file 2023-03-03 21:38:43 +00:00
modules accept attr args to pppoe service, and typecheck them 2023-07-14 16:53:36 +01:00
pkgs accept attr args to pppoe service, and typecheck them 2023-07-14 16:53:36 +01:00
tests rename luaSmall package to lua 2023-07-02 18:19:54 +01:00
.gitignore extract secrets for extneder 2023-03-08 20:37:08 +00:00
bordervm-configuration.nix bordervm: add sshd, usbutils 2023-05-17 15:38:22 +01:00
bordervm.conf-example.nix support USB ethernet in bordervm 2023-05-09 22:58:56 +01:00
ci.nix declare build product 2023-05-21 21:27:52 +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
default.nix rename config.outputs to config.system.outputs 2023-07-13 19:24:59 +01: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
overlay.nix rename luaSmall package to lua 2023-07-02 18:19:54 +01:00
README.md link to CoC, mention IRC 2023-02-22 18:14:40 +00:00
shell.nix shell.nix: set FENNEL_PATH for interactive convenience 2023-07-08 23:08:25 +01:00
STYLE.md explain package/module distinction, add notes on side tracks 2022-09-27 14:11:23 +01:00
THOUGHTS.txt more thoughts about modules 2023-07-13 11:54:50 +01:00
vanilla-configuration.nix remove non-building ntp service from test config 2023-06-20 22:15:38 +01: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.

What about NixWRT?

This is an in-progress rewrite of NixWRT, incorporating Lessons Learned.

Documentation

Documentation is in the doc directory. You can build it by running

nix-shell -p sphinx --run "make -C doc html"

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.