docs: add missing headlines, add a few notes

2025-12-06 00:57:22 +01:00 · 2025-06-29 15:40:15 +02:00 · 2025-06-29 15:40:15 +02:00 · 6cac368378
commit 6cac368378
parent 9075c97ce8
5 changed files with 1031 additions and 372 deletions
--- a/SwarselSystems.org
+++ b/SwarselSystems.org
@ -1455,7 +1455,13 @@ This machine mainly acts as an external sync helper. It manages the following th

 #+end_src
 **** Moonside (OCI)
+:PROPERTIES:
+:CUSTOM_ID: h:f547ed16-5e6e-4744-9e33-af090e0a175b
+:END:
 ***** Main Configuration
+:PROPERTIES:
+:CUSTOM_ID: h:a8f20a56-ce92-43d8-8bfe-3edccebf2bf9
+:END:

 #+begin_src nix :tangle hosts/nixos/moonside/default.nix
  { lib, config, primaryUser, ... }:
@ -1688,6 +1694,9 @@ This machine mainly acts as an external sync helper. It manages the following th

 #+end_src
 ***** hardware-configuration
+:PROPERTIES:
+:CUSTOM_ID: h:f99c05ab-f047-4350-b80a-4c1ff55b91bf
+:END:

      loader.grub = {
        efiSupport = true;
@ -2307,6 +2316,9 @@ This is just a demo host. It applies all the configuration found in the common p

 I also set the =WLR_RENDERER_ALLOW_SOFTWARE=1= to allow this configuration to run in a virtualized environment. I also enable =qemuGuest= for a smoother experience when testing on QEMU.
 ***** Main configuration
+:PROPERTIES:
+:CUSTOM_ID: h:9f1f3439-b0af-4dcd-a96f-b6aa7b6cd2ab
+:END:

 #+begin_src nix :tangle hosts/nixos/chaostheatre/default.nix
  { self, inputs, config, pkgs, lib, primaryUser, ... }:
@ -2384,6 +2396,9 @@ I also set the =WLR_RENDERER_ALLOW_SOFTWARE=1= to allow this configuration to ru
 #+end_src

 ***** NixOS dummy options configuration
+:PROPERTIES:
+:CUSTOM_ID: h:6f9c1a3b-452e-4944-86e8-cb17603cc3f9
+:END:

 #+begin_src nix :tangle hosts/nixos/chaostheatre/options.nix
  _:
@ -2392,6 +2407,9 @@ I also set the =WLR_RENDERER_ALLOW_SOFTWARE=1= to allow this configuration to ru
 #+end_src

 ***** home-manager dummy options configuration
+:PROPERTIES:
+:CUSTOM_ID: h:88ccb198-74b9-4269-8e22-af1277f44667
+:END:

 #+begin_src nix :tangle hosts/nixos/chaostheatre/options-home.nix
  _:
@ -4106,6 +4124,9 @@ AppImage version of mgba in which the lua scripting works.
 #+end_src

 **** swarsel-deploy
+:PROPERTIES:
+:CUSTOM_ID: h:c3362d4e-d3a8-43e8-9ef7-272b6de0572e
+:END:

 #+begin_src nix :tangle pkgs/swarsel-deploy/default.nix
  # heavily inspired from https://github.com/oddlama/nix-config/blob/d42cbde676001a7ad8a3cace156e050933a4dcc3/pkgs/deploy.nix
@ -4235,6 +4256,9 @@ AppImage version of mgba in which the lua scripting works.
 #+end_src

 **** sshrm
+:PROPERTIES:
+:CUSTOM_ID: h:02842543-caca-4d4c-a4d2-7ac749b5c136
+:END:

 This programs simply runs ssh-keygen on the last host that I tried to ssh into. I need this frequently when working with cloud-init usually.

@ -4385,8 +4409,10 @@ Modules that need to be loaded on the NixOS level. Note that these will not be a
    imports = lib.swarselsystems.mkImports profileNames "profiles/nixos";
  }
 #+end_src
-
 ***** Personal
+:PROPERTIES:
+:CUSTOM_ID: h:32d654de-8db2-403a-9a27-4c46d7b9172d
+:END:

 #+begin_src nix :tangle profiles/nixos/personal/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4455,6 +4481,9 @@ Modules that need to be loaded on the NixOS level. Note that these will not be a
 #+end_src

 ***** Chaostheatre
