Merge pull request #318285 from gador/nixos-zabbixWeb-nginx

nixos/zabbixWeb: Add nginx as webserver, add zabbix 6.4

nixos/modules/services/web-apps/zabbix.nix

@@ -1,9 +1,31 @@
-{ config, lib, options, pkgs, ... }:
+{
+  config,
+  lib,
+  options,
+  pkgs,
+  ...
+}:
 
 let
 
-  inherit (lib) mkDefault mkEnableOption mkPackageOption mkForce mkIf mkMerge mkOption types;
-  inherit (lib) literalExpression mapAttrs optionalString versionAtLeast;
+  inherit (lib)
+    mkDefault
+    mkEnableOption
+    mkPackageOption
+    mkRenamedOptionModule
+    mkForce
+    mkIf
+    mkMerge
+    mkOption
+    types
+    ;
+  inherit (lib)
+    literalExpression
+    mapAttrs
+    optionalString
+    optionals
+    versionAtLeast
+    ;
 
   cfg = config.services.zabbixWeb;
   opt = options.services.zabbixWeb;
@@ -17,13 +39,25 @@ let
     <?php
     // Zabbix GUI configuration file.
     global $DB;
-    $DB['TYPE'] = '${ { mysql = "MYSQL"; pgsql = "POSTGRESQL"; oracle = "ORACLE"; }.${cfg.database.type} }';
+    $DB['TYPE'] = '${
+      {
+        mysql = "MYSQL";
+        pgsql = "POSTGRESQL";
+        oracle = "ORACLE";
+      }
+      .${cfg.database.type}
+    }';
     $DB['SERVER'] = '${cfg.database.host}';
     $DB['PORT'] = '${toString cfg.database.port}';
     $DB['DATABASE'] = '${cfg.database.name}';
     $DB['USER'] = '${cfg.database.user}';
     # NOTE: file_get_contents adds newline at the end of returned string
