模块 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 服务器接收的响应第一部分的缓冲区 大小
。此部分通常包含一个小的响应头。默认情况下,缓冲区大小等于一个内存页。这可能是 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 服务器的响应的缓冲区的 数量
和 大小
,适用于单个连接。默认情况下,缓冲区大小等于一个内存页。这可能是 4K 或 8K,具体取决于平台。
语法 |
fastcgi_busy_buffers_size |
---|---|
默认值 |
fastcgi_busy_buffers_size 8k|16k; |
上下文 |
http 、server 、location |
启用来自 FastCGI 服务器的响应 缓冲 时,限制在将响应发送到客户端时可能处于繁忙状态的缓冲区的总 大小
,而响应尚未完全读取。同时,其余缓冲区可用于读取响应,并在需要时将响应的一部分缓冲到临时文件。默认情况下,大小
受限于由 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 服务器的请求在指定 时间
内未完成,则可以将另一个请求传递给 FastCGI 服务器。
语法 |
fastcgi_cache_lock_timeout |
---|---|
默认值 |
fastcgi_cache_lock_timeout 5s; |
上下文 |
http 、server 、location |
此指令出现在 1.1.12 版本中。
设置 fastcgi_cache_lock 的超时时间。当 时间
到期时,请求将传递给 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 |
设置请求次数,在达到此次数后响应将被缓存。
语法 |
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 版本开始,临时文件和缓存可以放在不同的文件系统上。但是,请注意,在这种情况下,文件将在两个文件系统之间复制,而不是廉价的重命名操作。因此,建议对于任何给定的位置,缓存和保存临时文件的目录都放在同一文件系统上。临时文件的目录根据 use_temp_path
参数 (1.7.10) 设置。如果省略此参数或将其设置为 on
值,则将使用为给定位置由 fastcgi_temp_path 指令设置的目录。如果该值设置为 off
,则临时文件将直接放在缓存目录中。
此外,所有活动键和有关数据的信息都存储在共享内存区域中,其 名称
和 大小
由 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不会将“Status”和“X-Accel-...”头字段从FastCGI服务器的响应传递到客户端。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 |
确定是否应将代码大于或等于300的FastCGI服务器响应传递给客户端,或者是否应拦截并重定向到nginx以使用error_page指令进行处理。
语法 |
fastcgi_keep_conn |
---|---|
默认值 |
fastcgi_keep_conn off; |
上下文 |
http 、server 、location |
此指令出现在1.1.4版本中。
默认情况下,FastCGI服务器将在发送响应后立即关闭连接。但是,当此指令设置为on
值时,nginx将指示FastCGI服务器保持连接打开。这对于保持活动连接到FastCGI服务器的功能尤其必要。
语法 |
fastcgi_limit_rate |
---|---|
默认值 |
fastcgi_limit_rate 0; |
上下文 |
http 、server 、location |
此指令出现在1.7.7版本中。
限制从FastCGI服务器读取响应的速度。rate
以每秒字节数指定。零值禁用速率限制。限制针对每个请求设置,因此如果nginx同时打开两个到FastCFI服务器的连接,则总速率将是指定限制的两倍。仅当启用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;
SCRIPT_FILENAME
参数在 PHP 中用于确定脚本名称,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
套接字选项(使用指定的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”行为。默认情况下,操作系统的设置对套接字有效。如果指令设置为“on
”值,则套接字的SO_KEEPALIVE
套接字选项将被打开。
语法 |
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 版本开始,临时文件和持久存储可以放在不同的文件系统上。但是,请注意,在这种情况下,文件将在两个文件系统之间复制,而不是廉价的重命名操作。因此,建议对于任何给定的位置,保存的文件和由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指令配置的索引文件名。此变量可用于设置确定 PHP 中脚本名称的
SCRIPT_FILENAME
和PATH_TRANSLATED
参数。例如,对于“/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
参数。