Differences between revisions 8 and 16 (spanning 8 versions)
Revision 8 as of 2021-11-18 08:45:42
Size: 4711
Comment:
Revision 16 as of 2022-09-25 19:03:58
Size: 784
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
'''PHP-FPM''' is a PHP implementation of the FastCGI, an enhancement of the earlier Common Gateway Interface (CGI). It works especially well with [[NGINX/FastCGIConfiguration|NGINX]]. The PHP '''FastCGI Process Manager''' ('''PHP-FPM''') is an implementation of the [[Protocols/CGI|FastCGI]] specification.
Line 13: Line 13:
To install PHP-FPM on a system, use your local package to manager to grab all of the following: `php`, `php-fpm`, `fcgiwrap`, and `nginx`. PHP-FPM naturally depends on `php(1)`. See [[PHP#Installation|here]] for help with installation, and [[PHP/Configuration|here]] for help with configuration.
Line 15: Line 15:
Often `apache2-utils` (a.k.a. `apache-tools`, `httpd-utils`, etc... consult your package manager!) is also necessary, for creating `.htpasswd` files. Most Linux and BSD distributions will offer a `php-fpm` package.
Line 17: Line 17:
Upstream manages a Docker file with frequent security patching, as `bitnami/php-fpm:latest`. This will expose PHP-FPM on port 9000 and generally work out of the box. Official container images are available from the upstream development team. They are tagged like `php:<version>-fpm`

----
Line 21: Line 23:
=== PHP === == Configuration ==
Line 23: Line 25:
PHP-FPM unsurprisingly runs in '''PHP''' and will require a working installation. The primary configuration for PHP is found at `/etc/php/php.ini`. Some distributions provide two versions: a hardened `php.ini-production` and a verbose `php.ini-development`.

See [[PHPConfiguration|here]] for help in configuring PHP.

The upstream Docker image bundles PHP internally, but it is ''possible'' to un-bundle it and force the use of an existing installation.



=== PHP-FPM ===

For the most part, distributed configuration for PHP-FPM work out of the box.
As a security measure, the allowable extensions should be set as strictly as possible.
Line 36: Line 28:
; Pid file
pid = /run/php-fpm/php-fpm.pid

; Error log
error_log = /var/log/php-fpm.log
}}}




=== FCGIWrap ===

'''FCGIWrap''' is, as the name implies, a wrapper script. It manages the configuration of FastCGI through PHP-FPM so that all you need to do is point NGINX at `/run/fcgiwrap.sock`.

At the same time, it is ''entirely'' optional. The upstream Docker image does not include it. Not using '''FCGIWrap''' will require more attention on the [[PHPFPMConfiguration|configuration of PHP-FPM]], however.



=== NGINX ===

'''NGINX''' is a modern and lightweight web server, which works well with PHP-FPM. For more details on NGINX configuration, see [[NGINXSetup|here]].

A basic site configuration for PHP-FPM would be:

{{{
user www-data www-data;

http {
  server {
    listen 80;
    server_name example.com;
    root /var/www;

    location ~ \.php(/|$) {
      fastcgi_split_path_info ^(.+\.php)(/.+)$;
      fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
      fastcgi_param PATH_INFO $fastcgi_path_info;

      try_files $uri =404;

      fastcgi_pass unix:/run/fcgiwrap.sock;
      include fastcgi_params;
    }
  }
}
}}}

As stated above, `/run/fcgiwrap.sock` can be used through FCGIWrap. If you are not using that package, or if you are using the upstream Docker image, you will need to set this differently. In particular, if you are redirecting to a PHP environment on another server, you will need to set this to an address and port.

{{{
fastcgi_pass 127.0.0.1:9000
}}}



=== Test Script ===

A minimal test script to validate the PHP installation.

{{{
<?php phpinfo(); ?>
security.limit_extensions = .php .html .htm
Line 103: Line 35:
== Remote Files, chroots, and Work Directories ==

PHP applications can be placed anywhere on the web root and they will work as expected. This is because PHP-FPM defaults to working in the current work directory.

However, it is ''recommended'' to isolate PHP-FPM by running it in a different work directory. This is accomplished by configuring PHP-FPM on a pool level, which you can read more about [[PHPFPMConfiguration#PoolConfiguration|here]]. What needs to be addressed up-front is how a web server will interact with an isolated FastCGI environment.

The NGINX `try_files` command, as shown below, checks for existence of files. This will cause issues if PHP applications are actually living in a different directory (or a different server). However, without checking for the existence of an executable, you can run into difficult-to-debug errors and security issues regarding embedded PHP in ordinary files.

The workaround is to set the key FastCGI parameters for the target server and check the URI against local null files. Furthermore, note the specific ordering in this configuration.

{{{
location ~ \.php(/|$) {
    fastcgi_split_path_info ^(.+?\.php)(/.*)$;
    fastcgi_param SCRIPT_FILENAME /remote/path/to/work/directory/$fastcgi_script_name;
    fastcgi_param PATH_INFO $fastcgi_path_info;

    try_files $uri =404;

    fastcgi_pass 127.0.0.1:9000;
    include fastcgi_params;
}
}}}

Note that `try_files` is called ''strictly after'' path info has been pulled out. Try files will, on success, overwrite `$uri` with the matched local URI. To avoid this, set the value of parameters before validating file existence.
== Usage ==

PHP-FPM

The PHP FastCGI Process Manager (PHP-FPM) is an implementation of the FastCGI specification.


Installation

PHP-FPM naturally depends on php(1). See here for help with installation, and here for help with configuration.

Most Linux and BSD distributions will offer a php-fpm package.

Official container images are available from the upstream development team. They are tagged like php:<version>-fpm


Configuration

As a security measure, the allowable extensions should be set as strictly as possible.

security.limit_extensions = .php .html .htm


Usage


CategoryRicottone

PHP/FPM (last edited 2023-05-25 17:00:50 by DominicRicottone)