summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/search/hound.nix
blob: 3cca9f4eb1bda332a1a6e155f19c5c47d06d7d57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
{
  config,
  lib,
  pkgs,
  ...
}:
let
  cfg = config.services.hound;
  settingsFormat = pkgs.formats.json { };
  houndConfigFile = pkgs.writeTextFile {
    name = "hound-config.json";
    text = builtins.toJSON cfg.settings;
    checkPhase = ''
      ${cfg.package}/bin/houndd -check-config -conf $out
    '';
  };
in
{
  imports = [
    (lib.mkRemovedOptionModule [
      "services"
      "hound"
      "extraGroups"
    ] "Use users.users.hound.extraGroups instead")
    (lib.mkChangedOptionModule [ "services" "hound" "config" ] [ "services" "hound" "settings" ] (
      config: builtins.fromJSON config.services.hound.config
    ))
  ];

  meta.maintainers = with lib.maintainers; [ SuperSandro2000 ];

  options = {
    services.hound = {
      enable = lib.mkEnableOption "hound";

      package = lib.mkPackageOption pkgs "hound" { };

      user = lib.mkOption {
        default = "hound";
        type = lib.types.str;
        description = ''
          User the hound daemon should execute under.
        '';
      };

      group = lib.mkOption {
        default = "hound";
        type = lib.types.str;
        description = ''
          Group the hound daemon should execute under.
        '';
      };

      home = lib.mkOption {
        default = "/var/lib/hound";
        type = lib.types.path;
        description = ''
          The path to use as hound's $HOME.
          If the default user "hound" is configured then this is the home of the "hound" user.
        '';
      };

      settings = lib.mkOption {
        type = settingsFormat.type;
        example = lib.literalExpression ''
          {
            max-concurrent-indexers = 2;
            repos.nixpkgs.url = "https://www.github.com/NixOS/nixpkgs.git";
          }
        '';
        description = ''
          The full configuration of the Hound daemon.
          See the upstream documentation <https://github.com/hound-search/hound/blob/main/docs/config-options.md> for details.

          :::{.note}
          The `dbpath` should be an absolute path to a writable directory.
          :::.com/hound-search/hound/blob/main/docs/config-options.md>.
        '';
      };

      listen = lib.mkOption {
        type = lib.types.str;
        default = "0.0.0.0:6080";
        example = ":6080";
        description = ''
          Listen on this [IP]:port
        '';
      };
    };
  };

  config = lib.mkIf cfg.enable {
    users.groups = lib.mkIf (cfg.group == "hound") {
      hound = { };
    };

    users.users = lib.mkIf (cfg.user == "hound") {
      hound = {
        description = "Hound code search";
        createHome = true;
        isSystemUser = true;
        inherit (cfg) home group;
      };
    };

    environment.etc."hound/config.json".source = houndConfigFile;

    services.hound.settings = {
      dbpath = "${config.services.hound.home}/data";
    };

    systemd.services.hound = {
      description = "Hound Code Search";
      wantedBy = [ "multi-user.target" ];
      after = [ "network.target" ];
      restartTriggers = [ houndConfigFile ];
      serviceConfig = {
        User = cfg.user;
        Group = cfg.group;
        WorkingDirectory = cfg.home;
        ExecStartPre = "${pkgs.git}/bin/git config --global --replace-all http.sslCAinfo ${config.security.pki.caBundle}";
        ExecStart = "${cfg.package}/bin/houndd -addr ${cfg.listen} -conf /etc/hound/config.json";
      };
    };
  };
}