feat: add a nix flake (#132)

* feat: wip `nix` Add initial code to be used when working with `nix` and `NixOS`. * a Nix flake * building a package * a NixOS module * feat: build `hp_agent` with `nix` * feat: add `hp_agent` as a flake output * feat: nix: start `headplane` after `headscale` * feat: do not rely on `git` for versioning It causes lots of pain when building with `nix` for a local `flake.nix`. Not sure if it's a good general solution: * now it requires a manual step of updating `./version` on each release. * we're losing commit hash abbreviation, like `0.5.3-5-gbe5a291` I guess, this can be fixed by installing git-pre-commit-hook, but even then it'd be wrong, because the output of `git describe --tags --always` won't be the same before and after commit. * feat: include `hp_agent` to the NixOS module * fix: version error message * fix: use relative path imports in `nix` * fix: NixOS module: generate `/etc/headplane/config.yaml` from `services.headplane.settings` * fix: NixOS module: allow passing `bool` in `services.headplane.settings.*` * fix: NixOS module: fix `/etc/headplane/config.yaml` generation * docs: add Nix/NixOS docs * feat: nix: read version from `package.json` * fix: nix: fix `agent` env vars configuration * feat: nix: add `services.headplane.agent.debug` option * fix: delete unnecessary `version` file * fix: nix: remove unnecessary `sed` substitutions A left over from previous versions. See: https://github.com/tale/headplane/issues/95#issue-2807487849 * feat: nix: do not hardcode `headplane-agent` configuration environment variables To make the module more flexible and to reduce the dependency on the config API. * docs: improve `Nix` documentation * Reflect recent changes. * Link `Nix` in README * feat: nix: setup Nix CI * feat: nix: CI without depending on flakehub.com * chore: begin bundling all deps into the server * fix: loosen headscale config validation * fix: navigate back to machines page on node deletion * fix: slice off trailing slash if present on headscale url * feat: switch to a central singleton handler This also adds support for Headscale TLS installations * fix: shamefully-hoist dependencies * fix: handle localized number fields * fix: revert dependency bundling for now * chore: cleanup and remove from readme for now --------- Co-authored-by: Aarnav Tale <aarnavtale@icloud.com>
2026-08-17 16:47:51 +00:00 · 2025-03-18 05:31:37 +01:00
parent 483f86c457
commit 03a7e51384
9 changed files with 492 additions and 0 deletions
@@ -0,0 +1,69 @@
+rec {
+  description = "headplane";
+
+  inputs = {
+    devshell = {
+      inputs.nixpkgs.follows = "nixpkgs";
+      url = "github:numtide/devshell";
+    };
+    flake-utils.url = "github:numtide/flake-utils";
+    nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";
+  };
+
+  outputs = {
+    devshell,
+    flake-utils,
+    nixpkgs,
+    ...
+  }:
+    flake-utils.lib.eachSystem [
+      "aarch64-darwin"
+      "x86_64-darwin"
+      "x86_64-linux"
+    ]
+    (system: let
+      pkgs = import nixpkgs {
+        inherit system;
+        overlays = [devshell.overlays.default];
+      };
+    in rec {
+      formatter = pkgs.alejandra;
+      packages = {
+        headplane = pkgs.callPackage ./nix/package.nix {};
+        headplane-agent = pkgs.callPackage ./nix/agent.nix {};
+      };
+      checks.default = pkgs.symlinkJoin {
+        name = "headplane-with-agent";
+        paths = [packages.headplane packages.headplane-agent];
+      };
+      devShells.default = pkgs.devshell.mkShell rec {
+        name = description;
+        motd = let
+          providedPackages = pkgs.lib.concatStringsSep "\n" (
+            pkgs.lib.map
+            (pkg: "\t* ${pkgs.lib.getName pkg}")
+            (pkgs.lib.reverseList packages)
+          );
+        in ''
+          Entered '${description}' development environment.
+
+          Provided packages:
+          ${providedPackages}
+        '';
+        packages = [
+          pkgs.go
+          pkgs.nodejs-slim_22
+          pkgs.pnpm_10
+          pkgs.typescript-language-server
+        ];
+        env = [];
+      };
+    })
+    // {
+      overlays.default = final: prev: {
+        headplane = final.callPackage ./nix/package.nix {};
+        headplane-agent = final.callPackage ./nix/agent.nix {};
+      };
+      nixosModules.headplane = import ./nix/module.nix;
+    };
+}