aboutsummaryrefslogtreecommitdiff
path: root/nixpkgs/nixos/modules/services/search/solr.nix
diff options
context:
space:
mode:
Diffstat (limited to 'nixpkgs/nixos/modules/services/search/solr.nix')
-rw-r--r--nixpkgs/nixos/modules/services/search/solr.nix118
1 files changed, 118 insertions, 0 deletions
diff --git a/nixpkgs/nixos/modules/services/search/solr.nix b/nixpkgs/nixos/modules/services/search/solr.nix
new file mode 100644
index 00000000000..5ef7d9893a4
--- /dev/null
+++ b/nixpkgs/nixos/modules/services/search/solr.nix
@@ -0,0 +1,118 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+ cfg = config.services.solr;
+
+in
+
+{
+ options = {
+ services.solr = {
+ enable = mkEnableOption "Solr";
+
+ # default to the 8.x series not forcing major version upgrade of those on the 7.x series
+ package = mkOption {
+ type = types.package;
+ default = if versionAtLeast config.system.stateVersion "19.09"
+ then pkgs.solr_8
+ else pkgs.solr_7
+ ;
+ defaultText = "pkgs.solr";
+ description = ''
+ Which Solr package to use. This defaults to version 7.x if
+ <literal>system.stateVersion &lt; 19.09</literal> and version 8.x
+ otherwise.
+ '';
+ };
+
+ port = mkOption {
+ type = types.int;
+ default = 8983;
+ description = "Port on which Solr is ran.";
+ };
+
+ stateDir = mkOption {
+ type = types.path;
+ default = "/var/lib/solr";
+ description = "The solr home directory containing config, data, and logging files.";
+ };
+
+ extraJavaOptions = mkOption {
+ type = types.listOf types.str;
+ default = [];
+ description = "Extra command line options given to the java process running Solr.";
+ };
+
+ user = mkOption {
+ type = types.str;
+ default = "solr";
+ description = "User under which Solr is ran.";
+ };
+
+ group = mkOption {
+ type = types.str;
+ default = "solr";
+ description = "Group under which Solr is ran.";
+ };
+ };
+ };
+
+ config = mkIf cfg.enable {
+
+ environment.systemPackages = [ cfg.package ];
+
+ systemd.services.solr = {
+ after = [ "network.target" "remote-fs.target" "nss-lookup.target" "systemd-journald-dev-log.socket" ];
+ wantedBy = [ "multi-user.target" ];
+
+ environment = {
+ SOLR_HOME = "${cfg.stateDir}/data";
+ LOG4J_PROPS = "${cfg.stateDir}/log4j2.xml";
+ SOLR_LOGS_DIR = "${cfg.stateDir}/logs";
+ SOLR_PORT = "${toString cfg.port}";
+ };
+ path = with pkgs; [
+ gawk
+ procps
+ ];
+ preStart = ''
+ mkdir -p "${cfg.stateDir}/data";
+ mkdir -p "${cfg.stateDir}/logs";
+
+ if ! test -e "${cfg.stateDir}/data/solr.xml"; then
+ install -D -m0640 ${cfg.package}/server/solr/solr.xml "${cfg.stateDir}/data/solr.xml"
+ install -D -m0640 ${cfg.package}/server/solr/zoo.cfg "${cfg.stateDir}/data/zoo.cfg"
+ fi
+
+ if ! test -e "${cfg.stateDir}/log4j2.xml"; then
+ install -D -m0640 ${cfg.package}/server/resources/log4j2.xml "${cfg.stateDir}/log4j2.xml"
+ fi
+ '';
+
+ serviceConfig = {
+ User = cfg.user;
+ Group = cfg.group;
+ ExecStart="${cfg.package}/bin/solr start -f -a \"${concatStringsSep " " cfg.extraJavaOptions}\"";
+ ExecStop="${cfg.package}/bin/solr stop";
+ };
+ };
+
+ users.users = optionalAttrs (cfg.user == "solr") (singleton
+ { name = "solr";
+ group = cfg.group;
+ home = cfg.stateDir;
+ createHome = true;
+ uid = config.ids.uids.solr;
+ });
+
+ users.groups = optionalAttrs (cfg.group == "solr") (singleton
+ { name = "solr";
+ gid = config.ids.gids.solr;
+ });
+
+ };
+
+}