home-manager/modules/services/hound.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

82 lines
2 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.hound;
jsonFormat = pkgs.formats.json { };
configFile = jsonFormat.generate "hound-config.json" {
max-concurrent-indexers = cfg.maxConcurrentIndexers;
dbpath = cfg.databasePath;
repos = cfg.repositories;
health-check-url = "/healthz";
};
houndOptions = [ "--addr ${cfg.listenAddress}" "--conf ${configFile}" ];
in {
meta.maintainers = [ maintainers.adisbladis ];
options.services.hound = {
enable = mkEnableOption (lib.mdDoc "hound");
maxConcurrentIndexers = mkOption {
type = types.ints.positive;
default = 2;
description = lib.mdDoc "Limit the amount of concurrent indexers.";
};
databasePath = mkOption {
type = types.path;
default = "${config.xdg.dataHome}/hound";
defaultText = "$XDG_DATA_HOME/hound";
description = lib.mdDoc "The Hound database path.";
};
listenAddress = mkOption {
type = types.str;
default = "localhost:6080";
description = lib.mdDoc "Listen address of the Hound daemon.";
};
repositories = mkOption {
type = types.attrsOf jsonFormat.type;
default = { };
example = literalExpression ''
{
SomeGitRepo = {
url = "https://www.github.com/YourOrganization/RepoOne.git";
ms-between-poll = 10000;
exclude-dot-files = true;
};
}
'';
description = lib.mdDoc "The repository configuration.";
};
};
config = mkIf cfg.enable {
assertions = [
(lib.hm.assertions.assertPlatform "services.hound" pkgs
lib.platforms.linux)
];
home.packages = [ pkgs.hound ];
systemd.user.services.hound = {
Unit = { Description = "Hound source code search engine"; };
Install = { WantedBy = [ "default.target" ]; };
Service = {
Environment = "PATH=${makeBinPath [ pkgs.mercurial pkgs.git ]}";
ExecStart =
"${pkgs.hound}/bin/houndd ${concatStringsSep " " houndOptions}";
};
};
};
}