模块 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)允许从非本地 IP 地址(例如客户端的真实 IP 地址)发起连接到 FastCGI 服务器:
fastcgi_bind $remote_addr transparent;
为使该参数工作,通常需要以 超级用户 权限运行 nginx 工作进程。在 Linux 上,如果指定了 transparent
参数,不需要(1.13.8),因为工作进程从主进程继承了 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 服务器读取响应的缓冲区的 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 服务器。
语法: | 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
参数配置。一个兆字节的区域可以存储约8000个密钥。
作为商业订阅的一部分,共享内存区域还存储扩展缓存信息,因此,需要为相同数量的密钥指定较大的区域大小。例如,一个兆字节的区域可以存储约4000个密钥。
未在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 中。
启用使用带有“如果修改自”和“如果无匹配”的条件请求重新验证过期的缓存项。
语法: | fastcgi_cache_use_stale |
---|---|
默认值: |
fastcgi_cache_use_stale off; |
上下文: | http , server , location |
确定在与 FastCGI 服务器通信期间发生错误时可以在哪些情况下使用陈旧的缓存响应。该指令的参数与fastcgi_next_upstream指令的参数相匹配。
如果无法选择用于处理请求的 FastCGI 服务器,则error
参数还允许使用陈旧的缓存响应。
此外,updating
参数允许在当前正在更新时使用陈旧的缓存响应。这允许在更新缓存数据时最小化对 FastCGI 服务器的访问次数。
在响应变得陈旧后的指定秒数内,还可以直接在响应头中启用使用陈旧的缓存响应(1.11.10)。这比使用指令参数的优先级低。
- The “stale-while-revalidate” extension of the “Cache-Control” header field permits using a stale cached response if it is currently being updated.
- The “stale-if-error” extension of the “Cache-Control” header field permits using a stale cached response in case of an 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分钟。
如果只指定缓存时间 时间
fastcgi_cache_valid 5m;
那么只有代码为200、301和302的响应会被缓存。
此外,还可以指定 any
参数来缓存任何响应:
fastcgi_cache_valid 200 302 10m; fastcgi_cache_valid 301 1h; fastcgi_cache_valid any 1m;
缓存参数也可以直接在响应头中设置。这比使用指令设置缓存时间的优先级更高。
- The “X-Accel-Expires” header field sets caching time of a response in seconds. The zero value disables caching for a response. If the value starts with the
@
prefix, it sets an absolute time in seconds since Epoch, up to which the response may be cached. - If the header does not include the “X-Accel-Expires” field, parameters of caching may be set in the header fields “Expires” or “Cache-Control”.
- If the header includes the “Set-Cookie” field, such a response will not be cached.
- If the header includes the “Vary” field with the special value “
*
”, such a response will not be cached (1.7.7). If the header includes the “Vary” field with another value, such a response will be cached taking into account the corresponding request header fields (1.7.7).
可以使用 fastcgi_ignore_headers 指令来禁用其中一个或多个响应头字段的处理。
语法: | fastcgi_catch_stderr |
---|---|
默认: | — |
上下文: | http , server , location |
设置在从FastCGI服务器接收的响应的错误流中搜索的字符串。如果找到 字符串
,则认为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”, and “Vary” set the parameters of response caching;
- “X-Accel-Redirect” performs an internal redirect to the specified URI;
- “X-Accel-Limit-Rate” sets the rate limit for transmission of a response to a client;
- “X-Accel-Buffering” enables or disables buffering of a response;
- “X-Accel-Charset” sets the desired charset of a response.
语法: | 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 服务器保持连接打开。这对于使keepalive连接到 FastCGI 服务器正常工作是必要的。
语法: | fastcgi_limit_rate |
---|---|
默认值: |
fastcgi_limit_rate 0; |
上下文: | http , server , location |
该指令出现在版本 1.7.7 中。
限制从 FastCGI 服务器读取响应的速度。速率以每秒字节数指定。零值禁用速率限制。限制设置为每个请求,因此如果 nginx 同时打开两个连接到 FastCFI 服务器,则整体速率将是指定限制的两倍。仅当启用从 FastCGI 服务器缓冲响应时,限制才起作用。
语法: | fastcgi_max_temp_file_size |
---|---|
默认值: |
fastcgi_max_temp_file_size 1024m; |
上下文: | http , server , location |
当启用从 FastCGI 服务器缓冲响应,并且整个响应不适合由 fastcgi_buffer_size 和 fastcgi_buffers 指令设置的缓冲区时,响应的一部分可以保存到临时文件中。该指令设置临时文件的最大大小。一次写入临时文件的数据大小由 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 服务器的 参数
。 值
可以包含文本、变量及其组合。 如果在当前级别上没有定义 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
配置参数构建的,则还应传递值为“200”的 REDIRECT_STATUS
参数:
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
套接字选项,最小化对发送到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
参数禁用文件保存。此外,可以使用带有变量的字符串
来显式设置文件名:
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 用户:rw; |
上下文: | http , server , location |
设置新创建文件和目录的访问权限,例如:
fastcgi_store_access user:rw group:rw all:r;
如果指定了任何组
或全部
访问权限,则可以省略用户
权限:
fastcgi_store_access group:rw all:r;
语法: | fastcgi_temp_file_write_size |
---|---|
默认值: |
fastcgi_temp_file_write_size 8k|16k; |
上下文: | http , server , location |
限制启用从FastCGI服务器到临时文件的响应缓冲时一次写入临时文件的大小
。默认情况下,大小
受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
-
request URI or, if a URI ends with a slash, request URI with an index file name configured by the fastcgi_index directive appended to it. This variable can be used to set the
SCRIPT_FILENAME
andPATH_TRANSLATED
parameters that determine the script name in PHP. For example, for the “/info/
” request with the following directivesfastcgi_index index.php; fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;
SCRIPT_FILENAME
parameter will be equal to “/home/www/scripts/php/info/index.php
”.When using the fastcgi_split_path_info directive, the
$fastcgi_script_name
variable equals the value of the first capture set by the directive. -
$fastcgi_path_info
-
the value of the second capture set by the fastcgi_split_path_info directive. This variable can be used to set the
PATH_INFO
parameter.