init:

clan: init manpage
2024-04-30 10:37:36 +02:00 · 2024-04-26 14:02:24 +02:00
162 changed files with 897 additions and 8998 deletions
--- a/.gitea/workflows/checks.yaml
+++ b/.gitea/workflows/checks.yaml
@@ -5,6 +5,11 @@ on:
    branches:
      - main
 jobs:
+  checks:
+    runs-on: nix
+    steps:
+      - uses: actions/checkout@v3
+      - run: nix run --refresh github:Mic92/nix-fast-build -- --no-nom --eval-workers 10
  checks-impure:
    runs-on: nix
    steps:
--- a/.gitea/workflows/deploy.yaml
+++ b/.gitea/workflows/deploy.yaml
@@ -1,13 +0,0 @@
-name: deploy
-on:
- push:
-    branches:
-      - main
-jobs:
-  deploy-docs:
-    runs-on: nix
-    steps:
-      - uses: actions/checkout@v3
-      - run: nix run .#deploy-docs
-    env:
-      SSH_HOMEPAGE_KEY: ${{ secrets.SSH_HOMEPAGE_KEY }}
--- a/.gitignore
+++ b/.gitignore
@@ -13,9 +13,6 @@ nixos.qcow2
 **/*.glade~
 /docs/out

-# dream2nix
-.dream2nix
-
 # python
 __pycache__
 .coverage
@@ -31,8 +28,3 @@ build
 build-dir
 repo
 .env
-
-# node
-node_modules
-dist
-.webui
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# Clan Core Repository
+# cLAN Core Repository

-Welcome to the Clan Core Repository, the heart of the [clan.lol](https://clan.lol/) project! This monorepo is the foundation of Clan, a revolutionary open-source project aimed at restoring fun, freedom, and functionality to computing. Here, you'll find all the essential packages, NixOS modules, CLI tools, and tests needed to contribute to and work with the cLAN project. Clan leverages the Nix system to ensure reliability, security, and seamless management of digital environments, putting the power back into the hands of users.
+Welcome to the cLAN Core Repository, the heart of the [clan.lol](https://clan.lol/) project! This monorepo is the foundation of Clan, a revolutionary open-source project aimed at restoring fun, freedom, and functionality to computing. Here, you'll find all the essential packages, NixOS modules, CLI tools, and tests needed to contribute to and work with the cLAN project. Clan leverages the Nix system to ensure reliability, security, and seamless management of digital environments, putting the power back into the hands of users.

 ## Why Clan?

@@ -14,11 +14,11 @@ Our mission is simple: to democratize computing by providing tools that empower
 - **Robust Backup Management:** Long-term, self-hosted data preservation.
 - **Intuitive Secret Management:** Simplified encryption and password management processes.

-## Getting Started with Clan
+## Getting Started with cLAN

-If you're new to Clan and eager to dive in, start with our quickstart guide and explore the core functionalities that Clan offers:
+If you're new to cLAN and eager to dive in, start with our quickstart guide and explore the core functionalities that Clan offers:

- **Quickstart Guide**: Check out [getting started](https://docs.clan.lol/#starting-with-a-new-clan-project)<!-- [docs/site/index.md](docs/site/index.md) --> to get up and running with Clan in no time.
+- **Quickstart Guide**: Check out [getting started](https://docs.clan.lol/#starting-with-a-new-clan-project)<!-- [docs/site/index.md](docs/site/index.md) --> to get up and running with cLAN in no time.

 ### Managing Secrets

@@ -26,7 +26,7 @@ In the Clan ecosystem, security is paramount. Learn how to handle secrets effect

 - **Secrets Management**: Securely manage secrets by consulting [secrets](https://docs.clan.lol/getting-started/secrets/)<!-- [secrets.md](docs/site/getting-started/secrets.md) -->.

-### Contributing to Clan
+### Contributing to cLAN

 The Clan project thrives on community contributions. We welcome everyone to contribute and collaborate:

@@ -34,12 +34,12 @@ The Clan project thrives on community contributions. We welcome everyone to cont

 ## Join the Revolution

-Clan is more than a tool; it's a movement towards a better digital future. By contributing to the Clan project, you're part of changing technology for the better, together.
+Clan is more than a tool; it's a movement towards a better digital future. By contributing to the cLAN project, you're part of changing technology for the better, together.

 ### Community and Support

 Connect with us and the Clan community for support and discussion:

- [Matrix channel](https://matrix.to/#/#clan:lassul.us) for live discussions.
+- [Matrix channel](https://matrix.to/#/!djzOHBBBHnwQkgNgdV:matrix.org?via=blog.clan.lol) for live discussions.
 - IRC bridges (coming soon) for real-time chat support.

--- a/checks/flake-module.nix
+++ b/checks/flake-module.nix
@@ -46,6 +46,7 @@
            syncthing = import ./syncthing nixosTestArgs;
            wayland-proxy-virtwl = import ./wayland-proxy-virtwl nixosTestArgs;
          };
+          schemaTests = pkgs.callPackages ./schemas.nix { inherit self; };

          flakeOutputs =
            lib.mapAttrs' (
@@ -57,7 +58,7 @@
              self'.legacyPackages.homeConfigurations or { }
            );
        in
-        { inherit renderClanOptions; } // nixosTests // flakeOutputs;
+        { inherit renderClanOptions; } // nixosTests // schemaTests // flakeOutputs;
      legacyPackages = {
        nixosTests =
          let
--- a/checks/flash/flake-module.nix
+++ b/checks/flash/flake-module.nix
@@ -1,33 +1,49 @@
-{ ... }:
+{ self, ... }:
 {
  perSystem =
-    { ... }:
    {
-      # checks = pkgs.lib.mkIf (pkgs.stdenv.isLinux) {
-      #   flash = (import ../lib/test-base.nix) {
-      #     name = "flash";
-      #     nodes.target = {
-      #       virtualisation.emptyDiskImages = [ 4096 ];
-      #       virtualisation.memorySize = 3000;
-      #       environment.systemPackages = [ self.packages.${pkgs.system}.clan-cli ];
-      #       environment.etc."install-closure".source = "${closureInfo}/store-paths"; 
+      nodes,
+      pkgs,
+      lib,
+      ...
+    }:
+    let
+      dependencies = [
+        self
+        pkgs.stdenv.drvPath
+        self.clanInternals.machines.${pkgs.hostPlatform.system}.test_install_machine.config.system.build.toplevel
+        self.clanInternals.machines.${pkgs.hostPlatform.system}.test_install_machine.config.system.build.diskoScript
+        self.clanInternals.machines.${pkgs.hostPlatform.system}.test_install_machine.config.system.clan.deployment.file
+        self.inputs.nixpkgs.legacyPackages.${pkgs.hostPlatform.system}.disko
+      ] ++ builtins.map (i: i.outPath) (builtins.attrValues self.inputs);
+      closureInfo = pkgs.closureInfo { rootPaths = dependencies; };
+    in
+    {
+      checks = pkgs.lib.mkIf (pkgs.stdenv.isLinux) {
+        flash = (import ../lib/test-base.nix) {
+          name = "flash";
+          nodes.target = {
+            virtualisation.emptyDiskImages = [ 4096 ];
+            virtualisation.memorySize = 3000;
+            environment.systemPackages = [ self.packages.${pkgs.system}.clan-cli ];
+            environment.etc."install-closure".source = "${closureInfo}/store-paths";

-      #       nix.settings = {
-      #         substituters = lib.mkForce [ ];
-      #         hashed-mirrors = null;
-      #         connect-timeout = lib.mkForce 3;
-      #         flake-registry = pkgs.writeText "flake-registry" ''{"flakes":[],"version":2}'';
-      #         experimental-features = [
-      #           "nix-command"
-      #           "flakes"
-      #         ];
-      #       };
-      #     };
-      #     testScript = ''
-      #       start_all()
-      #       machine.succeed("clan --debug --flake ${../..} flash --yes --disk main /dev/vdb test_install_machine")
-      #     '';
-      #   } { inherit pkgs self; };
-      # };
+            nix.settings = {
+              substituters = lib.mkForce [ ];
+              hashed-mirrors = null;
+              connect-timeout = lib.mkForce 3;
+              flake-registry = pkgs.writeText "flake-registry" ''{"flakes":[],"version":2}'';
+              experimental-features = [
+                "nix-command"
+                "flakes"
+              ];
+            };
+          };
+          testScript = ''
+            start_all()
+            machine.succeed("clan --flake ${../..} flash --debug --yes --disk main /dev/vdb test_install_machine")
+          '';
+        } { inherit pkgs self; };
+      };
    };
 }
--- a/checks/impure/flake-module.nix
+++ b/checks/impure/flake-module.nix
@@ -7,8 +7,6 @@
        #!${pkgs.bash}/bin/bash
        set -euo pipefail

-        unset CLAN_DIR
-
        export PATH="${
          lib.makeBinPath [
            pkgs.gitMinimal
--- a/checks/installation/flake-module.nix
+++ b/checks/installation/flake-module.nix
@@ -12,11 +12,11 @@
      { lib, modulesPath, ... }:
      {
        imports = [
-          self.clanModules.disk-layouts
+          self.clanModules.diskLayouts
          (modulesPath + "/testing/test-instrumentation.nix") # we need these 2 modules always to be able to run the tests
          (modulesPath + "/profiles/qemu-guest.nix")
        ];
-        clan.disk-layouts.singleDiskExt4.device = "/dev/vdb";
+        clan.diskLayouts.singleDiskExt4.device = "/dev/vdb";

        environment.etc."install-successful".text = "ok";

--- a/checks/schemas.nix
+++ b/checks/schemas.nix
@@ -0,0 +1,48 @@
+{
+  self,
+  runCommand,
+  check-jsonschema,
+  pkgs,
+  lib,
+  ...
+}:
+let
+  clanModules.clanCore = self.nixosModules.clanCore;
+
+  baseModule = {
+    imports = (import (pkgs.path + "/nixos/modules/module-list.nix")) ++ [
+      {
+        nixpkgs.hostPlatform = "x86_64-linux";
+        clanCore.clanName = "dummy";
+      }
+    ];
+  };
+
+  optionsFromModule =
+    module:
+    let
+      evaled = lib.evalModules {
+        modules = [
+          module
+          baseModule
+        ];
+      };
+    in
+    evaled.options.clan;
+
+  clanModuleSchemas = lib.mapAttrs (
+    _: module: self.lib.jsonschema.parseOptions (optionsFromModule module)
+  ) clanModules;
+
+  mkTest =
+    name: schema:
+    runCommand "schema-${name}" { } ''
+      ${check-jsonschema}/bin/check-jsonschema \
+        --check-metaschema ${builtins.toFile "schema-${name}" (builtins.toJSON schema)}
+        touch $out
+    '';
+in
+lib.mapAttrs' (name: schema: {
+  name = "schema-${name}";
+  value = mkTest name schema;
+}) clanModuleSchemas
--- a/checks/secrets/default.nix
+++ b/checks/secrets/default.nix
@@ -4,11 +4,10 @@
  nodes.machine =
    { self, config, ... }:
    {
-      environment.etc."privkey.age".source = ./key.age;
      imports = [ (self.nixosModules.clanCore) ];
      environment.etc."secret".source = config.sops.secrets.secret.path;
      environment.etc."group-secret".source = config.sops.secrets.group-secret.path;
-      sops.age.keyFile = "/etc/privkey.age";
+      sops.age.keyFile = ./key.age;

      clanCore.clanDir = "${./.}";
      clanCore.machineName = "machine";
--- a/clanModules/borgbackup/default.nix
+++ b/clanModules/borgbackup/default.nix
--- a/clanModules/borgbackup/README.md
+++ b/clanModules/borgbackup/README.md
@@ -1,2 +0,0 @@
-Efficient, deduplicating backup program with optional compression and secure encryption.
---
--- a/clanModules/deltachat/README.md
+++ b/clanModules/deltachat/README.md
@@ -1,5 +1,4 @@
 Email-based instant messaging for Desktop.
---

 !!! warning "Under construction"

--- a/clanModules/disk-layouts/README.md
+++ b/clanModules/disk-layouts/README.md
@@ -1,2 +0,0 @@
-Automatically format a disk drive on clan installation
---
--- a/clanModules/disk-layouts/default.nix
+++ b/clanModules/disk-layouts/default.nix
@@ -1,6 +1,6 @@
 { config, lib, ... }:
 {
-  options.clan.disk-layouts.singleDiskExt4 = {
+  options.clan.diskLayouts.singleDiskExt4 = {
    device = lib.mkOption {
      type = lib.types.str;
      example = "/dev/disk/by-id/ata-Samsung_SSD_850_EVO_250GB_S21PNXAGB12345";
@@ -13,14 +13,13 @@
      disk = {
        main = {
          type = "disk";
-          device = config.clan.disk-layouts.singleDiskExt4.device;
+          device = config.clan.diskLayouts.singleDiskExt4.device;
          content = {
            type = "gpt";
            partitions = {
              boot = {
                size = "1M";
                type = "EF02"; # for grub MBR
-                priority = 1;
              };
              ESP = {
                size = "512M";
--- a/clanModules/ergochat/default.nix
+++ b/clanModules/ergochat/default.nix
--- a/clanModules/ergochat/README.md
+++ b/clanModules/ergochat/README.md
@@ -1,2 +0,0 @@
-A modern IRC server
---
--- a/clanModules/flake-module.nix
+++ b/clanModules/flake-module.nix
@@ -1,26 +1,29 @@
-{ ... }:
+{ inputs, ... }:
 {
  flake.clanModules = {
-    disk-layouts = {
-      imports = [ ./disk-layouts ];
+    diskLayouts = {
+      imports = [
+        ./diskLayouts.nix
+        inputs.disko.nixosModules.default
+      ];
    };
-    borgbackup = ./borgbackup;
+    borgbackup = ./borgbackup.nix;
+    ergochat = ./ergochat.nix;
    deltachat = ./deltachat;
-    ergochat = ./ergochat;
-    localbackup = ./localbackup;
-    localsend = ./localsend;
-    matrix-synapse = ./matrix-synapse;
-    moonlight = ./moonlight;
-    root-password = ./root-password;
-    sshd = ./sshd;
-    sunshine = ./sunshine;
-    static-hosts = ./static-hosts;
+    graphical = ./graphical.nix;
+    localbackup = ./localbackup.nix;
+    localsend = ./localsend.nix;
+    matrix-synapse = ./matrix-synapse.nix;
+    moonlight = ./moonlight.nix;
+    sshd = ./sshd.nix;
+    sunshine = ./sunshine.nix;
    syncthing = ./syncthing;
-    thelounge = ./thelounge;
-    trusted-nix-caches = ./trusted-nix-caches;
-    user-password = ./user-password;
-    xfce = ./xfce;
-    zerotier-static-peers = ./zerotier-static-peers;
-    zt-tcp-relay = ./zt-tcp-relay;
+    root-password = ./root-password;
+    thelounge = ./thelounge.nix;
+    vm-user = ./vm-user.nix;
+    waypipe = ./waypipe.nix;
+    xfce = ./xfce.nix;
+    xfce-vm = ./xfce-vm.nix;
+    zt-tcp-relay = ./zt-tcp-relay.nix;
  };
 }
--- a/clanModules/graphical.nix
+++ b/clanModules/graphical.nix
@@ -0,0 +1 @@
+_: { fonts.enableDefaultPackages = true; }
--- a/clanModules/localbackup/default.nix
+++ b/clanModules/localbackup/default.nix
--- a/clanModules/localbackup/README.md
+++ b/clanModules/localbackup/README.md
@@ -1,2 +0,0 @@
-Automatically backups current machine to local directory.
---
--- a/clanModules/localsend/default.nix
+++ b/clanModules/localsend/default.nix
--- a/clanModules/localsend/README.md
+++ b/clanModules/localsend/README.md
@@ -1,2 +0,0 @@
-Securely sharing files and messages over a local network without internet connectivity.
---
--- a/clanModules/matrix-synapse/default.nix
+++ b/clanModules/matrix-synapse/default.nix
--- a/clanModules/matrix-synapse/README.md
+++ b/clanModules/matrix-synapse/README.md
@@ -1,2 +0,0 @@
-A federated messaging server with end-to-end encryption.
---
--- a/clanModules/moonlight/default.nix
+++ b/clanModules/moonlight/default.nix
--- a/clanModules/moonlight/README.md
+++ b/clanModules/moonlight/README.md
@@ -1,2 +0,0 @@
-A desktop streaming client optimized for remote gaming and synchronized movie viewing.
---
--- a/clanModules/root-password/README.md
+++ b/clanModules/root-password/README.md
@@ -1,5 +1,6 @@
-Automatically generates and configures a password for the root user.
---
+Creates a root-password
+
+!!! tip "This module sets the password for the root user (automatically)."

 After the system was installed/deployed the following command can be used to display the root-password:

@@ -7,5 +8,6 @@ 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)
--- a/clanModules/sshd/default.nix
+++ b/clanModules/sshd/default.nix
@@ -1,7 +1,6 @@
 { config, pkgs, ... }:
 {
  services.openssh.enable = true;
-  services.openssh.settings.PasswordAuthentication = false;

  services.openssh.hostKeys = [
    {
--- a/clanModules/sshd/README.md
+++ b/clanModules/sshd/README.md
@@ -1,2 +0,0 @@
-Enables secure remote access to the machine over ssh
---
--- a/clanModules/static-hosts/README.md
+++ b/clanModules/static-hosts/README.md
@@ -1,2 +0,0 @@
-Statically configure the host names of machines based on their respective zerotier-ip.
---
--- a/clanModules/static-hosts/default.nix
+++ b/clanModules/static-hosts/default.nix
@@ -1,30 +0,0 @@
-{ lib, config, ... }:
-{
-  options.clan.static-hosts = {
-    excludeHosts = lib.mkOption {
-      type = lib.types.listOf lib.types.str;
-      default = [ config.clanCore.machineName ];
-      description = "Hosts that should be excluded";
-    };
-  };
-
-  config.networking.hosts =
-    let
-      clanDir = config.clanCore.clanDir;
-      machineDir = clanDir + "/machines/";
-      zerotierIpMachinePath = machines: machineDir + machines + "/facts/zerotier-ip";
-      machines = builtins.readDir machineDir;
-      filteredMachines = lib.filterAttrs (
-        name: _: !(lib.elem name config.clan.static-hosts.excludeHosts)
-      ) machines;
-    in
-    lib.filterAttrs (_: value: value != null) (
-      lib.mapAttrs' (
-        machine: _:
-        let
-          path = zerotierIpMachinePath machine;
-        in
-        if builtins.pathExists path then lib.nameValuePair (builtins.readFile path) [ machine ] else null
-      ) filteredMachines
-    );
-}
--- a/clanModules/sunshine/default.nix
+++ b/clanModules/sunshine/default.nix
--- a/clanModules/sunshine/README.md
+++ b/clanModules/sunshine/README.md
@@ -1,2 +0,0 @@
-A desktop streaming server optimized for remote gaming and synchronized movie viewing.
---
--- a/clanModules/syncthing/README.md
+++ b/clanModules/syncthing/README.md
@@ -1,5 +1,7 @@
-A secure, file synchronization app for devices over networks, offering a private alternative to cloud services.
---
+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.
+
 ## Usage

 We recommend configuring this module as an sync-service through the provided options. Although it provides a Web GUI through which more usage scenarios are supported.
--- a/clanModules/syncthing/default.nix
+++ b/clanModules/syncthing/default.nix
@@ -34,10 +34,6 @@
      '';
      type = lib.types.listOf lib.types.str;
      default = [ ];
-      example = [
-        "folder1"
-        "folder2"
-      ];
    };
  };

--- a/clanModules/thelounge/default.nix
+++ b/clanModules/thelounge/default.nix
--- a/clanModules/thelounge/README.md
+++ b/clanModules/thelounge/README.md
@@ -1,2 +0,0 @@
-Modern web IRC client
---
--- a/clanModules/trusted-nix-caches/README.md
+++ b/clanModules/trusted-nix-caches/README.md
@@ -1,2 +0,0 @@
-This module sets the `clan.lol` and `nix-community` cache up as a trusted cache.
----
--- a/clanModules/trusted-nix-caches/default.nix
+++ b/clanModules/trusted-nix-caches/default.nix
@@ -1,10 +0,0 @@
-{
-  nix.settings.trusted-substituters = [
-    "https://cache.clan.lol"
-    "https://nix-community.cachix.org"
-  ];
-  nix.settings.trusted-public-keys = [
-    "nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs="
-    "cache.clan.lol-1:3KztgSAB5R1M+Dz7vzkBGzXdodizbgLXGXKXlcQLA28="
-  ];
-}
--- a/clanModules/user-password/README.md
+++ b/clanModules/user-password/README.md
@@ -1,18 +0,0 @@
-Automatically generates and configures a password for the specified user account.
---
-
-If setting the option prompt to true, the user will be prompted to type in their desired password.
-
-!!! Note
-    This module will set `mutableUsers` to `false`, meaning you can not manage user passwords through `passwd` anymore.
-
-
-After the system was installed/deployed the following command can be used to display the user-password:
-
-```bash
-clan secrets get {machine_name}-user-password
-```
-
-See also: [Facts / Secrets](../../getting-started/secrets.md)
-
-To regenerate the password, delete the password files in the clan directory and redeploy the machine.
--- a/clanModules/user-password/default.nix
+++ b/clanModules/user-password/default.nix
@@ -1,49 +0,0 @@
-{
-  pkgs,
-  config,
-  lib,
-  ...
-}:
-{
-  options.clan.user-password = {
-    user = lib.mkOption {
-      type = lib.types.str;
-      example = "alice";
-      description = "The user the password should be generated for.";
-    };
-    prompt = lib.mkOption {
-      type = lib.types.bool;
-      default = true;
-      example = false;
-      description = "Whether the user should be prompted.";
-    };
-  };
-
-  config = {
-    users.mutableUsers = false;
-    users.users.${config.clan.user-password.user}.hashedPasswordFile =
-      config.clanCore.facts.services.user-password.secret.user-password-hash.path;
-    sops.secrets."${config.clanCore.machineName}-user-password-hash".neededForUsers = true;
-    clanCore.facts.services.user-password = {
-      secret.user-password = { };
-      secret.user-password-hash = { };
-      generator.prompt = (
-        lib.mkIf config.clan.user-password.prompt "Set the password for your $user: ${config.clan.user-password.user}.
-      You can autogenerate a password, if you leave this prompt blank."
-      );
-      generator.path = with pkgs; [
-        coreutils
-        xkcdpass
-        mkpasswd
-      ];
-      generator.script = ''
-        if [[ -n $prompt_value ]]; then
-          echo $prompt_value > $secrets/user-password
-        else
-          xkcdpass --numwords 3 --delimiter - --count 1 > $secrets/user-password
-        fi
-        cat $secrets/user-password | mkpasswd -s -m sha-512 > $secrets/user-password-hash
-      '';
-    };
-  };
-}
--- a/clanModules/vm-user.nix
+++ b/clanModules/vm-user.nix
@@ -0,0 +1,20 @@
+{
+  security = {
+    sudo.wheelNeedsPassword = false;
+    polkit.enable = true;
+    rtkit.enable = true;
+  };
+
+  users.users.user = {
+    isNormalUser = true;
+    createHome = true;
+    uid = 1000;
+    initialHashedPassword = "";
+    extraGroups = [
+      "wheel"
+      "video"
+      "render"
+    ];
+    shell = "/run/current-system/sw/bin/bash";
+  };
+}
--- a/nixosModules/waypipe.nix
+++ b/nixosModules/waypipe.nix
--- a/clanModules/xfce-vm.nix
+++ b/clanModules/xfce-vm.nix
@@ -0,0 +1,15 @@
+{
+  imports = [
+    ./vm-user.nix
+    ./graphical.nix
+  ];
+
+  services.xserver = {
+    enable = true;
+    displayManager.autoLogin.enable = true;
+    displayManager.autoLogin.user = "user";
+    desktopManager.xfce.enable = true;
+    desktopManager.xfce.enableScreensaver = false;
+    xkb.layout = "us";
+  };
+}
--- a/clanModules/xfce/default.nix
+++ b/clanModules/xfce/default.nix
--- a/clanModules/xfce/README.md
+++ b/clanModules/xfce/README.md
@@ -1,2 +0,0 @@
-A lightweight desktop manager
---
--- a/clanModules/zerotier-static-peers/README.md
+++ b/clanModules/zerotier-static-peers/README.md
@@ -1,5 +0,0 @@
-Statically configure the `zerotier` peers of a clan network.
---
-Statically configure the `zerotier` peers of a clan network.
-
-Requires a machine, that is the zerotier controller configured in the network.
--- a/clanModules/zerotier-static-peers/default.nix
+++ b/clanModules/zerotier-static-peers/default.nix
@@ -1,71 +0,0 @@
-{
-  lib,
-  config,
-  pkgs,
-  inputs,
-  ...
-}:
-let
-  clanDir = config.clanCore.clanDir;
-  machineDir = clanDir + "/machines/";
-  machinesFileSet = builtins.readDir machineDir;
-  machines = lib.mapAttrsToList (name: _: name) machinesFileSet;
-
-  zerotierNetworkIdPath = machines: machineDir + machines + "/facts/zerotier-network-id";
-  networkIdsUnchecked = builtins.map (
-    machine:
-    let
-      fullPath = zerotierNetworkIdPath machine;
-    in
-    if builtins.pathExists fullPath then builtins.readFile fullPath else null
-  ) machines;
-  networkIds = lib.filter (machine: machine != null) networkIdsUnchecked;
-  networkId = builtins.elemAt networkIds 0;
-in
-#TODO:trace on multiple found network-ids
-#TODO:trace on no single found networkId
-{
-  options.clan.zerotier-static-peers = {
-    excludeHosts = lib.mkOption {
-      type = lib.types.listOf lib.types.str;
-      default = [ config.clanCore.machineName ];
-      description = "Hosts that should be excluded";
-    };
-  };
-
-  config.systemd.services.zerotier-static-peers-autoaccept =
-    let
-      machines = builtins.readDir machineDir;
-      zerotierIpMachinePath = machines: machineDir + machines + "/facts/zerotier-ip";
-      filteredMachines = lib.filterAttrs (
-        name: _: !(lib.elem name config.clan.static-hosts.excludeHosts)
-      ) machines;
-      hosts = lib.mapAttrsToList (host: _: host) (
-        lib.mapAttrs' (
-          machine: _:
-          let
-            fullPath = zerotierIpMachinePath machine;
-          in
-          if builtins.pathExists fullPath then
-            lib.nameValuePair (builtins.readFile fullPath) [ machine ]
-          else
-            null
-        ) filteredMachines
-      );
-    in
-    lib.mkIf (config.clan.networking.zerotier.controller.enable) {
-      wantedBy = [ "multi-user.target" ];
-      after = [ "zerotierone.service" ];
-      path = [ pkgs.zerotierone ];
-      serviceConfig.ExecStart = pkgs.writeScript "static-zerotier-peers-autoaccept" ''
-        #!/bin/sh
-        ${lib.concatMapStringsSep "\n" (host: ''
-          ${
-            inputs.clan-core.packages.${pkgs.system}.zerotier-members
-          }/bin/zerotier-members allow --member-ip ${host}
-        '') hosts}
-      '';
-    };
-
-  config.clan.networking.zerotier.networkId = lib.mkDefault networkId;
-}
--- a/clanModules/zt-tcp-relay/default.nix
+++ b/clanModules/zt-tcp-relay/default.nix
@@ -20,7 +20,7 @@
      after = [ "network.target" ];
      serviceConfig = {
        ExecStart = "${
-          pkgs.callPackage ../../pkgs/zt-tcp-relay { }
+          pkgs.callPackage ../pkgs/zt-tcp-relay { }
        }/bin/zt-tcp-relay --listen [::]:${builtins.toString config.clan.zt-tcp-relay.port}";
        Restart = "always";
        RestartSec = "5";
--- a/clanModules/zt-tcp-relay/README.md
+++ b/clanModules/zt-tcp-relay/README.md
@@ -1,2 +0,0 @@
-Enable ZeroTier VPN over TCP for networks where UDP is blocked.
---
--- a/devShell.nix
+++ b/devShell.nix
@@ -1,4 +1,3 @@
-{ inputs, ... }:
 {
  perSystem =
    {
@@ -9,7 +8,6 @@
    }:
    let
      writers = pkgs.callPackage ./pkgs/builders/script-writers.nix { };
-      inherit (pkgs.callPackage inputs.git-hooks { }) lib;

      ansiEscapes = {
        reset = ''\033[0m'';
@@ -22,11 +20,6 @@
      select-shell = writers.writePython3Bin "select-shell" {
        flakeIgnore = [ "E501" ];
      } ./pkgs/scripts/select-shell.py;
-
-      # run treefmt before each commit
-      install-pre-commit-hook =
-        with lib.git-hooks;
-        pre-commit (wrap.abort-on-change config.treefmt.build.wrapper);
    in
    {
      devShells.default = pkgs.mkShell {
@@ -41,7 +34,8 @@
          config.treefmt.build.wrapper
        ];
        shellHook = ''
-          ${install-pre-commit-hook}
+          # no longer used
+          rm -f "$(git rev-parse --show-toplevel)/.git/hooks/pre-commit"

          echo -e "${ansiEscapes.green}switch to another dev-shell using: select-shell${ansiEscapes.reset}"
        '';
--- a/docs/.envrc
+++ b/docs/.envrc
@@ -1,6 +1,6 @@
 source_up

-watch_file $(find ./nix -name "*.nix" -printf '%p ')
+watch_file $(find ./nix -name "*.nix" -printf '"%p" ')

 # Because we depend on nixpkgs sources, uploading to builders takes a long time
 use flake .#docs --builders ''
--- a/docs/main.py
+++ b/docs/main.py
@@ -1,30 +0,0 @@
-from typing import Any
-
-
-def define_env(env: Any) -> None:
-    static_dir = "/static/"
-    video_dir = "https://clan.lol/" + "videos/"
-    asciinema_dir = static_dir + "asciinema-player/"
-
-    @env.macro
-    def video(name: str) -> str:
-        return f"""<video loop muted autoplay id="{name}">
-                <source src={video_dir + name} type="video/webm">
-                Your browser does not support the video tag.
-            </video>"""
-
-    @env.macro
-    def asciinema(name: str) -> str:
-        return f"""<div id="{name}">
-            <script src="{asciinema_dir}/asciinema-player.min.js"></script>
-            <script>
-                AsciinemaPlayer.create('{video_dir + name}',
-                document.getElementById("{name}"), {{
-                    loop: true,
-                    autoPlay: true,
-                    controls: false,
-                    speed: 1.5,
-                    theme: "solarized-light"
-                }});
-            </script>
-        </div>"""
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -1,4 +1,4 @@
-site_name: Clan Docs
+site_name: cLAN documentation
 site_url: https://docs.clan.lol
 repo_url: https://git.clan.lol/clan/clan-core/
 repo_name: clan-core
@@ -13,7 +13,6 @@ markdown_extensions:
  - admonition
  - attr_list
  - footnotes
-  - md_in_html
  - meta
  - plantuml_markdown
  - pymdownx.emoji:
@@ -27,8 +26,6 @@ markdown_extensions:
  - pymdownx.details
  - pymdownx.highlight:
      use_pygments: true
-      anchor_linenums: true
-  - pymdownx.keys
  - toc:
      title: On this page

@@ -38,23 +35,29 @@ exclude_docs: |
  /drafts/

 nav:
-  - Blog:
-    - blog/index.md
  - Getting started:
      - index.md
-      - Installer: getting-started/installer.md
      - Configure: getting-started/configure.md
-      - Secrets & Facts: getting-started/secrets.md
-      - Deploy Machine: getting-started/deploy.md
-      - Mesh VPN: getting-started/mesh-vpn.md
+      - Deploy Machine: getting-started/machines.md
+      - Installer: getting-started/installer.md
+      - Setup Networking: getting-started/networking.md
+      - Provision Secrets & Passwords: getting-started/secrets.md
      - Backup & Restore: getting-started/backups.md
      - Flake-parts: getting-started/flake-parts.md
-  - Modules:
-      - Clan Modules:
+  - Templates: templates/index.md
+  - Reference:
+      - clan-core:
+          - reference/clan-core/index.md
+          - reference/clan-core/backups.md
+          - reference/clan-core/facts.md
+          - reference/clan-core/sops.md
+          - reference/clan-core/state.md
+      - clanModules:
          - reference/clanModules/borgbackup.md
          - reference/clanModules/deltachat.md
-          - reference/clanModules/disk-layouts.md
+          - reference/clanModules/diskLayouts.md
          - reference/clanModules/ergochat.md
+          - reference/clanModules/graphical.md
          - reference/clanModules/localbackup.md
          - reference/clanModules/localsend.md
          - reference/clanModules/matrix-synapse.md
@@ -63,50 +66,27 @@ nav:
          - reference/clanModules/sshd.md
          - reference/clanModules/sunshine.md
          - reference/clanModules/syncthing.md
-          - reference/clanModules/static-hosts.md
          - reference/clanModules/thelounge.md
-          - reference/clanModules/trusted-nix-caches.md
-          - reference/clanModules/user-password.md
+          - reference/clanModules/vm-user.md
+          - reference/clanModules/waypipe.md
+          - reference/clanModules/xfce-vm.md
          - reference/clanModules/xfce.md
-          - reference/clanModules/zerotier-static-peers.md
          - reference/clanModules/zt-tcp-relay.md
-      - CLI:
-          - reference/cli/index.md
-          - reference/cli/backups.md
-          - reference/cli/config.md
-          - reference/cli/facts.md
-          - reference/cli/flakes.md
-          - reference/cli/flash.md
-          - reference/cli/history.md
-          - reference/cli/machines.md
-          - reference/cli/secrets.md
-          - reference/cli/ssh.md
-          - reference/cli/vms.md
-      - Clan Core:
-          - reference/clan-core/index.md
-          - reference/clan-core/backups.md
-          - reference/clan-core/facts.md
-          - reference/clan-core/sops.md
-          - reference/clan-core/state.md
  - Contributing: contributing/contributing.md

 docs_dir: site
 site_dir: out

 theme:
-  logo: https://clan.lol/static/logo/clan-white.png
-  favicon: https://clan.lol/static/logo/clan-dark.png
+  logo: static/logo.png
  name: material
  features:
    - navigation.instant
    - navigation.tabs
-    - content.code.annotate
    - content.code.copy
    - content.tabs.link
  icon:
    repo: fontawesome/brands/git
-  font:
-    code: Roboto Mono

  palette:
    # Palette toggle for light mode
@@ -127,35 +107,5 @@ theme:
        icon: material/weather-sunny
        name: Switch to light mode

-extra_css:
-  - static/asciinema-player/custom-theme.css
-  - static/asciinema-player/asciinema-player.css
-
-extra:
-  social:
-    - icon: fontawesome/regular/comment
-      link: https://matrix.to/#/#clan:lassul.us
-    - icon: fontawesome/brands/gitlab
-      link: https://git.clan.lol/clan/clan-core
-    - icon: fontawesome/brands/github
-      link: https://github.com/clan-lol/clan-core
-    - icon: fontawesome/solid/rss
-      link: /feed_rss_created.xml
-
-
 plugins:
  - search
-  - blog
-  - macros
-  - rss:
-      match_path: blog/posts/.*
-      use_git: false
-      date_from_meta:
-        as_creation: "date"
-        as_update: "date"
-        datetime_format: "%Y-%m-%d %H:%M"
-        default_timezone: Europe/Paris
-        default_time: "17:18"
-      categories:
-        - categories
-        - tags
--- a/docs/nix/default.nix
+++ b/docs/nix/default.nix
@@ -1,11 +1,4 @@
-{
-  pkgs,
-  module-docs,
-  clan-cli-docs,
-  asciinema-player-js,
-  asciinema-player-css,
-  ...
-}:
+{ pkgs, module-docs, ... }:
 let
  uml-c4 = pkgs.python3Packages.plantuml-markdown.override { plantuml = pkgs.plantuml-c4; };
 in
@@ -22,17 +15,11 @@ pkgs.stdenv.mkDerivation {
    ++ (with pkgs.python3Packages; [
      mkdocs
      mkdocs-material
-      mkdocs-rss-plugin
-      mkdocs-macros
    ]);
  configurePhase = ''
-    mkdir -p ./site/reference/cli
+    mkdir -p ./site/reference
    cp -af ${module-docs}/* ./site/reference/
-    cp -af ${clan-cli-docs}/* ./site/reference/cli/

-    mkdir -p ./site/static/asciinema-player
-    ln -snf ${asciinema-player-js} ./site/static/asciinema-player/asciinema-player.min.js
-    ln -snf ${asciinema-player-css} ./site/static/asciinema-player/asciinema-player.css
  '';

  buildPhase = ''
--- a/docs/nix/deploy-docs.nix
+++ b/docs/nix/deploy-docs.nix
@@ -8,7 +8,7 @@
 }:

 writeShellScriptBin "deploy-docs" ''
-  set -eu -o pipefail
+  set -eux -o pipefail
  export PATH="${
    lib.makeBinPath [
      coreutils
@@ -17,12 +17,6 @@ writeShellScriptBin "deploy-docs" ''
    ]
  }"

-  #########################################
-  #                                       #
-  # DO NOT PRINT THE SSH KEY TO THE LOGS  #
-  #                                       #
-  #########################################
-  set +x
  if [ -n "''${SSH_HOMEPAGE_KEY:-}" ]; then
    echo "$SSH_HOMEPAGE_KEY" > ./ssh_key
    chmod 600 ./ssh_key
@@ -30,13 +24,6 @@ writeShellScriptBin "deploy-docs" ''
  else
    sshExtraArgs=
  fi
-  set -x
-  ###########################
-  #                         #
-  #    END OF DANGER ZONE   #
-  #                         #
-  ###########################
-

  rsync \
    -e "ssh -o StrictHostKeyChecking=no $sshExtraArgs" \
--- a/docs/nix/flake-module.nix
+++ b/docs/nix/flake-module.nix
@@ -40,15 +40,6 @@
            mypy --strict $out
          '';

-      asciinema-player-js = pkgs.fetchurl {
-        url = "https://github.com/asciinema/asciinema-player/releases/download/v3.7.0/asciinema-player.min.js";
-        sha256 = "sha256-Ymco/+FinDr5YOrV72ehclpp4amrczjo5EU3jfr/zxs=";
-      };
-      asciinema-player-css = pkgs.fetchurl {
-        url = "https://github.com/asciinema/asciinema-player/releases/download/v3.7.0/asciinema-player.css";
-        sha256 = "sha256-GZMeZFFGvP5GMqqh516mjJKfQaiJ6bL38bSYOXkaohc=";
-      };
-
      module-docs = pkgs.runCommand "rendered" { nativeBuildInputs = [ pkgs.python3 ]; } ''
        export CLAN_CORE=${jsonDocs.clanCore}/share/doc/nixos/options.json 
        # A file that contains the links to all clanModule docs
@@ -63,21 +54,19 @@
    in
    {
      devShells.docs = pkgs.callPackage ./shell.nix {
-        inherit (self'.packages) docs clan-cli-docs;
+        inherit (self'.packages) docs;
        inherit module-docs;
-        inherit asciinema-player-js;
-        inherit asciinema-player-css;
      };
      packages = {
        docs = pkgs.python3.pkgs.callPackage ./default.nix {
-          inherit (self'.packages) clan-cli-docs;
          inherit (inputs) nixpkgs;
          inherit module-docs;
-          inherit asciinema-player-js;
-          inherit asciinema-player-css;
        };
        deploy-docs = pkgs.callPackage ./deploy-docs.nix { inherit (config.packages) docs; };
        inherit module-docs;
      };
+      legacyPackages = {
+        foo = jsonDocs;
+      };
    };
 }
--- a/docs/nix/get-module-docs.nix
+++ b/docs/nix/get-module-docs.nix
@@ -38,7 +38,20 @@ let
  ) clanModules;

  clanModulesReadmes = builtins.mapAttrs (
-    module_name: _module: self.lib.modules.getReadme module_name
+    module_name: _module:
+    let
+      readme = "${self}/clanModules/${module_name}/README.md";
+      readmeContents =
+        if
+          builtins.trace "Trying to get Module README.md for ${module_name} from ${readme}"
+            # TODO: Edge cases
+            (builtins.pathExists readme)
+        then
+          (builtins.readFile readme)
+        else
+          null;
+    in
+    readmeContents
  ) clanModules;

  # clanCore docs
--- a/docs/nix/scripts/renderOptions.py
+++ b/docs/nix/scripts/renderOptions.py
@@ -74,7 +74,7 @@ def render_option(name: str, option: dict[str, Any], level: int = 3) -> str:
    read_only = option.get("readOnly")

    res = f"""
-{"#" * level} {sanitize(name)}
+{"#" * level} {sanitize(name)} {{#{sanitize(name)}}}
 {"Readonly" if read_only else ""}
 {option.get("description", "No description available.")}

--- a/docs/nix/shell.nix
+++ b/docs/nix/shell.nix
@@ -2,23 +2,15 @@
  docs,
  pkgs,
  module-docs,
-  clan-cli-docs,
-  asciinema-player-js,
-  asciinema-player-css,
  ...
 }:
 pkgs.mkShell {
  inputsFrom = [ docs ];
  shellHook = ''
-    mkdir -p ./site/reference/cli
+    mkdir -p ./site/reference
    cp -af ${module-docs}/* ./site/reference/
-    cp -af ${clan-cli-docs}/* ./site/reference/cli/
    chmod +w ./site/reference/*

    echo "Generated API documentation in './site/reference/' "
-
-    mkdir -p ./site/static/asciinema-player
-    ln -snf ${asciinema-player-js} ./site/static/asciinema-player/asciinema-player.min.js
-    ln -snf ${asciinema-player-css} ./site/static/asciinema-player/asciinema-player.css
  '';
 }
--- a/docs/site/blog/.authors.yml
+++ b/docs/site/blog/.authors.yml
@@ -1,26 +0,0 @@
-authors:
-  DavHau:
-    name: "DavHau"
-    description: "Core Developer"
-    avatar: "https://clan.lol/static/profiles/davhau.jpg"
-    url: "https://DavHau.com"
-  Lassulus:
-    name: "Lassulus"
-    description: "Core Developer"
-    avatar: "https://clan.lol/static/profiles/lassulus.jpg"
-    url: "https://http://lassul.us/"
-  Mic92:
-    name: "Mic92"
-    description: "Core Developer"
-    avatar: "https://clan.lol/static/profiles/mic92.jpg"
-    url: "https://thalheim.io"
-  W:
-    name: "W"
-    description: "Founder of Clan"
-    avatar: "https://clan.lol/static/profiles/w_profile.webp"
-    url: ""
-  Qubasa:
-    name: "Qubasa"
-    description: "Core Developer"
-    avatar: "https://clan.lol/static/profiles/qubasa.png"
-    url: "https://github.com/Qubasa"
--- a/docs/site/blog/index.md
+++ b/docs/site/blog/index.md
@@ -1,2 +0,0 @@
-# Blog
-
--- a/docs/site/blog/posts/hello-world.md
+++ b/docs/site/blog/posts/hello-world.md
@@ -1,72 +0,0 @@
---
-title: "Introducing Clan: Full-Stack Computing Redefined"
-description: "Introducing Clan, a new model for a decentralized network, designed to provide families, smaller groups, and small businesses a platform that’s private, secure, and user-friendly."
-authors:
-  - W
-  - Qubasa
-date: 2024-03-19
---
-
-
-In a digital age where users are guided increasingly toward submission and dependence, Clan reclaims computing and networking from the ground up.
-
-Clan enables users to build any system from a git repository, automate secret handling, and join devices in a secure darknet. This control extends beyond applications to communication protocols and the operating system itself, putting you fully in charge of your own digital environment.
-
-## Why We're Building Clan
-
-Our mission is simple: to restore fun, freedom, and functionality to computing as an open source project. We believe in building tools that empower users, foster innovation, and challenge the limitations imposed by outdated paradigms. Clan, in its essence, is an open source endeavor; it's our contribution to a future where technology serves humanity, not the other way around.
-
-## How Clan Changes the Game
-Clan embodies a new philosophy in system, application, and network design. It enables seamless, secure communication across devices, simplifies software distribution and updates, and offers both public and private network configurations. Here are some of the ways it accomplishes this:
-
- **Nix as a Foundation:** Imagine a safety net for your computer's operating system, one that lets you make changes or updates without the fear of causing a crash or losing data. Nix simplifies the complexities of system design, ensuring that updates are safe and systems are more reliable.
-
- **Simplified System Deployment:** Building and managing a computer system, from the operating system to the software you use, often feels like putting together a complex puzzle. With Clan, the puzzle pieces are replaced by a set of building blocks. Leveraging the power of Nix and Clan's innovative toolkit, anyone from tech-savvy administrators to everyday users can create and maintain what we call "full-stack systems" (everything your computer needs to run smoothly).
-
- **A Leap in Connectivity:** Imagine if you could create private, secure pathways between your devices, bypassing the noisy and often insecure internet. Clan makes this possible through something called "overlay networks." These networks are like private tunnels, allowing your devices to talk to each other securely and directly. With Clan's built-in overlay networks and automatically configured services, connecting your devices becomes seamless, secure, and hassle-free.
-
- **Security Through Separation:** Clan employs sandboxing and virtual machines, a technology that runs code in isolated environments - so even if you explore new Clans, your system remains protected from potential threats.
-
- **Reliable:** With Clan, your data and services are preserved for the long haul. We focus on self-hosted backups and integration with the [Fediverse](https://de.wikipedia.org/wiki/Fediverse), a network of interconnected, independent online communities, so your digital life remains uninterrupted and under your control.
-
-
-## A Glimpse at Clan's Features
-
- **Social Scaling:** Choose between creating a private sanctuary for your closest contacts, a dynamic space for a self-contained community, or embracing the open web with public Clans anyone can join.
-
-{{ video(name="show_join.webm")}}
-
- **Seamless VM Integration:** Applications running in virtual machines can appear and behave as if they're part of your main operating system — a blend of power and simplicity.
-
-{{ video(name="show_run.webm")}}
-
- **Robust Backup Management:** Keep your data safe _forever_ - never worry about cloud services disappearing in 10 years.
-
-{{ asciinema(name="backups.cast") }}
-
- **Intuitive Secret Management:** Clan simplifies digital security by automating the creation and management of encryption keys and passwords for your services.
-
-{{ asciinema(name="secrets.cast") }}
-
- **Remote Install:** Set up and manage Clan systems anywhere in the world with just a QR scan or SSH access, making remote installations as easy as snapping a photo or sharing a link.
-
-{{ asciinema(name="nixos-install.cast") }}
-
-
-## Who Stands to Benefit?
-
-Clan is for anyone and everyone who believes in the power of open source technology to connect, empower, and protect. From system administrators to less tech-savvy individuals, small business owners to privacy-conscious users, Clan offers something for everyone — a way to reclaim control and redefine how we interact with technology.
-
-## Join the Revolution
-
-Ready to control your digital world? Clan is more than a tool—it's a movement. Secure your data, manage your systems easily, or connect with others how you like. Start with Clan for a better digital future.
-
-Connect with us on our [Matrix channel at clan.lol](https://matrix.to/#/#clan:lassul.us) or through our IRC bridges (coming soon).
-
-Want to see the code? Check it out [on our Gitea](https://git.clan.lol/clan/clan-core) or [on GitHub](https://github.com/clan-lol/clan-core).
-
-Or follow our [RSS feed](https://docs.clan.lol/feed_rss_created.xml)!
-
-Join us and be part of changing technology for the better, together.
-
-
--- a/docs/site/blog/posts/jsonschema.md
+++ b/docs/site/blog/posts/jsonschema.md
@@ -1,194 +0,0 @@
---
-title: "Dev Report: Introducing the NixOS to JSON Schema Converter"
-description: "Discover our new library designed to extract JSON schema interfaces from NixOS modules, streamlining frontend development"
-authors:
-  - DavHau
-date: 2024-05-25
-slug: jsonschema-converter
---
-
-## Overview
-
-We’ve developed a new library designed to extract interfaces from NixOS modules and convert them into JSON schemas, paving the way for effortless GUI generation. This blog post outlines the motivations behind this development, demonstrates the capabilities of the library, and guides you through leveraging it to create GUIs seamlessly.
-
-## Motivation
-
-In recent months, our team has been exploring various graphical user interfaces (GUIs) to streamline NixOS machine configuration. While our opinionated Clan modules simplify NixOS configurations, there's a need to configure these modules from diverse frontends, such as:
-
- Command-line interfaces (CLIs)
- Web-based UIs
- Desktop applications
- Mobile applications
- Large Language Models (LLMs)
-
-Given this need, a universal format like JSON is a natural choice. It is already possible as of now, to import json based NixOS configurations, as illustrated below:
-
-`configuration.json`:
-```json
-{ "networking": { "hostName": "my-machine" } }
-```
-
-This configuration can be then imported inside a classic NixOS config:
-```nix
-{config, lib, pkgs, ...}: {
-  imports = [
-    (lib.importJSON ./configuration.json)
-  ];
-}
-```
-
-This straightforward approach allows us to build a frontend that generates JSON, enabling the configuration of NixOS machines. But, two critical questions arise:
-
-1. How does the frontend learn about existing configuration options?
-2. How can it verify user input without running Nix?
-
-Introducing [JSON schema](https://json-schema.org/), a widely supported standard that defines interfaces in JSON and validates input against them.
-
-Example schema for `networking.hostName`:
-```json
-{
-  "type": "object",
-  "properties": {
-    "networking": {
-      "type": "object",
-      "properties": {
-        "hostName": {
-          "type": "string",
-          "pattern": "^$|^[a-z0-9]([a-z0-9_-]{0,61}[a-z0-9])?$"
-        }
-      }
-    }
-  }
-}
-```
-
-## Client-Side Input Validation
-
-Validating input against JSON schemas is both efficient and well-supported across numerous programming languages. Using JSON schema validators, you can accurately check configurations like our `configuration.json`.
-
-Validation example:
-
-```shell
-$ nix-shell -p check-jsonschema
-$ jsonschema -o pretty ./schema.json -i ./configuration.json
-===[SUCCESS]===(./configuration.json)===
-```
-
-In case of invalid input, schema validators provide explicit error messages:
-
-```shell
-$ echo '{ "networking": { "hostName": "my/machine" } }' > configuration.json
-$ jsonschema -o pretty ./schema.json -i ./configuration.json
-===[ValidationError]===(./configuration.json)===
-
-'my/machine' does not match '^$|^[a-z0-9]([a-z0-9_-]{0,61}[a-z0-9])?$'
-
-Failed validating 'pattern' in schema['properties']['networking']['properties']['hostName']:
-    {'pattern': '^$|^[a-z0-9]([a-z0-9_-]{0,61}[a-z0-9])?$',
-     'type': 'string'}
-
-On instance['networking']['hostName']:
-    'my/machine'
-```
-
-## Automatic GUI Generation
-
-Certain libraries facilitate straightforward GUI generation from JSON schemas. For instance, the [react-jsonschema-form playground](https://rjsf-team.github.io/react-jsonschema-form/) auto-generates a form for any given schema.
-
-## NixOS Module to JSON Schema Converter
-
-To enable the development of responsive frontends, our library allows the extraction of interfaces from NixOS modules to JSON schemas. Open-sourced for community collaboration, this library supports building sophisticated user interfaces for NixOS.
-
-Here’s a preview of our library's functions exposed through the [clan-core](https://git.clan.lol/clan/clan-core) flake:
-
- `lib.jsonschema.parseModule` - Generates a schema for a NixOS module.
- `lib.jsonschema.parseOption` - Generates a schema for a single NixOS option.
- `lib.jsonschema.parseOptions` - Generates a schema from an attrset of NixOS options.
-
-Example:
-`module.nix`:
-```nix
-{lib, config, pkgs, ...}: {
-  # a simple service with two options
-  options.services.example-web-service = {
-    enable = lib.mkEnableOption "Example web service";
-    port = lib.mkOption {
-      type = lib.types.int;
-      description = "Port used to serve the content";
-    };
-  };
-}
-```
-
-Converted, using the `parseModule` function:
-```shell
-$ cd clan-core
-$ nix eval --json --impure --expr \
-  '(import ./lib/jsonschema {}).parseModule ./module.nix' | jq | head
-{
-  "properties": {
-    "services": {
-      "properties": {
-        "example-web-service": {
-          "properties": {
-            "enable": {
-              "default": false,
-              "description": "Whether to enable Example web service.",
-              "examples": [
-...
-```
-
-This utility can also generate interfaces for existing NixOS modules or options.
-
-## GUI for NGINX in Under a Minute
-
-Creating a prototype GUI for the NGINX module using our library and [react-jsonschema-form playground](https://rjsf-team.github.io/react-jsonschema-form/) can be done quickly:
-
-1. Export all NGINX options into a JSON schema using a Nix expression:
-
-```nix
-# export.nix
-let
-  pkgs = import <nixpkgs> {};
-  clan-core = builtins.getFlake "git+https://git.clan.lol/clan/clan-core";
-  options = (pkgs.nixos {}).options.services.nginx;
-in
-  clan-core.lib.jsonschema.parseOption options
-```
-
-2. Write the schema into a file:
-```shell
-$ nix eval --json -f ./export.nix | jq > nginx.json
-```
-
-3. Open the [react-jsonschema-form playground](https://rjsf-team.github.io/react-jsonschema-form/), select `Blank` and paste the `nginx.json` contents.
-
-This provides a quick look at a potential GUI (screenshot is cropped).
-
-![Image title](https://clan.lol/static/blog-post-jsonschema/nginx-gui.jpg)
-
-## Limitations
-
-### Laziness
-
-JSON schema mandates the declaration of all required fields upfront, which might be configured implicitly or remain unused. For instance, `services.nginx.virtualHosts.<name>.sslCertificate` must be specified even if SSL isn’t enabled.
-
-### Limited Types
-
-Certain NixOS module types, like `types.functionTo` and `types.package`, do not map straightforwardly to JSON. For full compatibility, adjustments to NixOS modules might be necessary, such as substituting `listOf package` with `listOf str`.
-
-### Parsing NixOS Modules
-
-Currently, our converter relies on the `options` attribute of evaluated NixOS modules, extracting information from the `type.name` attribute, which is suboptimal. Enhanced introspection capabilities within the NixOS module system would be beneficial.
-
-## Future Prospects
-
-We hope these experiments inspire the community, encourage contributions and further development in this space. Share your ideas and contributions through our issue tracker or matrix channel!
-
-## Links
-
- [Comments on NixOS Discourse](https://discourse.nixos.org/t/introducing-the-nixos-to-json-schema-converter/45948)
- [Source Code of the JSON Schema Library](https://git.clan.lol/clan/clan-core/src/branch/main/lib/jsonschema)
- [Our Issue Tracker](https://git.clan.lol/clan/clan-core/issues)
- [Our Matrix Channel](https://matrix.to/#/#clan:lassul.us)
- [react-jsonschema-form Playground](https://rjsf-team.github.io/react-jsonschema-form/)
--- a/docs/site/blog/posts/new-docs.md
+++ b/docs/site/blog/posts/new-docs.md
@@ -1,13 +0,0 @@
---
-title: "New documentation site and weekly new meetup"
-authors:
-  - Lassulus
-  - Mic92
-date: 2024-04-16
---
-
-Last week, we added a new documentation hub for clan at [docs.clan.lol](https://docs.clan.lol).
-We are still working on improving the installation procedures, so stay tuned.
-We now have weekly office hours where people are invited to hangout and ask questions.
-They are every Wednesday 15:30 UTC (17:30 CEST) in our [jitsi](https://jitsi.lassul.us/clan.lol).
-Otherwise drop by in our [matrix channel](https://matrix.to/#/#clan:lassul.us).
--- a/docs/site/drafts/deployment-framework.md
+++ b/docs/site/drafts/deployment-framework.md
@@ -1,63 +0,0 @@
---
-title: "Git Based Machine Deployment with Clan-Core"
-description: ""
-authors:
-  - Qubasa
-date: 2024-05-25
---
-## Revolutionizing Server Management
-
-In the world of server management, countless tools claim to offer seamless deployment of multiple machines. Yet, many fall short, leaving server admins and self-hosting enthusiasts grappling with complexity. Enter the Clan-Core Framework—a groundbreaking all in one solution designed to transform decentralized self-hosting into an effortless and scalable endeavor.
-
-### The Power of Clan-Core
-
-Imagine having the power to manage your servers with unparalleled ease, scaling your IT infrastructure like never before. Clan-Core empowers you to do just that. At its core, Clan-Core leverages a single Git repository to define everything about your machines. This central repository utilizes Nix or JSON files to specify configurations, including disk formatting, ensuring a streamlined and unified approach.
-
-### Simplified Deployment Process
-
-With Clan-Core, the cumbersome task of bootstrapping a specific ISO is a thing of the past. All you need is SSH access to your Linux server. Clan-Core allows you to overwrite any existing Linux distribution live over SSH, eliminating time-consuming setup processes. This capability means you can deploy updates or new configurations swiftly and efficiently, maximizing uptime and minimizing hassle.
-
-### Secure and Efficient Secret Management
-
-Security is paramount in server management, and Clan-Core takes it seriously. Passwords and other sensitive information are encrypted within the Git repository, automatically decrypted during deployment. This not only ensures the safety of your secrets but also simplifies their management. Clan-Core supports sharing secrets with other admins, fostering collaboration and maintaining reproducibillity and security without sacrificing convenience.
-
-### Services as Apps
-
-Setting up a service can be quite difficult. Many server adjustments need to be made, from setting up a database to adjusting webserver configurations and generating the correct private keys. However, Clan-Core aims to make setting up a service as easy as installing an application. Through Clan-Core's Module system, everything down to secrets can be automatically set up. This transforms the often daunting task of service setup into a smooth, automated process, making it accessible to all.
-
-### Decentralized Mesh VPN
-
-Building on these features is a self-configuring decentralized mesh VPN that interconnects all your machines into a private darknet. This ensures that sensitive services, which might have too much attack surface to be hosted on the public internet, can still be made available privately without the need to worry about potential system compromise. By creating a secure, private network, Clan-Core offers an additional layer of protection for your most critical services.
-
-### Decentralized Domain Name System
-
-Current DNS implementations are distributed but not truly decentralized. For Clan-Core, we implemented our own truly decentralized DNS module. This module uses simple flooding and caching algorithms to discover available domains inside the darknet. This approach ensures that your internal domain name system is robust, reliable, and independent of external control, enhancing the resilience and security of your infrastructure.
-
-
-### A New Era of Decentralized Self-Hosting
-
-Clan-Core is more than just a tool; it's a paradigm shift in server management. By consolidating machine definitions, secrets and network configuration, into a single, secure repository, it transforms how you manage and scale your infrastructure. Whether you're a seasoned server admin or a self-hosting enthusiast, Clan-Core offers a powerful, user-friendly solution to take your capabilities to the next level.
-
-
-### Key Features of Clan-Core:
-
- **Unified Git Repository**: All machine configurations and secrets stored in a single repository.
- **Live Overwrites**: Deploy configurations over existing Linux distributions via SSH.
- **Automated Service Setup**: Easily set up services with Clan-Core's Module system.
- **Decentralized Mesh VPN**: Securely interconnect all machines into a private darknet.
- **Decentralized DNS**: Robust, independent DNS using flooding and caching algorithms.
- **Automated Secret Management**: Encrypted secrets that are automatically decrypted during deployment.
- **Collaboration Support**: Share secrets securely with other admins.
-
-
-## Clan-Cores Future
-
-Our vision for Clan-Core extends far beyond being just another deployment tool. Clan-Core is a framework we've developed to achieve something much greater. We want to put the "personal" back into "personal computing." Our goal is for everyday users to fully customize their phones or laptops and create truly private spaces for friends and family.
-
-Our first major step is to develop a Graphical User Interface (GUI) that makes configuring all this possible. Initial tests have shown that AI can be leveraged as an alternative to traditional GUIs. This paves the way for a future where people can simply talk to their computers, and they will configure themselves according to the users' wishes. 
-
-By adopting Clan, you're not just embracing a tool—you're joining a movement towards a more efficient, secure, and scalable approach to server management. Join us and revolutionize your IT infrastructure today.
-
-
-
-
--- a/docs/site/getting-started/configure.md
+++ b/docs/site/getting-started/configure.md
@@ -5,6 +5,10 @@
 In the `flake.nix` file:

 - [x] set a unique `clanName`.
+- [ ] set `clanIcon` (optional)
+- [ ] Set `machineIcon` per machine (optional)
+
+These icons will be used by our future GUI.

 === "**buildClan**"

@@ -12,12 +16,16 @@ In the `flake.nix` file:
    buildClan {
        # Set a unique name 
        clanName = "Lobsters";
+        # Optional, a path to an image file
+        clanIcon = ./path/to/file; 
        # Should usually point to the directory of flake.nix
        directory = ./.;

        machines = {
            jon = {
                # ...
+                # Optional, a path to an image file
+                clanCore.machineIcon = ./path/to/file; 
            };
            # ...
        }
@@ -32,10 +40,14 @@ In the `flake.nix` file:
    clan = {
        # Set a unique name 
        clanName = "Lobsters";
+        # Optional, a path to an image file
+        clanIcon = ./path/to/file;

        machines = {
            jon = {
                # ...
+                # Optional, a path to an image file
+                clanCore.machineIcon = ./path/to/file; 
            };
            # ...
        }
@@ -51,15 +63,12 @@ Adding or configuring a new machine requires two simple steps:
 1. Find the remote disk id by executing:

    ```bash title="setup computer"
-    ssh root@flash-installer.local lsblk --output NAME,ID-LINK,FSTYPE,SIZE,MOUNTPOINT
+    ssh root@<target-computer> lsblk --output NAME,ID-LINK,FSTYPE,SIZE,MOUNTPOINT
    ```

-    !!! Note
-        Replace `flash-installer.local` with the IP address of the machine if you don't have the avahi service running which resolves mDNS local domains.
-
    Which should show something like:

-    ```{.shellSession hl_lines="6" .no-copy}
+    ```bash
    NAME        ID-LINK                                         FSTYPE   SIZE MOUNTPOINT
    sda         usb-ST_16GB_AA6271026J1000000509-0:0                    14.9G 
    ├─sda1      usb-ST_16GB_AA6271026J1000000509-0:0-part1                 1M 
@@ -75,113 +84,76 @@ Adding or configuring a new machine requires two simple steps:

    === "**buildClan**"

-        ```nix title="clan-core.lib.buildClan" hl_lines="18 23"
+        ```nix title="clan-core.lib.buildClan"
        buildClan {
          # ...
          machines = {
            "jon" = {
-              imports = [
-                # ...
-                ./modules/disko.nix
-                ./machines/jon/configuration.nix
-              ];
              # ...

              # Change this to the correct ip-address or hostname
              # The hostname is the machine name by default
-              clan.networking.targetHost = pkgs.lib.mkDefault "root@jon"
-
+              clan.networking.targetHost = pkgs.lib.mkDefault "root@<hostname>"
+              
              # Change this to the ID-LINK of the desired disk shown by 'lsblk'
-              disko.devices.disk.main = {
+              clan.diskLayouts.singleDiskExt4 = {
                device = "/dev/disk/by-id/__CHANGE_ME__";
              }

-              # e.g. > cat ~/.ssh/id_ed25519.pub
-              users.users.root.openssh.authorizedKeys.keys = [
-                  "<YOUR SSH_KEY>"
-              ];
              # ...
            };
-          };
+          };     
        }
        ```

    === "**flakeParts**"

-        ```nix title="clan-core.flakeModules.default" hl_lines="18 23"
+
+
+        ```nix title="clan-core.flakeModules.default"
        clan = {
          # ...
          machines = {
            "jon" = {
-              imports = [
-                # ...
-                ./modules/disko.nix
-                ./machines/jon/configuration.nix
-              ];
              # ...

              # Change this to the correct ip-address or hostname
              # The hostname is the machine name by default
-              clan.networking.targetHost = pkgs.lib.mkDefault "root@jon"
-
+              clan.networking.targetHost = pkgs.lib.mkDefault "root@<hostname>"
+              
              # Change this to the ID-LINK of the desired disk shown by 'lsblk'
-              disko.devices.disk.main = {
+              clan.diskLayouts.singleDiskExt4 = {
                device = "/dev/disk/by-id/__CHANGE_ME__";
              }

-              # e.g. > cat ~/.ssh/id_ed25519.pub
-              users.users.root.openssh.authorizedKeys.keys = [
-                  "__YOUR_SSH_KEY__"
-              ];
              # ...
            };
-          };
+          };     
        };
        ```

+### Step 2. Detect hardware specific drivers

-!!! Info "Replace `__CHANGE_ME__` with the appropriate identifier, such as `nvme-eui.e8238fa6bf530001001b448b4aec2929`"
-!!! Info "Replace `__YOUR_SSH_KEY__` with your personal key, like `ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILoMI0NC5eT9pHlQExrvR5ASV3iW9+BXwhfchq0smXUJ jon@jon-desktop`"
+1. Generate a `hardware-configuration.nix` for your target computer

-These steps will allow you to update your machine later.
+    ```bash
+    ssh root@<target-computer> nixos-generate-config --no-filesystems --show-hardware-config > hardware-configuration.nix
+    ```

-### Step 2: Detect Drivers
+2. Move the generated file to `machines/jon/hardware-configuration.nix`.

-Generate the `hardware-configuration.nix` file for your machine by executing the following command:
+### Initialize the facts

-```bash
-ssh root@flash-installer.local nixos-generate-config --no-filesystems --show-hardware-config > machines/jon/hardware-configuration.nix
-```
-
-This command connects to `flash-installer.local` as `root`, runs `nixos-generate-config` to detect hardware configurations (excluding filesystems), and writes them to `machines/jon/hardware-configuration.nix`.
-
-### Step 3: Custom Disk Formatting
-
-In `./modules/disko.nix`, a simple `ext4` disk partitioning scheme is defined for the Disko module. For more complex disk partitioning setups, refer to the [Disko examples](https://github.com/nix-community/disko/tree/master/example).
-
-### Step 4: Custom Configuration
-
-Modify `./machines/jon/configuration.nix` to personalize the system settings according to your requirements.
-
-### Step 5: Check Configuration
-
-Validate your configuration by running:
-
-```bash
-nix flake check
-```
-
-This command helps ensure that your system configuration is correct and free from errors.
-
-!!! Note
-
-    Integrate this step into your [Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration) workflow to ensure that only valid Nix configurations are merged into your codebase. This practice helps maintain system stability and reduces integration issues.
+!!! Info
+    **All facts are automatically initialized.**

+If you need additional help see our [facts chapter](./secrets.md)

 ---

 ## Whats next?

- [Secrets & Facts](secrets.md): Setting up secrets with nix-sops
+- [Deploying](machines.md): Deploying a Machine configuration
+- [Secrets](secrets.md): Learn about secrets and facts

 ---
--- a/docs/site/getting-started/deploy.md
+++ b/docs/site/getting-started/deploy.md
@@ -1,231 +0,0 @@
-# Deploy Machine
-
-Integrating a new machine into your Clan environment is an easy yet flexible process, allowing for a straight forward management of multiple NixOS configurations.
-
-We'll walk you through adding a new computer to your Clan.
-
-## Installing a New Machine
-
-Clan CLI, in conjunction with [nixos-anywhere](https://github.com/nix-community/nixos-anywhere), provides a seamless method for installing NixOS on various machines.
-
-This process involves preparing a suitable hardware and disk partitioning configuration and ensuring the target machine is accessible via SSH.
-
-### Step 0. Prerequisites
-
-=== "**Physical Hardware**"
-
-    - [x] **Two Computers**: You need one computer that you're getting ready (we'll call this the Target Computer) and another one to set it up from (we'll call this the Setup Computer). Make sure both can talk to each other over the network using SSH.
-    - [x] **Machine configuration**: See our basic [configuration guide](./configure.md)
-    - [x] **Initialized secrets**: See [secrets](secrets.md) for how to initialize your secrets.
-    - [x] **USB Flash Drive**: See [Clan Installer](installer.md)
-
-    !!! Steps
-
-        1. Create a NixOS installer image and transfer it to a bootable USB drive as described in the [installer](./installer.md).
-
-        2. Boot the target machine and connect it to a network that makes it reachable from your setup computer.
-
-=== "**Remote Machines**"
-
-    - [x] **Two Computers**: You need one computer that you're getting ready (we'll call this the Target Computer) and another one to set it up from (we'll call this the Setup Computer). Make sure both can talk to each other over the network using SSH.
-    - [x] **Machine configuration**: See our basic [configuration guide](./configure.md)
-    - [x] **Initialized secrets**: See [secrets](secrets.md) for how to initialize your secrets.
-
-    !!! Steps
-
-        - Any cloud machine if it is reachable via SSH and supports `kexec`.
-
-
-### Step 1. Deploy the machine
-
-**Finally deployment time!** Use the following command to build and deploy the image via SSH onto your machine.
-
-
-=== "**Image Installer**"
-
-    This method makes use of the image installers of [nixos-images](https://github.com/nix-community/nixos-images).
-    See how to prepare the installer for use [here](./installer.md).
-
-    The installer will randomly generate a password and local addresses on boot, then run ssh with these preconfigured.
-    The installer shows it's deployment relevant information in two formats, a text form, as well as a QR code.
-
-
-    This is an example of the booted installer.
-
-    ```{ .bash .annotate .no-copy .nohighlight}
-    ┌─────────────────────────────────────────────────────────────────────────────────────┐
-    │ ┌───────────────────────────┐                                                       │
-    │ │███████████████████████████│ # This is the QR Code (1)                             │
-    │ │██ ▄▄▄▄▄ █▀▄█▀█▀▄█ ▄▄▄▄▄ ██│                                                       │
-    │ │██ █   █ █▀▄▄▄█ ▀█ █   █ ██│                                                       │
-    │ │██ █▄▄▄█ █▀▄ ▀▄▄▄█ █▄▄▄█ ██│                                                       │
-    │ │██▄▄▄▄▄▄▄█▄▀ ▀▄▀▄█▄▄▄▄▄▄▄██│                                                       │
-    │ │███▀▀▀ █▄▄█ ▀▄   ▄▀▄█   ███│                                                       │
-    │ │██▄██▄▄█▄▄▀▀██▄▀ ▄▄▄ ▄▀█▀██│                                                       │
-    │ │██ ▄▄▄▄▄ █▄▄▄▄ █ █▄█ █▀ ███│                                                       │
-    │ │██ █   █ █ █  █ ▄▄▄  ▄▀▀ ██│                                                       │
-    │ │██ █▄▄▄█ █ ▄ ▄    ▄ ▀█ ▄███│                                                       │
-    │ │██▄▄▄▄▄▄▄█▄▄▄▄▄▄█▄▄▄▄▄█▄███│                                                       │
-    │ │███████████████████████████│                                                       │
-    │ └───────────────────────────┘                                                       │
-    │ ┌─────────────────────────────────────────────────────────────────────────────────┐ │
-    │ │Root password: cheesy-capital-unwell  # password (2)                             │ │
-    │ │Local network addresses:                                                         │ │
-    │ │enp1s0           UP    192.168.178.169/24 metric 1024 fe80::21e:6ff:fe45:3c92/64 │ │
-    │ │enp2s0           DOWN                                                            │ │
-    │ │wlan0            DOWN # connect to wlan (3)                                      │ │
-    │ │Onion address: 6evxy5yhzytwpnhc2vpscrbti3iktxdhpnf6yim6bbs25p4v6beemzyd.onion    │ │
-    │ │Multicast DNS: nixos-installer.local                                             │ │
-    │ └─────────────────────────────────────────────────────────────────────────────────┘ │
-    │ Press 'Ctrl-C' for console access                                                   │ 
-    │                                                                                     │
-    └─────────────────────────────────────────────────────────────────────────────────────┘
-    ```
-
-    1.  This is not an actual QR code, because it is displayed rather poorly on text sites.
-        This would be the actual content of this specific QR code prettified:
-        ```json
-        {
-            "pass": "cheesy-capital-unwell",
-            "tor": "6evxy5yhzytwpnhc2vpscrbti3iktxdhpnf6yim6bbs25p4v6beemzyd.onion",
-            "addrs": [
-            "2001:9e8:347:ca00:21e:6ff:fe45:3c92"
-            ]
-        }
-        ```
-
-        To generate the actual QR code, that would be displayed use:
-        ```shellSession
-        echo '{"pass":"cheesy-capital-unwell","tor":"6evxy5yhzytwpnhc2vpscrbti3iktxdhpnf6yim6bbs25p4v6beemzyd.onion","addrs":["2001:9e8:347:ca00:21e:6ff:fe45:3c92"]}' | nix run nixpkgs#qrencode -- -s 2 -m 2 -t utf8
-        ```
-    2.  The root password for the installer medium.
-        This password is autogenerated and meant to be easily typeable.
-    3.  See how to connect the installer medium to wlan [here](./installer.md#optional-connect-to-wifi).
-    4.  :man_raising_hand: I'm a code annotation! I can contain `code`, __formatted
-        text__, images, ... basically anything that can be written in Markdown.
-
-    !!!tip
-        For easy sharing of deployment information via QR code, we highly recommend using [KDE Connect](https://apps.kde.org/de/kdeconnect/).
-
-    There are two ways to deploy your machine:
-
-    1. **SSH with Password Authentication**
-        Run the following command to install using SSH:
-        ```bash
-        clan machines install [MACHINE] flash-installer.local
-        ```
-
-    2. **Scanning a QR Code for Installation Details**
-        You can input the information by following one of these methods:
-          - **Using a JSON String or File Path:**
-              Provide the path to a JSON string or input the string directly:
-              ```terminal
-              clan machines install [MACHINE] --json [JSON]
-              ```
-          - **Using an Image Containing the QR Code:**
-              Provide the path to an image file containing the relevant QR code:
-              ```terminal
-              clan machines install [MACHINE] --png [PATH]
-           ```
-
-=== "**SSH access**"
-
-    Replace `<target_host>` with the **target computers' ip address**:
-
-    ```bash
-    clan machines install [MACHINE] <target_host>
-    ```
-
-
-If you are using our template `[MACHINE]` would be `jon`
-
-
-!!! success
-    Your machine is all set up. 🎉 🚀
-
-
-## Update Your Machines
-
-Clan CLI enables you to remotely update your machines over SSH. This requires setting up a target address for each target machine.
-
-### Setting the Target Host
-
-Replace `root@jon` with the actual hostname or IP address of your target machine:
-```{.nix hl_lines="9" .no-copy}
-buildClan {
-    # ...
-    machines = {
-        # "jon" will be the hostname of the machine
-        "jon" = {
-            # Set this for clan commands use ssh i.e. `clan machines update`
-            # If you change the hostname, you need to update this line to root@<new-hostname>
-            # This only works however if you have avahi running on your admin machine else use IP
-            clan.networking.targetHost = pkgs.lib.mkDefault "root@jon";
-        };
-    };
-};
-```
-
-
-!!! warning
-    The use of `root@` in the target address implies SSH access as the `root` user.
-    Ensure that the root login is secured and only used when necessary.
-
-### Updating Machine Configurations
-
-Execute the following command to update the specified machine:
-
-```bash
-clan machines update jon
-```
-
-You can also update all configured machines simultaneously by omitting the machine name:
-
-```bash
-clan machines update
-```
-
-### Setting a Build Host
-
-If the machine does not have enough resources to run the NixOS evaluation or build itself,
-it is also possible to specify a build host instead.
-During an update, the cli will ssh into the build host and run `nixos-rebuild` from there.
-
-
-```{.nix hl_lines="5" .no-copy}
-buildClan {
-    # ...
-    machines = {
-        "jon" = {
-            clan.networking.buildHost = "root@<host_or_ip>";
-        };
-    };
-};
-```
-
-### Excluding a machine from `clan machine update`
-
-To exclude machines from being updated when running `clan machines update` without any machines specified,
-one can set the `clan.deployment.requireExplicitUpdate` option to true:
-
-```{.nix hl_lines="5" .no-copy}
-buildClan {
-    # ...
-    machines = {
-        "jon" = {
-            clan.deployment.requireExplicitUpdate = true;
-        };
-    };
-};
-```
-
-This is useful for machines that are not always online or are not part of the regular update cycle.
-
---
-
-## What's next ?
-
- [**Mesh VPN**](./mesh-vpn.md): Configuring a secure mesh network.
-
---
-
--- a/docs/site/getting-started/flake-parts.md
+++ b/docs/site/getting-started/flake-parts.md
@@ -69,16 +69,16 @@ Below is a guide on how to structure this in your flake.nix:
          jon = {
            imports = [
              ./machines/jon/configuration.nix
-              ./modules/disko.nix
              # ... more modules
            ];
            nixpkgs.hostPlatform = "x86_64-linux";
+            clanCore.machineIcon = null; # Optional, a path to an image file

            # Set this for clan commands use ssh i.e. `clan machines update`
            clan.networking.targetHost = pkgs.lib.mkDefault "root@jon";

            # remote> lsblk --output NAME,ID-LINK,FSTYPE,SIZE,MOUNTPOINT
-            disko.devices.disk.main = {
+            clan.diskLayouts.singleDiskExt4 = {
              device = "/dev/disk/by-id/nvme-eui.e8238fa6bf530001001b448b4aec2929";
            };

@@ -94,4 +94,9 @@ Below is a guide on how to structure this in your flake.nix:
 For detailed information about configuring `flake-parts` and the available options within Clan,
 refer to the Clan module documentation located [here](https://git.clan.lol/clan/clan-core/src/branch/main/flakeModules/clan.nix).

+## Whats next?
+
+- [Configure Machines](configure.md): Customize machine configuration
+- [Deploying](machines.md): Deploying a Machine configuration
+
 ---
--- a/docs/site/getting-started/installer.md
+++ b/docs/site/getting-started/installer.md
@@ -1,11 +1,10 @@
 # Installer

-Our installer image simplifies the process of performing remote installations.
+We offer a dedicated installer to assist remote installations.

-Follow our step-by-step guide to create and transfer this image onto a bootable USB drive.
+In this tutorial we will guide you through building and flashing it to a bootable USB drive.

-!!! info 
-    If you already have a NixOS machine you can ssh into (in the cloud for example) you can skip this chapter and go directly to [Configure Machines](configure.md).
+## Creating and Using the **Clan Installer**

 ### Step 0. Prerequisites

@@ -22,7 +21,7 @@ Follow our step-by-step guide to create and transfer this image onto a bootable
    lsblk
    ```

-    ```{.shellSession hl_lines="2" .no-copy}
+    ```{.console, .no-copy}
    NAME                                          MAJ:MIN RM   SIZE RO TYPE  MOUNTPOINTS
    sdb                                             8:0    1 117,2G  0 disk
    └─sdb1                                          8:1    1 117,2G  0 part  /run/media/qubasa/INTENSO
@@ -39,44 +38,28 @@ Follow our step-by-step guide to create and transfer this image onto a bootable
 ```shellSession
 sudo umount /dev/sdb1
 ```
-=== "**Linux OS**"
-    ### Step 2. Flash Custom Installer

-    Using clan flash enables the inclusion of ssh public keys and disables ssh password authentication.
-    It also includes the language and keymap currently used into the installer image.
+### Step 2. Download the Installer

-    ```bash
-    clan --flake git+https://git.clan.lol/clan/clan-core flash flash-installer --disk main /dev/sd<X>
-    ```
+```shellSession
+wget https://github.com/nix-community/nixos-images/releases/download/nixos-unstable/nixos-installer-x86_64-linux.iso
+```

-    !!! Danger "Specifying the wrong device can lead to unrecoverable data loss."
+### Step 3. Flash the Installer to the USB Drive

-        The `clan flash` utility will erase the disk. Make sure to specify the correct device
+!!! Danger "Specifying the wrong device can lead to unrecoverable data loss."

+    The `dd` utility will erase the disk. Make sure to specify the correct device (`of=...`)

+    For example if the USB device is `sdb` use `of=/dev/sdb`.

-=== "**Other OS**"
-    ### Step 2. Download Generic Installer
+    

-    ```shellSession
-    wget https://github.com/nix-community/nixos-images/releases/download/nixos-unstable/nixos-installer-x86_64-linux.iso
-    ```
+Use the `dd` utility to write the NixOS installer image to your USB drive:

-    ### Step 3. Flash the Installer to the USB Drive
-
-    !!! Danger "Specifying the wrong device can lead to unrecoverable data loss."
-
-        The `dd` utility will erase the disk. Make sure to specify the correct device (`of=...`)
-
-        For example if the USB device is `sdb` use `of=/dev/sdb`.
-
-
-
-    Use the `dd` utility to write the NixOS installer image to your USB drive:
-
-    ```shellSession
-    sudo dd bs=4M conv=fsync oflag=direct status=progress if=./nixos-installer-x86_64-linux.iso of=/dev/sd<X>
-    ```
+```shellSession
+sudo dd bs=4M conv=fsync oflag=direct status=progress if=./nixos-installer-x86_64-linux.iso of=/dev/sd<X>
+```

 ### Step 4. Boot and Connect to your network

@@ -106,6 +89,17 @@ Select `NixOS` to boot into the clan installer.

 For deploying your configuration the machine needs to be connected via LAN (recommended).

+For connecting via Wifi, please consult the [guide below](#optional-connect-to-wifi).
+
+---
+
+## Whats next?
+
+- [Configure Machines](configure.md): Customize machine configuration
+- [Deploying](machines.md): Deploying a Machine configuration
+- [WiFi](#optional-connect-to-wifi): Guide for connecting to Wifi.
+
+---

 ## (Optional) Connect to Wifi

@@ -123,10 +117,9 @@ This will enter `iwd`

 Now run the following command to connect to your Wifi:

-```{.shellSession .no-copy}
+```shellSession
 # Identify your network device.
 device list
-
 # Replace 'wlan0' with your wireless device name
 # Find your Wifi SSID.
 station wlan0 scan
@@ -148,17 +141,9 @@ Connected network     FRITZ!Box (Your router device)
 IPv4 address          192.168.188.50 (Your new local ip)
 ```

-Press ++ctrl+d++ to exit `IWD`.
+Press `ctrl-d` to exit `IWD`.

 !!! Important
-    Press ++ctrl+d++ **again** to update the displayed QR code and connection information.
+    Press `ctrl-d` **again** to update the displayed QR code and connection information.

 You're all set up
-
---
-
-## Whats next?
-
- [Configure Machines](configure.md): Customize machine configuration
-
---
--- a/docs/site/getting-started/machines.md
+++ b/docs/site/getting-started/machines.md
@@ -0,0 +1,125 @@
+# Deploy Machine
+
+Integrating a new machine into your Clan environment is an easy yet flexible process, allowing for a straight forward management of multiple NixOS configurations.
+
+We'll walk you through adding a new computer to your Clan.
+
+## Installing a New Machine
+
+Clan CLI, in conjunction with [nixos-anywhere](https://github.com/nix-community/nixos-anywhere), provides a seamless method for installing NixOS on various machines.
+
+This process involves preparing a suitable hardware and disk partitioning configuration and ensuring the target machine is accessible via SSH.
+
+### Step 0. Prerequisites
+
+=== "**Physical Hardware**"
+
+    - [x] **Two Computers**: You need one computer that you're getting ready (we'll call this the Target Computer) and another one to set it up from (we'll call this the Setup Computer). Make sure both can talk to each other over the network using SSH.
+    - [x] **Machine configuration**: See our basic [configuration guide](./configure.md)
+    - [x] **Initialized secrets**: See [secrets](secrets.md) for how to initialize your secrets.
+    - [x] **USB Flash Drive**: See [Clan Installer](installer.md)
+
+    !!! Steps
+    
+        1. Create a NixOS installer image and transfer it to a bootable USB drive as described in the [installer](./installer.md).
+         
+        2. Boot the target machine and connect it to a network that makes it reachable from your setup computer.
+
+=== "**Baremetal Machines**"
+
+    - [x] **Two Computers**: You need one computer that you're getting ready (we'll call this the Target Computer) and another one to set it up from (we'll call this the Setup Computer). Make sure both can talk to each other over the network using SSH.
+    - [x] **Machine configuration**: See our basic [configuration guide](./configure.md)
+    - [x] **Initialized secrets**: See [secrets](secrets.md) for how to initialize your secrets.
+
+    !!! Steps
+
+        - Any cloud machine if it is reachable via SSH and supports `kexec`.
+
+Confirm the machine is reachable via SSH from your setup computer.
+
+```bash
+ssh root@<your_target_machine_ip>
+```
+
+### Step 1. Deploy the machine
+
+**Finally deployment time!** Use the following command to build and deploy the image via SSH onto your machine.
+
+Replace `<target_host>` with the **target computers' ip address**:
+
+```bash
+clan machines install my-machine <target_host>
+```
+
+> Note: This may take a while for building and for the file transfer.
+
+!!! success
+
+    Your machine is all set up. 🎉 🚀
+
+---
+
+## What's next ?
+
+- [**Update a Machine**](#update-your-machines): Learn how to update an existing machine?
+- [**Configure a Private Network**](./networking.md): Configuring a secure mesh network.
+
+---
+
+## Update Your Machines
+
+Clan CLI enables you to remotely update your machines over SSH. This requires setting up a target address for each target machine.
+
+### Setting the Target Host
+
+Replace `host_or_ip` with the actual hostname or IP address of your target machine:
+
+```bash
+clan config --machine my-machine clan.networking.targetHost root@host_or_ip
+```
+
+!!! warning
+    The use of `root@` in the target address implies SSH access as the `root` user.
+    Ensure that the root login is secured and only used when necessary.
+
+### Updating Machine Configurations
+
+Execute the following command to update the specified machine:
+
+```bash
+clan machines update my-machine
+```
+
+You can also update all configured machines simultaneously by omitting the machine name:
+
+```bash
+clan machines update
+```
+
+### Setting a Build Host
+
+If the machine does not have enough resources to run the NixOS evaluation or build itself,
+it is also possible to specify a build host instead.
+During an update, the cli will ssh into the build host and run `nixos-rebuild` from there.
+
+```bash
+clan config --machine my-machine clan.networking.buildHost root@host_or_ip
+```
+
+### Excluding a machine from `clan machine update`
+
+To exclude machines from being updated when running `clan machines update` without any machines specified,
+one can set the `clan.deployment.requireExplicitUpdate` option to true:
+
+```bash
+clan config --machine my-machine clan.deployment.requireExplicitUpdate true
+```
+
+This is useful for machines that are not always online or are not part of the regular update cycle.
+
+---
+
+# TODO:
+* TODO: How to join others people zerotier
+  * `services.zerotier.joinNetworks = [ "network-id" ]`
+* Controller needs to approve over webinterface or cli
--- a/docs/site/getting-started/networking.md
+++ b/docs/site/getting-started/networking.md
@@ -1,4 +1,4 @@
-# Mesh VPN
+# Overlay Networks

 This guide provides detailed instructions for configuring
 [ZeroTier VPN](https://zerotier.com) within Clan. Follow the
@@ -9,7 +9,7 @@ include a new machine into the VPN.

 By default all machines within one clan are connected via a chosen network technology.

-```{.no-copy}
+```
 Clan 
    Node A
    <-> (zerotier / mycelium / ...)
@@ -36,7 +36,7 @@ peers. Once addresses are allocated, the controller's continuous operation is no
   ```
 3. **Update the Controller Machine**: Execute the following:
   ```bash
-   clan machines update <CONTROLLER>
+   $ clan machines update <CONTROLLER>
   ```
   Your machine is now operational as the VPN controller.

--- a/docs/site/getting-started/secrets.md
+++ b/docs/site/getting-started/secrets.md
@@ -4,6 +4,9 @@ Clan enables encryption of secrets (such as passwords & keys) ensuring security

 Clan utilizes the [sops](https://github.com/getsops/sops) format and integrates with [sops-nix](https://github.com/Mic92/sops-nix) on NixOS machines.

+This documentation will guide you through managing secrets with the Clan CLI
+
+## Initializing Secrets (Quickstart)

 ### Create Your Master Keypair

@@ -38,7 +41,8 @@ Also add your age public key to the repository with 'clan secrets users add YOUR
 clan secrets users add <your_username> <your_public_key>
 ```

-It's best to choose the same username as on your Setup/Admin Machine that you use to control the deployment with.
+!!! note
+    Choose the same username as on your Setup/Source Machine that you use to control the deployment with.

 Once run this will create the following files:

@@ -48,145 +52,17 @@ sops/
    └── <your_username>/
        └── key.json
 ```
-If you followed the quickstart tutorial all necessary secrets are initialized at this point.

 ---

-## Whats next?
+> If you followed the quickstart tutorial all necessary secrets are initialized at this point.

- [Deployment](deploy.md): How to remotely deploy your machine
+- Continue with [deploying machines](./machines.md)
+- Learn about the [basics concept](#concept) of clan secrets

 ---

-## More on Secrets
-
-If you want to know more about how to save and share passwords in your clan read further!
-
-### Adding a Secret
-
-```shellSession
-clan secrets set mysecret
-Paste your secret:
-```
-
-### Retrieving a Stored Secret
-
-```bash
-clan secrets get mysecret
-```
-
-### List all Secrets
-
-```bash
-clan secrets list
-```
-
-### NixOS integration
-
-A NixOS machine will automatically import all secrets that are encrypted for the
-current machine. At runtime it will use the host key to decrypt all secrets into
-an in-memory, non-persistent filesystem using [sops-nix](https://github.com/Mic92/sops-nix). 
-In your nixos configuration you can get a path to secrets like this `config.sops.secrets.<name>.path`. For example:
-
-```nix
-{ config, ...}: {
-  sops.secrets.my-password.neededForUsers = true;
-
-  users.users.mic92 = {
-    isNormalUser = true;
-    passwordFile = config.sops.secrets.my-password.path;
-  };
-}
-```
-
-### Assigning Access
-
-By default, secrets are encrypted for your key. To specify which users and machines can access a secret:
-
-```bash
-clan secrets set --machine <machine1> --machine <machine2> --user <user1> --user <user2> <secret_name>
-```
-You can also just add machines/users to existing secrets:
-
-```bash
- clan secrets machines add-secret <machine_name> <secret_name>
-```
-
-## Advanced
-
-In this section we go into more advanced secret management topics.
-
-### Groups
-
-Clan CLI makes it easy to manage access by allowing you to create groups.
-
-All users within a group inherit access to all secrets of the group.
-
-This feature eases the process of handling permissions for multiple users.
-
-Here's how to get started:
-
-1. **Creating Groups**:
-
-   Assign users to a new group, e.g., `admins`:
-
-   ```bash
-   clan secrets groups add admins <username>
-   ```
-
-2. **Listing Groups**:
-
-   ```bash
-   clan secrets groups list
-   ```
-
-3. **Assigning Secrets to Groups**:
-
-   ```bash
-   clan secrets groups add-secret <group_name> <secret_name>
-   ```
-
-### Adding Machine Keys
-
-New machines in Clan come with age keys stored in `./sops/machines/<machine_name>`. To list these machines:
-
-```bash
- clan secrets machines list
-```
-
-For existing machines, add their keys:
-
-```bash
- clan secrets machines add <machine_name> <age_key>
-```
-
-To fetch an age key from an SSH host key:
-
-```bash
- ssh-keyscan <domain_name> | nix shell nixpkgs#ssh-to-age -c ssh-to-age
-```
-
-### Migration: Importing existing sops-based keys / sops-nix
-
-`clan secrets` stores each secret in a single file, whereas [sops](https://github.com/Mic92/sops-nix) commonly allows to put all secrets in a yaml or json document.
-
-If you already happened to use sops-nix, you can migrate by using the `clan secrets import-sops` command by importing these files:
-
-```bash
-% clan secrets import-sops --prefix matchbox- --group admins --machine matchbox nixos/matchbox/secrets/secrets.yaml
-```
-
-This will create secrets for each secret found in `nixos/matchbox/secrets/secrets.yaml` in a `./sops` folder of your repository.
-Each member of the group `admins` in this case will be able to decrypt the secrets with their respective key.
-
-Since our clan secret module will auto-import secrets that are encrypted for a particular nixos machine,
-you can now remove `sops.secrets.<secrets> = { };` unless you need to specify more options for the secret like owner/group of the secret file.
-
-
-
-## Indepth Explanation
-
-
+## Concept

 The secrets system conceptually knows two different entities:

@@ -242,6 +118,9 @@ Rel_R(secret, machine, "Decrypt", "", "machine privkey" )
@enduml
 ```

+### Groups
+
+It is possible to create semantic groups to make access control more convenient.

 #### User groups

@@ -303,16 +182,146 @@ Rel(secret, c1, "Decrypt", "", "Both machine A or B can decrypt using their priv

 <!-- TODO: See also [Groups Reference](#groups-reference) -->

+---

+## 2. Adding Machine Keys
+
+New machines in Clan come with age keys stored in `./sops/machines/<machine_name>`. To list these machines:
+
+```bash
+$ clan secrets machines list
+```
+
+For existing machines, add their keys:
+
+```bash
+$ clan secrets machines add <machine_name> <age_key>
+```
+
+### Advanced
+
+To fetch an age key from an SSH host key:
+
+```bash
+$ ssh-keyscan <domain_name> | nix shell nixpkgs#ssh-to-age -c ssh-to-age
+```
+
+## 3. Assigning Access
+
+By default, secrets are encrypted for your key. To specify which users and machines can access a secret:
+
+```bash
+$ clan secrets set --machine <machine1> --machine <machine2> --user <user1> --user <user2> <secret_name>
+```
+
+You can add machines/users to existing secrets without modifying the secret:
+
+```bash
+$ clan secrets machines add-secret <machine_name> <secret_name>
+```
+
+## 4. Adding Secrets
+
+```bash
+$ clan secrets set mysecret
+Paste your secret: 
+```
+
+!!! note 
+    As you type your secret won't be displayed. Press Enter to save the secret.
+
+## 5. Retrieving Stored Secrets
+
+```bash
+$ clan secrets get mysecret
+```
+
+### List all Secrets
+
+```bash
+$ clan secrets list
+```
+
+## 6. Groups
+
+Clan CLI makes it easy to manage access by allowing you to create groups.
+
+All users within a group inherit access to all secrets of the group.
+
+This feature eases the process of handling permissions for multiple users.
+
+Here's how to get started:
+
+1. **Creating Groups**:
+
+   Assign users to a new group, e.g., `admins`:
+
+   ```bash
+   $ clan secrets groups add admins <username>
+   ```
+
+2. **Listing Groups**:
+
+   ```bash
+   $ clan secrets groups list
+   ```
+
+3. **Assigning Secrets to Groups**:
+
+   ```bash
+   $ clan secrets groups add-secret <group_name> <secret_name>
+   ```
+
+## Further
+
+Secrets in the repository follow this structure:
+
+```{.console, .no-copy}
+sops/
+├── secrets/
+│   └── <secret_name>/
+│       ├── secret
+│       └── users/
+│           └── <your_username>/
+```
+
+The content of the secret is stored encrypted inside the `secret` file under `mysecret`.
+
+By default, secrets are encrypted with your key to ensure readability.
+
+### NixOS integration
+
+A NixOS machine will automatically import all secrets that are encrypted for the
+current machine. At runtime it will use the host key to decrypt all secrets into
+an in-memory, non-persistent filesystem using [sops-nix](https://github.com/Mic92/sops-nix). 
+In your nixos configuration you can get a path to secrets like this `config.sops.secrets.<name>.path`. For example:
+
+```nix
+{ config, ...}: {
+  sops.secrets.my-password.neededForUsers = true;
+
+  users.users.mic92 = {
+    isNormalUser = true;
+    passwordFile = config.sops.secrets.my-password.path;
+  };
+}
+```

 See the [readme](https://github.com/Mic92/sops-nix) of sops-nix for more
 examples.

+### Migration: Importing existing sops-based keys / sops-nix

---
+`clan secrets` stores each secret in a single file, whereas [sops](https://github.com/Mic92/sops-nix) commonly allows to put all secrets in a yaml or json document.

-## Whats next?
+If you already happened to use sops-nix, you can migrate by using the `clan secrets import-sops` command by importing these files:

- [Deployment](deploy.md): How to remotely deploy your machine
+```bash
+% clan secrets import-sops --prefix matchbox- --group admins --machine matchbox nixos/matchbox/secrets/secrets.yaml
+```

---
+This will create secrets for each secret found in `nixos/matchbox/secrets/secrets.yaml` in a `./sops` folder of your repository.
+Each member of the group `admins` in this case will be able to decrypt the secrets with their respective key.
+
+Since our clan secret module will auto-import secrets that are encrypted for a particular nixos machine,
+you can now remove `sops.secrets.<secrets> = { };` unless you need to specify more options for the secret like owner/group of the secret file.
--- a/docs/site/index.md
+++ b/docs/site/index.md
@@ -1,31 +1,44 @@
-# Setup
+# Getting Started

-Create your own clan with these initial steps and manage a fleet of machines with one single testable git repository!
+Welcome to your simple guide on starting a new Clan project.
+
+## What's Inside
+
+We've put together a straightforward guide to help you out:
+
+- [**Starting with a New Clan Project**](#starting-with-a-new-clan-project): Create a new Clan from scratch.
+- [**Integrating Clan using Flake-Parts**](getting-started/flake-parts.md)
+
+---
+
+## **Starting with a New Clan Project**
+
+Create your own clan with these initial steps.

 ### Prerequisites

-=== "**Linux**"
+#### Linux

-    Clan depends on nix installed on your system. Run the following command to install nix.
+Clan depends on nix installed on your system. Run the following command to install nix.

-    ```bash
-    curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
-    ```
+```bash
+curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
+```

-=== "**NixOS**"
+#### NixOS

-    If you run NixOS the `nix` binary is already installed.
+If you run NixOS the `nix` binary is already installed.

-    You will also need to enable the `flakes` and `nix-commands` experimental features.
+You will also need to enable the `flakes` and `nix-commands` experimental features.

-    ```bash
-    # /etc/nix/nix.conf or ~/.config/nix/nix.conf
-    experimental-features = nix-command flakes
-    ```
+```bash
+# /etc/nix/nix.conf or ~/.config/nix/nix.conf
+experimental-features = nix-command flakes
+```

-=== "**Other**"
+#### Other

-    Clan doesn't offer dedicated support for other operating systems yet.
+Clan doesn't offer dedicated support for other operating systems yet.

 ### Step 1: Add Clan CLI to Your Shell

@@ -35,13 +48,6 @@ Add the Clan CLI into your development workflow:
 nix shell git+https://git.clan.lol/clan/clan-core#clan-cli
 ```

-You can find reference documentation for the `clan` cli program [here](./reference/cli/index.md).
-
-Alternatively you can check out the help pages directly:
-```terminalSession
-clan --help
-```
-
 ### Step 2: Initialize Your Project

 Set the foundation of your Clan project by initializing it as follows:
@@ -51,7 +57,6 @@ clan flakes create my-clan
 ```

 This command creates the `flake.nix` and `.clan-flake` files for your project.
-It will also generate files from a default template, to help show general clan usage patterns.

 ### Step 3: Verify the Project Structure

@@ -97,6 +102,12 @@ sara

 ### What's Next?

+- [**Machine Configuration**](getting-started/configure.md): Declare behavior and configuration of machines.
+
+- [**Deploy Machines**](getting-started/machines.md): Learn how to deploy to any remote machine.
+
 - [**Installer**](getting-started/installer.md): Setting up new computers remotely is easy with an USB stick.

+- [**Check out our Templates**](templates/index.md)
+
 ---
--- a/docs/site/static/asciinema-player/asciinema-player.css
+++ b/docs/site/static/asciinema-player/asciinema-player.css
@@ -1 +0,0 @@
-/nix/store/8y5h98wk5p94mv1wyb2c4gkrr7bswd19-asciinema-player.css
--- a/docs/site/static/asciinema-player/asciinema-player.min.js
+++ b/docs/site/static/asciinema-player/asciinema-player.min.js
@@ -1 +0,0 @@
-/nix/store/w0i3f9qzn9n6jmfnfgiw5wnab2f9ssdw-asciinema-player.min.js
--- a/docs/site/static/logo.png
+++ b/docs/site/static/logo.png
--- a/docs/site/templates/index.md
+++ b/docs/site/templates/index.md
@@ -0,0 +1,24 @@
+# Templates
+
+We provide some starting templates you can easily use one of those via `nix flakes`.
+
+They showcase best practices and guide you through setting up and using Clan's modules
+
+I.e. To use the `new-clan` template run the following command:
+
+```bash
+nix flake init -t git+https://git.clan.lol/clan/clan-core#new-clan
+```
+
+## Available Templates
+
+We offer the following templates:
+
+To initialize a clan with one of those run:
+```bash
+nix flake init -t git+https://git.clan.lol/clan/clan-core#[TEMPLATE_NAME]
+```
+
+Substitute `[TEMPLATE_NAME]` with the name of the template.
+
+- **new-clan**:  Perfect for beginners, this template shows you how to link two machines in a basic setup.
--- a/flake.lock
+++ b/flake.lock
@@ -7,11 +7,11 @@
        ]
      },
      "locked": {
-        "lastModified": 1716394172,
-        "narHash": "sha256-B+pNhV8GFeCj9/MoH+qtGqKbgv6fU4hGaw2+NoYYtB0=",
+        "lastModified": 1712356478,
+        "narHash": "sha256-kTcEtrQIRnexu5lAbLsmUcfR2CrmsACF1s3ZFw1NEVA=",
        "owner": "nix-community",
        "repo": "disko",
-        "rev": "23c63fb09334c3e8958b57e2ddc3870b75b9111d",
+        "rev": "0a17298c0d96190ef3be729d594ba202b9c53beb",
        "type": "github"
      },
      "original": {
@@ -27,11 +27,11 @@
        ]
      },
      "locked": {
-        "lastModified": 1715865404,
-        "narHash": "sha256-/GJvTdTpuDjNn84j82cU6bXztE0MSkdnTWClUCRub78=",
+        "lastModified": 1712014858,
+        "narHash": "sha256-sB4SWl2lX95bExY2gMFG5HIzvva5AVMJd4Igm+GpZNw=",
        "owner": "hercules-ci",
        "repo": "flake-parts",
-        "rev": "8dc45382d5206bd292f9c2768b8058a8fd8311d9",
+        "rev": "9126214d0a59633752a136528f5f3b9aa8565b7d",
        "type": "github"
      },
      "original": {
@@ -40,29 +40,13 @@
        "type": "github"
      }
    },
-    "git-hooks": {
-      "flake": false,
-      "locked": {
-        "lastModified": 1716413087,
-        "narHash": "sha256-nSTIB7JeJGBGsvtqlyfhUByh/isyK1nfOq2YMxUOFJQ=",
-        "owner": "fricklerhandwerk",
-        "repo": "git-hooks",
-        "rev": "99a78fcf7dc03ba7b1d5c00af109c1e28ced3490",
-        "type": "github"
-      },
-      "original": {
-        "owner": "fricklerhandwerk",
-        "repo": "git-hooks",
-        "type": "github"
-      }
-    },
    "nixlib": {
      "locked": {
-        "lastModified": 1712450863,
-        "narHash": "sha256-K6IkdtMtq9xktmYPj0uaYc8NsIqHuaAoRBaMgu9Fvrw=",
+        "lastModified": 1711846064,
+        "narHash": "sha256-cqfX0QJNEnge3a77VnytM0Q6QZZ0DziFXt6tSCV8ZSc=",
        "owner": "nix-community",
        "repo": "nixpkgs.lib",
-        "rev": "3c62b6a12571c9a7f65ab037173ee153d539905f",
+        "rev": "90b1a963ff84dc532db92f678296ff2499a60a87",
        "type": "github"
      },
      "original": {
@@ -71,22 +55,6 @@
        "type": "github"
      }
    },
-    "nixos-2311": {
-      "locked": {
-        "lastModified": 1715818734,
-        "narHash": "sha256-WvAJWCwPj/6quKcsgsvQYyZRxV8ho/yUzj0HZQ34DVU=",
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "95742536dc6debb5a8b8b78b27001c38f369f1e7",
-        "type": "github"
-      },
-      "original": {
-        "owner": "NixOS",
-        "ref": "release-23.11",
-        "repo": "nixpkgs",
-        "type": "github"
-      }
-    },
    "nixos-generators": {
      "inputs": {
        "nixlib": "nixlib",
@@ -95,11 +63,11 @@
        ]
      },
      "locked": {
-        "lastModified": 1716123454,
-        "narHash": "sha256-U2o4UPM/UsEyIX2p11+YEQgR9HY3PmjZ2mRl/x5e4xo=",
+        "lastModified": 1712191720,
+        "narHash": "sha256-xXtSSnVHURHsxLQO30dzCKW5NJVGV/umdQPmFjPFMVA=",
        "owner": "nix-community",
        "repo": "nixos-generators",
-        "rev": "a63e0c83dd83fe28cc571b97129e13373436bd82",
+        "rev": "0c15e76bed5432d7775a22e8d22059511f59d23a",
        "type": "github"
      },
      "original": {
@@ -108,34 +76,13 @@
        "type": "github"
      }
    },
-    "nixos-images": {
-      "inputs": {
-        "nixos-2311": "nixos-2311",
-        "nixos-unstable": [
-          "nixpkgs"
-        ]
-      },
-      "locked": {
-        "lastModified": 1716132123,
-        "narHash": "sha256-rATSWbPaKQfZGaemu0tHL2xfCzVIVwpuTjk+KSBC+k4=",
-        "owner": "nix-community",
-        "repo": "nixos-images",
-        "rev": "8c9cab8c44434c12dafc465fbf61a710c5bceb08",
-        "type": "github"
-      },
-      "original": {
-        "owner": "nix-community",
-        "repo": "nixos-images",
-        "type": "github"
-      }
-    },
    "nixpkgs": {
      "locked": {
-        "lastModified": 1716127062,
-        "narHash": "sha256-2rk8FqB/iQV2d0vQLs684/Tj5PUHaS1sFwG7fng5vXE=",
+        "lastModified": 1712468661,
+        "narHash": "sha256-n2gVVBs+rV+HzPv/N3QQv5cdAXqSkjmaObvfeMqnw2c=",
        "owner": "NixOS",
        "repo": "nixpkgs",
-        "rev": "8a2555763c48e2410054de3f52f7310ce3241ec5",
+        "rev": "298edc8f1e0dfffce67f50375c9f5952e04a6d02",
        "type": "github"
      },
      "original": {
@@ -149,9 +96,7 @@
      "inputs": {
        "disko": "disko",
        "flake-parts": "flake-parts",
-        "git-hooks": "git-hooks",
        "nixos-generators": "nixos-generators",
-        "nixos-images": "nixos-images",
        "nixpkgs": "nixpkgs",
        "sops-nix": "sops-nix",
        "treefmt-nix": "treefmt-nix"
@@ -165,11 +110,11 @@
        "nixpkgs-stable": []
      },
      "locked": {
-        "lastModified": 1716087663,
-        "narHash": "sha256-zuSAGlx8Qk0OILGCC2GUyZ58/SJ5R3GZdeUNQ6IS0fQ=",
+        "lastModified": 1712458908,
+        "narHash": "sha256-DMgBS+jNHDg8z3g9GkwqL8xTKXCRQ/0FGsAyrniVonc=",
        "owner": "Mic92",
        "repo": "sops-nix",
-        "rev": "0bf1808e70ce80046b0cff821c019df2b19aabf5",
+        "rev": "39191e8e6265b106c9a2ba0cfd3a4dafe98a31c6",
        "type": "github"
      },
      "original": {
@@ -185,11 +130,11 @@
        ]
      },
      "locked": {
-        "lastModified": 1715940852,
-        "narHash": "sha256-wJqHMg/K6X3JGAE9YLM0LsuKrKb4XiBeVaoeMNlReZg=",
+        "lastModified": 1711963903,
+        "narHash": "sha256-N3QDhoaX+paWXHbEXZapqd1r95mdshxToGowtjtYkGI=",
        "owner": "numtide",
        "repo": "treefmt-nix",
-        "rev": "2fba33a182602b9d49f0b2440513e5ee091d838b",
+        "rev": "49dc4a92b02b8e68798abd99184f228243b6e3ac",
        "type": "github"
      },
      "original": {
--- a/flake.nix
+++ b/flake.nix
@@ -8,6 +8,7 @@

  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable-small";
+
    disko.url = "github:nix-community/disko";
    disko.inputs.nixpkgs.follows = "nixpkgs";
    sops-nix.url = "github:Mic92/sops-nix";
@@ -15,14 +16,10 @@
    sops-nix.inputs.nixpkgs-stable.follows = "";
    nixos-generators.url = "github:nix-community/nixos-generators";
    nixos-generators.inputs.nixpkgs.follows = "nixpkgs";
-    nixos-images.url = "github:nix-community/nixos-images";
-    nixos-images.inputs.nixos-unstable.follows = "nixpkgs";
    flake-parts.url = "github:hercules-ci/flake-parts";
    flake-parts.inputs.nixpkgs-lib.follows = "nixpkgs";
    treefmt-nix.url = "github:numtide/treefmt-nix";
    treefmt-nix.inputs.nixpkgs.follows = "nixpkgs";
-    git-hooks.url = "github:fricklerhandwerk/git-hooks";
-    git-hooks.flake = false;
  };

  outputs =
--- a/formatter.nix
+++ b/formatter.nix
@@ -11,9 +11,7 @@
      treefmt.programs.mypy.directories = {
        "pkgs/clan-cli".extraPythonPackages = self'.packages.clan-cli.testDependencies;
        "pkgs/clan-vm-manager".extraPythonPackages =
-          # clan-vm-manager currently only exists on linux 
-          (self'.packages.clan-vm-manager.externalTestDeps or [ ])
-          ++ self'.packages.clan-cli.testDependencies;
+          self'.packages.clan-vm-manager.externalTestDeps ++ self'.packages.clan-cli.testDependencies;
      };

      treefmt.settings.formatter.nix = {
--- a/lib/default.nix
+++ b/lib/default.nix
@@ -6,6 +6,6 @@
 }:
 {
  jsonschema = import ./jsonschema { inherit lib; };
-  modules = import ./description.nix { inherit clan-core lib; };
+
  buildClan = import ./build-clan { inherit clan-core lib nixpkgs; };
 }
--- a/lib/description.nix
+++ b/lib/description.nix
@@ -1,33 +0,0 @@
-{ lib, clan-core, ... }:
-
-rec {
-  getReadme =
-    modulename:
-    let
-      readme = "${clan-core}/clanModules/${modulename}/README.md";
-      readmeContents =
-        if (builtins.pathExists readme) then
-          (builtins.readFile readme)
-        else
-          throw "No README.md found for module ${modulename}";
-    in
-    readmeContents;
-
-  getShortDescription =
-    modulename:
-    let
-      content = (getReadme modulename);
-      parts = lib.splitString "---" content;
-      description = builtins.head parts;
-      number_of_newlines = builtins.length (lib.splitString "\n" description);
-    in
-    if (builtins.length parts) > 1 then
-      if number_of_newlines > 4 then
-        throw "Short description in README.md for module ${modulename} is too long. Max 3 newlines."
-      else if number_of_newlines <= 1 then
-        throw "Missing short description in README.md for module ${modulename}."
-      else
-        description
-    else
-      throw "Short description delimiter `---` not found in README.md for module ${modulename}";
-}
--- a/lib/jsonschema/default.nix
+++ b/lib/jsonschema/default.nix
@@ -17,18 +17,12 @@ let
      location: ${lib.concatStringsSep "." option.loc}
    '';

-  # Exclude the option if its type is in the excludedTypes list
-  # or if the option has a defaultText attribute
-  isExcludedOption =
-    option: ((lib.elem (option.type.name or null) excludedTypes) || (option ? defaultText));
+  isExcludedOption = option: (lib.elem (option.type.name or null) excludedTypes);

  filterExcluded = lib.filter (opt: !isExcludedOption opt);

  filterExcludedAttrs = lib.filterAttrs (_name: opt: !isExcludedOption opt);

-  # Filter out options where the visible attribute is set to false
-  filterInvisibleOpts = lib.filterAttrs (_name: opt: opt.visible or true);
-
  allBasicTypes = [
    "boolean"
    "integer"
@@ -53,7 +47,7 @@ rec {
  parseOptions =
    options':
    let
-      options = filterInvisibleOpts (filterExcludedAttrs (clean options'));
+      options = filterExcludedAttrs (clean options');
      # parse options to jsonschema properties
      properties = lib.mapAttrs (_name: option: parseOption option) options;
      # TODO: figure out how to handle if prop.anyOf is used
@@ -73,37 +67,33 @@ rec {
    option:
    let
      default = lib.optionalAttrs (option ? default) { inherit (option) default; };
-      example = lib.optionalAttrs (option ? example) {
-        examples =
-          if (builtins.typeOf option.example) == "list" then option.example else [ option.example ];
-      };
      description = lib.optionalAttrs (option ? description) {
        description = option.description.text or option.description;
      };
    in

    # either type
-    # TODO: if all nested options are excluded, the parent should be excluded too
+    # TODO: if all nested optiosn are excluded, the parent sould be excluded too
    if
-      option.type.name or null == "either" || option.type.name or null == "coercedTo"
+      option.type.name or null == "either"
    # return jsonschema property definition for either
    then
      let
        optionsList' = [
          {
-            type = option.type.nestedTypes.left or option.type.nestedTypes.coercedType;
+            type = option.type.nestedTypes.left;
            _type = "option";
            loc = option.loc;
          }
          {
-            type = option.type.nestedTypes.right or option.type.nestedTypes.finalType;
+            type = option.type.nestedTypes.right;
            _type = "option";
            loc = option.loc;
          }
        ];
        optionsList = filterExcluded optionsList';
      in
-      default // example // description // { anyOf = map parseOption optionsList; }
+      default // description // { anyOf = map parseOption optionsList; }

    # handle nested options (not a submodule)
    else if !option ? _type then
@@ -126,7 +116,6 @@ rec {
        };
      in
      default
-      // example
      // description
      // {
        anyOf = [
@@ -139,86 +128,63 @@ rec {
      option.type.name == "bool"
    # return jsonschema property definition for bool
    then
-      default // example // description // { type = "boolean"; }
+      default // description // { type = "boolean"; }

    # parse float
    else if
      option.type.name == "float"
    # return jsonschema property definition for float
    then
-      default // example // description // { type = "number"; }
+      default // description // { type = "number"; }

    # parse int
    else if
      (option.type.name == "int" || option.type.name == "positiveInt")
    # return jsonschema property definition for int
    then
-      default // example // description // { type = "integer"; }
-
-    # TODO: Add support for intMatching in jsonschema
-    # parse port type aka. "unsignedInt16"
-    else if
-      option.type.name == "unsignedInt16"
-      || option.type.name == "unsignedInt"
-      || option.type.name == "pkcs11"
-      || option.type.name == "intBetween"
-    then
-      default // example // description // { type = "integer"; }
+      default // description // { type = "integer"; }

    # parse string
-    # TODO: parse more precise string types
    else if
      option.type.name == "str"
-      || option.type.name == "singleLineStr"
-      || option.type.name == "passwdEntry str"
-      || option.type.name == "passwdEntry path"
    # return jsonschema property definition for string
    then
-      default // example // description // { type = "string"; }
-
-    # TODO: Add support for stringMatching in jsonschema
-    # parse stringMatching
-    else if lib.strings.hasPrefix "strMatching" option.type.name then
-      default // example // description // { type = "string"; }
-
-    # TODO: Add support for separatedString in jsonschema
-    else if lib.strings.hasPrefix "separatedString" option.type.name then
-      default // example // description // { type = "string"; }
+      default // description // { type = "string"; }

    # parse string
    else if
      option.type.name == "path"
    # return jsonschema property definition for path
    then
-      default // example // description // { type = "string"; }
+      default // description // { type = "string"; }

    # parse anything
    else if
      option.type.name == "anything"
    # return jsonschema property definition for anything
    then
-      default // example // description // { type = allBasicTypes; }
+      default // description // { type = allBasicTypes; }

    # parse unspecified
    else if
      option.type.name == "unspecified"
    # return jsonschema property definition for unspecified
    then
-      default // example // description // { type = allBasicTypes; }
+      default // description // { type = allBasicTypes; }

    # parse raw
    else if
      option.type.name == "raw"
    # return jsonschema property definition for raw
    then
-      default // example // description // { type = allBasicTypes; }
+      default // description // { type = allBasicTypes; }

    # parse enum
    else if
      option.type.name == "enum"
    # return jsonschema property definition for enum
    then
-      default // example // description // { enum = option.type.functor.payload; }
+      default // description // { enum = option.type.functor.payload; }

    # parse listOf submodule
    else if
@@ -226,7 +192,6 @@ rec {
    # return jsonschema property definition for listOf submodule
    then
      default
-      // example
      // description
      // {
        type = "array";
@@ -246,7 +211,6 @@ rec {
        };
      in
      default
-      // example
      // description
      // {
        type = "array";
@@ -258,7 +222,7 @@ rec {
      (option.type.name == "listOf") && (option.type.functor.wrapped.name == "unspecified")
    # return jsonschema property definition for list
    then
-      default // example // description // { type = "array"; }
+      default // description // { type = "array"; }

    # parse attrsOf submodule
    else if
@@ -266,7 +230,6 @@ rec {
    # return jsonschema property definition for attrsOf submodule
    then
      default
-      // example
      // description
      // {
        type = "object";
@@ -279,7 +242,6 @@ rec {
    # return jsonschema property definition for attrs
    then
      default
-      // example
      // description
      // {
        type = "object";
@@ -300,7 +262,6 @@ rec {
        };
      in
      default
-      // example
      // description
      // {
        type = "object";
--- a/lib/jsonschema/example-data.json
+++ b/lib/jsonschema/example-data.json
@@ -10,11 +10,5 @@
  },
  "services": {
    "opt": "this option doesn't make sense"
-  },
-  "destinations": {
-    "test-backup": {
-      "name": "John Doe",
-      "repo": "test-backup"
-    }
  }
 }
--- a/lib/jsonschema/example-interface.nix
+++ b/lib/jsonschema/example-interface.nix
@@ -50,26 +50,5 @@
      ];
      description = "A list of enabled kernel modules";
    };
-    destinations = lib.mkOption {
-      type = lib.types.attrsOf (
-        lib.types.submodule (
-          { name, ... }:
-          {
-            options = {
-              name = lib.mkOption {
-                type = lib.types.strMatching "^[a-zA-Z0-9._-]+$";
-                default = name;
-                description = "the name of the backup job";
-              };
-              repo = lib.mkOption {
-                type = lib.types.str;
-                description = "the borgbackup repository to backup to";
-              };
-            };
-          }
-        )
-      );
-      default = { };
-    };
  };
 }
--- a/lib/jsonschema/example-schema.json
+++ b/lib/jsonschema/example-schema.json
@@ -45,27 +45,6 @@
          "description": "A submodule option"
        }
      }
-    },
-    "destinations": {
-      "additionalProperties": {
-        "properties": {
-          "name": {
-            "default": "‹name›",
-            "description": "the name of the backup job",
-            "type": "string"
-          },
-          "repo": {
-            "description": "the borgbackup repository to backup to",
-            "type": "string"
-          }
-        },
-        "required": [
-          "repo"
-        ],
-        "type": "object"
-      },
-      "default": {},
-      "type": "object"
    }
  }
 }
--- a/nixosModules/bcachefs.nix
+++ b/nixosModules/bcachefs.nix
@@ -1,17 +0,0 @@
-{ lib, pkgs, ... }:
-
-{
-  # use latest kernel we can support to get more hardware support
-  boot.kernelPackages =
-    lib.mkForce
-      (pkgs.zfs.override { removeLinuxDRM = pkgs.hostPlatform.isAarch64; }).latestCompatibleLinuxPackages;
-  boot.zfs.removeLinuxDRM = lib.mkDefault pkgs.hostPlatform.isAarch64;
-
-  # Enable bcachefs support
-  boot.supportedFilesystems.bcachefs = lib.mkDefault true;
-
-  environment.systemPackages = with pkgs; [
-    bcachefs-tools
-    keyutils
-  ];
-}
--- a/nixosModules/clanCore/metadata.nix
+++ b/nixosModules/clanCore/metadata.nix
@@ -22,8 +22,8 @@
      '';
    };
    clanDir = lib.mkOption {
-      type = lib.types.path;
-      default = ./.;
+      type = lib.types.either lib.types.path lib.types.str;
+      default = ".";
      description = ''
        the location of the flake repo, used to calculate the location of facts and secrets
      '';
--- a/nixosModules/clanCore/nix-settings.nix
+++ b/nixosModules/clanCore/nix-settings.nix
@@ -9,6 +9,7 @@
  nix.settings.experimental-features = [
    "nix-command"
    "flakes"
+    "repl-flake"
  ];

  # The default at 10 is rarely enough.
--- a/nixosModules/flake-module.nix
+++ b/nixosModules/flake-module.nix
@@ -2,15 +2,13 @@
 {
  flake.nixosModules = {
    hidden-ssh-announce.imports = [ ./hidden-ssh-announce.nix ];
-    bcachefs.imports = [ ./bcachefs.nix ];
    installer.imports = [
      ./installer
      self.nixosModules.hidden-ssh-announce
-      self.nixosModules.bcachefs
+      inputs.disko.nixosModules.disko
    ];
    clanCore.imports = [
      inputs.sops-nix.nixosModules.sops
-      inputs.disko.nixosModules.default
      ./clanCore
      ./iso
      (
--- a/nixosModules/installer/default.nix
+++ b/nixosModules/installer/default.nix
@@ -4,38 +4,6 @@
  modulesPath,
  ...
 }:
-
-let
-  network-status = pkgs.writeShellScript "network-status" ''
-    export PATH=${
-      lib.makeBinPath (
-        with pkgs;
-        [
-          iproute2
-          coreutils
-          gnugrep
-          nettools
-          gum
-        ]
-      )
-    }
-    set -efu -o pipefail
-    msgs=()
-    if [[ -e /var/shared/qrcode.utf8 ]]; then
-      qrcode=$(gum style --border-foreground 240 --border normal "$(< /var/shared/qrcode.utf8)")
-      msgs+=("$qrcode")
-    fi
-    network_status="Local network addresses:
-    $(ip -brief -color addr | grep -v 127.0.0.1)
-    $([[ -e /var/shared/onion-hostname ]] && echo "Onion address: $(cat /var/shared/onion-hostname)" || echo "Onion address: Waiting for tor network to be ready...")
-    Multicast DNS: $(hostname).local"
-    network_status=$(gum style --border-foreground 240 --border normal "$network_status")
-    msgs+=("$network_status")
-    msgs+=("Press 'Ctrl-C' for console access")
-
-    gum join --vertical "''${msgs[@]}"
-  '';
-in
 {
  ############################################
  #                                          #
@@ -43,21 +11,19 @@ in
  # $ qemu-kvm result/stick.raw -snapshot    #
  #                                          #
  ############################################
+  systemd.tmpfiles.rules = [ "d /var/shared 0777 root root - -" ];
  imports = [
    (modulesPath + "/profiles/installation-device.nix")
    (modulesPath + "/profiles/all-hardware.nix")
    (modulesPath + "/profiles/base.nix")
+    (modulesPath + "/installer/cd-dvd/iso-image.nix")
  ];
-
-  ########################################################################################################
-  #                                                                                                      #
-  # Copied from:                                                                                         #
-  # https://github.com/nix-community/nixos-images/blob/main/nix/image-installer/module.nix#L46C3-L117C6  #
-  #                                                                                                      #
-  ########################################################################################################
-  systemd.tmpfiles.rules = [ "d /var/shared 0777 root root - -" ];
-  services.openssh.settings.PermitRootLogin = lib.mkForce "prohibit-password";
-
+  services.openssh.settings.PermitRootLogin = "yes";
+  system.activationScripts.root-password = ''
+    mkdir -p /var/shared
+    ${pkgs.pwgen}/bin/pwgen -s 16 1 > /var/shared/root-password
+    echo "root:$(cat /var/shared/root-password)" | chpasswd
+  '';
  hidden-ssh-announce = {
    enable = true;
    script = pkgs.writeShellScript "write-hostname" ''
@@ -78,48 +44,26 @@ in
      echo "$1" > /var/shared/onion-hostname
      local_addrs=$(ip -json addr | jq '[map(.addr_info) | flatten | .[] | select(.scope == "global") | .local]')
      jq -nc \
+        --arg password "$(cat /var/shared/root-password)" \
        --arg onion_address "$(cat /var/shared/onion-hostname)" \
        --argjson local_addrs "$local_addrs" \
-        '{ pass: null, tor: $onion_address, addrs: $local_addrs }' \
+        '{ pass: $password, onion_address: $onion_address, addrs: $local_addrs }' \
        > /var/shared/login.json
-      cat /var/shared/login.json | qrencode -s 2 -m 2 -t utf8 -o /var/shared/qrcode.utf8
+      cat /var/shared/login.json | qrencode -t utf8 -o /var/shared/qrcode.utf8
    '';
  };
-
  services.getty.autologinUser = lib.mkForce "root";
-
-  console.earlySetup = true;
-  console.font = lib.mkDefault "${pkgs.terminus_font}/share/consolefonts/ter-u22n.psf.gz";
-
-  # Less ipv6 addresses to reduce the noise
-  networking.tempAddresses = "disabled";
-
-  # Tango theme: https://yayachiken.net/en/posts/tango-colors-in-terminal/
-  console.colors = lib.mkDefault [
-    "000000"
-    "CC0000"
-    "4E9A06"
-    "C4A000"
-    "3465A4"
-    "75507B"
-    "06989A"
-    "D3D7CF"
-    "555753"
-    "EF2929"
-    "8AE234"
-    "FCE94F"
-    "739FCF"
-    "AD7FA8"
-    "34E2E2"
-    "EEEEEC"
-  ];
-
  programs.bash.interactiveShellInit = ''
    if [[ "$(tty)" =~ /dev/(tty1|hvc0|ttyS0)$ ]]; then
-      # workaround for https://github.com/NixOS/nixpkgs/issues/219239
-      systemctl restart systemd-vconsole-setup.service
-
-      watch --no-title --color ${network-status}
+      echo -n 'waiting for tor to generate the hidden service'
+      until test -e /var/shared/qrcode.utf8; do echo -n .; sleep 1; done
+      echo
+      echo "Root password: $(cat /var/shared/root-password)"
+      echo "Onion address: $(cat /var/shared/onion-hostname)"
+      echo "Local network addresses:"
+      ${pkgs.iproute}/bin/ip -brief -color addr | grep -v 127.0.0.1
+      cat /var/shared/qrcode.utf8
    fi
  '';
+  isoImage.squashfsCompression = "zstd";
 }
--- a/nixosModules/iso/default.nix
+++ b/nixosModules/iso/default.nix
@@ -43,7 +43,6 @@ let
                  boot = {
                    size = "1M";
                    type = "EF02"; # for grub MBR
-                    priority = 1; # Needs to be first partition
                  };
                  ESP = {
                    size = "100M";
--- a/pkgs/clan-cli/api.py
+++ b/pkgs/clan-cli/api.py
@@ -1,15 +0,0 @@
-import json
-
-from clan_cli.api import API
-
-
-def main() -> None:
-    schema = API.to_json_schema()
-    print(
-        f"""export const schema = {json.dumps(schema, indent=2)} as const;
-"""
-    )
-
-
-if __name__ == "__main__":
-    main()
--- a/pkgs/clan-cli/clan_cli/init.py
+++ b/pkgs/clan-cli/clan_cli/init.py
@@ -19,7 +19,7 @@ from . import (
    vms,
 )
 from .custom_logger import setup_logging
-from .dirs import get_clan_flake_toplevel_or_env
+from .dirs import get_clan_flake_toplevel
 from .errors import ClanCmdError, ClanError
 from .profiler import profile
 from .ssh import cli as ssh_cli
@@ -52,23 +52,12 @@ class AppendOptionAction(argparse.Action):


 def create_parser(prog: str | None = None) -> argparse.ArgumentParser:
-    parser = argparse.ArgumentParser(
-        prog=prog,
-        description="cLAN tool",
-        epilog=(
-            """
-Online reference for the clan cli tool: https://docs.clan.lol/reference/cli/
-For more detailed information, visit: https://docs.clan.lol
-        """
-        ),
-        formatter_class=argparse.RawTextHelpFormatter,
-    )
+    parser = argparse.ArgumentParser(prog=prog, description="cLAN tool")

    parser.add_argument(
        "--debug",
        help="Enable debug logging",
        action="store_true",
-        default=False,
    )

    parser.add_argument(
@@ -88,154 +77,37 @@ For more detailed information, visit: https://docs.clan.lol

    parser.add_argument(
        "--flake",
-        help="path to the flake where the clan resides in, can be a remote flake or local, can be set through the [CLAN_DIR] environment variable",
-        default=get_clan_flake_toplevel_or_env(),
-        metavar="PATH",
+        help="path to the flake where the clan resides in, can be a remote flake or local",
+        default=get_clan_flake_toplevel(),
        type=flake_path,
    )

    subparsers = parser.add_subparsers()

    parser_backups = subparsers.add_parser(
-        "backups",
-        help="manage backups of clan machines",
-        description="manage backups of clan machines",
-        epilog=(
-            """
-This subcommand provides an interface to backups that clan machines expose.
-
-Examples:
-
-  $ clan backups list [MACHINE]
-  List backups for the machine [MACHINE]
-
-  $ clan backups create [MACHINE]
-  Create a backup for the machine [MACHINE].
-
-  $ clan backups restore [MACHINE] [PROVIDER] [NAME]
-  The backup to restore for the machine [MACHINE] with the configured [PROVIDER]
-  with the name [NAME].
-
-For more detailed information, visit: https://docs.clan.lol/getting-started/backups/
-        """
-        ),
-        formatter_class=argparse.RawTextHelpFormatter,
+        "backups", help="manage backups of clan machines"
    )
    backups.register_parser(parser_backups)

    parser_flake = subparsers.add_parser(
-        "flakes",
-        help="create a clan flake inside the current directory",
-        epilog=(
-            """
-Examples:
-  $ clan flakes create [DIR]
-  Will create a new clan flake in the specified directory and create it if it
-  doesn't exist yet. The flake will be created from a default template.
-
-For more detailed information, visit: https://docs.clan.lol/getting-started
-        """
-        ),
-        formatter_class=argparse.RawTextHelpFormatter,
+        "flakes", help="create a clan flake inside the current directory"
    )
    flakes.register_parser(parser_flake)

-    parser_config = subparsers.add_parser(
-        "config",
-        help="set nixos configuration",
-        epilog=(
-            """
-        """
-        ),
-        formatter_class=argparse.RawTextHelpFormatter,
-    )
+    parser_config = subparsers.add_parser("config", help="set nixos configuration")
    config.register_parser(parser_config)

    parser_ssh = subparsers.add_parser("ssh", help="ssh to a remote machine")
    ssh_cli.register_parser(parser_ssh)

-    parser_secrets = subparsers.add_parser(
-        "secrets",
-        help="manage secrets",
-        epilog=(
-            """
-This subcommand provides an interface to secret facts.
-
-Examples:
-
-  $ clan secrets list [regex]
-  Will list secrets for all managed machines.
-  It accepts an optional regex, allowing easy filtering of returned secrets.
-
-  $ clan secrets get [SECRET]
-  Will display the content of the specified secret.
-
-For more detailed information, visit: https://docs.clan.lol/getting-started/secrets/
-        """
-        ),
-        formatter_class=argparse.RawTextHelpFormatter,
-    )
+    parser_secrets = subparsers.add_parser("secrets", help="manage secrets")
    secrets.register_parser(parser_secrets)

-    parser_facts = subparsers.add_parser(
-        "facts",
-        help="manage facts",
-        epilog=(
-            """
-
-This subcommand provides an interface to facts of clan machines.
-Facts are artifacts that a service can generate.
-There are public and secret facts. 
-Public facts can be referenced by other machines directly.
-Public facts can include: ip addresses, public keys.
-Secret facts can include: passwords, private keys.
-
-A service is an included clan-module that implements facts generation functionality.
-For example the zerotier module will generate private and public facts.
-In this case the public fact will be the resulting zerotier-ip of the machine.
-The secret fact will be the zerotier-identity-secret, which is used by zerotier
-to prove the machine has control of the zerotier-ip.
-
-Examples:
-
-  $ clan facts generate
-  Will generate facts for all machines.
-   
-  $ clan facts generate --service [SERVICE] --regenerate
-  Will regenerate facts, if they are already generated for a specific service.
-  This is especially useful for resetting certain passwords while leaving the rest
-  of the facts for a machine in place.
-
-For more detailed information, visit: https://docs.clan.lol/getting-started/secrets/
-        """
-        ),
-        formatter_class=argparse.RawTextHelpFormatter,
-    )
+    parser_facts = subparsers.add_parser("facts", help="manage facts")
    facts.register_parser(parser_facts)

    parser_machine = subparsers.add_parser(
-        "machines",
-        help="manage machines and their configuration",
-        epilog=(
-            """
-This subcommand provides an interface to machines managed by clan.
-
-Examples:
-
-  $ clan machines list
-  List all the machines managed by clan.
-
-  $ clan machines update [MACHINES]
-  Will update the specified machine [MACHINE], if [MACHINE] is omitted, the command 
-  will attempt to update every configured machine.
-
-  $ clan machines install [MACHINES] [TARGET_HOST]
-  Will install the specified machine [MACHINE], to the specified [TARGET_HOST].
-
-For more detailed information, visit: https://docs.clan.lol/getting-started/deploy
-        """
-        ),
-        formatter_class=argparse.RawTextHelpFormatter,
+        "machines", help="Manage machines and their configuration"
    )
    machines.register_parser(parser_machine)

--- a/pkgs/clan-cli/clan_cli/api/init.py
+++ b/pkgs/clan-cli/clan_cli/api/init.py
@@ -1,90 +0,0 @@
-from collections.abc import Callable
-from dataclasses import dataclass
-from typing import Any, Generic, Literal, TypeVar
-
-T = TypeVar("T")
-
-
-ResponseDataType = TypeVar("ResponseDataType")
-
-
-@dataclass
-class ApiError:
-    message: str
-    description: str | None
-    location: list[str] | None
-
-
-@dataclass
-class ApiResponse(Generic[ResponseDataType]):
-    status: Literal["success", "error"]
-    errors: list[ApiError] | None
-    data: ResponseDataType | None
-
-
-class _MethodRegistry:
-    def __init__(self) -> None:
-        self._registry: dict[str, Callable[[Any], Any]] = {}
-
-    def register(self, fn: Callable[..., T]) -> Callable[..., T]:
-        self._registry[fn.__name__] = fn
-        return fn
-
-    def to_json_schema(self) -> dict[str, Any]:
-        # Import only when needed
-        from typing import get_type_hints
-
-        from clan_cli.api.util import type_to_dict
-
-        api_schema: dict[str, Any] = {
-            "$comment": "An object containing API methods. ",
-            "type": "object",
-            "additionalProperties": False,
-            "required": [func_name for func_name in self._registry.keys()],
-            "properties": {},
-        }
-
-        for name, func in self._registry.items():
-            hints = get_type_hints(func)
-
-            serialized_hints = {
-                key: type_to_dict(
-                    value, scope=name + " argument" if key != "return" else "return"
-                )
-                for key, value in hints.items()
-            }
-
-            return_type = serialized_hints.pop("return")
-
-            api_schema["properties"][name] = {
-                "type": "object",
-                "required": ["arguments", "return"],
-                "additionalProperties": False,
-                "properties": {
-                    "return": return_type,
-                    "arguments": {
-                        "type": "object",
-                        "required": [k for k in serialized_hints.keys()],
-                        "additionalProperties": False,
-                        "properties": serialized_hints,
-                    },
-                },
-            }
-
-        return api_schema
-
-    def get_method_argtype(self, method_name: str, arg_name: str) -> Any:
-        from inspect import signature
-
-        func = self._registry.get(method_name, None)
-        if func:
-            sig = signature(func)
-            param = sig.parameters.get(arg_name)
-            if param:
-                param_class = param.annotation
-                return param_class
-
-        return None
-
-
-API = _MethodRegistry()
--- a/pkgs/clan-cli/clan_cli/api/util.py
+++ b/pkgs/clan-cli/clan_cli/api/util.py
@@ -1,84 +0,0 @@
-import dataclasses
-import pathlib
-from types import NoneType, UnionType
-from typing import Any, Union
-
-
-def type_to_dict(t: Any, scope: str = "") -> dict:
-    if t is None:
-        return {"type": "null"}
-
-    if dataclasses.is_dataclass(t):
-        fields = dataclasses.fields(t)
-        properties = {
-            f.name: type_to_dict(f.type, f"{scope} {t.__name__}.{f.name}")
-            for f in fields
-        }
-        required = [pn for pn, pv in properties.items() if "null" not in pv["type"]]
-        return {
-            "type": "object",
-            "properties": properties,
-            "required": required,
-            # Dataclasses can only have the specified properties
-            "additionalProperties": False,
-        }
-    elif type(t) is UnionType:
-        return {
-            "type": [type_to_dict(arg, scope)["type"] for arg in t.__args__],
-        }
-
-    elif hasattr(t, "__origin__"):  # Check if it's a generic type
-        origin = getattr(t, "__origin__", None)
-
-        if origin is None:
-            # Non-generic user-defined or built-in type
-            # TODO: handle custom types
-            raise BaseException("Unhandled Type: ", origin)
-
-        elif origin is Union:
-            return {"type": [type_to_dict(arg, scope)["type"] for arg in t.__args__]}
-
-        elif issubclass(origin, list):
-            return {"type": "array", "items": type_to_dict(t.__args__[0], scope)}
-
-        elif issubclass(origin, dict):
-            value_type = t.__args__[1]
-            if value_type is Any:
-                return {"type": "object", "additionalProperties": True}
-            else:
-                return {
-                    "type": "object",
-                    "additionalProperties": type_to_dict(value_type, scope),
-                }
-
-        raise BaseException(f"Error api type not yet supported {t!s}")
-
-    elif isinstance(t, type):
-        if t is str:
-            return {"type": "string"}
-        if t is int:
-            return {"type": "integer"}
-        if t is float:
-            return {"type": "number"}
-        if t is bool:
-            return {"type": "boolean"}
-        if t is object:
-            return {"type": "object"}
-        if t is Any:
-            raise BaseException(
-                f"Usage of the Any type is not supported for API functions. In: {scope}"
-            )
-
-        if t is pathlib.Path:
-            return {
-                # TODO: maybe give it a pattern for URI
-                "type": "string",
-            }
-
-        # Optional[T] gets internally transformed Union[T,NoneType]
-        if t is NoneType:
-            return {"type": "null"}
-
-        raise BaseException(f"Error primitive type not supported {t!s}")
-    else:
-        raise BaseException(f"Error type not supported {t!s}")
--- a/pkgs/clan-cli/clan_cli/dirs.py
+++ b/pkgs/clan-cli/clan_cli/dirs.py
@@ -7,12 +7,6 @@ from pathlib import Path
 log = logging.getLogger(__name__)


-def get_clan_flake_toplevel_or_env() -> Path | None:
-    if clan_dir := os.environ.get("CLAN_DIR"):
-        return Path(clan_dir)
-    return get_clan_flake_toplevel()
-
-
 def get_clan_flake_toplevel() -> Path | None:
    return find_toplevel([".clan-flake", ".git", ".hg", ".svn", "flake.nix"])

--- a/pkgs/clan-cli/clan_cli/facts/init.py
+++ b/pkgs/clan-cli/clan_cli/facts/init.py
@@ -23,42 +23,7 @@ def register_parser(parser: argparse.ArgumentParser) -> None:
    register_list_parser(list_parser)

    parser_generate = subparser.add_parser(
-        "generate",
-        help="generate public and secret facts for machines",
-        epilog=(
-            """
-This subcommand allows control of the generation of facts.
-Often this function will be invoked automatically on deploying machines,
-but there are situations the user may want to have more granular control,
-especially for the regeneration of certain services.
-
-A service is an included clan-module that implements facts generation functionality.
-For example the zerotier module will generate private and public facts.
-In this case the public fact will be the resulting zerotier-ip of the machine.
-The secret fact will be the zerotier-identity-secret, which is used by zerotier
-to prove the machine has control of the zerotier-ip.
-
-
-Examples:
-
-  $ clan facts generate
-  Will generate facts for all machines.
-   
-  $ clan facts generate [MACHINE]
-  Will generate facts for the specified machine.
-
-  $ clan facts generate [MACHINE] --service [SERVICE]
-  Will generate facts for the specified machine for the specified service.
-
-  $ clan facts generate --service [SERVICE] --regenerate
-  Will regenerate facts, if they are already generated for a specific service.
-  This is especially useful for resetting certain passwords while leaving the rest
-  of the facts for a machine in place.
-
-For more detailed information, visit: https://docs.clan.lol/getting-started/secrets/
-        """
-        ),
-        formatter_class=argparse.RawTextHelpFormatter,
+        "generate", help="generate secrets for machines if they don't exist yet"
    )
    register_generate_parser(parser_generate)

--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
a-kenji	e9e5e702e5	init:	2024-04-30 10:37:36 +02:00
a-kenji	d2beeba6ff	clan: init manpage	2024-04-26 14:02:24 +02:00
				`@@ -1 +0,0 @@`
				`/nix/store/8y5h98wk5p94mv1wyb2c4gkrr7bswd19-asciinema-player.css`
				`@@ -1 +0,0 @@`
				`/nix/store/w0i3f9qzn9n6jmfnfgiw5wnab2f9ssdw-asciinema-player.min.js`