+:PROPERTIES:
+:CUSTOM_ID: h:b79fbb59-9cf2-48eb-b469-2589223dda95
+:END:

 #+begin_src nix :tangle profiles/nixos/chaostheatre/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4515,6 +4544,9 @@ Modules that need to be loaded on the NixOS level. Note that these will not be a
 #+end_src

 ***** toto
+:PROPERTIES:
+:CUSTOM_ID: h:125443fb-deb6-44c9-83ee-bbd10daf78dd
+:END:

 #+begin_src nix :tangle profiles/nixos/toto/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4545,6 +4577,9 @@ Modules that need to be loaded on the NixOS level. Note that these will not be a
 #+end_src

 ***** Work
+:PROPERTIES:
+:CUSTOM_ID: h:cb3631a8-9c1b-42f2-ab01-502c7b4c273d
+:END:

 #+begin_src nix :tangle profiles/nixos/work/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4564,6 +4599,9 @@ Modules that need to be loaded on the NixOS level. Note that these will not be a
 #+end_src

 ***** Framework
+:PROPERTIES:
+:CUSTOM_ID: h:eb272c99-842a-4095-bc65-283562749300
+:END:

 #+begin_src nix :tangle profiles/nixos/framework/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4583,6 +4621,9 @@ Modules that need to be loaded on the NixOS level. Note that these will not be a
 #+end_src

 ***** AMD CPU
+:PROPERTIES:
+:CUSTOM_ID: h:b7beb4a5-8808-438d-8799-7f08f38fd1ba
+:END:

 #+begin_src nix :tangle profiles/nixos/amdcpu/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4602,6 +4643,9 @@ Modules that need to be loaded on the NixOS level. Note that these will not be a
 #+end_src

 ***** AMD GPU
+:PROPERTIES:
+:CUSTOM_ID: h:79c71b6d-a1ad-447d-8940-bb5bfd71dced
+:END:

 #+begin_src nix :tangle profiles/nixos/amdgpu/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4621,6 +4665,9 @@ Modules that need to be loaded on the NixOS level. Note that these will not be a
 #+end_src

 ***** Hibernation
+:PROPERTIES:
+:CUSTOM_ID: h:641d0a2a-0592-448a-a6e3-d0a9c330293e
+:END:

 #+begin_src nix :tangle profiles/nixos/hibernation/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4640,6 +4687,9 @@ Modules that need to be loaded on the NixOS level. Note that these will not be a
 #+end_src

 ***** BTRFS
+:PROPERTIES:
+:CUSTOM_ID: h:0bb401e3-b195-4ff2-bc74-23c5a54d83d2
+:END:

 #+begin_src nix :tangle profiles/nixos/btrfs/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4659,6 +4709,9 @@ Modules that need to be loaded on the NixOS level. Note that these will not be a
 #+end_src

 ***** Local Server
+:PROPERTIES:
+:CUSTOM_ID: h:dfc076fd-ee74-4663-b164-653370c52b75
+:END:

 #+begin_src nix :tangle profiles/nixos/localserver/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4712,6 +4765,9 @@ Modules that need to be loaded on the NixOS level. Note that these will not be a

 #+end_src
 ***** OCI Sync Server
+:PROPERTIES:
+:CUSTOM_ID: h:9b7b50d1-57ad-41ca-94ab-74393aae01bf
+:END:

 #+begin_src nix :tangle profiles/nixos/syncserver/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4745,6 +4801,9 @@ Modules that need to be loaded on the NixOS level. Note that these will not be a

 #+end_src
 ***** Moonside
+:PROPERTIES:
+:CUSTOM_ID: h:cc780ef2-7e5e-4835-b659-c731b306a320
+:END:

 #+begin_src nix :tangle profiles/nixos/moonside/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4797,6 +4856,9 @@ This holds modules that are to be used on most hosts. These are also the most im
 #+end_src

 ***** Personal
+:PROPERTIES:
+:CUSTOM_ID: h:26512487-8c29-4b92-835b-d67394c3f5ef
+:END:

 #+begin_src nix :tangle profiles/home/personal/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4853,6 +4915,9 @@ This holds modules that are to be used on most hosts. These are also the most im
 #+end_src

 ***** Chaostheatre
