<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Configuration</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="install.fpm.install.html">Installation</a></div>
<div class="next" style="text-align: right; float: right;"><a href="install.pecl.html">Installation of PECL extensions</a></div>
<div class="up"><a href="install.fpm.html">FastCGI Process Manager (FPM)</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="install.fpm.configuration" class="sect1">
<h2 class="title">Configuration</h2>
<p class="para">
FPM uses <var class="filename">php.ini</var> syntax for its configuration file - <var class="filename">php-fpm.conf</var>, and pool configuration files.
</p>
<div class="sect2">
<h3 class="title">List of global <var class="filename">php-fpm.conf</var> directives</h3>
<dl>
<dt id="pid">
<code class="parameter">pid</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Path to PID file. Default value: none.
</p>
</dd>
<dt id="error-log">
<code class="parameter">error_log</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Path to error log file. Default value:
<em>#INSTALL_PREFIX#/log/php-fpm.log</em>.
If it's set to "syslog", log is sent to syslogd instead of being written in a local file.
</p>
</dd>
<dt id="log-level">
<code class="parameter">log_level</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Error log level. Possible values: alert, error, warning, notice,
debug. Default value: notice.
</p>
</dd>
<dt id="syslog-facility">
<code class="parameter">syslog.facility</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
used to specify what type of program is logging the message.
Default value: daemon.
</p>
</dd>
<dt id="syslog-ident">
<code class="parameter">syslog.ident</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Prepended to every message.
If you have multiple FPM instances running on the same server,
you can change the default value which must suit common needs.
Default value: php-fpm.
</p>
</dd>
<dt id="emergency-restart-threshold">
<code class="parameter">emergency_restart_threshold</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
If this number of child processes exit with SIGSEGV or SIGBUS within
the time interval set by <em>emergency_restart_interval</em>,
then FPM will restart. A value of 0 means 'Off'. Default value: 0 (Off).
</p>
</dd>
<dt id="emergency-restart-interval">
<code class="parameter">emergency_restart_interval</code>
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
</dt>
<dd>
<p class="para">
Interval of time used by <em>emergency_restart_interval</em> to determine when
a graceful restart will be initiated. This can be useful to work around
accidental corruptions in an accelerator's shared memory.
Available Units: s(econds), m(inutes), h(ours), or d(ays).
Default Unit: seconds. Default value: 0 (Off).
</p>
</dd>
<dt id="process-control-timeout">
<code class="parameter">process_control_timeout</code>
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
</dt>
<dd>
<p class="para">
Time limit for child processes to wait for a reaction on signals from
master. Available units: s(econds), m(inutes), h(ours), or d(ays)
Default Unit: seconds. Default value: 0.
</p>
</dd>
<dt id="process-max">
<code class="parameter">process.max</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
The maximum number of processes FPM will fork. This has been design
to control the global number of processes when using dynamic PM
within a lot of pools. Use it with caution.
Default value: 0.
</p>
</dd>
<dt id="process-priority">
<code class="parameter">process.priority</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
Specify the nice(2) priority to apply to the master process (only if set).
The value can vary from -19 (highest priority) to 20 (lower priority).
Default value: not set.
</p>
</dd>
<dt id="daemonize">
<code class="parameter">daemonize</code>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</dt>
<dd>
<p class="para">
Send FPM to background. Set to 'no' to keep FPM in foreground for
debugging. Default value: yes.
</p>
</dd>
<dt id="rlimit-files-master">
<code class="parameter">rlimit_files</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
Set open file descriptor rlimit for the master process.
Default value: Set open file descriptor rlimit for the master process.
</p>
</dd>
<dt id="rlimit-core-master">
<code class="parameter">rlimit_core</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
Set max core size rlimit for the master process.
Default value: 0.
</p>
</dd>
<dt id="events-mechanism">
<code class="parameter">events.mechanism</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Specify the event mechanism FPM will use.
The following is available: select, pool, epoll, kqueue (*BSD), port (Solaris).
Default value: not set (auto detection).
</p>
</dd>
<dt id="systemd-interval">
<code class="parameter">systemd_interval</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
When FPM is build with systemd integration, specify the interval,
in second, between health report notification to systemd.
Set to 0 to disable.
Default value: 10.
</p>
</dd>
</dl>
</div>
<div class="sect2">
<h3 class="title">List of pool directives</h3>
<p class="para">
With FPM you can run several pools of processes with different setting.
These are settings that can be tweaked per pool.
</p>
<dl>
<dt id="listen">
<code class="parameter">listen</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
The address on which to accept FastCGI requests. Valid syntaxes are:
'ip.add.re.ss:port', 'port', '/path/to/unix/socket'. This option is
mandatory for each pool.
</p>
</dd>
<dt id="listen-backlog">
<code class="parameter">listen.backlog</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
Set listen(2) backlog. A value of '-1' means unlimited. Default value:
-1.
</p>
</dd>
<dt id="listen-allowed-clients">
<code class="parameter">listen.allowed_clients</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
List of IPv4 addresses of FastCGI clients which are allowed to
connect. Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the
original PHP FastCGI (5.2.2+). Makes sense only with a tcp listening socket.
Each address must be separated by a comma. If this value is left blank,
connections will be accepted from any ip address. Default value: any.
IPv6 addresses are allowed since PHP 5.5.20 and 5.6.4.
</p>
</dd>
<dt id="listen-owner">
<code class="parameter">listen.owner</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Set permissions for unix socket, if one is used. In Linux, read/write
permissions must be set in order to allow connections from a web
server. Many BSD-derived systems allow connections regardless of permissions.
Default values: user and group are set as the running user, mode is set to 0660.
</p>
</dd>
<dt id="listen-group">
<code class="parameter">listen.group</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
See <em>listen.owner</em>.
</p>
</dd>
<dt id="listen-mode">
<code class="parameter">listen.mode</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
See <em>listen.owner</em>.
</p>
</dd>
<dt id="listen-acl-users">
<code class="parameter">listen.acl_users</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
When POSIX Access Control Lists are supported you can set them using this option.
When set, <em>listen.owner</em> and <em>listen.group</em>
are ignored. Value is a comma separated list of user names. Since PHP 5.6.5.
</p>
</dd>
<dt id="listen-acl-groups">
<code class="parameter">listen.acl_groups</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
See <em>listen.acl_users</em>.
Value is a comma separated list of group names. Since PHP 5.6.5.
</p>
</dd>
<dt id="user">
<code class="parameter">user</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Unix user of FPM processes. This option is mandatory.
</p>
</dd>
<dt id="group">
<code class="parameter">group</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Unix group of FPM processes. If not set, the default user's group is
used.
</p>
</dd>
<dt id="pm">
<code class="parameter">pm</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Choose how the process manager will control the number of child
processes. Possible values: <em>static</em>, <em>ondemand</em>,
<em>dynamic</em>.
This option is mandatory.
</p>
<p class="para">
<em>static</em> - the number of child processes is fixed (<em>pm.max_children</em>).
</p>
<p class="para">
<em>ondemand</em> - the processes spawn on demand (when requested,
as opposed to dynamic, where <em>pm.start_servers</em> are started
when the service is started.
</p>
<p class="para">
<em>dynamic</em> - the number of child processes is set dynamically based on the
following directives: <em>pm.max_children</em>, <em>pm.start_servers</em>,
<em>pm.min_spare_servers</em>, <em>pm.max_spare_servers</em>.
</p>
</dd>
<dt id="pm.max-children">
<code class="parameter">pm.max_children</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
The number of child processes to be created when <em>pm</em> is set to
<em>static</em> and the maximum number of child processes to be created
when <em>pm</em> is set to <em>dynamic</em>. This
option is mandatory.
</p>
<p class="para">
This option sets the limit on the number of simultaneous requests that
will be served. Equivalent to the ApacheMaxClients directive with
mpm_prefork and to the <var class="varname"><var class="varname">PHP_FCGI_CHILDREN</var></var> environment variable in the
original PHP FastCGI.
</p>
</dd>
<dt id="pm.start-servers">
<code class="parameter">pm.start_servers</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
The number of child processes created on startup.
Used only when <em>pm</em> is set to <em>dynamic</em>.
Default Value: min_spare_servers + (max_spare_servers -
min_spare_servers) / 2.
</p>
</dd>
<dt id="pm.min-spare-servers">
<code class="parameter">pm.min_spare_servers</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
The desired minimum number of idle server processes. Used only when
<em>pm</em> is set to <em>dynamic</em>. Also
mandatory in this case.
</p>
</dd>
<dt id="pm.max-spare-servers">
<code class="parameter">pm.max_spare_servers</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
The desired maximum number of idle server processes. Used only when
<em>pm</em> is set to <em>dynamic</em>. Also
mandatory in this case.
</p>
</dd>
<dt id="pm.process-idle-timeout">
<code class="parameter">pm.process_idle_timeout</code>
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
</dt>
<dd>
<p class="para">
The number of seconds after which an idle process will be killed.
Used only when <em>pm</em> is set to <em>ondemand</em>.
Available units: s(econds)(default), m(inutes), h(ours), or d(ays).
Default value: 10s.
</p>
</dd>
<dt id="pm.max-requests">
<code class="parameter">pm.max_requests</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
The number of requests each child process should execute before
respawning. This can be useful to work around memory leaks in 3rd party
libraries. For endless request processing specify '0'. Equivalent to
<var class="varname"><var class="varname">PHP_FCGI_MAX_REQUESTS</var></var>. Default value: 0.
</p>
</dd>
<dt id="pm.status-path">
<code class="parameter">pm.status_path</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
The URI to view the FPM status page. If this value is not set, no URI
will be recognized as a status page. Default value: none.
</p>
</dd>
<dt id="ping.path">
<code class="parameter">ping.path</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
The ping URI to call the monitoring page of FPM. If this value is not
set, no URI will be recognized as a ping page. This could be used to test
from outside that FPM is alive and responding. Please note that the value must
start with a leading slash (/).
</p>
</dd>
<dt id="ping.response">
<code class="parameter">ping.response</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
This directive may be used to customize the response to a ping
request. The response is formatted as text/plain with a 200 response code.
Default value: pong.
</p>
</dd>
<dt id="worker-process-priority">
<code class="parameter">process.priority</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
Specify the nice(2) priority to apply to the worker process (only if set).
The value can vary from -19 (highest priority) to 20 (lower priority).
Default value: not set.
</p>
</dd>
<dt id="process-dumpable">
<code class="parameter">process.dumpable</code>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</dt>
<dd>
<p class="para">
Set the process dumpable flag (PR_SET_DUMPABLE prctl) even if the process user
or group is different than the master process user. It allows to create process
core dump and ptrace the process for the pool user.
Default Value: no. Since PHP 7.0.29, 7.1.17 and 7.2.5.
</p>
</dd>
<dt id="prefix">
<code class="parameter">prefix</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Specify prefix for path evaluation
</p>
</dd>
<dt id="request-terminate-timeout">
<code class="parameter">request_terminate_timeout</code>
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
</dt>
<dd>
<p class="para">
The timeout for serving a single request after which the worker
process will be killed. This option should be used when the 'max_execution_time'
ini option does not stop script execution for some reason. A value of '0' means
'Off'. Available units: s(econds)(default), m(inutes), h(ours), or d(ays).
Default value: 0.
</p>
</dd>
<dt id="request-slowlog-timeout">
<code class="parameter">request_slowlog_timeout</code>
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
</dt>
<dd>
<p class="para">
The timeout for serving a single request after which a PHP backtrace
will be dumped to the 'slowlog' file. A value of '0' means 'Off'.
Available units: s(econds)(default), m(inutes), h(ours), or d(ays).
Default value: 0.
</p>
</dd>
<dt id="slowlog">
<code class="parameter">slowlog</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
The log file for slow requests. Default value:
<em>#INSTALL_PREFIX#/log/php-fpm.log.slow</em>.
</p>
</dd>
<dt id="rlimit-files">
<code class="parameter">rlimit_files</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
Set open file descriptor rlimit for child processes in this pool. Default value: system defined value.
</p>
</dd>
<dt id="rlimit-core">
<code class="parameter">rlimit_core</code>
<span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
</dt>
<dd>
<p class="para">
Set max core size rlimit for child processes in this pool. Possible Values: 'unlimited' or an integer greater or equal to 0.
Default value: system defined value.
</p>
</dd>
<dt id="chroot">
<code class="parameter">chroot</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Chroot to this directory at the start. This value must be defined as
an absolute path. When this value is not set, chroot is not used.
</p>
</dd>
<dt id="chdir">
<code class="parameter">chdir</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Chdir to this directory at the start. This value must be an absolute
path. Default value: current directory or / when chroot.
</p>
</dd>
<dt id="catch-workers-output">
<code class="parameter">catch_workers_output</code>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</dt>
<dd>
<p class="para">
Redirect worker stdout and stderr into main error log. If not set,
stdout and stderr will be redirected to /dev/null according to FastCGI specs.
Default value: no.
</p>
</dd>
<dt id="clear-env">
<code class="parameter">clear_env</code>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</dt>
<dd>
<p class="para">
Clear environment in FPM workers.
Prevents arbitrary environment variables from reaching FPM worker processes
by clearing the environment in workers before env vars specified in this
pool configuration are added. Since PHP 5.4.27, 5.5.11, and 5.6.0.
Default value: Yes.
</p>
</dd>
<dt id="security-limit-extensions">
<code class="parameter">security.limit_extensions</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
Limits the extensions of the main script FPM will allow to parse.
This can prevent configuration mistakes on the web server side.
You should only limit FPM to .php extensions to prevent malicious
users to use other extensions to execute php code.
Default value: .php .phar
</p>
</dd>
<dt id="access-log">
<code class="parameter">access.log</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
The access log file.
Default value: not set
</p>
</dd>
<dt id="access-format">
<code class="parameter">access.format</code>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</dt>
<dd>
<p class="para">
The access log format.
Default value: "%R - %u %t \"%m %r\" %s"
</p>
</dd>
</dl>
<p class="para">
It's possible to pass additional environment variables and update PHP settings of a certain pool.
To do this, you need to add the following options to the pool configuration file.
<div class="example" id="example-33">
<p><strong>Example #1 Passing environment variables and PHP settings to a pool</strong></p>
<div class="example-contents">
<div class="inicode"><pre class="inicode">env[HOSTNAME] = $HOSTNAME
env[PATH] = /usr/local/bin:/usr/bin:/bin
env[TMP] = /tmp
env[TMPDIR] = /tmp
env[TEMP] = /tmp
php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com
php_flag[display_errors] = off
php_admin_value[error_log] = /var/log/fpm-php.www.log
php_admin_flag[log_errors] = on
php_admin_value[memory_limit] = 32M</pre>
</div>
</div>
</div>
PHP settings passed with <em>php_value</em> or
<em>php_flag</em> will overwrite their previous value.
Please note that defining
<a href="ini.core.html#ini.disable-functions" class="link">disable_functions</a> or
<a href="ini.core.html#ini.disable-classes" class="link">disable_classes</a> will
not overwrite previously defined <var class="filename">php.ini</var> values,
but will append the new value instead.
</p>
<p class="para">
Settings defined with <em>php_admin_value</em> and <em>php_admin_flag</em>
cannot be overriden with <span class="function"><a href="function.ini-set.html" class="function">ini_set()</a></span>.
</p>
<p class="para">
As of 5.3.3, PHP settings are also possible to be set in webserver.
<div class="example" id="example-34">
<p><strong>Example #2 set PHP settings in nginx.conf</strong></p>
<div class="example-contents">
<div class="inicode"><pre class="inicode">set $php_value "pcre.backtrack_limit=424242";
set $php_value "$php_value \n pcre.recursion_limit=99999";
fastcgi_param PHP_VALUE $php_value;
fastcgi_param PHP_ADMIN_VALUE "open_basedir=/var/www/htdocs";</pre>
</div>
</div>
</div>
<div class="caution"><strong class="caution">Caution</strong>
<p class="para">
Because these settings are passed to php-fpm as fastcgi headers,
php-fpm should not be bound to a worldwide accessible address.
Otherwise, anyone could alter the PHP configuration options.
See also
<a href="install.fpm.configuration.html#listen-allowed-clients" class="link">listen.allowed_clients</a>.
</p>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="install.fpm.install.html">Installation</a></div>
<div class="next" style="text-align: right; float: right;"><a href="install.pecl.html">Installation of PECL extensions</a></div>
<div class="up"><a href="install.fpm.html">FastCGI Process Manager (FPM)</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
