jithendra
/
liminix
forked from dan/liminix
1
0
Fork 0
Code Pull Requests Activity
490 Commits
1 Branch
0 Tags
2.5 MiB
Nix 73.3%
Lua 10.8%
Python 5.7%
Shell 4.4%
Fennel 3.4%
Other 2.4%
 
 
 
 
 
 
Go to file
Daniel Barlow be044cb59e doc: print headline for modules with no preamble 2023-08-07 23:08:41 +01:00
devices rename config.outputs to config.system.outputs 2023-07-13 19:24:59 +01:00
doc doc: print headline for modules with no preamble 2023-08-07 23:08:41 +01:00
examples convert ntp to serviceDefn 2023-08-05 14:16:54 +01:00
kernel delete unused file 2023-03-03 21:38:43 +00:00
modules add preamble text to each service-providing-module 2023-08-07 23:03:49 +01:00
pkgs move module-based-service parameter types into service 2023-08-04 20:39:29 +01:00
tests update hostapd to "build" syntax 2023-08-05 12:21:18 +01:00
.gitignore extract secrets for extneder 2023-03-08 20:37:08 +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 markup 2023-07-20 12:07:09 +01:00
STYLE.md explain package/module distinction, add notes on side tracks 2022-09-27 14:11:23 +01:00
THOUGHTS.txt thunk 2023-07-15 23:40:16 +01: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 extract module top-level comment to docs 2023-08-07 22:14:58 +01:00
default.nix rename config.outputs to config.system.outputs 2023-07-13 19:24:59 +01:00
nat.nft example config for ppoe router 2023-02-25 23:12:55 +00:00
overlay.nix move typeChecked into pkgs.liminix.lib 2023-07-14 20:22:29 +01:00
shell.nix shell.nix: set FENNEL_PATH for interactive convenience 2023-07-08 23:08:25 +01:00
vanilla-configuration.nix convert ntp to serviceDefn 2023-08-05 14:16:54 +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. This will change when it settles down.

In general: 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.

In particular: as of July 2023, a significant re-arrangement of modules and services is ongoing:

  • if you are using out-of-tree configurations created before commit 2e50368, especially if they reference things under pkgs.liminix, they will need updating. Look at changes to examples/rotuer.nix for guidance

  • the same is intermittently true for examples/{extensino,arhcive}.nix where I've updated rotuer and not updated them to match.

Documentation

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

nix-shell -p sphinx --run "make -C doc 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.