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