forked from dan/liminix
1
0
Fork 0
This fork of liminix is currently only used for PRs. To check my personnal hacks that I don't tried to upstream yet, check this fork https://git.dgnum.eu/HackENS/liminix-fork https://git.dgnum.eu/HackENS/liminix-fork
Go to file
Daniel Barlow cc67116845 link to CoC, mention IRC 2023-02-22 18:14:40 +00:00
devices add notes about dual-band hardware 2023-02-19 18:14:27 +00:00
doc add another link I've previously found useful 2023-02-19 18:14:27 +00:00
kernel refine the TODO list 2023-02-15 22:06:28 +00:00
modules move dts config from kernel to boot 2023-02-18 15:13:19 +00:00
pkgs harcode paths for kpppoed, add port num in config 2023-02-17 00:09:02 +00:00
tests inline lib/merge-modules.nix 2023-02-16 17:22:27 +00:00
.gitignore convert docs to restructuredText 2023-02-16 22:06:50 +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
LICENSE licence: remove accidental punctuation, update copyright year 2023-01-29 16:39:50 +00:00
README.md link to CoC, mention IRC 2023-02-22 18:14:40 +00:00
STYLE.md explain package/module distinction, add notes on side tracks 2022-09-27 14:11:23 +01:00
THOUGHTS.txt TODO 2023-02-18 14:02:22 +00:00
bordervm-configuration.nix bordervm: make configurable 2023-02-17 16:49:44 +00:00
bordervm.conf-example.nix bordervm: make configurable 2023-02-17 16:49:44 +00:00
ci.nix add buildEnv to CI so we know next time tufted breaks 2023-02-08 00:12:29 +00:00
default.nix inline lib/merge-modules.nix 2023-02-16 17:22:27 +00:00
overlay.nix harcode paths for kpppoed, add port num in config 2023-02-17 00:09:02 +00:00
shell.nix simplify calling buildEnv 2023-02-17 20:41:55 +00:00
vanilla-configuration.nix tftp load address is per-device, IP addresses are local config 2023-02-15 22:06:28 +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.

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.