pkgs/servers/headscale/default.nix

   1 {
   2   lib,
   3   buildGoModule,
   4   fetchFromGitHub,
   5   installShellFiles,
   6   nixosTests,
   7 }:
   8 buildGoModule rec {
   9   pname = "headscale";
  10   version = "0.23.0";
  11
  12   src = fetchFromGitHub {
  13     owner = "juanfont";
  14     repo = "headscale";
  15     rev = "v${version}";
  16     hash = "sha256-5tlnVNpn+hJayxHjTpbOO3kRInOYOFz0pe9pwjXZlBE=";
  17   };
  18
  19   vendorHash = "sha256-+8dOxPG/Q+wuHgRwwWqdphHOuop0W9dVyClyQuh7aRc=";
  20
  21   ldflags = ["-s" "-w" "-X github.com/juanfont/headscale/cmd/headscale/cli.Version=v${version}"];
  22
  23   nativeBuildInputs = [installShellFiles];
  24   checkFlags = ["-short"];
  25
  26   postInstall = ''
  27     installShellCompletion --cmd headscale \
  28       --bash <($out/bin/headscale completion bash) \
  29       --fish <($out/bin/headscale completion fish) \
  30       --zsh <($out/bin/headscale completion zsh)
  31   '';
  32
  33   passthru.tests = {inherit (nixosTests) headscale;};
  34
  35   meta = with lib; {
  36     homepage = "https://github.com/juanfont/headscale";
  37     description = "Open source, self-hosted implementation of the Tailscale control server";
  38     longDescription = ''
  39       Tailscale is a modern VPN built on top of Wireguard. It works like an
  40       overlay network between the computers of your networks - using all kinds
  41       of NAT traversal sorcery.
  42
  43       Everything in Tailscale is Open Source, except the GUI clients for
  44       proprietary OS (Windows and macOS/iOS), and the
  45       'coordination/control server'.
  46
  47       The control server works as an exchange point of Wireguard public keys for
  48       the nodes in the Tailscale network. It also assigns the IP addresses of
  49       the clients, creates the boundaries between each user, enables sharing
  50       machines between users, and exposes the advertised routes of your nodes.
  51
  52       Headscale implements this coordination server.
  53     '';
  54     license = licenses.bsd3;
  55     mainProgram = "headscale";
  56     maintainers = with maintainers; [nkje jk kradalby misterio77 ghuntley];
  57   };
  58 }