-    $DB['PASSWORD'] = ${if cfg.database.passwordFile != null then "trim(file_get_contents('${cfg.database.passwordFile}'), \"\\r\\n\")" else "''"};
+    $DB['PASSWORD'] = ${
+      if cfg.database.passwordFile != null then
+        "trim(file_get_contents('${cfg.database.passwordFile}'), \"\\r\\n\")"
+      else
+        "''"
+    };
     // Schema name. Used for IBM DB2 and PostgreSQL.
     $DB['SCHEMA'] = ''';
     $ZBX_SERVER = '${cfg.server.address}';
@@ -33,16 +67,33 @@ let
 
     ${cfg.extraConfig}
   '';
-
 in
 {
+  imports = [
+    (mkRenamedOptionModule
+      [
+        "services"
+        "zabbixWeb"
+        "virtualHost"
+      ]
+      [
+        "services"
+        "zabbixWeb"
+        "httpd"
+        "virtualHost"
+      ]
+    )
+  ];
   # interface
 
   options.services = {
     zabbixWeb = {
       enable = mkEnableOption "the Zabbix web interface";
 
-      package = mkPackageOption pkgs [ "zabbix" "web" ] { };
+      package = mkPackageOption pkgs [
+        "zabbix"
+        "web"
+      ] { };
 
       server = {
         port = mkOption {
@@ -60,7 +111,11 @@ in
 
       database = {
         type = mkOption {
-          type = types.enum [ "mysql" "pgsql" "oracle" ];
+          type = types.enum [
+            "mysql"
+            "pgsql"
+            "oracle"
+          ];
           example = "mysql";
           default = "pgsql";
           description = "Database engine to use.";
@@ -75,9 +130,12 @@ in
         port = mkOption {
           type = types.port;
           default =
-            if cfg.database.type == "mysql" then config.services.mysql.port
-            else if cfg.database.type == "pgsql" then config.services.postgresql.settings.port
-            else 1521;
+            if cfg.database.type == "mysql" then
+              config.services.mysql.port
+            else if cfg.database.type == "pgsql" then
+              config.services.postgresql.settings.port
+            else
+              1521;
           defaultText = literalExpression ''
             if config.${opt.database.type} == "mysql" then config.${options.services.mysql.port}
             else if config.${opt.database.type} == "pgsql" then config.services.postgresql.settings.port
@@ -116,7 +174,17 @@ in
         };
       };
 
-      virtualHost = mkOption {
+      frontend = mkOption {
+        type = types.enum [
+          "nginx"
+          "httpd"
+        ];
+        example = "nginx";
+        default = "httpd";
+        description = "Frontend server to use.";
+      };
+
+      httpd.virtualHost = mkOption {
         type = types.submodule (import ../web-servers/apache-httpd/vhost-options.nix);
         example = literalExpression ''
           {
@@ -126,14 +194,43 @@ in
             enableACME = true;
           }
         '';
+        default = { };
         description = ''
           Apache configuration can be done by adapting `services.httpd.virtualHosts.<name>`.
           See [](#opt-services.httpd.virtualHosts) for further information.
         '';
       };
 
+      hostname = mkOption {
+        type = types.str;
+        default = "zabbix.local";
+        description = "Hostname for either nginx or httpd.";
+      };
+
+      nginx.virtualHost = mkOption {
+        type = types.submodule (import ../web-servers/nginx/vhost-options.nix);
+        example = literalExpression ''
+          {
+            forceSSL = true;
+            sslCertificateKey = "/etc/ssl/zabbix.key";
+            sslCertificate = "/etc/ssl/zabbix.crt";
+          }
+        '';
+        default = { };
+        description = ''
+          Nginx configuration can be done by adapting `services.nginx.virtualHosts.<name>`.
+          See [](#opt-services.nginx.virtualHosts) for further information.
+        '';
+      };
+
       poolConfig = mkOption {
-        type = with types; attrsOf (oneOf [ str int bool ]);
+        type =
+          with types;
+          attrsOf (oneOf [
+            str
+            int
+            bool
+          ]);
         default = {
           "pm" = "dynamic";
           "pm.max_children" = 32;
@@ -154,7 +251,6 @@ in
           Additional configuration to be copied verbatim into {file}`zabbix.conf.php`.
         '';
       };
-
     };
   };
 
@@ -162,61 +258,96 @@ in
 
   config = mkIf cfg.enable {
 
-    services.zabbixWeb.extraConfig = optionalString ((versionAtLeast config.system.stateVersion "20.09") && (versionAtLeast cfg.package.version "5.0.0")) ''
-      $DB['DOUBLE_IEEE754'] = 'true';
-    '';
+    services.zabbixWeb.extraConfig =
+      optionalString
+        (
+          (versionAtLeast config.system.stateVersion "20.09") && (versionAtLeast cfg.package.version "5.0.0")
+        )
+        ''
+          $DB['DOUBLE_IEEE754'] = 'true';
+        '';
 
-    systemd.tmpfiles.rules = [
-      "d '${stateDir}' 0750 ${user} ${group} - -"
-      "d '${stateDir}/session' 0750 ${user} ${config.services.httpd.group} - -"
-    ];
+    systemd.tmpfiles.rules =
+      [ "d '${stateDir}' 0750 ${user} ${group} - -" ]
+      ++ optionals (cfg.frontend == "httpd") [
+        "d '${stateDir}/session' 0750 ${user} ${config.services.httpd.group} - -"
+      ]
+      ++ optionals (cfg.frontend == "nginx") [
+        "d '${stateDir}/session' 0750 ${user} ${config.services.nginx.group} - -"
+      ];
 
     services.phpfpm.pools.zabbix = {
       inherit user;
-      group = config.services.httpd.group;
-      phpOptions = ''
-        # https://www.zabbix.com/documentation/current/manual/installation/install
-        memory_limit = 128M
-        post_max_size = 16M
-        upload_max_filesize = 2M
-        max_execution_time = 300
-        max_input_time = 300
-        session.auto_start = 0
-        mbstring.func_overload = 0
-        always_populate_raw_post_data = -1
-        # https://bbs.archlinux.org/viewtopic.php?pid=1745214#p1745214
-        session.save_path = ${stateDir}/session
-      '' + optionalString (config.time.timeZone != null) ''
-        date.timezone = "${config.time.timeZone}"
-      '' + optionalString (cfg.database.type == "oracle") ''
-        extension=${pkgs.phpPackages.oci8}/lib/php/extensions/oci8.so
-      '';
+      group = config.services.${cfg.frontend}.group;
+      phpOptions =
+        ''
+          # https://www.zabbix.com/documentation/current/manual/installation/install
+          memory_limit = 128M
+          post_max_size = 16M
+          upload_max_filesize = 2M
+          max_execution_time = 300
+          max_input_time = 300
+          session.auto_start = 0
+          mbstring.func_overload = 0
+          always_populate_raw_post_data = -1
+          # https://bbs.archlinux.org/viewtopic.php?pid=1745214#p1745214
+          session.save_path = ${stateDir}/session
+        ''
+        + optionalString (config.time.timeZone != null) ''
+          date.timezone = "${config.time.timeZone}"
+        ''
+        + optionalString (cfg.database.type == "oracle") ''
+          extension=${pkgs.phpPackages.oci8}/lib/php/extensions/oci8.so
+        '';
       phpEnv.ZABBIX_CONFIG = "${zabbixConfig}";
       settings = {
-        "listen.owner" = config.services.httpd.user;
-        "listen.group" = config.services.httpd.group;
+        "listen.owner" =
+          if cfg.frontend == "httpd" then config.services.httpd.user else config.services.nginx.user;
+        "listen.group" =
+          if cfg.frontend == "httpd" then config.services.httpd.group else config.services.nginx.group;
       } // cfg.poolConfig;
     };
 
-    services.httpd = {
+    services.httpd = mkIf (cfg.frontend == "httpd") {
       enable = true;
-      adminAddr = mkDefault cfg.virtualHost.adminAddr;
+      adminAddr = mkDefault cfg.httpd.virtualHost.adminAddr;
       extraModules = [ "proxy_fcgi" ];
-      virtualHosts.${cfg.virtualHost.hostName} = mkMerge [ cfg.virtualHost {
-        documentRoot = mkForce "${cfg.package}/share/zabbix";
-        extraConfig = ''
-          <Directory "${cfg.package}/share/zabbix">
-            <FilesMatch "\.php$">
-              <If "-f %{REQUEST_FILENAME}">
-                SetHandler "proxy:unix:${fpm.socket}|fcgi://localhost/"
-              </If>
-            </FilesMatch>
-            AllowOverride all
-            Options -Indexes
-            DirectoryIndex index.php
-          </Directory>
-        '';
-      } ];
+      virtualHosts.${cfg.hostname} = mkMerge [
+        cfg.httpd.virtualHost
+        {
+          documentRoot = mkForce "${cfg.package}/share/zabbix";
+          extraConfig = ''
+            <Directory "${cfg.package}/share/zabbix">
+              <FilesMatch "\.php$">
+                <If "-f %{REQUEST_FILENAME}">
+                  SetHandler "proxy:unix:${fpm.socket}|fcgi://localhost/"
+                </If>
+              </FilesMatch>
+              AllowOverride all
+              Options -Indexes
+              DirectoryIndex index.php
+            </Directory>
+          '';
+        }
+      ];
+    };
+
+    services.nginx = mkIf (cfg.frontend == "nginx") {
+      enable = true;
+      virtualHosts.${cfg.hostname} = mkMerge [
+        cfg.nginx.virtualHost
+        {
+          root = mkForce "${cfg.package}/share/zabbix";
+          locations."/" = {
+            index = "index.html index.htm index.php";
+            tryFiles = "$uri $uri/ =404";
+          };
+          locations."~ \.php$".extraConfig = ''
+            fastcgi_pass  unix:${fpm.socket};
+            fastcgi_index index.php;
+          '';
+        }
+      ];
     };
 
     users.users.${user} = mapAttrs (name: mkDefault) {
@@ -225,9 +356,6 @@ in
       inherit group;
     };
 
-    users.groups.${group} = mapAttrs (name: mkDefault) {
-      gid = config.ids.gids.zabbix;
-    };
-
+    users.groups.${group} = mapAttrs (name: mkDefault) { gid = config.ids.gids.zabbix; };
   };
 }

pkgs/servers/monitoring/zabbix/versions.nix

@@ -1,4 +1,9 @@
 generic: {
+  v64 = generic {
+    version = "6.4.15";
+    hash = "sha256-CtmNCuzDVchijinWcop3lGUTVGS2JbiQCbmusyXBQvY=";
+    vendorHash = null;
+  };
   v60 = generic {
     version = "6.0.26";
     hash = "sha256-MIOKe5hqfDecB1oWZKzbFmJCsQLuAGtp21l2WxxVG+g=";

pkgs/top-level/all-packages.nix

@@ -26443,6 +26443,7 @@ with pkgs;
   };
 
   zabbix60 = recurseIntoAttrs (zabbixFor "v60");
+  zabbix64 = recurseIntoAttrs (zabbixFor "v64");
   zabbix50 = recurseIntoAttrs (zabbixFor "v50");
 
   zabbix = zabbix60;