Phpfpm: Difference between revisions

Latest revision as of 13:45, 1 April 2024

php-fpm is a fastcgi interface for php.

Configuration for nginx

This configuration will set up phpfpm for serving php files from ${dataDir}. Import this from your configuration.nix.

{ pkgs, lib, config, ... }:
let
  app = "phpdemo";
  domain = "${app}.example.com";
  dataDir = "/srv/http/${domain}";
in {
  services.phpfpm.pools.${app} = {
    user = app;
    settings = {
      "listen.owner" = config.services.nginx.user;
      "pm" = "dynamic";
      "pm.max_children" = 32;
      "pm.max_requests" = 500;
      "pm.start_servers" = 2;
      "pm.min_spare_servers" = 2;
      "pm.max_spare_servers" = 5;
      "php_admin_value[error_log]" = "stderr";
      "php_admin_flag[log_errors]" = true;
      "catch_workers_output" = true;
    };
    phpEnv."PATH" = lib.makeBinPath [ pkgs.php ];
  };
  services.nginx = {
    enable = true;
    virtualHosts.${domain}.locations."/" = {
      root = dataDir;
      extraConfig = ''
        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        fastcgi_pass unix:${config.services.phpfpm.pools.${app}.socket};
        include ${pkgs.nginx}/conf/fastcgi.conf;
      '';
     };
  };
  users.users.${app} = {
    isSystemUser = true;
    createHome = true;
    home = dataDir;
    group  = app;
  };
  users.groups.${app} = {};
}

Escaping special chars

When using regular expressions in locations blocks, be ware of the need to escape some special chars like \.

i.e. locations."~ ^(.+\.php)(.*)$" = { should be escaped to locations."~ ^(.+\\.php)(.*)$" = {

Otherwise file names like glyphpro.css will be matched and parsed by the php interpreter. Which likely fails with an access error because of php-fpms security.limit_extensions.

PHP Extensions

To use certain PHP extensions you will need to configure them in the php.ini-configuration of phpfpm via services.phpfpm.phpOptions or services.phpfpm.pools.${pool}.phpOptions:

{
  services.phpfpm.phpOptions = ''
    extension=${pkgs.phpExtensions.redis}/lib/php/extensions/redis.so
    extension=${pkgs.phpExtensions.apcu}/lib/php/extensions/apcu.so
  '';
}

@@ Line 2: / Line 2: @@
 == Configuration for nginx==
-This configuration will set up phpfpm for serving php files from <code>/var/www/example.com</code>.
+This configuration will set up phpfpm for serving php files from <code>${dataDir}</code>.
-put into your <code>configuration.nix</code>
+Import this from your <code>configuration.nix</code>.
 <syntaxHighlight lang=nix>
-{
+{ pkgs, lib, config, ... }:
-      services.phpfpm.poolConfigs."example.com" = ''
+let
-        listen = /var/run/example.com-phpfpm.sock
+  app = "phpdemo";
-        user = nginx
+  domain = "${app}.example.com";
-        group = nginx
+  dataDir = "/srv/http/${domain}";
-        pm = dynamic
+in {
-        pm.max_children = 32
+  services.phpfpm.pools.${app} = {
-        pm.max_requests = 500
+    user = app;
-        pm.start_servers = 2
+    settings = {
-        pm.min_spare_servers = 2
+      "listen.owner" = config.services.nginx.user;
-        pm.max_spare_servers = 5
+      "pm" = "dynamic";
-        listen.owner = nginx
+      "pm.max_children" = 32;
-        listen.group = nginx
+      "pm.max_requests" = 500;
-        php_admin_value[error_log] = 'stderr'
+      "pm.start_servers" = 2;
-        php_admin_flag[log_errors] = on
+      "pm.min_spare_servers" = 2;
-        env[PATH] = ${lib.makeBinPath [ pkgs.php ]}
+      "pm.max_spare_servers" = 5;
-         catch_workers_output = yes
+      "php_admin_value[error_log]" = "stderr";
+      "php_admin_flag[log_errors]" = true;
+      "catch_workers_output" = true;
+    };
+    phpEnv."PATH" = lib.makeBinPath [ pkgs.php ];
+  };
+  services.nginx = {
+    enable = true;
+    virtualHosts.${domain}.locations."/" = {
+      root = dataDir;
+      extraConfig = ''
+        fastcgi_split_path_info ^(.+\.php)(/.+)$;
+        fastcgi_pass unix:${config.services.phpfpm.pools.${app}.socket};
+         include ${pkgs.nginx}/conf/fastcgi.conf;
        '';
-     services.nginx = {
-       enable = true;
-       virtualHosts."example.com".locations."/" = {
-           root = "/var/www/example.com";
-           extraConfig = ''
-             fastcgi_split_path_info ^(.+\.php)(/.+)$;
-             fastcgi_pass unix:/var/run/example.com-phpfpm.sock;
-              include ${pkgs.nginx}/conf/fastcgi_params;
-              include ${pkgs.nginx}/conf/fastcgi.conf;
-           '';
-         };
-       };
       };
+  };
+  users.users.${app} = {
+    isSystemUser = true;
+    createHome = true;
+    home = dataDir;
+    group  = app;
+  };
+  users.groups.${app} = {};
 }
-</syntaxHightlight>
+</syntaxHighlight>
+===  Escaping special chars ===
+When using regular expressions in <code>locations</code> blocks, be ware of the [https://nixos.org/manual/nix/stable/language/values.html#type-string need to escape some special chars] like <code>\</code>.
+i.e. <code>locations."~ ^(.+\.php)(.*)$"  = {</code> should be escaped to <code>locations."~ ^(.+\\.php)(.*)$"  = {</code>
+Otherwise file names like ''gly'''php'''ro.css'' will be matched and parsed by the php interpreter. Which likely fails with an access error because of php-fpms [https://www.php.net/manual/en/install.fpm.configuration.php security.limit_extensions].
+See also [[Nginx | the nginx article]].
 == PHP Extensions ==
-To use certain PHP extensions you will need to configure them in the <code>php.ini</code>-configuration of phpfpm:
+To use certain PHP extensions you will need to configure them in the <code>php.ini</code>-configuration of phpfpm via <code>services.phpfpm.phpOptions</code> or <code>services.phpfpm.pools.${pool}.phpOptions</code>:
-<syntaxHightlight lang=nix>
+<syntaxHighlight lang=nix>
 {
    services.phpfpm.phpOptions = ''
-     extension=${pkgs.phpPackages.redis}/lib/php/extensions/redis.so
+     extension=${pkgs.phpExtensions.redis}/lib/php/extensions/redis.so
-     extension=${pkgs.phpPackages.apcu}/lib/php/extensions/apcu.so
+     extension=${pkgs.phpExtensions.apcu}/lib/php/extensions/apcu.so
    '';
 }
-</syntaxHightlight>
+</syntaxHighlight>