ngx_http_fastcgi_module 模块
ngx_http_fastcgi_module
模块允许将请求传递给FastCGI服务器。
配置示例
location / { fastcgi_pass localhost:9000; fastcgi_index index.php; fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name; fastcgi_param QUERY_STRING $query_string; fastcgi_param REQUEST_METHOD $request_method; fastcgi_param CONTENT_TYPE $content_type; fastcgi_param CONTENT_LENGTH $content_length; }
指令
语法 |
fastcgi_bind |
---|---|
默认值 | — |
上下文 |
http , server , location |
该指令出现在版本 0.8.22 中。
使发往FastCGI服务器的出站连接源自指定的本地IP地址,可选择指定端口 (1.11.2)。参数值可以包含变量 (1.3.12)。特殊值 off
(1.3.12) 取消了从前一个配置级别继承的 fastcgi_bind
指令的效果,这允许系统自动分配本地IP地址和端口。
transparent
参数 (1.11.0) 允许发往FastCGI服务器的出站连接源自非本地IP地址,例如客户端的真实IP地址
fastcgi_bind $remote_addr transparent;
为了使此参数生效,通常需要以超级用户权限运行nginx工作进程。在Linux上这不是必需的 (1.13.8),因为如果指定了 transparent
参数,工作进程会从主进程继承 CAP_NET_RAW
能力。还需要配置内核路由表以拦截来自FastCGI服务器的网络流量。
语法 |
fastcgi_buffer_size |
---|---|
默认值 |
fastcgi_buffer_size 4k|8k; |
上下文 |
http , server , location |
设置用于读取从FastCGI服务器接收到的响应第一部分的缓冲区 size
。这部分通常包含一个小的响应头。默认情况下,缓冲区大小等于一个内存页。这取决于平台,可以是4K或8K。但是,它可以设置得更小。
语法 |
fastcgi_buffering |
---|---|
默认值 |
fastcgi_buffering on; |
上下文 |
http , server , location |
该指令出现在版本 1.5.6 中。
启用或禁用FastCGI服务器响应的缓冲。
启用缓冲后,nginx会尽快从FastCGI服务器接收响应,并将其保存到 fastcgi_buffer_size 和 fastcgi_buffers 指令设置的缓冲区中。如果整个响应无法放入内存,则部分响应可以保存到磁盘上的临时文件中。临时文件的写入由 fastcgi_max_temp_file_size 和 fastcgi_temp_file_write_size 指令控制。
禁用缓冲后,响应会同步传递给客户端,收到后立即发送。nginx不会尝试从FastCGI服务器读取整个响应。nginx一次可以从服务器接收的数据的最大大小由 fastcgi_buffer_size 指令设置。
也可以通过在“X-Accel-Buffering”响应头字段中传递“yes
”或“no
”来启用或禁用缓冲。可以使用 fastcgi_ignore_headers 指令禁用此功能。
语法 |
fastcgi_buffers |
---|---|
默认值 |
fastcgi_buffers 8 4k|8k; |
上下文 |
http , server , location |
设置用于读取FastCGI服务器响应的缓冲区 number
和 size
,用于单个连接。默认情况下,缓冲区大小等于一个内存页。这取决于平台,可以是4K或8K。
语法 |
fastcgi_busy_buffers_size |
---|---|
默认值 |
fastcgi_busy_buffers_size 8k|16k; |
上下文 |
http , server , location |
当启用FastCGI服务器响应的缓冲时,限制在响应尚未完全读取时,用于向客户端发送响应的繁忙缓冲区总 size
。同时,其余缓冲区可用于读取响应,并在需要时将部分响应缓冲到临时文件。默认情况下,size
由 fastcgi_buffer_size 和 fastcgi_buffers 指令设置的两个缓冲区大小限制。
语法 |
fastcgi_cache |
---|---|
默认值 |
fastcgi_cache off; |
上下文 |
http , server , location |
定义用于缓存的共享内存区域。同一个区域可以在多个地方使用。参数值可以包含变量 (1.7.9)。off
参数禁用从前一个配置级别继承的缓存。
语法 |
fastcgi_cache_background_update |
---|---|
默认值 |
fastcgi_cache_background_update off; |
上下文 |
http , server , location |
该指令出现在版本 1.11.10 中。
允许启动后台子请求来更新已过期的缓存项,同时向客户端返回过期的缓存响应。请注意,在更新缓存项时,需要允许使用过期的缓存响应。
语法 |
fastcgi_cache_bypass |
---|---|
默认值 | — |
上下文 |
http , server , location |
定义不从缓存中获取响应的条件。如果字符串参数中至少有一个值非空且不等于“0”,则不会从缓存中获取响应。
fastcgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment; fastcgi_cache_bypass $http_pragma $http_authorization;
可以与 fastcgi_no_cache 指令一起使用。
语法 |
fastcgi_cache_key |
---|---|
默认值 | — |
上下文 |
http , server , location |
定义缓存键,例如:
fastcgi_cache_key localhost:9000$request_uri;
语法 |
fastcgi_cache_lock |
---|---|
默认值 |
fastcgi_cache_lock off; |
上下文 |
http , server , location |
该指令出现在版本 1.1.12 中。
启用后,根据 fastcgi_cache_key 指令识别的同一缓存元素,一次只允许一个请求通过向FastCGI服务器传递请求来填充新的缓存元素。同一缓存元素的其他请求将等待响应出现在缓存中,或者等待该元素的缓存锁被释放,最长等待时间由 fastcgi_cache_lock_timeout 指令设置。
语法 |
fastcgi_cache_lock_age |
---|---|
默认值 |
fastcgi_cache_lock_age 5s; |
上下文 |
http , server , location |
该指令出现在版本 1.7.8 中。
如果上一个为填充新的缓存元素而传递给FastCGI服务器的请求在指定的 time
内未完成,则可能会再传递一个请求到FastCGI服务器。
语法 |
fastcgi_cache_lock_timeout |
---|---|
默认值 |
fastcgi_cache_lock_timeout 5s; |
上下文 |
http , server , location |
该指令出现在版本 1.1.12 中。
设置 fastcgi_cache_lock 的超时时间。当 time
到期后,请求将传递给FastCGI服务器,但响应不会被缓存。
在 1.7.8 版本之前,响应可能会被缓存。
语法 |
fastcgi_cache_max_range_offset |
---|---|
默认值 | — |
上下文 |
http , server , location |
该指令出现在版本 1.11.6 中。
设置字节范围请求的字节偏移量。如果请求的范围超出此偏移量,则该范围请求将被传递给FastCGI服务器,且响应不会被缓存。
语法 |
fastcgi_cache_methods |
---|---|
默认值 |
fastcgi_cache_methods GET HEAD; |
上下文 |
http , server , location |
该指令出现在版本 0.7.59 中。
如果客户端请求方法在此指令中列出,则响应将被缓存。“GET
”和“HEAD
”方法总是会添加到列表中,但建议显式指定它们。另请参阅 fastcgi_no_cache 指令。
语法 |
fastcgi_cache_min_uses |
---|---|
默认值 |
fastcgi_cache_min_uses 1; |
上下文 |
http , server , location |
设置响应在被缓存前所需的请求 number
。
语法 |
fastcgi_cache_path |
---|---|
默认值 | — |
上下文 |
http |
设置缓存的路径及其他参数。缓存数据存储在文件中。缓存中的键和文件名都是对代理的URL应用MD5函数的结果。levels
参数定义了缓存的层次结构级别:从1到3,每个级别接受值1或2。例如,在以下配置中
fastcgi_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m;
缓存中的文件名将如下所示:
/data/nginx/cache/c/29/b7f54b2df7773722d382f4809d65029c
缓存的响应首先写入临时文件,然后重命名文件。从版本 0.8.9 开始,临时文件和缓存可以放在不同的文件系统上。但是请注意,在这种情况下,文件会在两个文件系统之间复制,而不是简单的重命名操作。因此建议,对于任何给定的location,缓存和存放临时文件的目录都放在同一个文件系统上。临时文件目录是根据 use_temp_path
参数 (1.7.10) 设置的。如果省略此参数或将其设置为 on
,则将使用给定location的 fastcgi_temp_path 指令设置的目录。如果值设置为 off
,临时文件将直接放在缓存目录中。
此外,所有活动键和关于数据的信息都存储在一个共享内存区域中,其 name
和 size
由 keys_zone
参数配置。一个兆字节的区域大约可以存储8千个键。
作为商业订阅的一部分,共享内存区域还存储扩展的缓存信息,因此,相同数量的键需要指定更大的区域大小。例如,一个兆字节的区域大约可以存储4千个键。
在 inactive
参数指定的时间内未被访问的缓存数据将从缓存中删除,无论其新鲜度如何。默认情况下,inactive
设置为10分钟。
特殊的“缓存管理器”进程监控 max_size
参数设置的最大缓存大小,以及缓存所在文件系统上由 min_free
(1.19.1) 参数设置的最小可用空间量。当大小超出或可用空间不足时,它会移除最近最少使用的数据。数据以由 manager_files
、manager_threshold
和 manager_sleep
参数 (1.11.5) 配置的迭代方式移除。在一次迭代中,删除的项目不超过 manager_files
(默认100)。一次迭代的持续时间由 manager_threshold
参数限制 (默认200毫秒)。在迭代之间,会有由 manager_sleep
参数配置的暂停 (默认50毫秒)。
启动一分钟后,特殊的“缓存加载器”进程会被激活。它将文件系统上存储的先前缓存数据的信息加载到缓存区域中。加载也以迭代方式进行。在一次迭代中,加载的项目不超过 loader_files
(默认100)。此外,一次迭代的持续时间由 loader_threshold
参数限制 (默认200毫秒)。在迭代之间,会有由 loader_sleep
参数配置的暂停 (默认50毫秒)。
此外,以下参数作为我们的商业订阅的一部分提供:
-
purger
=on
|off
- 指示与通配符键匹配的缓存条目是否会由缓存清除器从磁盘中删除 (1.7.12)。将参数设置为
on
(默认off
) 将激活“缓存清除器”进程,该进程会永久遍历所有缓存条目并删除与通配符键匹配的条目。 -
purger_files
=number
- 设置在一次迭代中扫描的项目数量 (1.7.12)。默认情况下,
purger_files
设置为10。 -
purger_threshold
=number
- 设置一次迭代的持续时间 (1.7.12)。默认情况下,
purger_threshold
设置为50毫秒。 -
purger_sleep
=number
- 设置迭代之间的暂停时间 (1.7.12)。默认情况下,
purger_sleep
设置为50毫秒。
在版本 1.7.3, 1.7.7, 和 1.11.10 中,缓存头格式已更改。升级到较新版本的nginx后,先前缓存的响应将被视为无效。
语法 |
fastcgi_cache_purge string ...; |
---|---|
默认值 | — |
上下文 |
http , server , location |
该指令出现在版本 1.5.7 中。
定义何时请求被视为缓存清除请求。如果字符串参数中至少有一个值非空且不等于“0”,则删除具有相应缓存键的缓存条目。成功操作的结果通过返回 204 (无内容) 响应指示。
如果清除请求的缓存键以星号(“*
”)结尾,则所有匹配该通配符键的缓存条目都将从缓存中移除。但是,这些条目将保留在磁盘上,直到它们因不活动而被删除,或由缓存清除器处理 (1.7.12),或客户端尝试访问它们。
配置示例:
fastcgi_cache_path /data/nginx/cache keys_zone=cache_zone:10m; map $request_method $purge_method { PURGE 1; default 0; } server { ... location / { fastcgi_pass backend; fastcgi_cache cache_zone; fastcgi_cache_key $uri; fastcgi_cache_purge $purge_method; } }
此功能作为我们的商业订阅的一部分提供。
语法 |
fastcgi_cache_revalidate |
---|---|
默认值 |
fastcgi_cache_revalidate off; |
上下文 |
http , server , location |
该指令出现在版本 1.5.7 中。
使用包含“If-Modified-Since”和“If-None-Match”头字段的条件请求,启用对过期缓存项的重新验证。
语法 |
fastcgi_cache_use_stale |
---|---|
默认值 |
fastcgi_cache_use_stale off; |
上下文 |
http , server , location |
确定在与FastCGI服务器通信期间发生错误时,可以使用过期缓存响应的情况。该指令的参数与 fastcgi_next_upstream 指令的参数匹配。
error
参数还允许在无法选择FastCGI服务器来处理请求时,使用过期缓存响应。
此外,updating
参数允许在使用过期缓存响应时,如果它当前正在更新。这可以在更新缓存数据时最大程度地减少对FastCGI服务器的访问次数。
也可以在响应头中直接启用使用过期缓存响应,指定响应过期后的秒数 (1.11.10)。这比使用指令参数的优先级低。
- “Cache-Control”头字段的“stale-while-revalidate”扩展允许在使用过期缓存响应时,如果它当前正在更新。
- “Cache-Control”头字段的“stale-if-error”扩展允许在发生错误时使用过期缓存响应。
为了最大程度地减少填充新缓存元素时对FastCGI服务器的访问次数,可以使用 fastcgi_cache_lock 指令。
语法 |
fastcgi_cache_valid [ |
---|---|
默认值 | — |
上下文 |
http , server , location |
设置不同响应代码的缓存时间。例如,以下指令
fastcgi_cache_valid 200 302 10m; fastcgi_cache_valid 404 1m;
对代码为200和302的响应设置10分钟缓存,对代码为404的响应设置1分钟缓存。
如果只指定了缓存 time
fastcgi_cache_valid 5m;
则只缓存 200、301 和 302 响应。
此外,可以指定 any
参数来缓存任何响应
fastcgi_cache_valid 200 302 10m; fastcgi_cache_valid 301 1h; fastcgi_cache_valid any 1m;
缓存参数也可以直接在响应头中设置。这比使用指令设置缓存时间具有更高的优先级。
- “X-Accel-Expires”头字段以秒为单位设置响应的缓存时间。零值禁用响应缓存。如果值以
@
前缀开头,则表示自Epoch以来的绝对时间(秒),响应可以缓存到该时间点。 - 如果响应头中不包含“X-Accel-Expires”字段,则可以在“Expires”或“Cache-Control”头字段中设置缓存参数。
- 如果响应头包含“Set-Cookie”字段,则此类响应不会被缓存。
- 如果响应头包含“Vary”字段,并且值为特殊值“
*
”,则此类响应不会被缓存 (1.7.7)。如果响应头包含“Vary”字段,并且值为其他值,则此类响应会根据相应的请求头字段进行缓存 (1.7.7)。
可以使用 fastcgi_ignore_headers 指令禁用对一个或多个这些响应头字段的处理。
语法 |
fastcgi_catch_stderr |
---|---|
默认值 | — |
上下文 |
http , server , location |
设置在从FastCGI服务器接收到的响应错误流中搜索的字符串。如果找到了 string
,则认为FastCGI服务器返回了无效响应。这允许在nginx中处理应用程序错误,例如:
location /php/ { fastcgi_pass backend:9000; ... fastcgi_catch_stderr "PHP Fatal error"; fastcgi_next_upstream error timeout invalid_header; }
语法 |
fastcgi_connect_timeout |
---|---|
默认值 |
fastcgi_connect_timeout 60s; |
上下文 |
http , server , location |
定义与FastCGI服务器建立连接的超时时间。需要注意的是,此超时通常不能超过75秒。
语法 |
fastcgi_force_ranges |
---|---|
默认值 |
fastcgi_force_ranges off; |
上下文 |
http , server , location |
该指令出现在版本 1.7.7 中。
无论FastCGI服务器响应中是否包含“Accept-Ranges”字段,都启用对缓存和未缓存响应的字节范围支持。
语法 |
fastcgi_hide_header |
---|---|
默认值 | — |
上下文 |
http , server , location |
默认情况下,nginx不会将FastCGI服务器响应中的“Status”和“X-Accel-...”头字段传递给客户端。fastcgi_hide_header
指令设置了不会传递的其他字段。反之,如果需要允许传递某些字段,可以使用 fastcgi_pass_header 指令。
语法 |
fastcgi_ignore_client_abort |
---|---|
默认值 |
fastcgi_ignore_client_abort off; |
上下文 |
http , server , location |
确定当客户端在未等待响应的情况下关闭连接时,是否应关闭与FastCGI服务器的连接。
语法 |
fastcgi_ignore_headers |
---|---|
默认值 | — |
上下文 |
http , server , location |
禁用处理FastCGI服务器响应中的某些头字段。可以忽略以下字段:“X-Accel-Redirect”,“X-Accel-Expires”,“X-Accel-Limit-Rate” (1.1.6),“X-Accel-Buffering” (1.1.6),“X-Accel-Charset” (1.1.6),“Expires”,“Cache-Control”,“Set-Cookie” (0.8.44) 和“Vary” (1.7.7)。
如果未禁用,对这些头字段的处理具有以下效果:
- “X-Accel-Expires”、“Expires”、“Cache-Control”、“Set-Cookie”和“Vary”设置响应缓存的参数;
- “X-Accel-Redirect”对指定的URI执行内部重定向;
- “X-Accel-Limit-Rate”设置将响应传输到客户端的速率限制;
- “X-Accel-Buffering”启用或禁用响应的缓冲;
- “X-Accel-Charset”设置响应所需的字符集。
语法 |
fastcgi_index |
---|---|
默认值 | — |
上下文 |
http , server , location |
在以斜杠结尾的URI之后附加一个文件名,作为 $fastcgi_script_name
变量的值。例如,使用以下设置:
fastcgi_index index.php; fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;
对于“/page.php
”请求,SCRIPT_FILENAME
参数将等于“/home/www/scripts/php/page.php
”,对于“/
”请求,它将等于“/home/www/scripts/php/index.php
”。
语法 |
fastcgi_intercept_errors |
---|---|
默认值 |
fastcgi_intercept_errors off; |
上下文 |
http , server , location |
确定FastCGI服务器返回代码大于或等于300的响应是应传递给客户端,还是应被拦截并重定向到nginx由 error_page 指令处理。
语法 |
fastcgi_keep_conn |
---|---|
默认值 |
fastcgi_keep_conn off; |
上下文 |
http , server , location |
该指令出现在版本 1.1.4 中。
默认情况下,FastCGI服务器在发送响应后会立即关闭连接。但是,当此指令设置为 on
时,nginx将指示FastCGI服务器保持连接打开。这对于FastCGI服务器的keepalive连接正常工作特别必要。
语法 |
fastcgi_limit_rate |
---|---|
默认值 |
fastcgi_limit_rate 0; |
上下文 |
http , server , location |
该指令出现在版本 1.7.7 中。
限制从FastCGI服务器读取响应的速度。rate
以字节/秒为单位指定。零值禁用速率限制。该限制按请求设置,因此如果nginx同时打开两个与FastCGI服务器的连接,总速率将是指定限制的两倍。此限制仅在启用FastCGI服务器响应缓冲时有效。参数值可以包含变量 (1.27.0)。
语法 |
fastcgi_max_temp_file_size |
---|---|
默认值 |
fastcgi_max_temp_file_size 1024m; |
上下文 |
http , server , location |
当启用FastCGI服务器响应缓冲时,如果整个响应无法放入由 fastcgi_buffer_size 和 fastcgi_buffers 指令设置的缓冲区中,则响应的一部分可以保存到临时文件。此指令设置临时文件的最大 size
。一次写入临时文件的数据大小由 fastcgi_temp_file_write_size 指令设置。
零值禁用将响应缓冲到临时文件。
此限制不适用于将要缓存或存储到磁盘的响应。
语法 |
fastcgi_next_upstream |
---|---|
默认值 |
fastcgi_next_upstream error timeout; |
上下文 |
http , server , location |
指定在哪些情况下应将请求传递给下一个服务器:
error
- 与服务器建立连接、向其传递请求或读取响应头时发生错误;
timeout
- 与服务器建立连接、向其传递请求或读取响应头时发生超时;
invalid_header
- 服务器返回空或无效响应;
http_500
- 服务器返回代码为500的响应;
http_503
- 服务器返回代码为503的响应;
http_403
- 服务器返回代码为403的响应;
http_404
- 服务器返回代码为404的响应;
http_429
- 服务器返回代码为429的响应 (1.11.13);
non_idempotent
- 通常,具有非幂等方法 (
POST
,LOCK
,PATCH
) 的请求在已发送到上游服务器后不会传递给下一个服务器 (1.9.13);启用此选项明确允许重试此类请求; off
- 禁用将请求传递到下一个服务器。
需要注意的是,只有在尚未向客户端发送任何内容的情况下,才能将请求传递给下一个服务器。也就是说,如果在传输响应过程中发生错误或超时,则无法进行修复。
该指令还定义了与服务器通信的不成功尝试。error
、timeout
和 invalid_header
情况总是被视为不成功尝试,即使指令中没有指定它们。只有当指令中指定了 http_500
、http_503
和 http_429
情况时,它们才被视为不成功尝试。http_403
和 http_404
情况永远不会被视为不成功尝试。
语法 |
fastcgi_next_upstream_timeout |
---|---|
默认值 |
fastcgi_next_upstream_timeout 0; |
上下文 |
http , server , location |
该指令出现在版本 1.7.5 中。
限制请求可以传递到下一个服务器的时间。0
值关闭此限制。
语法 |
fastcgi_next_upstream_tries |
---|---|
默认值 |
fastcgi_next_upstream_tries 0; |
上下文 |
http , server , location |
该指令出现在版本 1.7.5 中。
限制将请求传递到下一个服务器的可能尝试次数。0
值关闭此限制。
语法 |
fastcgi_no_cache |
---|---|
默认值 | — |
上下文 |
http , server , location |
定义响应不会保存到缓存的条件。如果字符串参数中至少有一个值非空且不等于“0”,则响应不会被保存。
fastcgi_no_cache $cookie_nocache $arg_nocache$arg_comment; fastcgi_no_cache $http_pragma $http_authorization;
可以与 fastcgi_cache_bypass 指令一起使用。
语法 |
fastcgi_param |
---|---|
默认值 | — |
上下文 |
http , server , location |
设置应传递给FastCGI服务器的 parameter
。value
可以包含文本、变量及其组合。这些指令仅在当前级别没有定义 fastcgi_param
指令时才从前一个配置级别继承。
以下示例显示了PHP所需的最低设置:
fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name; fastcgi_param QUERY_STRING $query_string;
在PHP中,SCRIPT_FILENAME
参数用于确定脚本名称,QUERY_STRING
参数用于传递请求参数。
对于处理 POST
请求的脚本,还需要以下三个参数:
fastcgi_param REQUEST_METHOD $request_method; fastcgi_param CONTENT_TYPE $content_type; fastcgi_param CONTENT_LENGTH $content_length;
如果PHP是使用 --enable-force-cgi-redirect
配置参数构建的,则还应传递 REDIRECT_STATUS
参数,其值为“200”
fastcgi_param REDIRECT_STATUS 200;
如果指令指定了 if_not_empty
(1.1.11),则只有当其值非空时,此类参数才会传递给服务器。
fastcgi_param HTTPS $https if_not_empty;
语法 |
fastcgi_pass |
---|---|
默认值 | — |
上下文 |
location , if in location |
设置FastCGI服务器的地址。地址可以指定为域名、IP地址和端口,例如:
fastcgi_pass localhost:9000;
或者指定为UNIX域套接字路径,例如:
fastcgi_pass unix:/tmp/fastcgi.socket;
如果一个域名解析到多个地址,它们将以轮询方式全部使用。此外,地址也可以指定为服务器组。
参数值可以包含变量。在这种情况下,如果地址指定为域名,则会在描述的服务器组中搜索该名称,如果未找到,则使用解析器确定。
语法 |
fastcgi_pass_header |
---|---|
默认值 | — |
上下文 |
http , server , location |
允许将FastCGI服务器中否则被禁用的头字段传递给客户端。
语法 |
fastcgi_pass_request_body |
---|---|
默认值 |
fastcgi_pass_request_body on; |
上下文 |
http , server , location |
指示是否将原始请求体传递给 FastCGI 服务器。另请参阅 fastcgi_pass_request_headers 指令。
语法 |
fastcgi_pass_request_headers |
---|---|
默认值 |
fastcgi_pass_request_headers on; |
上下文 |
http , server , location |
指示是否将原始请求的头部字段传递给 FastCGI 服务器。另请参阅 fastcgi_pass_request_body 指令。
语法 |
fastcgi_read_timeout |
---|---|
默认值 |
fastcgi_read_timeout 60s; |
上下文 |
http , server , location |
定义了从 FastCGI 服务器读取响应的超时时间。该超时时间仅设置在两次连续的读取操作之间,而不是针对整个响应的传输。如果 FastCGI 服务器在此时间内没有传输任何数据,连接将被关闭。
语法 |
fastcgi_request_buffering |
---|---|
默认值 |
fastcgi_request_buffering on; |
上下文 |
http , server , location |
此指令出现在版本 1.7.11 中。
启用或禁用客户端请求体的缓冲。
当启用缓冲时,在将请求发送到 FastCGI 服务器之前,会从客户端 读取 整个请求体。
当禁用缓冲时,请求体在收到时会立即发送到 FastCGI 服务器。在这种情况下,如果 nginx 已经开始发送请求体,请求就不能被传递给 下一个服务器。
语法 |
fastcgi_send_lowat |
---|---|
默认值 |
fastcgi_send_lowat 0; |
上下文 |
http , server , location |
如果指令设置为非零值,nginx 将尝试通过使用 kqueue 方法的 NOTE_LOWAT
标志或 SO_SNDLOWAT
socket 选项(使用指定的 size
),来最小化与 FastCGI 服务器建立的出站连接上的发送操作数量。
此指令在 Linux、Solaris 和 Windows 上被忽略。
语法 |
fastcgi_send_timeout |
---|---|
默认值 |
fastcgi_send_timeout 60s; |
上下文 |
http , server , location |
设置将请求传输到 FastCGI 服务器的超时时间。该超时时间仅设置在两次连续的写入操作之间,而不是针对整个请求的传输。如果 FastCGI 服务器在此时间内没有收到任何数据,连接将被关闭。
语法 |
fastcgi_socket_keepalive |
---|---|
默认值 |
fastcgi_socket_keepalive off; |
上下文 |
http , server , location |
此指令出现在版本 1.15.6 中。
配置与 FastCGI 服务器建立的出站连接的“TCP keepalive”行为。默认情况下,socket 使用操作系统的设置。如果指令设置为“on
”,则为该 socket 启用 SO_KEEPALIVE
socket 选项。
语法 |
fastcgi_split_path_info |
---|---|
默认值 | — |
上下文 |
location |
定义一个正则表达式,用于捕获 $fastcgi_path_info
变量的值。该正则表达式应该有两个捕获组:第一个捕获组的值将成为 $fastcgi_script_name
变量的值,第二个捕获组的值将成为 $fastcgi_path_info
变量的值。例如,使用以下设置
location ~ ^(.+\.php)(.*)$ { fastcgi_split_path_info ^(.+\.php)(.*)$; fastcgi_param SCRIPT_FILENAME /path/to/php$fastcgi_script_name; fastcgi_param PATH_INFO $fastcgi_path_info;
以及请求“/show.php/article/0001
”,SCRIPT_FILENAME
参数将等于“/path/to/php/show.php
”,并且 PATH_INFO
参数将等于“/article/0001
”。
语法 |
fastcgi_store |
---|---|
默认值 |
fastcgi_store off; |
上下文 |
http , server , location |
启用将文件保存到磁盘。on
参数会按照与 alias 或 root 指令对应的路径保存文件。off
参数禁用保存文件。此外,文件名可以使用带有变量的 string
显式设置
fastcgi_store /data/www$original_uri;
文件的修改时间根据接收到的“Last-Modified”响应头部字段设置。响应首先写入临时文件,然后重命名该文件。从版本 0.8.9 开始,临时文件和持久存储可以放在不同的文件系统上。然而,请注意,在这种情况下,文件会在两个文件系统之间复制,而不是廉价的重命名操作。因此建议,对于任何给定的 location,保存的文件和由 fastcgi_temp_path 指令设置的包含临时文件的目录,都放在同一个文件系统上。
此指令可用于创建静态不变文件的本地副本,例如:
location /images/ { root /data/www; error_page 404 = /fetch$uri; } location /fetch/ { internal; fastcgi_pass backend:9000; ... fastcgi_store on; fastcgi_store_access user:rw group:rw all:r; fastcgi_temp_path /data/temp; alias /data/www/; }
语法 |
fastcgi_store_access |
---|---|
默认值 |
fastcgi_store_access user:rw; |
上下文 |
http , server , location |
设置新建文件和目录的访问权限,例如:
fastcgi_store_access user:rw group:rw all:r;
如果指定了 group
或 all
的访问权限,则可以省略 user
权限
fastcgi_store_access group:rw all:r;
语法 |
fastcgi_temp_file_write_size |
---|---|
默认值 |
fastcgi_temp_file_write_size 8k|16k; |
上下文 |
http , server , location |
限制每次写入临时文件的数据的 size
,当启用了将来自 FastCGI 服务器的响应缓冲到临时文件时。默认情况下,size
受限于由 fastcgi_buffer_size 和 fastcgi_buffers 指令设置的两个缓冲区。临时文件的最大大小由 fastcgi_max_temp_file_size 指令设置。
语法 |
fastcgi_temp_path |
---|---|
默认值 |
fastcgi_temp_path fastcgi_temp; |
上下文 |
http , server , location |
定义一个目录,用于存储从 FastCGI 服务器接收到的数据的临时文件。在指定目录下最多可以使用三级子目录层级。例如,在以下配置中
fastcgi_temp_path /spool/nginx/fastcgi_temp 1 2;
临时文件可能看起来像这样
/spool/nginx/fastcgi_temp/7/45/00000123457
另请参阅 fastcgi_cache_path 指令的 use_temp_path
参数。
传递给FastCGI服务器的参数
HTTP 请求头部字段作为参数传递给 FastCGI 服务器。在作为 FastCGI 服务器运行的应用程序和脚本中,这些参数通常以环境变量的形式提供。例如,“User-Agent”头部字段作为 HTTP_USER_AGENT
参数传递。除了 HTTP 请求头部字段外,还可以使用 fastcgi_param 指令传递任意参数。
嵌入式变量
ngx_http_fastcgi_module
模块支持嵌入式变量,这些变量可以使用 fastcgi_param 指令来设置参数
$fastcgi_script_name
- 请求 URI;或者,如果 URI 以斜杠结尾,则是在请求 URI 后附加由 fastcgi_index 指令配置的索引文件名。此变量可用于设置
SCRIPT_FILENAME
和PATH_TRANSLATED
参数,这些参数决定了 PHP 中的脚本名。例如,对于请求“/info/
”以及以下指令fastcgi_index index.php; fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;
SCRIPT_FILENAME
参数将等于“/home/www/scripts/php/info/index.php
”。当使用 fastcgi_split_path_info 指令时,
$fastcgi_script_name
变量等于该指令设置的第一个捕获组的值。 $fastcgi_path_info
- 由 fastcgi_split_path_info 指令设置的第二个捕获组的值。此变量可用于设置
PATH_INFO
参数。