1; Start a new pool named 'www'. 2; the variable $pool can be used in any directive and will be replaced by the 3; pool name ('www' here) 4[www] 5 6; Per pool prefix 7; It only applies on the following directives: 8; - 'access.log' 9; - 'slowlog' 10; - 'listen' (unixsocket) 11; - 'chroot' 12; - 'chdir' 13; - 'php_values' 14; - 'php_admin_values' 15; When not set, the global prefix (or @php_fpm_prefix@) applies instead. 16; Note: This directive can also be relative to the global prefix. 17; Default Value: none 18;prefix = /path/to/pools/$pool 19 20; Unix user/group of processes 21; Note: The user is mandatory. If the group is not set, the default user's group 22; will be used. 23user = @php_fpm_user@ 24group = @php_fpm_group@ 25 26; The address on which to accept FastCGI requests. 27; Valid syntaxes are: 28; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific IPv4 address on 29; a specific port; 30; '0.0.0.0:port' - to listen on a TCP socket to all IPv4 addresses on 31; a specific port; 32; '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on 33; a specific port; 34; 'port' - to listen on a TCP socket to all addresses 35; (IPv6 and IPv4-mapped) on a specific port; 36; Note: IPv4-mapped addresses are disabled by-default in 37; FreeBSD for security reasons; 38; '/path/to/unix/socket' - to listen on a unix socket. 39; Note: This value is mandatory. 40listen = 127.0.0.1:9000 41 42; Set listen(2) backlog. 43; Default Value: 511 (-1 on FreeBSD and OpenBSD) 44;listen.backlog = 511 45 46; Set permissions for unix socket, if one is used. In Linux, read/write 47; permissions must be set in order to allow connections from a web server. Many 48; BSD-derived systems allow connections regardless of permissions. The owner 49; and group can be specified either by name or by their numeric IDs. 50; Default Values: user and group are set as the running user 51; mode is set to 0660 52;listen.owner = @php_fpm_user@ 53;listen.group = @php_fpm_group@ 54;listen.mode = 0660 55; When POSIX Access Control Lists are supported you can set them using 56; these options, value is a comma separated list of user/group names. 57; When set, listen.owner and listen.group are ignored 58;listen.acl_users = 59;listen.acl_groups = 60 61; List of addresses (IPv4/IPv6) of FastCGI clients which are allowed to connect. 62; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original 63; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address 64; must be separated by a comma. If this value is left blank, connections will be 65; accepted from any ip address. 66; Default Value: any 67;listen.allowed_clients = 127.0.0.1 68 69; Specify the nice(2) priority to apply to the pool processes (only if set) 70; The value can vary from -19 (highest priority) to 20 (lower priority) 71; Note: - It will only work if the FPM master process is launched as root 72; - The pool processes will inherit the master process priority 73; unless it specified otherwise 74; Default Value: no set 75; process.priority = -19 76 77; Set the process dumpable flag (PR_SET_DUMPABLE prctl) even if the process user 78; or group is different than the master process user. It allows to create process 79; core dump and ptrace the process for the pool user. 80; Default Value: no 81; process.dumpable = yes 82 83; Choose how the process manager will control the number of child processes. 84; Possible Values: 85; static - a fixed number (pm.max_children) of child processes; 86; dynamic - the number of child processes are set dynamically based on the 87; following directives. With this process management, there will be 88; always at least 1 children. 89; pm.max_children - the maximum number of children that can 90; be alive at the same time. 91; pm.start_servers - the number of children created on startup. 92; pm.min_spare_servers - the minimum number of children in 'idle' 93; state (waiting to process). If the number 94; of 'idle' processes is less than this 95; number then some children will be created. 96; pm.max_spare_servers - the maximum number of children in 'idle' 97; state (waiting to process). If the number 98; of 'idle' processes is greater than this 99; number then some children will be killed. 100; ondemand - no children are created at startup. Children will be forked when 101; new requests will connect. The following parameter are used: 102; pm.max_children - the maximum number of children that 103; can be alive at the same time. 104; pm.process_idle_timeout - The number of seconds after which 105; an idle process will be killed. 106; Note: This value is mandatory. 107pm = dynamic 108 109; The number of child processes to be created when pm is set to 'static' and the 110; maximum number of child processes when pm is set to 'dynamic' or 'ondemand'. 111; This value sets the limit on the number of simultaneous requests that will be 112; served. Equivalent to the ApacheMaxClients directive with mpm_prefork. 113; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP 114; CGI. The below defaults are based on a server without much resources. Don't 115; forget to tweak pm.* to fit your needs. 116; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand' 117; Note: This value is mandatory. 118pm.max_children = 5 119 120; The number of child processes created on startup. 121; Note: Used only when pm is set to 'dynamic' 122; Default Value: (min_spare_servers + max_spare_servers) / 2 123pm.start_servers = 2 124 125; The desired minimum number of idle server processes. 126; Note: Used only when pm is set to 'dynamic' 127; Note: Mandatory when pm is set to 'dynamic' 128pm.min_spare_servers = 1 129 130; The desired maximum number of idle server processes. 131; Note: Used only when pm is set to 'dynamic' 132; Note: Mandatory when pm is set to 'dynamic' 133pm.max_spare_servers = 3 134 135; The number of seconds after which an idle process will be killed. 136; Note: Used only when pm is set to 'ondemand' 137; Default Value: 10s 138;pm.process_idle_timeout = 10s; 139 140; The number of requests each child process should execute before respawning. 141; This can be useful to work around memory leaks in 3rd party libraries. For 142; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS. 143; Default Value: 0 144;pm.max_requests = 500 145 146; The URI to view the FPM status page. If this value is not set, no URI will be 147; recognized as a status page. It shows the following information: 148; pool - the name of the pool; 149; process manager - static, dynamic or ondemand; 150; start time - the date and time FPM has started; 151; start since - number of seconds since FPM has started; 152; accepted conn - the number of request accepted by the pool; 153; listen queue - the number of request in the queue of pending 154; connections (see backlog in listen(2)); 155; max listen queue - the maximum number of requests in the queue 156; of pending connections since FPM has started; 157; listen queue len - the size of the socket queue of pending connections; 158; idle processes - the number of idle processes; 159; active processes - the number of active processes; 160; total processes - the number of idle + active processes; 161; max active processes - the maximum number of active processes since FPM 162; has started; 163; max children reached - number of times, the process limit has been reached, 164; when pm tries to start more children (works only for 165; pm 'dynamic' and 'ondemand'); 166; Value are updated in real time. 167; Example output: 168; pool: www 169; process manager: static 170; start time: 01/Jul/2011:17:53:49 +0200 171; start since: 62636 172; accepted conn: 190460 173; listen queue: 0 174; max listen queue: 1 175; listen queue len: 42 176; idle processes: 4 177; active processes: 11 178; total processes: 15 179; max active processes: 12 180; max children reached: 0 181; 182; By default the status page output is formatted as text/plain. Passing either 183; 'html', 'xml' or 'json' in the query string will return the corresponding 184; output syntax. Example: 185; http://www.foo.bar/status 186; http://www.foo.bar/status?json 187; http://www.foo.bar/status?html 188; http://www.foo.bar/status?xml 189; 190; By default the status page only outputs short status. Passing 'full' in the 191; query string will also return status for each pool process. 192; Example: 193; http://www.foo.bar/status?full 194; http://www.foo.bar/status?json&full 195; http://www.foo.bar/status?html&full 196; http://www.foo.bar/status?xml&full 197; The Full status returns for each process: 198; pid - the PID of the process; 199; state - the state of the process (Idle, Running, ...); 200; start time - the date and time the process has started; 201; start since - the number of seconds since the process has started; 202; requests - the number of requests the process has served; 203; request duration - the duration in µs of the requests; 204; request method - the request method (GET, POST, ...); 205; request URI - the request URI with the query string; 206; content length - the content length of the request (only with POST); 207; user - the user (PHP_AUTH_USER) (or '-' if not set); 208; script - the main script called (or '-' if not set); 209; last request cpu - the %cpu the last request consumed 210; it's always 0 if the process is not in Idle state 211; because CPU calculation is done when the request 212; processing has terminated; 213; last request memory - the max amount of memory the last request consumed 214; it's always 0 if the process is not in Idle state 215; because memory calculation is done when the request 216; processing has terminated; 217; If the process is in Idle state, then informations are related to the 218; last request the process has served. Otherwise informations are related to 219; the current request being served. 220; Example output: 221; ************************ 222; pid: 31330 223; state: Running 224; start time: 01/Jul/2011:17:53:49 +0200 225; start since: 63087 226; requests: 12808 227; request duration: 1250261 228; request method: GET 229; request URI: /test_mem.php?N=10000 230; content length: 0 231; user: - 232; script: /home/fat/web/docs/php/test_mem.php 233; last request cpu: 0.00 234; last request memory: 0 235; 236; Note: There is a real-time FPM status monitoring sample web page available 237; It's available in: @EXPANDED_DATADIR@/fpm/status.html 238; 239; Note: The value must start with a leading slash (/). The value can be 240; anything, but it may not be a good idea to use the .php extension or it 241; may conflict with a real PHP file. 242; Default Value: not set 243;pm.status_path = /status 244 245; The address on which to accept FastCGI status request. This creates a new 246; invisible pool that can handle requests independently. This is useful 247; if the main pool is busy with long running requests because it is still possible 248; to get the status before finishing the long running requests. 249; 250; Valid syntaxes are: 251; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific IPv4 address on 252; a specific port; 253; '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on 254; a specific port; 255; 'port' - to listen on a TCP socket to all addresses 256; (IPv6 and IPv4-mapped) on a specific port; 257; '/path/to/unix/socket' - to listen on a unix socket. 258; Default Value: value of the listen option 259;pm.status_listen = 127.0.0.1:9001 260 261; The ping URI to call the monitoring page of FPM. If this value is not set, no 262; URI will be recognized as a ping page. This could be used to test from outside 263; that FPM is alive and responding, or to 264; - create a graph of FPM availability (rrd or such); 265; - remove a server from a group if it is not responding (load balancing); 266; - trigger alerts for the operating team (24/7). 267; Note: The value must start with a leading slash (/). The value can be 268; anything, but it may not be a good idea to use the .php extension or it 269; may conflict with a real PHP file. 270; Default Value: not set 271;ping.path = /ping 272 273; This directive may be used to customize the response of a ping request. The 274; response is formatted as text/plain with a 200 response code. 275; Default Value: pong 276;ping.response = pong 277 278; The access log file 279; Default: not set 280;access.log = log/$pool.access.log 281 282; The access log format. 283; The following syntax is allowed 284; %%: the '%' character 285; %C: %CPU used by the request 286; it can accept the following format: 287; - %{user}C for user CPU only 288; - %{system}C for system CPU only 289; - %{total}C for user + system CPU (default) 290; %d: time taken to serve the request 291; it can accept the following format: 292; - %{seconds}d (default) 293; - %{milliseconds}d 294; - %{mili}d 295; - %{microseconds}d 296; - %{micro}d 297; %e: an environment variable (same as $_ENV or $_SERVER) 298; it must be associated with embraces to specify the name of the env 299; variable. Some examples: 300; - server specifics like: %{REQUEST_METHOD}e or %{SERVER_PROTOCOL}e 301; - HTTP headers like: %{HTTP_HOST}e or %{HTTP_USER_AGENT}e 302; %f: script filename 303; %l: content-length of the request (for POST request only) 304; %m: request method 305; %M: peak of memory allocated by PHP 306; it can accept the following format: 307; - %{bytes}M (default) 308; - %{kilobytes}M 309; - %{kilo}M 310; - %{megabytes}M 311; - %{mega}M 312; %n: pool name 313; %o: output header 314; it must be associated with embraces to specify the name of the header: 315; - %{Content-Type}o 316; - %{X-Powered-By}o 317; - %{Transfert-Encoding}o 318; - .... 319; %p: PID of the child that serviced the request 320; %P: PID of the parent of the child that serviced the request 321; %q: the query string 322; %Q: the '?' character if query string exists 323; %r: the request URI (without the query string, see %q and %Q) 324; %R: remote IP address 325; %s: status (response code) 326; %t: server time the request was received 327; it can accept a strftime(3) format: 328; %d/%b/%Y:%H:%M:%S %z (default) 329; The strftime(3) format must be encapsuled in a %{<strftime_format>}t tag 330; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t 331; %T: time the log has been written (the request has finished) 332; it can accept a strftime(3) format: 333; %d/%b/%Y:%H:%M:%S %z (default) 334; The strftime(3) format must be encapsuled in a %{<strftime_format>}t tag 335; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t 336; %u: remote user 337; 338; Default: "%R - %u %t \"%m %r\" %s" 339;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%" 340 341; The log file for slow requests 342; Default Value: not set 343; Note: slowlog is mandatory if request_slowlog_timeout is set 344;slowlog = log/$pool.log.slow 345 346; The timeout for serving a single request after which a PHP backtrace will be 347; dumped to the 'slowlog' file. A value of '0s' means 'off'. 348; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) 349; Default Value: 0 350;request_slowlog_timeout = 0 351 352; Depth of slow log stack trace. 353; Default Value: 20 354;request_slowlog_trace_depth = 20 355 356; The timeout for serving a single request after which the worker process will 357; be killed. This option should be used when the 'max_execution_time' ini option 358; does not stop script execution for some reason. A value of '0' means 'off'. 359; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) 360; Default Value: 0 361;request_terminate_timeout = 0 362 363; The timeout set by 'request_terminate_timeout' ini option is not engaged after 364; application calls 'fastcgi_finish_request' or when application has finished and 365; shutdown functions are being called (registered via register_shutdown_function). 366; This option will enable timeout limit to be applied unconditionally 367; even in such cases. 368; Default Value: no 369;request_terminate_timeout_track_finished = no 370 371; Set open file descriptor rlimit. 372; Default Value: system defined value 373;rlimit_files = 1024 374 375; Set max core size rlimit. 376; Possible Values: 'unlimited' or an integer greater or equal to 0 377; Default Value: system defined value 378;rlimit_core = 0 379 380; Chroot to this directory at the start. This value must be defined as an 381; absolute path. When this value is not set, chroot is not used. 382; Note: you can prefix with '$prefix' to chroot to the pool prefix or one 383; of its subdirectories. If the pool prefix is not set, the global prefix 384; will be used instead. 385; Note: chrooting is a great security feature and should be used whenever 386; possible. However, all PHP paths will be relative to the chroot 387; (error_log, sessions.save_path, ...). 388; Default Value: not set 389;chroot = 390 391; Chdir to this directory at the start. 392; Note: relative path can be used. 393; Default Value: current directory or / when chroot 394;chdir = /var/www 395 396; Redirect worker stdout and stderr into main error log. If not set, stdout and 397; stderr will be redirected to /dev/null according to FastCGI specs. 398; Note: on highloaded environment, this can cause some delay in the page 399; process time (several ms). 400; Default Value: no 401;catch_workers_output = yes 402 403; Decorate worker output with prefix and suffix containing information about 404; the child that writes to the log and if stdout or stderr is used as well as 405; log level and time. This options is used only if catch_workers_output is yes. 406; Settings to "no" will output data as written to the stdout or stderr. 407; Default value: yes 408;decorate_workers_output = no 409 410; Clear environment in FPM workers 411; Prevents arbitrary environment variables from reaching FPM worker processes 412; by clearing the environment in workers before env vars specified in this 413; pool configuration are added. 414; Setting to "no" will make all environment variables available to PHP code 415; via getenv(), $_ENV and $_SERVER. 416; Default Value: yes 417;clear_env = no 418 419; Limits the extensions of the main script FPM will allow to parse. This can 420; prevent configuration mistakes on the web server side. You should only limit 421; FPM to .php extensions to prevent malicious users to use other extensions to 422; execute php code. 423; Note: set an empty value to allow all extensions. 424; Default Value: .php 425;security.limit_extensions = .php .php3 .php4 .php5 .php7 426 427; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from 428; the current environment. 429; Default Value: clean env 430;env[HOSTNAME] = $HOSTNAME 431;env[PATH] = /usr/local/bin:/usr/bin:/bin 432;env[TMP] = /tmp 433;env[TMPDIR] = /tmp 434;env[TEMP] = /tmp 435 436; Additional php.ini defines, specific to this pool of workers. These settings 437; overwrite the values previously defined in the php.ini. The directives are the 438; same as the PHP SAPI: 439; php_value/php_flag - you can set classic ini defines which can 440; be overwritten from PHP call 'ini_set'. 441; php_admin_value/php_admin_flag - these directives won't be overwritten by 442; PHP call 'ini_set' 443; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no. 444 445; Defining 'extension' will load the corresponding shared extension from 446; extension_dir. Defining 'disable_functions' or 'disable_classes' will not 447; overwrite previously defined php.ini values, but will append the new value 448; instead. 449 450; Note: path INI options can be relative and will be expanded with the prefix 451; (pool, global or @prefix@) 452 453; Default Value: nothing is defined by default except the values in php.ini and 454; specified at startup with the -d argument 455;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com 456;php_flag[display_errors] = off 457;php_admin_value[error_log] = /var/log/fpm-php.www.log 458;php_admin_flag[log_errors] = on 459;php_admin_value[memory_limit] = 32M 460