1;;;;;;;;;;;;;;;;;;;;; 2; FPM Configuration ; 3;;;;;;;;;;;;;;;;;;;;; 4 5; All relative paths in this configuration file are relative to PHP's install 6; prefix (@prefix@). This prefix can be dynamically changed by using the 7; '-p' argument from the command line. 8 9; Include one or more files. If glob(3) exists, it is used to include a bunch of 10; files from a glob(3) pattern. This directive can be used everywhere in the 11; file. 12; Relative path can also be used. They will be prefixed by: 13; - the global prefix if it's been set (-p argument) 14; - @prefix@ otherwise 15;include=etc/fpm.d/*.conf 16 17;;;;;;;;;;;;;;;;;; 18; Global Options ; 19;;;;;;;;;;;;;;;;;; 20 21[global] 22; Pid file 23; Note: the default prefix is @EXPANDED_LOCALSTATEDIR@ 24; Default Value: none 25;pid = run/php-fpm.pid 26 27; Error log file 28; If it's set to "syslog", log is sent to syslogd instead of being written 29; in a local file. 30; Note: the default prefix is @EXPANDED_LOCALSTATEDIR@ 31; Default Value: log/php-fpm.log 32;error_log = log/php-fpm.log 33 34; syslog_facility is used to specify what type of program is logging the 35; message. This lets syslogd specify that messages from different facilities 36; will be handled differently. 37; See syslog(3) for possible values (ex daemon equiv LOG_DAEMON) 38; Default Value: daemon 39;syslog.facility = daemon 40 41; syslog_ident is prepended to every message. If you have multiple FPM 42; instances running on the same server, you can change the default value 43; which must suit common needs. 44; Default Value: php-fpm 45;syslog.ident = php-fpm 46 47; Log level 48; Possible Values: alert, error, warning, notice, debug 49; Default Value: notice 50;log_level = notice 51 52; If this number of child processes exit with SIGSEGV or SIGBUS within the time 53; interval set by emergency_restart_interval then FPM will restart. A value 54; of '0' means 'Off'. 55; Default Value: 0 56;emergency_restart_threshold = 0 57 58; Interval of time used by emergency_restart_interval to determine when 59; a graceful restart will be initiated. This can be useful to work around 60; accidental corruptions in an accelerator's shared memory. 61; Available Units: s(econds), m(inutes), h(ours), or d(ays) 62; Default Unit: seconds 63; Default Value: 0 64;emergency_restart_interval = 0 65 66; Time limit for child processes to wait for a reaction on signals from master. 67; Available units: s(econds), m(inutes), h(ours), or d(ays) 68; Default Unit: seconds 69; Default Value: 0 70;process_control_timeout = 0 71 72; The maximum number of processes FPM will fork. This has been design to control 73; the global number of processes when using dynamic PM within a lot of pools. 74; Use it with caution. 75; Note: A value of 0 indicates no limit 76; Default Value: 0 77; process.max = 128 78 79; Specify the nice(2) priority to apply to the master process (only if set) 80; The value can vary from -19 (highest priority) to 20 (lower priority) 81; Note: - It will only work if the FPM master process is launched as root 82; - The pool process will inherit the master process priority 83; unless it specified otherwise 84; Default Value: no set 85; process.priority = -19 86 87; Send FPM to background. Set to 'no' to keep FPM in foreground for debugging. 88; Default Value: yes 89;daemonize = yes 90 91; Set open file descriptor rlimit for the master process. 92; Default Value: system defined value 93;rlimit_files = 1024 94 95; Set max core size rlimit for the master process. 96; Possible Values: 'unlimited' or an integer greater or equal to 0 97; Default Value: system defined value 98;rlimit_core = 0 99 100; Specify the event mechanism FPM will use. The following is available: 101; - select (any POSIX os) 102; - poll (any POSIX os) 103; - epoll (linux >= 2.5.44) 104; - kqueue (FreeBSD >= 4.1, OpenBSD >= 2.9, NetBSD >= 2.0) 105; - /dev/poll (Solaris >= 7) 106; - port (Solaris >= 10) 107; Default Value: not set (auto detection) 108;events.mechanism = epoll 109 110; When FPM is build with systemd integration, specify the interval, 111; in second, between health report notification to systemd. 112; Set to 0 to disable. 113; Available Units: s(econds), m(inutes), h(ours) 114; Default Unit: seconds 115; Default value: 10 116;systemd_interval = 10 117 118;;;;;;;;;;;;;;;;;;;; 119; Pool Definitions ; 120;;;;;;;;;;;;;;;;;;;; 121 122; Multiple pools of child processes may be started with different listening 123; ports and different management options. The name of the pool will be 124; used in logs and stats. There is no limitation on the number of pools which 125; FPM can handle. Your system will tell you anyway :) 126 127; Start a new pool named 'www'. 128; the variable $pool can we used in any directive and will be replaced by the 129; pool name ('www' here) 130[www] 131 132; Per pool prefix 133; It only applies on the following directives: 134; - 'slowlog' 135; - 'listen' (unixsocket) 136; - 'chroot' 137; - 'chdir' 138; - 'php_values' 139; - 'php_admin_values' 140; When not set, the global prefix (or @php_fpm_prefix@) applies instead. 141; Note: This directive can also be relative to the global prefix. 142; Default Value: none 143;prefix = /path/to/pools/$pool 144 145; Unix user/group of processes 146; Note: The user is mandatory. If the group is not set, the default user's group 147; will be used. 148user = @php_fpm_user@ 149group = @php_fpm_group@ 150 151; The address on which to accept FastCGI requests. 152; Valid syntaxes are: 153; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific address on 154; a specific port; 155; 'port' - to listen on a TCP socket to all addresses on a 156; specific port; 157; '/path/to/unix/socket' - to listen on a unix socket. 158; Note: This value is mandatory. 159listen = 127.0.0.1:9000 160 161; Set listen(2) backlog. 162; Default Value: 128 (-1 on FreeBSD and OpenBSD) 163;listen.backlog = 128 164 165; Set permissions for unix socket, if one is used. In Linux, read/write 166; permissions must be set in order to allow connections from a web server. Many 167; BSD-derived systems allow connections regardless of permissions. 168; Default Values: user and group are set as the running user 169; mode is set to 0660 170;listen.owner = @php_fpm_user@ 171;listen.group = @php_fpm_group@ 172;listen.mode = 0660 173 174; List of ipv4 addresses of FastCGI clients which are allowed to connect. 175; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original 176; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address 177; must be separated by a comma. If this value is left blank, connections will be 178; accepted from any ip address. 179; Default Value: any 180;listen.allowed_clients = 127.0.0.1 181 182; Specify the nice(2) priority to apply to the pool processes (only if set) 183; The value can vary from -19 (highest priority) to 20 (lower priority) 184; Note: - It will only work if the FPM master process is launched as root 185; - The pool processes will inherit the master process priority 186; unless it specified otherwise 187; Default Value: no set 188; process.priority = -19 189 190; Choose how the process manager will control the number of child processes. 191; Possible Values: 192; static - a fixed number (pm.max_children) of child processes; 193; dynamic - the number of child processes are set dynamically based on the 194; following directives. With this process management, there will be 195; always at least 1 children. 196; pm.max_children - the maximum number of children that can 197; be alive at the same time. 198; pm.start_servers - the number of children created on startup. 199; pm.min_spare_servers - the minimum number of children in 'idle' 200; state (waiting to process). If the number 201; of 'idle' processes is less than this 202; number then some children will be created. 203; pm.max_spare_servers - the maximum number of children in 'idle' 204; state (waiting to process). If the number 205; of 'idle' processes is greater than this 206; number then some children will be killed. 207; ondemand - no children are created at startup. Children will be forked when 208; new requests will connect. The following parameter are used: 209; pm.max_children - the maximum number of children that 210; can be alive at the same time. 211; pm.process_idle_timeout - The number of seconds after which 212; an idle process will be killed. 213; Note: This value is mandatory. 214pm = dynamic 215 216; The number of child processes to be created when pm is set to 'static' and the 217; maximum number of child processes when pm is set to 'dynamic' or 'ondemand'. 218; This value sets the limit on the number of simultaneous requests that will be 219; served. Equivalent to the ApacheMaxClients directive with mpm_prefork. 220; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP 221; CGI. The below defaults are based on a server without much resources. Don't 222; forget to tweak pm.* to fit your needs. 223; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand' 224; Note: This value is mandatory. 225pm.max_children = 5 226 227; The number of child processes created on startup. 228; Note: Used only when pm is set to 'dynamic' 229; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2 230pm.start_servers = 2 231 232; The desired minimum number of idle server processes. 233; Note: Used only when pm is set to 'dynamic' 234; Note: Mandatory when pm is set to 'dynamic' 235pm.min_spare_servers = 1 236 237; The desired maximum number of idle server processes. 238; Note: Used only when pm is set to 'dynamic' 239; Note: Mandatory when pm is set to 'dynamic' 240pm.max_spare_servers = 3 241 242; The number of seconds after which an idle process will be killed. 243; Note: Used only when pm is set to 'ondemand' 244; Default Value: 10s 245;pm.process_idle_timeout = 10s; 246 247; The number of requests each child process should execute before respawning. 248; This can be useful to work around memory leaks in 3rd party libraries. For 249; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS. 250; Default Value: 0 251;pm.max_requests = 500 252 253; The URI to view the FPM status page. If this value is not set, no URI will be 254; recognized as a status page. It shows the following informations: 255; pool - the name of the pool; 256; process manager - static, dynamic or ondemand; 257; start time - the date and time FPM has started; 258; start since - number of seconds since FPM has started; 259; accepted conn - the number of request accepted by the pool; 260; listen queue - the number of request in the queue of pending 261; connections (see backlog in listen(2)); 262; max listen queue - the maximum number of requests in the queue 263; of pending connections since FPM has started; 264; listen queue len - the size of the socket queue of pending connections; 265; idle processes - the number of idle processes; 266; active processes - the number of active processes; 267; total processes - the number of idle + active processes; 268; max active processes - the maximum number of active processes since FPM 269; has started; 270; max children reached - number of times, the process limit has been reached, 271; when pm tries to start more children (works only for 272; pm 'dynamic' and 'ondemand'); 273; Value are updated in real time. 274; Example output: 275; pool: www 276; process manager: static 277; start time: 01/Jul/2011:17:53:49 +0200 278; start since: 62636 279; accepted conn: 190460 280; listen queue: 0 281; max listen queue: 1 282; listen queue len: 42 283; idle processes: 4 284; active processes: 11 285; total processes: 15 286; max active processes: 12 287; max children reached: 0 288; 289; By default the status page output is formatted as text/plain. Passing either 290; 'html', 'xml' or 'json' in the query string will return the corresponding 291; output syntax. Example: 292; http://www.foo.bar/status 293; http://www.foo.bar/status?json 294; http://www.foo.bar/status?html 295; http://www.foo.bar/status?xml 296; 297; By default the status page only outputs short status. Passing 'full' in the 298; query string will also return status for each pool process. 299; Example: 300; http://www.foo.bar/status?full 301; http://www.foo.bar/status?json&full 302; http://www.foo.bar/status?html&full 303; http://www.foo.bar/status?xml&full 304; The Full status returns for each process: 305; pid - the PID of the process; 306; state - the state of the process (Idle, Running, ...); 307; start time - the date and time the process has started; 308; start since - the number of seconds since the process has started; 309; requests - the number of requests the process has served; 310; request duration - the duration in µs of the requests; 311; request method - the request method (GET, POST, ...); 312; request URI - the request URI with the query string; 313; content length - the content length of the request (only with POST); 314; user - the user (PHP_AUTH_USER) (or '-' if not set); 315; script - the main script called (or '-' if not set); 316; last request cpu - the %cpu the last request consumed 317; it's always 0 if the process is not in Idle state 318; because CPU calculation is done when the request 319; processing has terminated; 320; last request memory - the max amount of memory the last request consumed 321; it's always 0 if the process is not in Idle state 322; because memory calculation is done when the request 323; processing has terminated; 324; If the process is in Idle state, then informations are related to the 325; last request the process has served. Otherwise informations are related to 326; the current request being served. 327; Example output: 328; ************************ 329; pid: 31330 330; state: Running 331; start time: 01/Jul/2011:17:53:49 +0200 332; start since: 63087 333; requests: 12808 334; request duration: 1250261 335; request method: GET 336; request URI: /test_mem.php?N=10000 337; content length: 0 338; user: - 339; script: /home/fat/web/docs/php/test_mem.php 340; last request cpu: 0.00 341; last request memory: 0 342; 343; Note: There is a real-time FPM status monitoring sample web page available 344; It's available in: @EXPANDED_DATADIR@/fpm/status.html 345; 346; Note: The value must start with a leading slash (/). The value can be 347; anything, but it may not be a good idea to use the .php extension or it 348; may conflict with a real PHP file. 349; Default Value: not set 350;pm.status_path = /status 351 352; The ping URI to call the monitoring page of FPM. If this value is not set, no 353; URI will be recognized as a ping page. This could be used to test from outside 354; that FPM is alive and responding, or to 355; - create a graph of FPM availability (rrd or such); 356; - remove a server from a group if it is not responding (load balancing); 357; - trigger alerts for the operating team (24/7). 358; Note: The value must start with a leading slash (/). The value can be 359; anything, but it may not be a good idea to use the .php extension or it 360; may conflict with a real PHP file. 361; Default Value: not set 362;ping.path = /ping 363 364; This directive may be used to customize the response of a ping request. The 365; response is formatted as text/plain with a 200 response code. 366; Default Value: pong 367;ping.response = pong 368 369; The access log file 370; Default: not set 371;access.log = log/$pool.access.log 372 373; The access log format. 374; The following syntax is allowed 375; %%: the '%' character 376; %C: %CPU used by the request 377; it can accept the following format: 378; - %{user}C for user CPU only 379; - %{system}C for system CPU only 380; - %{total}C for user + system CPU (default) 381; %d: time taken to serve the request 382; it can accept the following format: 383; - %{seconds}d (default) 384; - %{miliseconds}d 385; - %{mili}d 386; - %{microseconds}d 387; - %{micro}d 388; %e: an environment variable (same as $_ENV or $_SERVER) 389; it must be associated with embraces to specify the name of the env 390; variable. Some exemples: 391; - server specifics like: %{REQUEST_METHOD}e or %{SERVER_PROTOCOL}e 392; - HTTP headers like: %{HTTP_HOST}e or %{HTTP_USER_AGENT}e 393; %f: script filename 394; %l: content-length of the request (for POST request only) 395; %m: request method 396; %M: peak of memory allocated by PHP 397; it can accept the following format: 398; - %{bytes}M (default) 399; - %{kilobytes}M 400; - %{kilo}M 401; - %{megabytes}M 402; - %{mega}M 403; %n: pool name 404; %o: output header 405; it must be associated with embraces to specify the name of the header: 406; - %{Content-Type}o 407; - %{X-Powered-By}o 408; - %{Transfert-Encoding}o 409; - .... 410; %p: PID of the child that serviced the request 411; %P: PID of the parent of the child that serviced the request 412; %q: the query string 413; %Q: the '?' character if query string exists 414; %r: the request URI (without the query string, see %q and %Q) 415; %R: remote IP address 416; %s: status (response code) 417; %t: server time the request was received 418; it can accept a strftime(3) format: 419; %d/%b/%Y:%H:%M:%S %z (default) 420; %T: time the log has been written (the request has finished) 421; it can accept a strftime(3) format: 422; %d/%b/%Y:%H:%M:%S %z (default) 423; %u: remote user 424; 425; Default: "%R - %u %t \"%m %r\" %s" 426;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%" 427 428; The log file for slow requests 429; Default Value: not set 430; Note: slowlog is mandatory if request_slowlog_timeout is set 431;slowlog = log/$pool.log.slow 432 433; The timeout for serving a single request after which a PHP backtrace will be 434; dumped to the 'slowlog' file. A value of '0s' means 'off'. 435; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) 436; Default Value: 0 437;request_slowlog_timeout = 0 438 439; The timeout for serving a single request after which the worker process will 440; be killed. This option should be used when the 'max_execution_time' ini option 441; does not stop script execution for some reason. A value of '0' means 'off'. 442; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) 443; Default Value: 0 444;request_terminate_timeout = 0 445 446; Set open file descriptor rlimit. 447; Default Value: system defined value 448;rlimit_files = 1024 449 450; Set max core size rlimit. 451; Possible Values: 'unlimited' or an integer greater or equal to 0 452; Default Value: system defined value 453;rlimit_core = 0 454 455; Chroot to this directory at the start. This value must be defined as an 456; absolute path. When this value is not set, chroot is not used. 457; Note: you can prefix with '$prefix' to chroot to the pool prefix or one 458; of its subdirectories. If the pool prefix is not set, the global prefix 459; will be used instead. 460; Note: chrooting is a great security feature and should be used whenever 461; possible. However, all PHP paths will be relative to the chroot 462; (error_log, sessions.save_path, ...). 463; Default Value: not set 464;chroot = 465 466; Chdir to this directory at the start. 467; Note: relative path can be used. 468; Default Value: current directory or / when chroot 469;chdir = /var/www 470 471; Redirect worker stdout and stderr into main error log. If not set, stdout and 472; stderr will be redirected to /dev/null according to FastCGI specs. 473; Note: on highloaded environement, this can cause some delay in the page 474; process time (several ms). 475; Default Value: no 476;catch_workers_output = yes 477 478; Clear environment in FPM workers 479; Prevents arbitrary environment variables from reaching FPM worker processes 480; by clearing the environment in workers before env vars specified in this 481; pool configuration are added. 482; Setting to "no" will make all environment variables available to PHP code 483; via getenv(), $_ENV and $_SERVER. 484; Default Value: yes 485;clear_env = no 486 487; Limits the extensions of the main script FPM will allow to parse. This can 488; prevent configuration mistakes on the web server side. You should only limit 489; FPM to .php extensions to prevent malicious users to use other extensions to 490; exectute php code. 491; Note: set an empty value to allow all extensions. 492; Default Value: .php 493;security.limit_extensions = .php .php3 .php4 .php5 494 495; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from 496; the current environment. 497; Default Value: clean env 498;env[HOSTNAME] = $HOSTNAME 499;env[PATH] = /usr/local/bin:/usr/bin:/bin 500;env[TMP] = /tmp 501;env[TMPDIR] = /tmp 502;env[TEMP] = /tmp 503 504; Additional php.ini defines, specific to this pool of workers. These settings 505; overwrite the values previously defined in the php.ini. The directives are the 506; same as the PHP SAPI: 507; php_value/php_flag - you can set classic ini defines which can 508; be overwritten from PHP call 'ini_set'. 509; php_admin_value/php_admin_flag - these directives won't be overwritten by 510; PHP call 'ini_set' 511; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no. 512 513; Defining 'extension' will load the corresponding shared extension from 514; extension_dir. Defining 'disable_functions' or 'disable_classes' will not 515; overwrite previously defined php.ini values, but will append the new value 516; instead. 517 518; Note: path INI options can be relative and will be expanded with the prefix 519; (pool, global or @prefix@) 520 521; Default Value: nothing is defined by default except the values in php.ini and 522; specified at startup with the -d argument 523;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com 524;php_flag[display_errors] = off 525;php_admin_value[error_log] = /var/log/fpm-php.www.log 526;php_admin_flag[log_errors] = on 527;php_admin_value[memory_limit] = 32M 528
