From ee552d3020f66f2c03f2b5c884d8c5a5877aa146 Mon Sep 17 00:00:00 2001 From: Qubasa Date: Thu, 2 May 2024 16:33:37 +0200 Subject: [PATCH] Move vm clanModules to lib --- clanModules/borgbackup/README.md | 2 +- clanModules/deltachat/README.md | 1 + clanModules/disk-layouts/README.md | 1 + clanModules/ergochat/README.md | 1 + clanModules/flake-module.nix | 9 --------- clanModules/localbackup/README.md | 1 + clanModules/localsend/README.md | 1 + clanModules/matrix-synapse/README.md | 1 + clanModules/moonlight/README.md | 1 + clanModules/root-password/README.md | 6 ++---- clanModules/sshd/README.md | 1 + clanModules/sunshine/README.md | 1 + clanModules/syncthing/README.md | 4 +--- clanModules/thelounge/README.md | 1 + docs/mkdocs.yml | 3 --- lib/default.nix | 10 ++++++++++ {clanModules/xfce-vm => lib/graphical}/README.md | 1 + {clanModules => lib}/graphical/default.nix | 0 {clanModules/graphical => lib/vm-user}/README.md | 0 {clanModules => lib}/vm-user/default.nix | 0 {clanModules/vm-user => lib/xfce-vm}/README.md | 0 {clanModules => lib}/xfce-vm/default.nix | 0 22 files changed, 25 insertions(+), 20 deletions(-) rename {clanModules/xfce-vm => lib/graphical}/README.md (80%) rename {clanModules => lib}/graphical/default.nix (100%) rename {clanModules/graphical => lib/vm-user}/README.md (100%) rename {clanModules => lib}/vm-user/default.nix (100%) rename {clanModules/vm-user => lib/xfce-vm}/README.md (100%) rename {clanModules => lib}/xfce-vm/default.nix (100%) diff --git a/clanModules/borgbackup/README.md b/clanModules/borgbackup/README.md index 3a2765cd..b639786d 100644 --- a/clanModules/borgbackup/README.md +++ b/clanModules/borgbackup/README.md @@ -1,2 +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. +Efficient, deduplicating backup program with optional compression and secure encryption. --- \ No newline at end of file diff --git a/clanModules/deltachat/README.md b/clanModules/deltachat/README.md index 66968b37..3b5583fa 100644 --- a/clanModules/deltachat/README.md +++ b/clanModules/deltachat/README.md @@ -1,4 +1,5 @@ Email-based instant messaging for Desktop. +--- !!! warning "Under construction" diff --git a/clanModules/disk-layouts/README.md b/clanModules/disk-layouts/README.md index ed97d539..d88ecb7a 100644 --- a/clanModules/disk-layouts/README.md +++ b/clanModules/disk-layouts/README.md @@ -1 +1,2 @@ +Automatically format a disk drive on clan installation --- diff --git a/clanModules/ergochat/README.md b/clanModules/ergochat/README.md index ed97d539..ff4d1497 100644 --- a/clanModules/ergochat/README.md +++ b/clanModules/ergochat/README.md @@ -1 +1,2 @@ +A modern IRC server --- diff --git a/clanModules/flake-module.nix b/clanModules/flake-module.nix index a1cebb23..1a80b37d 100644 --- a/clanModules/flake-module.nix +++ b/clanModules/flake-module.nix @@ -10,7 +10,6 @@ borgbackup = ./borgbackup; ergochat = ./ergochat; deltachat = ./deltachat; - graphical = ./graphical; localbackup = ./localbackup; localsend = ./localsend; matrix-synapse = ./matrix-synapse; @@ -20,15 +19,7 @@ syncthing = ./syncthing; root-password = ./root-password; 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/localbackup/README.md b/clanModules/localbackup/README.md index ed97d539..47eea811 100644 --- a/clanModules/localbackup/README.md +++ b/clanModules/localbackup/README.md @@ -1 +1,2 @@ +Automatically backups current machine to local directory. --- diff --git a/clanModules/localsend/README.md b/clanModules/localsend/README.md index ed97d539..7fd4d9dc 100644 --- a/clanModules/localsend/README.md +++ b/clanModules/localsend/README.md @@ -1 +1,2 @@ +Securely sharing files and messages over a local network without internet connectivity. --- diff --git a/clanModules/matrix-synapse/README.md b/clanModules/matrix-synapse/README.md index ed97d539..e53000b2 100644 --- a/clanModules/matrix-synapse/README.md +++ b/clanModules/matrix-synapse/README.md @@ -1 +1,2 @@ +A federated messaging server with end-to-end encryption. --- diff --git a/clanModules/moonlight/README.md b/clanModules/moonlight/README.md index ed97d539..9abdc53f 100644 --- a/clanModules/moonlight/README.md +++ b/clanModules/moonlight/README.md @@ -1 +1,2 @@ +A desktop streaming client optimized for remote gaming and synchronized movie viewing. --- diff --git a/clanModules/root-password/README.md b/clanModules/root-password/README.md index 1fd0c2ec..a5a6d485 100644 --- a/clanModules/root-password/README.md +++ b/clanModules/root-password/README.md @@ -1,6 +1,5 @@ -Creates a root-password - -!!! tip "This module sets the password for the root user (automatically)." +Automatically generates and configures a password for the root user. +--- After the system was installed/deployed the following command can be used to display the root-password: @@ -8,6 +7,5 @@ After the system was installed/deployed the following command can be used to dis clan secrets get {machine_name}-password ``` ---- See also: [Facts / Secrets](../../getting-started/secrets.md) diff --git a/clanModules/sshd/README.md b/clanModules/sshd/README.md index ed97d539..57c1c333 100644 --- a/clanModules/sshd/README.md +++ b/clanModules/sshd/README.md @@ -1 +1,2 @@ +Enables secure remote access to the machine over ssh --- diff --git a/clanModules/sunshine/README.md b/clanModules/sunshine/README.md index ed97d539..11dbf9b0 100644 --- a/clanModules/sunshine/README.md +++ b/clanModules/sunshine/README.md @@ -1 +1,2 @@ +A desktop streaming server optimized for remote gaming and synchronized movie viewing. --- diff --git a/clanModules/syncthing/README.md b/clanModules/syncthing/README.md index f1da99c9..1bffe740 100644 --- a/clanModules/syncthing/README.md +++ b/clanModules/syncthing/README.md @@ -1,6 +1,4 @@ -Syncthing is a free, open-source file synchronization application designed to allow users to synchronize files between multiple devices over the internet or local networks securely and privately. - -It is an alternative to cloud-based file sharing services. +A secure, file synchronization app for devices over networks, offering a private alternative to cloud services. --- ## Usage diff --git a/clanModules/thelounge/README.md b/clanModules/thelounge/README.md index ed97d539..71714692 100644 --- a/clanModules/thelounge/README.md +++ b/clanModules/thelounge/README.md @@ -1 +1,2 @@ +Modern web IRC client --- diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index dde4c31e..4016dbcc 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -57,7 +57,6 @@ nav: - reference/clanModules/deltachat.md - reference/clanModules/disk-layouts.md - reference/clanModules/ergochat.md - - reference/clanModules/graphical.md - reference/clanModules/localbackup.md - reference/clanModules/localsend.md - reference/clanModules/matrix-synapse.md @@ -67,8 +66,6 @@ nav: - reference/clanModules/sunshine.md - reference/clanModules/syncthing.md - reference/clanModules/thelounge.md - - reference/clanModules/vm-user.md - - reference/clanModules/xfce-vm.md - reference/clanModules/xfce.md - reference/clanModules/zt-tcp-relay.md - Contributing: contributing/contributing.md diff --git a/lib/default.nix b/lib/default.nix index 4f5558ce..96b235ef 100644 --- a/lib/default.nix +++ b/lib/default.nix @@ -8,4 +8,14 @@ jsonschema = import ./jsonschema { inherit lib; }; modules = import ./description.nix { inherit clan-core; }; buildClan = import ./build-clan { inherit clan-core lib nixpkgs; }; + + vm-user = ./vm-user; + graphical = ./graphical; + xfce-vm = { + imports = [ + ./vm-user + ./graphical + ./xfce-vm + ]; + }; } diff --git a/clanModules/xfce-vm/README.md b/lib/graphical/README.md similarity index 80% rename from clanModules/xfce-vm/README.md rename to lib/graphical/README.md index ed97d539..88a0cbf0 100644 --- a/clanModules/xfce-vm/README.md +++ b/lib/graphical/README.md @@ -1 +1,2 @@ + --- diff --git a/clanModules/graphical/default.nix b/lib/graphical/default.nix similarity index 100% rename from clanModules/graphical/default.nix rename to lib/graphical/default.nix diff --git a/clanModules/graphical/README.md b/lib/vm-user/README.md similarity index 100% rename from clanModules/graphical/README.md rename to lib/vm-user/README.md diff --git a/clanModules/vm-user/default.nix b/lib/vm-user/default.nix similarity index 100% rename from clanModules/vm-user/default.nix rename to lib/vm-user/default.nix diff --git a/clanModules/vm-user/README.md b/lib/xfce-vm/README.md similarity index 100% rename from clanModules/vm-user/README.md rename to lib/xfce-vm/README.md diff --git a/clanModules/xfce-vm/default.nix b/lib/xfce-vm/default.nix similarity index 100% rename from clanModules/xfce-vm/default.nix rename to lib/xfce-vm/default.nix