From b95d95554ad3dc4f5df6ff7999ce14899362e480 Mon Sep 17 00:00:00 2001 From: Qubasa Date: Thu, 2 May 2024 14:34:58 +0200 Subject: [PATCH] Add description field to function-schema --- checks/installation/flake-module.nix | 4 +- clanModules/borgbackup/README.md | 2 + .../default.nix} | 0 clanModules/disk-layouts/README.md | 1 + .../default.nix} | 4 +- clanModules/ergochat/README.md | 1 + .../{ergochat.nix => ergochat/default.nix} | 0 clanModules/flake-module.nix | 38 +++++++++++-------- clanModules/graphical/README.md | 1 + .../{graphical.nix => graphical/default.nix} | 0 clanModules/localbackup/README.md | 1 + .../default.nix} | 0 clanModules/localsend/README.md | 1 + .../{localsend.nix => localsend/default.nix} | 0 clanModules/matrix-synapse/README.md | 1 + .../default.nix} | 0 clanModules/moonlight/README.md | 1 + .../{moonlight.nix => moonlight/default.nix} | 0 clanModules/sshd/README.md | 1 + clanModules/{sshd.nix => sshd/default.nix} | 0 clanModules/sunshine/README.md | 1 + .../{sunshine.nix => sunshine/default.nix} | 0 clanModules/thelounge/README.md | 1 + .../{thelounge.nix => thelounge/default.nix} | 0 clanModules/vm-user/README.md | 1 + .../{vm-user.nix => vm-user/default.nix} | 0 clanModules/xfce-vm/README.md | 1 + .../{xfce-vm.nix => xfce-vm/default.nix} | 5 --- clanModules/xfce/README.md | 1 + clanModules/{xfce.nix => xfce/default.nix} | 0 clanModules/zt-tcp-relay/README.md | 1 + .../default.nix} | 0 docs/mkdocs.yml | 2 +- pkgs/schemas/flake-module.nix | 2 +- templates/new-clan/modules/shared.nix | 2 +- 35 files changed, 45 insertions(+), 28 deletions(-) create mode 100644 clanModules/borgbackup/README.md rename clanModules/{borgbackup.nix => borgbackup/default.nix} (100%) create mode 100644 clanModules/disk-layouts/README.md rename clanModules/{diskLayouts.nix => disk-layouts/default.nix} (90%) create mode 100644 clanModules/ergochat/README.md rename clanModules/{ergochat.nix => ergochat/default.nix} (100%) create mode 100644 clanModules/graphical/README.md rename clanModules/{graphical.nix => graphical/default.nix} (100%) create mode 100644 clanModules/localbackup/README.md rename clanModules/{localbackup.nix => localbackup/default.nix} (100%) create mode 100644 clanModules/localsend/README.md rename clanModules/{localsend.nix => localsend/default.nix} (100%) create mode 100644 clanModules/matrix-synapse/README.md rename clanModules/{matrix-synapse.nix => matrix-synapse/default.nix} (100%) create mode 100644 clanModules/moonlight/README.md rename clanModules/{moonlight.nix => moonlight/default.nix} (100%) create mode 100644 clanModules/sshd/README.md rename clanModules/{sshd.nix => sshd/default.nix} (100%) create mode 100644 clanModules/sunshine/README.md rename clanModules/{sunshine.nix => sunshine/default.nix} (100%) create mode 100644 clanModules/thelounge/README.md rename clanModules/{thelounge.nix => thelounge/default.nix} (100%) create mode 100644 clanModules/vm-user/README.md rename clanModules/{vm-user.nix => vm-user/default.nix} (100%) create mode 100644 clanModules/xfce-vm/README.md rename clanModules/{xfce-vm.nix => xfce-vm/default.nix} (81%) create mode 100644 clanModules/xfce/README.md rename clanModules/{xfce.nix => xfce/default.nix} (100%) create mode 100644 clanModules/zt-tcp-relay/README.md rename clanModules/{zt-tcp-relay.nix => zt-tcp-relay/default.nix} (100%) diff --git a/checks/installation/flake-module.nix b/checks/installation/flake-module.nix index b5f87ef1..ff5a5d92 100644 --- a/checks/installation/flake-module.nix +++ b/checks/installation/flake-module.nix @@ -12,11 +12,11 @@ { lib, modulesPath, ... }: { imports = [ - self.clanModules.diskLayouts + self.clanModules.disk-layouts (modulesPath + "/testing/test-instrumentation.nix") # we need these 2 modules always to be able to run the tests (modulesPath + "/profiles/qemu-guest.nix") ]; - clan.diskLayouts.singleDiskExt4.device = "/dev/vdb"; + clan.disk-layouts.singleDiskExt4.device = "/dev/vdb"; environment.etc."install-successful".text = "ok"; diff --git a/clanModules/borgbackup/README.md b/clanModules/borgbackup/README.md new file mode 100644 index 00000000..3a2765cd --- /dev/null +++ b/clanModules/borgbackup/README.md @@ -0,0 +1,2 @@ +BorgBackup is an efficient backup program that uses data deduplication to store only changes, making it ideal for daily backups. It offers optional compression and authenticated encryption, ensuring secure backups even to untrusted targets. +--- \ No newline at end of file diff --git a/clanModules/borgbackup.nix b/clanModules/borgbackup/default.nix similarity index 100% rename from clanModules/borgbackup.nix rename to clanModules/borgbackup/default.nix diff --git a/clanModules/disk-layouts/README.md b/clanModules/disk-layouts/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/disk-layouts/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/diskLayouts.nix b/clanModules/disk-layouts/default.nix similarity index 90% rename from clanModules/diskLayouts.nix rename to clanModules/disk-layouts/default.nix index 32de6f11..78f2295a 100644 --- a/clanModules/diskLayouts.nix +++ b/clanModules/disk-layouts/default.nix @@ -1,6 +1,6 @@ { config, lib, ... }: { - options.clan.diskLayouts.singleDiskExt4 = { + options.clan.disk-layouts.singleDiskExt4 = { device = lib.mkOption { type = lib.types.str; example = "/dev/disk/by-id/ata-Samsung_SSD_850_EVO_250GB_S21PNXAGB12345"; @@ -13,7 +13,7 @@ disk = { main = { type = "disk"; - device = config.clan.diskLayouts.singleDiskExt4.device; + device = config.clan.disk-layouts.singleDiskExt4.device; content = { type = "gpt"; partitions = { diff --git a/clanModules/ergochat/README.md b/clanModules/ergochat/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/ergochat/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/ergochat.nix b/clanModules/ergochat/default.nix similarity index 100% rename from clanModules/ergochat.nix rename to clanModules/ergochat/default.nix diff --git a/clanModules/flake-module.nix b/clanModules/flake-module.nix index 8578e179..a1cebb23 100644 --- a/clanModules/flake-module.nix +++ b/clanModules/flake-module.nix @@ -1,28 +1,34 @@ { inputs, ... }: { flake.clanModules = { - diskLayouts = { + disk-layouts = { imports = [ - ./diskLayouts.nix + ./disk-layouts inputs.disko.nixosModules.default ]; }; - borgbackup = ./borgbackup.nix; - ergochat = ./ergochat.nix; + borgbackup = ./borgbackup; + ergochat = ./ergochat; deltachat = ./deltachat; - graphical = ./graphical.nix; - localbackup = ./localbackup.nix; - localsend = ./localsend.nix; - matrix-synapse = ./matrix-synapse.nix; - moonlight = ./moonlight.nix; - sshd = ./sshd.nix; - sunshine = ./sunshine.nix; + graphical = ./graphical; + localbackup = ./localbackup; + localsend = ./localsend; + matrix-synapse = ./matrix-synapse; + moonlight = ./moonlight; + sshd = ./sshd; + sunshine = ./sunshine; syncthing = ./syncthing; root-password = ./root-password; - thelounge = ./thelounge.nix; - vm-user = ./vm-user.nix; - xfce = ./xfce.nix; - xfce-vm = ./xfce-vm.nix; - zt-tcp-relay = ./zt-tcp-relay.nix; + thelounge = ./thelounge; + vm-user = ./vm-user; + xfce = ./xfce; + xfce-vm = { + imports = [ + ./vm-user + ./graphical + ./xfce-vm + ]; + }; + zt-tcp-relay = ./zt-tcp-relay; }; } diff --git a/clanModules/graphical/README.md b/clanModules/graphical/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/graphical/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/graphical.nix b/clanModules/graphical/default.nix similarity index 100% rename from clanModules/graphical.nix rename to clanModules/graphical/default.nix diff --git a/clanModules/localbackup/README.md b/clanModules/localbackup/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/localbackup/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/localbackup.nix b/clanModules/localbackup/default.nix similarity index 100% rename from clanModules/localbackup.nix rename to clanModules/localbackup/default.nix diff --git a/clanModules/localsend/README.md b/clanModules/localsend/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/localsend/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/localsend.nix b/clanModules/localsend/default.nix similarity index 100% rename from clanModules/localsend.nix rename to clanModules/localsend/default.nix diff --git a/clanModules/matrix-synapse/README.md b/clanModules/matrix-synapse/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/matrix-synapse/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/matrix-synapse.nix b/clanModules/matrix-synapse/default.nix similarity index 100% rename from clanModules/matrix-synapse.nix rename to clanModules/matrix-synapse/default.nix diff --git a/clanModules/moonlight/README.md b/clanModules/moonlight/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/moonlight/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/moonlight.nix b/clanModules/moonlight/default.nix similarity index 100% rename from clanModules/moonlight.nix rename to clanModules/moonlight/default.nix diff --git a/clanModules/sshd/README.md b/clanModules/sshd/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/sshd/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/sshd.nix b/clanModules/sshd/default.nix similarity index 100% rename from clanModules/sshd.nix rename to clanModules/sshd/default.nix diff --git a/clanModules/sunshine/README.md b/clanModules/sunshine/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/sunshine/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/sunshine.nix b/clanModules/sunshine/default.nix similarity index 100% rename from clanModules/sunshine.nix rename to clanModules/sunshine/default.nix diff --git a/clanModules/thelounge/README.md b/clanModules/thelounge/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/thelounge/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/thelounge.nix b/clanModules/thelounge/default.nix similarity index 100% rename from clanModules/thelounge.nix rename to clanModules/thelounge/default.nix diff --git a/clanModules/vm-user/README.md b/clanModules/vm-user/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/vm-user/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/vm-user.nix b/clanModules/vm-user/default.nix similarity index 100% rename from clanModules/vm-user.nix rename to clanModules/vm-user/default.nix diff --git a/clanModules/xfce-vm/README.md b/clanModules/xfce-vm/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/xfce-vm/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/xfce-vm.nix b/clanModules/xfce-vm/default.nix similarity index 81% rename from clanModules/xfce-vm.nix rename to clanModules/xfce-vm/default.nix index 7eadd7f4..ce9b797d 100644 --- a/clanModules/xfce-vm.nix +++ b/clanModules/xfce-vm/default.nix @@ -1,9 +1,4 @@ { - imports = [ - ./vm-user.nix - ./graphical.nix - ]; - services.xserver = { enable = true; displayManager.autoLogin.enable = true; diff --git a/clanModules/xfce/README.md b/clanModules/xfce/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/xfce/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/xfce.nix b/clanModules/xfce/default.nix similarity index 100% rename from clanModules/xfce.nix rename to clanModules/xfce/default.nix diff --git a/clanModules/zt-tcp-relay/README.md b/clanModules/zt-tcp-relay/README.md new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/clanModules/zt-tcp-relay/README.md @@ -0,0 +1 @@ +--- diff --git a/clanModules/zt-tcp-relay.nix b/clanModules/zt-tcp-relay/default.nix similarity index 100% rename from clanModules/zt-tcp-relay.nix rename to clanModules/zt-tcp-relay/default.nix diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 70e456fc..dde4c31e 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -55,7 +55,7 @@ nav: - clanModules: - reference/clanModules/borgbackup.md - reference/clanModules/deltachat.md - - reference/clanModules/diskLayouts.md + - reference/clanModules/disk-layouts.md - reference/clanModules/ergochat.md - reference/clanModules/graphical.md - reference/clanModules/localbackup.md diff --git a/pkgs/schemas/flake-module.nix b/pkgs/schemas/flake-module.nix index c124f44a..e3f17a0e 100644 --- a/pkgs/schemas/flake-module.nix +++ b/pkgs/schemas/flake-module.nix @@ -46,7 +46,7 @@ checks = { module-schema = pkgs.runCommand "schema-checks" { } '' ${pkgs.check-jsonschema}/bin/check-jsonschema \ - --check-metaschema ${packages.module-schema} + --check-metaschema --fill-defaults ${packages.module-schema} touch $out ''; }; diff --git a/templates/new-clan/modules/shared.nix b/templates/new-clan/modules/shared.nix index 5cc1ca73..56477b43 100644 --- a/templates/new-clan/modules/shared.nix +++ b/templates/new-clan/modules/shared.nix @@ -2,7 +2,7 @@ { imports = [ clan-core.clanModules.sshd - clan-core.clanModules.diskLayouts + clan-core.clanModules.disk-layouts clan-core.clanModules.root-password ]; }