This repository has no description
docs: read if cute
author
Cassie Cheung
date
(Mar 14, 2025, 7:42 PM +0800)
commit
aa4fb2a9
aa4fb2a9719efe26562acf19d9988f52c26f8dc7
parent
12277d8a
12277d8a1f185c3cb061c65c79288af4d3d4182f
+27
-5
+27
-5
readme.md
+27
-5
readme.md
···
1
-
read if cute
1
+
# knotserver-module
2
2
3
-
# this is experimental code
3
+
this flake contains an modified alternative (maybe opinionated) nixos module to the one provided in the [official core flake](https://tangled.sh/@tangled.sh/core).
4
4
5
-
i am not responsible if your car explodes after deploying this module.
5
+
this module enables some extra things not in the official module. at time of writing, those are:
6
6
7
-
## license
7
+
- securely define secrets like KNOT_SERVER_SECRET via an environment file (i.e. `.env`)
8
+
- proper support for `services.tangled-knotserver.server.internalListenAddr`
9
+
- proper(-ish) support for setting a `gitUser`
10
+
- not 100% perfect because appview still displays `git` as the clone user.
11
+
- allow setting extra options via environment variables with a freeform option `services.tangled-knotserver.extraConfig`
12
+
- does not add an unnecessary overlay to your system
13
+
- this also fixes a pitfall where the user's nixpkgs version doesn't match the flake's nixpkgs version (and thus the imported overlay's version in the module), and there were changes to the derivation argument.
8
14
9
-
mit, because i literally extracted the entire module from the [original flake](https://tangled.sh/@tangled.sh/core/blob/master/flake.nix).
15
+
and some minor opinionated things like
16
+
17
+
- better fhs compliance
18
+
- according to some fhs is mostly a meme, but i personally don't like the idea of having executables in /etc. putting a wrapped executable in /run is probably still not compliant, but i believe it makes more sense there than a directory with mostly configuration files.
19
+
- logging to `/var/log/knotserver` prevents other users from messing around with repoguard, possibly a dos by just creating `/tmp/repoguard.log`.
20
+
- these changes should not affect usage at all, just implementation details.
21
+
22
+
## stability
23
+
24
+
this module is stable to use.
25
+
26
+
we're also dogfooding this module [here](https://tangled.sh/did:plc:jmr637khkdb2fdxxvoyj672m/gensokyo/blob/main/systems/koumakan/services/scm/tangled-knot.nix).
10
27
11
28
please don't go to tangled for support if you use the module, make an issue on this repo instead.
29
+
i also idle in <irc://irc.libera.chat/#tangled> as `soopyc` if you prefer instant messaging.
30
+
31
+
## license
32
+
33
+
mit, because i literally extracted and modified the entire module from the [original flake](https://tangled.sh/@tangled.sh/core/blob/master/flake.nix).