+:PROPERTIES:
+:CUSTOM_ID: h:36a0209f-2c17-4808-a1d0-a9e1920c307a
+:END:

 #+begin_src nix :tangle profiles/home/chaostheatre/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4903,6 +4968,9 @@ This holds modules that are to be used on most hosts. These are also the most im
 #+end_src

 ***** toto
+:PROPERTIES:
+:CUSTOM_ID: h:e1d4f141-af11-448a-9796-fc822a8f77ec
+:END:

 #+begin_src nix :tangle profiles/home/toto/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4921,6 +4989,9 @@ This holds modules that are to be used on most hosts. These are also the most im
 #+end_src

 ***** Work
+:PROPERTIES:
+:CUSTOM_ID: h:7b091523-a5b0-48b6-8b03-4dc2405e2d81
+:END:

 #+begin_src nix :tangle profiles/home/work/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4939,6 +5010,9 @@ This holds modules that are to be used on most hosts. These are also the most im
 #+end_src

 ***** Framework
+:PROPERTIES:
+:CUSTOM_ID: h:712b9d7f-16c0-42b3-b02b-6d79ee15cfcc
+:END:

 #+begin_src nix :tangle profiles/home/framework/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4958,6 +5032,9 @@ This holds modules that are to be used on most hosts. These are also the most im
 #+end_src

 ***** Darwin
+:PROPERTIES:
+:CUSTOM_ID: h:24e6d661-f498-478c-9008-e8d8c17432ca
+:END:

 #+begin_src nix :tangle profiles/home/darwin/default.nix :mkdirp yes
  { lib, config, ... }:
@ -4974,6 +5051,9 @@ This holds modules that are to be used on most hosts. These are also the most im
 #+end_src

 ***** Local Server
+:PROPERTIES:
+:CUSTOM_ID: h:8027b858-369e-4f12-bbaf-f15eeee3d904
+:END:

 #+begin_src nix :tangle profiles/home/localserver/default.nix :mkdirp yes
  { lib, config, ... }:
@ -5207,7 +5287,13 @@ TODO
 #+end_src

 *** Auxiliary files
+:PROPERTIES:
+:CUSTOM_ID: h:23602ad9-91f6-4eba-943a-2308070fbaec
+:END:
 **** extra-builtins
+:PROPERTIES:
+:CUSTOM_ID: h:87c7893e-e946-4fc0-8973-1ca27d15cf0e
+:END:

 #+begin_src nix :tangle nix/extra-builtins.nix
 # adapted from https://github.com/oddlama/nix-config/blob/main/nix/extra-builtins.nix
@ -5240,6 +5326,9 @@ in

 #+end_src
 **** sops-decrypt-and-cache
+:PROPERTIES:
+:CUSTOM_ID: h:315e6ef6-27d5-4cd8-85ff-053eabe60ddb
+:END:

 #+begin_src shell :tangle nix/sops-decrypt-and-cache.sh
  #!/usr/bin/env bash
@ -5284,6 +5373,9 @@ in
  fi
 #+end_src
 **** nix-topology
+:PROPERTIES:
+:CUSTOM_ID: h:46458265-074e-4368-ad9a-055877754914
+:END:

 #+begin_src nix :tangle topology/default.nix
  { config, ... }:
@ -5647,6 +5739,9 @@ A breakdown of the flags being set:
 #+end_src

 **** Share configuration between nodes
+:PROPERTIES:
+:CUSTOM_ID: h:5c3027b4-ba66-445e-9c5f-c27e332c90e5
+:END:

 #+begin_src nix :tangle modules/nixos/common/nodes.nix
  # adapted from https://github.com/oddlama/nix-config/blob/main/modules/distributed-config.nix
