diff options
author | Alyssa Ross <hi@alyssa.is> | 2021-01-02 08:55:12 +0000 |
---|---|---|
committer | Alyssa Ross <hi@alyssa.is> | 2021-01-02 10:26:14 +0000 |
commit | 0886e232c6a24aa8a3a67363fb92db838ac16438 (patch) | |
tree | fcb0374c6189f74a970074be885f09610339194b /nixpkgs/nixos | |
parent | 0869df9250bff24f883c1c411e0db10fd789f7d4 (diff) | |
download | nixlib-0886e232c6a24aa8a3a67363fb92db838ac16438.tar nixlib-0886e232c6a24aa8a3a67363fb92db838ac16438.tar.gz nixlib-0886e232c6a24aa8a3a67363fb92db838ac16438.tar.bz2 nixlib-0886e232c6a24aa8a3a67363fb92db838ac16438.tar.lz nixlib-0886e232c6a24aa8a3a67363fb92db838ac16438.tar.xz nixlib-0886e232c6a24aa8a3a67363fb92db838ac16438.tar.zst nixlib-0886e232c6a24aa8a3a67363fb92db838ac16438.zip |
nixos/nginx: allow overriding fastcgi params
By default in Nginx, if you want to override a single fastcgi_param, you have to override all of them. This is less of a big deal if you're editing the Nginx configuration directly, but when you're generating the Nginx configuration with Nix it can be very annoying to bloat your configuration repeating the default values of FastCGI parameters every time. This patch adds a fastcgiParams option to Nginx locations. If any parameters are set through this, all the default values will be included as well, so only the ones that are changing need to be supplied. There's no way to use fastcgiParams to actually override all parameters if that's what you want, but I think that's a niche use case and it's still possible using extraConfig, which up until now was the only option Nginx allows the fastcgi_param directive in http and server scopes as well as location, but here I only support location. It would be possible to support the others, but I don't think it's worth it. It would be a possible future enhancement if somebody has a need for it.
Diffstat (limited to 'nixpkgs/nixos')
-rw-r--r-- | nixpkgs/nixos/modules/services/web-servers/nginx/default.nix | 31 | ||||
-rw-r--r-- | nixpkgs/nixos/modules/services/web-servers/nginx/location-options.nix | 10 |
2 files changed, 41 insertions, 0 deletions
diff --git a/nixpkgs/nixos/modules/services/web-servers/nginx/default.nix b/nixpkgs/nixos/modules/services/web-servers/nginx/default.nix index 8a015bb3556c..04d66ffd25c6 100644 --- a/nixpkgs/nixos/modules/services/web-servers/nginx/default.nix +++ b/nixpkgs/nixos/modules/services/web-servers/nginx/default.nix @@ -27,6 +27,33 @@ let ) cfg.virtualHosts; enableIPv6 = config.networking.enableIPv6; + defaultFastcgiParams = { + SCRIPT_FILENAME = "$document_root$fastcgi_script_name"; + QUERY_STRING = "$query_string"; + REQUEST_METHOD = "$request_method"; + CONTENT_TYPE = "$content_type"; + CONTENT_LENGTH = "$content_length"; + + SCRIPT_NAME = "$fastcgi_script_name"; + REQUEST_URI = "$request_uri"; + DOCUMENT_URI = "$document_uri"; + DOCUMENT_ROOT = "$document_root"; + SERVER_PROTOCOL = "$server_protocol"; + REQUEST_SCHEME = "$scheme"; + HTTPS = "$https if_not_empty"; + + GATEWAY_INTERFACE = "CGI/1.1"; + SERVER_SOFTWARE = "nginx/$nginx_version"; + + REMOTE_ADDR = "$remote_addr"; + REMOTE_PORT = "$remote_port"; + SERVER_ADDR = "$server_addr"; + SERVER_PORT = "$server_port"; + SERVER_NAME = "$server_name"; + + REDIRECT_STATUS = "200"; + }; + recommendedProxyConfig = pkgs.writeText "nginx-recommended-proxy-headers.conf" '' proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; @@ -287,6 +314,10 @@ let proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection $connection_upgrade; ''} + ${concatStringsSep "\n" + (mapAttrsToList (n: v: ''fastcgi_param ${n} "${v}";'') + (optionalAttrs (config.fastcgiParams != {}) + (defaultFastcgiParams // config.fastcgiParams)))} ${optionalString (config.index != null) "index ${config.index};"} ${optionalString (config.tryFiles != null) "try_files ${config.tryFiles};"} ${optionalString (config.root != null) "root ${config.root};"} diff --git a/nixpkgs/nixos/modules/services/web-servers/nginx/location-options.nix b/nixpkgs/nixos/modules/services/web-servers/nginx/location-options.nix index 3d9e391ecf20..a85bacb9e4e2 100644 --- a/nixpkgs/nixos/modules/services/web-servers/nginx/location-options.nix +++ b/nixpkgs/nixos/modules/services/web-servers/nginx/location-options.nix @@ -73,6 +73,16 @@ with lib; ''; }; + fastcgiParams = mkOption { + type = types.attrsOf types.str; + default = {}; + description = '' + FastCGI parameters to override. Unlike in the Nginx + configuration file, overriding only some default parameters + won't unset the default values for other parameters. + ''; + }; + extraConfig = mkOption { type = types.lines; default = ""; |