dan
/
liminix
1
0
Fork 5
Code Issues 3 Pull Requests 1 Projects Releases Wiki Activity
1,195 Commits 11 Branches 0 Tags 2.7 MiB
Nix 73.9%
Fennel 12.1%
Lua 5.1%
Shell 3.2%
C 3%
Other 2.7%
Go to file
Daniel Barlow a9d1582b53 remove unused arg 2024-07-26 23:41:50 +01:00
devices fix most doc warnings 2024-07-10 23:36:24 +01:00
doc finish moving pkgs.linimix.callService to config.system 2024-07-15 19:00:08 +01:00
examples convert l2tp example to use gateway profile 2024-07-23 09:31:34 +01:00
modules remove unused arg 2024-07-26 23:41:50 +01:00
pkgs anoia.svc use timeout for inotify 2024-07-26 23:40:40 +01:00
tests cleanup whitespace and commas 2024-06-30 17:16:28 +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 generalise profile.gateway.wan so not just pppoe 2024-07-23 09:31:34 +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-07-23 09:31:34 +01:00
boot.expect semi-automate tftpbooting with minicom 2024-05-26 18:03:32 +01:00
bordervm-configuration.nix disable security for bordervm "liminix" share 2024-07-01 20:53:03 +01:00
bordervm.conf-example.nix cleanup whitespace and commas 2024-06-30 17:16:28 +01:00
ci.nix fix most doc warnings 2024-07-10 23:36:24 +01:00
default.nix cleanup whitespace and commas 2024-06-30 17:16:28 +01:00
nat.nft example config for ppoe router 2023-02-25 23:12:55 +00:00
overlay.nix elfutils is reqd by iproute2 (for bpf?), build sans kitchen sink 2024-07-24 22:07:58 +01:00
shell.nix set FENNEL_PATH using absolute paths 2023-09-08 21:01:39 +01:00
vanilla-configuration.nix cleanup whitespace and commas 2024-06-30 17:16:28 +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.

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.