nixos/glitchtip: add nginx.createLocally option

Author: SuperSandro2000

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

@@ -53,7 +53,7 @@ in
 
       settings = lib.mkOption {
         description = ''
-          Configuration of GlitchTip. See <https://glitchtip.com/documentation/install#configuration> for more information.
+          Configuration of GlitchTip. See <https://glitchtip.com/documentation/install#configuration> for more information and required settings.
         '';
         default = { };
         defaultText = lib.literalExpression ''
@@ -62,6 +62,7 @@ in
             DEBUG_TOOLBAR = 0;
             DATABASE_URL = lib.mkIf config.services.glitchtip.database.createLocally "postgresql://@/glitchtip";
             ENABLE_OBSERVABILITY_API = false;
+            GLITCHTIP_DOMAIN = lib.mkIf config.services.glitchtip.nginx.createLocally "https://''${config.services.glitchtip.nginx.domain}";
             GLITCHTIP_ENABLE_MCP = false;
             GLITCHTIP_VERSION = config.services.glitchtip.package.version;
             GRANIAN_HOST = "127.0.0.1";
@@ -73,6 +74,7 @@ in
           }
         '';
         example = {
+          GLITCHTIP_DOMAIN = "https://glitchtip.example.com";
           DATABASE_URL = "postgres://postgres:postgres@postgres/postgres";
         };
 
@@ -86,6 +88,13 @@ in
             ]);
 
           options = {
+            GLITCHTIP_DOMAIN = lib.mkOption {
+              type = lib.types.nullOr lib.types.str;
+              description = "The URL under which GlitchTip is externally reachable.";
+              example = "https://glitchtip.example.com";
+              default = null;
+            };
+
             GLITCHTIP_ENABLE_MCP = lib.mkOption {
               type = lib.types.bool;
               description = "Whether to enable the MCP api.";
@@ -137,17 +146,31 @@ in
       database.createLocally = lib.mkOption {
         type = lib.types.bool;
         default = true;
-        description = ''
-          Whether to enable and configure a local PostgreSQL database server.
-        '';
+        description = "Whether to enable and configure a local PostgreSQL database server.";
+      };
+
+      nginx = {
+        createLocally = lib.mkOption {
+          type = lib.types.bool;
+          default = false;
+          description = "Whether to enable and configure a local Nginx server.";
+        };
+
+        domain = lib.mkOption {
+          type = lib.types.str;
+          example = "glitchtip.example.com";
+          description = ''
+            Domain under which GlitchTip will be reachable.
+            In contrast to `settings.GLITCHTIP_DOMAIN` this option has no protocol.
+            It will also set `settings.GLITCHTIP_DOMAIN` with the `https://` protocol.
+          '';
+        };
       };
 
       redis.createLocally = lib.mkOption {
         type = lib.types.bool;
         default = true;
-        description = ''
-          Whether to enable and configure a local Redis instance.
-        '';
+        description = "Whether to enable and configure a local Redis instance.";
       };
     };
   };
@@ -185,6 +208,9 @@ in
     // lib.optionalAttrs cfg.database.createLocally {
       DATABASE_URL = "postgresql://@/glitchtip";
     }
+    // lib.optionalAttrs cfg.nginx.createLocally {
+      GLITCHTIP_DOMAIN = "https://${cfg.nginx.domain}";
+    }
     // lib.optionalAttrs cfg.redis.createLocally {
       REDIS_URL = "unix://${config.services.redis.servers.glitchtip.unixSocket}";
     };
@@ -290,6 +316,22 @@ in
         };
       };
 
+    services.nginx = lib.mkIf cfg.nginx.createLocally {
+      enable = true;
+      virtualHosts.${cfg.nginx.domain} = {
+        forceSSL = lib.mkDefault true;
+        locations = {
+          "/".proxyPass = "http://${cfg.settings.GRANIAN_HOST}:${toString cfg.settings.GRANIAN_PORT}";
+          "/static/" = {
+            root = pkg;
+            extraConfig = ''
+              rewrite ^/(.*)$ /lib/glitchtip/$1 break;
+            '';
+          };
+        };
+      };
+    };
+
     services.postgresql = lib.mkIf cfg.database.createLocally {
       enable = true;
       ensureDatabases = [ "glitchtip" ];

pkgs/by-name/gl/glitchtip/package.nix

@@ -88,6 +88,14 @@ stdenv.mkDerivation (finalAttrs: {
     hash = "sha256-cv83nqoJob8rvBOFDUIr8kVSZQesG/ml+6n7yuZqP90=";
   };
 
+  postPatch = ''
+    echo 'import os
+    ALLAUTH_TRUSTED_CLIENT_IP_HEADER = os.getenv(
+        "ALLAUTH_TRUSTED_CLIENT_IP_HEADER",
+        None
+    )' >> glitchtip/settings.py
+  '';
+
   propagatedBuildInputs = pythonPackages;
 
   nativeBuildInputs = [