@ -5927,6 +6022,7 @@ Next, we will setup some environment variables that need to be set on the system
  {
    options.swarselsystems.modules.env = lib.mkEnableOption "environment config";
    config = lib.mkIf config.swarselsystems.modules.env {
+
      environment = {
        wordlist.enable = true;
        sessionVariables = {
@ -6401,6 +6497,9 @@ Setup timezone and locale. I want to use the US layout, but have the rest adapte
 #+end_src

 **** Meta options
+:PROPERTIES:
+:CUSTOM_ID: h:30b81bf9-1e69-4ce8-88af-5592896bcee4
+:END:


 #+begin_src nix :tangle modules/nixos/common/meta.nix
@ -6423,6 +6522,9 @@ Setup timezone and locale. I want to use the US layout, but have the rest adapte
 #+end_src

 **** Topology
+:PROPERTIES:
+:CUSTOM_ID: h:e2e7444b-cb85-4719-b154-e5f37274d02d
+:END:

 #+begin_src nix :tangle modules/nixos/common/topology.nix
  { self, lib, config, ... }:
@ -6511,6 +6613,9 @@ I use sops-nix to handle secrets that I want to have available on my machines at
 #+end_src

 **** PII management
+:PROPERTIES:
+:CUSTOM_ID: h:82b8ede2-02d8-4c43-8952-7200ebd4dc23
+:END:

 #+begin_src nix :tangle modules/nixos/common/pii.nix
  # largely based on https://github.com/oddlama/nix-config/blob/main/modules/secrets.nix
@ -6882,6 +6987,9 @@ Most of the time I am using =power-saver=, however, it is good to be able to cho
 #+end_src

 ***** SwayOSD
+:PROPERTIES:
+:CUSTOM_ID: h:5db15758-17d8-4bde-811d-d11ccdd3f3d3
+:END:

 #+begin_src nix :tangle modules/nixos/common/swayosd.nix
  { lib, pkgs, config, ... }:
@ -8217,6 +8325,9 @@ Here I am forcing =startWhenNeeded= to false so that the value will not be set t
 #+end_src

 **** postgresql
+:PROPERTIES:
+:CUSTOM_ID: h:6ca43d5a-8ba6-4cd1-96b9-f088f11662c0
+:END:

 #+begin_src nix :tangle modules/nixos/server/postgresql.nix
  { config, lib, pkgs, ... }:
@ -9913,6 +10024,9 @@ FreshRSS claims to support HTTP header auth, but at least it does not work with
 #+end_src

 **** kanidm
+:PROPERTIES:
+:CUSTOM_ID: h:ee625136-29ab-4696-919f-7b0d0042f6dd
+:END:

 The forgejo configuration is a little broken and will show a 500 error when signing in through kanidm. However, when pressing back and refreshing the page, I am logged in. Currently I cannot be bothered to fix this.

@ -10169,6 +10283,9 @@ To get other URLs (token, etc.), use https://<kanidmDomain>/oauth2/openid/<clien
 #+end_src

 **** oauth2-proxy
+:PROPERTIES:
+:CUSTOM_ID: h:605f5974-e985-4572-b353-fd1d3ccbadae
+:END:


 #+begin_src nix :tangle modules/nixos/server/oauth2-proxy.nix
@ -10390,6 +10507,9 @@ To get other URLs (token, etc.), use https://<kanidmDomain>/oauth2/openid/<clien
 #+end_src

 **** Firefly-III
+:PROPERTIES:
+:CUSTOM_ID: h:4248e9eb-4b9f-4771-bbfb-7186ef7a8331
+:END:

 #+begin_src nix :tangle modules/nixos/server/firefly-iii.nix
  { self, lib, config, ... }:
@ -10433,6 +10553,7 @@ To get other URLs (token, etc.), use https://<kanidmDomain>/oauth2/openid/<clien
            APP_ENV = "local";
            DB_CONNECTION = "sqlite";
            TRUSTED_PROXIES = "**";
+            # turning these on breaks api access using the waterfly app
            # AUTHENTICATION_GUARD = "remote_user_guard";
            # AUTHENTICATION_GUARD_HEADER = "X-User";
            # AUTHENTICATION_GUARD_EMAIL = "X-Email";
@ -10494,6 +10615,9 @@ To get other URLs (token, etc.), use https://<kanidmDomain>/oauth2/openid/<clien
 #+end_src

 **** Koillection
+:PROPERTIES:
+:CUSTOM_ID: h:09c0fed3-b9c6-487f-a5f6-49be039e5fa2
+:END:

 #+begin_src nix :tangle modules/nixos/server/koillection.nix
  { self, lib, config, ... }:
@ -11266,6 +11390,9 @@ This smashes Atmosphere 1.3.2 on the switch, which is what I am currenty using.
 #+end_src

 **** Framework
+:PROPERTIES:
+:CUSTOM_ID: h:bb542fa6-b087-4c1c-838e-d9ec14e4eb85
+:END:

 This holds configuration that is specific to framework laptops.

@ -11300,6 +11427,9 @@ This holds configuration that is specific to framework laptops.
 #+end_src

 **** AMD CPU
+:PROPERTIES:
+:CUSTOM_ID: h:b64b8988-94fa-440f-8cf1-ee5568bfd75e
+:END:

 #+begin_src nix :tangle modules/nixos/optional/amdcpu.nix
  { lib, config, ... }:
@ -11314,6 +11444,9 @@ This holds configuration that is specific to framework laptops.
 #+end_src

 **** AMD GPU
+:PROPERTIES:
+:CUSTOM_ID: h:0dc68d4f-72b3-465a-8d73-4453d06e7853
+:END:


 #+begin_src nix :tangle modules/nixos/optional/amdgpu.nix
@ -11335,6 +11468,9 @@ This holds configuration that is specific to framework laptops.
 #+end_src

 **** Hibernation
+:PROPERTIES:
+:CUSTOM_ID: h:15b581ab-09fe-4f84-af26-2f1fbf7d726b
+:END:

 #+begin_src nix :tangle modules/nixos/optional/hibernation.nix
  { lib, config, ... }:
@ -11364,6 +11500,9 @@ This holds configuration that is specific to framework laptops.
 #+end_src

 **** BTRFS
+:PROPERTIES:
+:CUSTOM_ID: h:86fb3236-9e18-43f0-8a08-3a2acd61cc98
+:END:

 #+begin_src nix :tangle modules/nixos/optional/btrfs.nix
  { lib, config, ... }:
@ -14212,6 +14351,9 @@ The `extraConfig` section here CANNOT be reindented. This has something to do wi
 #+end_src

 ***** SwayOSD
+:PROPERTIES:
+:CUSTOM_ID: h:388e71be-f00a-4d45-ade1-218ce942057d
+:END:

 #+begin_src nix :tangle modules/home/common/swayosd.nix
  { lib, config, ... }:
@ -15435,6 +15577,9 @@ The rest of the settings is at [[#h:bbf2ecb6-c8ff-4462-b5d5-d45b28604ddf][work]]
 #+end_src

 **** Framework
+:PROPERTIES:
+:CUSTOM_ID: h:8a7b1c26-3448-42d3-932a-5d05d54b5490
+:END:

 This holds configuration that is specific to framework laptops.

@ -18870,6 +19015,9 @@ autocmd DocStart vc-impimba-1.m.imp.ac.at/ui/webconsole mode ignore

 #+end_src
 ** tridactyl theme
+:PROPERTIES:
+:CUSTOM_ID: h:86f1fd9b-56ee-4fd2-8b35-9ea104d83df0
+:END:
 #+begin_src config :tangle programs/firefox/tridactyl/themes/swarsel.css :mkdirp yes

 :root {
--- a/index.html
+++ b/index.html
--- a/modules/nixos/common/env.nix
+++ b/modules/nixos/common/env.nix
@ -2,6 +2,7 @@
 {
  options.swarselsystems.modules.env = lib.mkEnableOption "environment config";
  config = lib.mkIf config.swarselsystems.modules.env {
+
    environment = {
      wordlist.enable = true;
      sessionVariables = {
--- a/modules/nixos/common/pii.nix
+++ b/modules/nixos/common/pii.nix
@ -1,3 +1,4 @@
+# largely based on https://github.com/oddlama/nix-config/blob/main/modules/secrets.nix
 { config, inputs, lib, ... }:
 let

--- a/modules/nixos/server/firefly-iii.nix
+++ b/modules/nixos/server/firefly-iii.nix
@ -39,6 +39,7 @@ in
          APP_ENV = "local";
          DB_CONNECTION = "sqlite";
          TRUSTED_PROXIES = "**";
+          # turning these on breaks api access using the waterfly app
          # AUTHENTICATION_GUARD = "remote_user_guard";
          # AUTHENTICATION_GUARD_HEADER = "X-User";
          # AUTHENTICATION_GUARD_EMAIL = "X-Email";