FastCGI#
该模块允许将请求传递给 FastCGI 服务器。 使到 FastCGI 服务器的出站连接源自指定的本地 IP 地址及可选端口。参数值可以包含变量。特殊值 要使此参数生效,
Angie 工作进程通常需要以
超级用户 权限运行。
在 Linux 上,这不是必需的:
如果指定了 备注 还应配置内核路由表
以拦截来自 FastCGI 服务器的网络流量。 设置用于读取从 FastCGI 服务器接收的响应的第一部分的缓冲区大小。这部分通常包含一个小的响应头。默认情况下,缓冲区大小等于一个内存页。根据平台不同,这可能是 4K 或 8K。但它可以设置得更小。 启用或禁用来自 FastCGI 服务器的响应的缓冲。 Angie 尽快从 FastCGI 服务器接收响应,将其保存到由 fastcgi_buffer_size 和 fastcgi_buffers 指令设置的缓冲区中。如果整个响应无法放入内存,则可以将其中一部分保存到磁盘上的 临时文件 中。写入临时文件由 fastcgi_max_temp_file_size 和 fastcgi_temp_file_write_size 指令控制。 响应在接收到时立即同步传递给客户端。Angie 不会尝试从 FastCGI 服务器读取整个响应。Angie 一次可以从服务器接收的数据的最大大小由 fastcgi_buffer_size 指令设置。 还可以通过在 设置用于从 FastCGI 服务器读取响应的缓冲区的数量和大小,针对单个连接。 默认情况下,缓冲区大小等于一个内存页。根据平台不同,这可能是 4K 或 8K。 当启用来自 FastCGI 服务器的响应的 缓冲 时,限制在响应尚未完全读取时可以忙于向客户端发送响应的缓冲区的总大小。同时,其余缓冲区可用于读取响应,如果需要,还可以将部分响应缓冲到临时文件。默认情况下,大小受 fastcgi_buffer_size 和 fastcgi_buffers 指令设置的两个缓冲区大小的限制。 定义用于缓存的共享内存区域。同一区域可以在多个地方使用。参数值可以包含变量。 默认值 http, server, location 允许启动后台子请求来更新过期的缓存项,同时将陈旧的缓存响应返回给客户端。请注意,必须 允许 在更新时使用陈旧的缓存响应。 定义不从缓存中获取响应的条件。如果字符串参数中至少有一个值不为空且不等于 "0",则不会从缓存中获取响应: 可以与 fastcgi_no_cache 指令一起使用。 定义缓存的键,例如 启用后,一次只允许一个请求通过将请求传递给 FastCGI 服务器来填充根据 fastcgi_cache_key 指令标识的新缓存元素。同一缓存元素的其他请求将等待响应出现在缓存中或此元素的缓存锁被释放,最长等待时间由 fastcgi_cache_lock_timeout 指令设置。 如果传递给 FastCGI 服务器以填充新缓存元素的最后一个请求在指定时间内未完成,则可以再传递一个请求给 FastCGI 服务器。 设置 fastcgi_cache_lock 的超时时间。当超时时间到期时,请求将被传递给 FastCGI 服务器,但响应不会被缓存。 为字节范围请求设置以字节为单位的偏移量。如果范围超出偏移量,范围请求将被传递给 FastCGI 服务器,且响应不会被缓存。 默认值 http, server, location 如果客户端请求方法在此指令中列出,则响应将被缓存。"GET" 和 "HEAD" 方法始终会被添加到列表中,但建议显式指定它们。另请参阅 fastcgi_no_cache 指令。 设置请求次数,达到该次数后响应将被缓存。 警告 缓存元数据存储在共享内存中。手动删除缓存文件不会重置计数器,可能导致不可预测的行为。要完全重置缓存,请停止服务器,删除缓存目录,然后重新启动。 备注 第三方缓存清除模块(例如 缓存清除)仅删除文件,但不会重置 fastcgi_cache_min_uses 计数器。该指令旨在保护缓存免受不频繁请求的污染,在清除时重置计数器可能会对性能产生负面影响。 默认值 — http, server, location 设置缓存的路径和其他参数。缓存数据存储在文件中。缓存中的键和文件名都是对代理 URL 应用 MD5 函数的结果。 缓存中的文件名将如下所示: 缓存的响应首先写入临时文件,然后重命名该文件。临时文件和缓存可以放在不同的文件系统上。但是,请注意,在这种情况下,文件将在两个文件系统之间复制,而不是进行廉价的重命名操作。因此,建议对于任何给定位置,将缓存和存放临时文件的目录放在同一文件系统上。 临时文件的目录基于 如果省略此参数或将其设置为值 临时文件将直接放在缓存目录中。 此外,所有活动键和数据信息都存储在共享内存区域中,其名称和大小由 在 默认情况下,:samp:inactive 设置为 10 分钟。 特殊的 缓存管理器 进程监控最大缓存大小以及缓存所在文件系统的最小可用空间量。当超出大小或可用空间不足时,它会删除最近最少使用的数据。数据以迭代方式删除。 最大缓存大小 缓存所在文件系统的最小可用空间量 限制一次迭代期间要删除的项目数 默认值为 限制一次迭代的持续时间 默认值为 配置迭代之间的暂停时间 默认值为 Angie 启动一分钟后,特殊的 缓存加载器 进程被激活。它将存储在文件系统上的先前缓存数据的信息加载到缓存区域中。加载也以迭代方式完成。 一次迭代中要加载的最大缓存项目数 默认值: 限制一次迭代的时间 默认值: 迭代之间保持暂停的时间 默认值: 启用使用带有 默认值 http, server, location 确定在与 FastCGI 服务器通信期间发生错误时,在哪些情况下可以使用陈旧的缓存响应。该指令的参数与 fastcgi_next_upstream 指令的参数匹配。 如果无法选择 FastCGI 服务器来处理请求,则允许使用陈旧的缓存响应。 一个附加参数,如果缓存响应当前正在更新,则允许使用陈旧的缓存响应。这可以在更新缓存数据时最小化对 FastCGI 服务器的访问次数。 也可以直接在响应头中允许使用陈旧的缓存响应,在响应变陈旧后的指定秒数内。 备注 此方法的优先级低于设置指令参数。 为了在填充新缓存元素时最小化对 FastCGI 服务器的访问次数,可以使用 fastcgi_cache_lock 指令。 为不同的响应代码设置缓存时间。例如,以下指令 为代码 200 和 302 的响应设置 10 分钟的缓存,为代码 404 的响应设置 1 分钟的缓存。 如果只指定了缓存时间, 则只缓存 200、301 和 302 响应。 此外,可以使用 备注 缓存参数也可以直接在响应头中设置。这比使用指令设置缓存时间具有更高的优先级。 如果头不包含 如果头包含 如果头包含具有特殊值 "*" 的 可以使用 fastcgi_ignore_headers 指令禁用对这些响应头字段中的一个或多个的处理。 设置要在从 FastCGI 服务器接收的响应的错误流中搜索的字符串。如果找到该字符串,则认为 FastCGI 服务器返回了 无效 响应。这允许在 Angie 中处理应用程序错误,例如: 定义与 FastCGI 服务器建立连接的超时时间。需要注意的是,此超时时间通常不能超过 75 秒。 启用在代理服务器从组中删除或通过 重新解析 进程或 API 命令 当为客户端或代理服务器处理下一个读取或写入事件时,连接将被终止。 设置 time 启用连接终止 超时;设置为 无论 FastCGI 服务器响应中的 默认情况下,Angie 不会将 FastCGI 服务器响应中的头字段 确定当客户端在不等待响应的情况下关闭连接时,是否应关闭与 FastCGI 服务器的连接。 禁用对 FastCGI 服务器某些响应头字段的处理。可以忽略以下字段: 如果未禁用,处理这些头字段将产生以下效果: 设置将附加在以斜杠结尾的 URI 之后的文件名,该文件名将用于 $fastcgi_script_name 变量的值。例如,使用以下设置 对于 确定代码大于或等于 300 的 FastCGI 服务器响应应该传递给客户端,还是被拦截并重定向到 Angie 以使用 error_page 指令进行处理。 默认情况下,FastCGI 服务器将在发送响应后立即关闭连接。但是,当此指令设置为值 限制从代理服务器读取响应的速度。
rate 以每秒字节数为单位指定;可以使用变量。 禁用速率限制 备注 该限制是针对每个请求设置的,因此如果 Angie 同时打开两个到 FastCGI 服务器的连接,总速率将是指定限制的两倍。该限制仅在启用 FastCGI 服务器响应的 缓冲 时有效。 当启用 FastCGI 服务器响应的 缓冲 时,如果整个响应无法放入 fastcgi_buffer_size 和 fastcgi_buffers 指令设置的缓冲区,响应的一部分可以保存到临时文件中。该指令设置临时文件的最大大小。一次写入临时文件的数据大小由 fastcgi_temp_file_write_size 指令设置。 禁用将响应缓冲到临时文件 默认值 http, server, location 指定在哪些情况下应将请求传递给下一个服务器: 与服务器建立连接、向其传递请求或读取响应头时发生错误; 与服务器建立连接、向其传递请求或读取响应头时发生超时; 服务器返回空响应或无效响应; 服务器返回代码为 500 的响应; 服务器返回代码为 503 的响应; 服务器返回代码为 403 的响应; 服务器返回代码为 404 的响应; 服务器返回代码为 429 的响应; 通常,使用 非幂等 方法
( 禁用将请求传递给下一个服务器。 备注 应该注意的是,只有在尚未向客户端发送任何内容时,才可能将请求传递给下一个服务器。也就是说,如果在传输响应的过程中发生错误或超时,则无法修复此问题。 该指令还定义了什么被视为与服务器通信的 失败尝试。 始终被视为失败尝试,即使它们未在指令中指定 仅在指令中指定时才被视为失败尝试 从不被视为失败尝试 限制可以将请求传递给 下一个服务器 的时间。 关闭此限制 限制将请求传递给 下一个服务器 的可能尝试次数。 关闭此限制 定义响应不会保存到缓存的条件。如果字符串参数中至少有一个值不为空且不等于"0",则响应将不会被保存: 可以与 fastcgi_cache_bypass 指令一起使用。 设置应传递给 FastCGI 服务器的参数。值可以包含文本、变量及其组合。当且仅当当前级别上没有定义 fastcgi_param 指令时,这些指令才从上一级配置继承。 以下示例显示了 PHP 所需的最小设置: SCRIPT_FILENAME 参数在 PHP 中用于确定脚本名称,QUERY_STRING 参数用于传递请求参数。 对于处理 POST 请求的脚本,还需要以下三个参数: 如果 PHP 使用 如果指令使用 设置 FastCGI 服务器的地址。地址可以指定为域名或 IP 地址以及端口: 或作为 UNIX 域套接字路径: 如果域名解析为多个地址,则所有地址都将以轮询方式使用。此外,地址可以指定为 服务器组。 参数值可以包含变量。在这种情况下,如果地址指定为域名,则在描述的 服务器组 中搜索该名称,如果未找到,则使用 解析器 确定。 允许将 FastCGI 服务器的 原本被禁用的 头字段传递给客户端。 指示是否将原始请求体传递给 FastCGI 服务器。另请参阅 fastcgi_pass_request_headers 指令。 默认值 http, server, location 指示是否将原始请求的头字段传递给 FastCGI 服务器。另请参阅 fastcgi_pass_request_body 指令。 定义从 FastCGI 服务器读取响应的超时时间。超时仅在两次连续读取操作之间设置,而不是针对整个响应的传输。如果 FastCGI 服务器在此时间内没有传输任何内容,则连接会关闭。 启用或禁用客户端请求体的缓冲。 如果该指令设置为非零值,Angie 将尝试通过使用 kqueue 方法的 NOTE_LOWAT 标志或 SO_SNDLOWAT 套接字选项(使用指定的大小),来最小化到 FastCGI 服务器的出站连接上的发送操作次数。 备注 此指令在 Linux、Solaris 和 Windows 上被忽略。 设置向 FastCGI 服务器传输请求的超时时间。该超时仅在两次连续的写操作之间设置,而不是用于整个请求的传输。如果 FastCGI 服务器在此时间内没有接收到任何内容,连接将被关闭。 配置到 FastCGI 服务器的出站连接的 "TCP keepalive" 行为。 默认情况下,套接字使用操作系统的设置。 为套接字启用 SO_KEEPALIVE 套接字选项。 定义一个正则表达式,用于捕获 $fastcgi_path_info 变量的值。该正则表达式应该有两个捕获组:第一个成为 $fastcgi_script_name 变量的值,第二个成为 $fastcgi_path_info 变量的值。例如,使用以下设置 对于 启用将文件保存到磁盘。 此外,可以使用带变量的字符串显式设置文件名: 文件的修改时间根据接收到的 此指令可用于创建静态不变文件的本地副本,例如: 默认值 http, server, location 设置新创建的文件和目录的访问权限,例如: 如果指定了任何 group 或 all 访问权限,则可以省略 user 权限: 默认值 http, server, location 当启用将 FastCGI 服务器的响应缓冲到临时文件时,限制一次写入临时文件的数据大小。默认情况下,大小受 fastcgi_buffer_size 和 fastcgi_buffers 指令设置的两个缓冲区限制。临时文件的最大大小由 fastcgi_max_temp_file_size 指令设置。 默认值 http, server, location 定义一个目录,用于存储从 FastCGI 服务器接收的数据的临时文件。在指定目录下可以使用最多三级子目录层次结构。例如,在以下配置中 临时文件可能如下所示: 另请参阅 fastcgi_cache_path 指令的 use_temp_path 参数。 HTTP 请求头字段作为参数传递给 FastCGI 服务器。在作为 FastCGI 服务器运行的应用程序和脚本中,这些参数通常作为环境变量可用。例如,:samp:User-Agent 头字段作为 HTTP_USER_AGENT 参数传递。除了 HTTP 请求头字段之外,还可以使用 fastcgi_param 指令传递任意参数。 http_fastcgi 模块支持内置变量,可用于使用 fastcgi_param 指令设置参数: 请求 URI,或者如果 URI 以斜杠结尾,则为请求 URI 加上由 fastcgi_index 指令配置的索引文件名。此变量可用于设置 SCRIPT_FILENAME 和 PATH_TRANSLATED 参数,这些参数特别用于确定 PHP 中的脚本名称。例如,对于 SCRIPT_FILENAME 参数将等于 当使用 fastcgi_split_path_info 指令时,`$fastcgi_script_name` 变量等于该指令设置的第一个捕获组的值。 由 fastcgi_split_path_info 指令设置的第二个捕获组的值。此变量可用于设置 PATH_INFO 参数。配置示例#
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#
off 取消从上一配置级别继承的 fastcgi_bind 指令的效果,允许系统自动分配本地 IP 地址和端口。transparent 参数允许到 FastCGI 服务器的出站连接源自非本地 IP 地址,例如来自客户端的真实 IP 地址:fastcgi_bind $remote_addr transparent;
transparent 参数,
工作进程会从主进程继承 CAP_NET_RAW 能力。fastcgi_buffer_size#
fastcgi_buffering#
onoffX-Accel-Buffering 响应头字段中传递 "yes" 或 "no" 来启用或禁用缓冲。可以使用 fastcgi_ignore_headers 指令禁用此功能。fastcgi_buffers#
fastcgi_busy_buffers_size#
fastcgi_cache#
off 参数禁用从上一配置级别继承的缓存。fastcgi_cache_background_update#
fastcgi_cache_background_update on | off;fastcgi_cache_background_update off;fastcgi_cache_bypass#
fastcgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment;
fastcgi_cache_bypass $http_pragma $http_authorization;
fastcgi_cache_key#
fastcgi_cache_key localhost:9000$request_uri;
fastcgi_cache_lock#
fastcgi_cache_lock_age#
fastcgi_cache_lock_timeout#
fastcgi_cache_max_range_offset#
fastcgi_cache_methods#
fastcgi_cache_methods GET | HEAD | POST ...;fastcgi_cache_methods GET HEAD;fastcgi_cache_min_uses#
fastcgi_cache_path#
fastcgi_cache_path path [levels=levels] [use_temp_path=on | off] keys_zone=name:size [inactive=time] [max_size=size] [min_free=size] [manager_files=number] [manager_sleep=time] [manager_threshold=time] [loader_files=number] [loader_sleep=time] [loader_threshold=time];levels 参数定义缓存的层次结构级别:从 1 到 3,每个级别接受值 1 或 2。例如,在以下配置中fastcgi_cache_path /data/angie/cache levels=1:2 keys_zone=one:10m;
/data/angie/cache/c/29/b7f54b2df7773722d382f4809d65029c
use_temp_path 参数设置。onon,将使用由给定位置的 fastcgi_temp_path 指令设置的目录。offkeys_zone 参数配置。一兆字节的区域可以存储大约 8 千个键。缓存元数据存储在共享内存中。inactive 参数指定的时间内未被访问的缓存数据将从缓存中删除,无论其新鲜度如何。max_sizemin_freemanager_files100。manager_threshold200 毫秒manager_sleep50 毫秒loader_files100loader_threshold200 毫秒loader_sleep50 毫秒fastcgi_cache_revalidate#
If-Modified-Since 和 If-None-Match 头字段的条件请求重新验证过期的缓存项。fastcgi_cache_use_stale#
fastcgi_cache_use_stale error | timeout | invalid_header | updating | http_500 | http_503 | http_403 | http_429 | off ...;fastcgi_cache_use_stale off;errorupdatingCache-Control 头字段的 stale-while-revalidate 扩展允许在缓存响应当前正在更新时使用陈旧的缓存响应。Cache-Control 头字段的 stale-if-error 扩展允许在发生错误时使用陈旧的缓存响应。fastcgi_cache_valid#
fastcgi_cache_valid 200 302 10m;
fastcgi_cache_valid 404 1m;
fastcgi_cache_valid 5m;
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 字段,则此类响应将不会被缓存。如果头包含具有其他值的 Vary 字段,则此类响应将根据相应的请求头字段进行缓存。fastcgi_catch_stderr#
location /php/ {
fastcgi_pass backend:9000;
...
fastcgi_catch_stderr "PHP Fatal error";
fastcgi_next_upstream error timeout invalid_header;
}
fastcgi_connect_timeout#
fastcgi_connection_drop#
DELETE 标记为永久不可用后,终止到该服务器的所有连接。on 时,连接将立即断开。fastcgi_force_ranges#
Accept-Ranges 字段如何,都为来自该服务器的缓存和非缓存响应启用字节范围支持。fastcgi_hide_header#
Status 和 X-Accel-... 传递给客户端。fastcgi_hide_header 指令设置不会被传递的其他字段。相反,如果需要允许传递字段,可以使用 fastcgi_pass_header 指令。fastcgi_ignore_client_abort#
fastcgi_ignore_headers#
X-Accel-Redirect、X-Accel-Expires、X-Accel-Limit-Rate、X-Accel-Buffering、X-Accel-Charset、Expires、Cache-Control、Set-Cookie 和 Vary。fastcgi_index#
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_keep_conn#
on 时,Angie 将指示 FastCGI 服务器保持连接打开。这对于到 FastCGI 服务器的 keepalive 连接正常工作尤其必要。fastcgi_limit_rate#
0fastcgi_max_temp_file_size#
0fastcgi_next_upstream#
fastcgi_next_upstream error | timeout | invalid_header | http_500 | http_503 | http_403 | http_404 | http_429 | non_idempotent | off ...;fastcgi_next_upstream error timeout;errortimeoutinvalid_headerhttp_500http_503http_403http_404http_429non_idempotentPOST、LOCK、PATCH)的请求在已发送到上游服务器后不会传递给下一个服务器;
启用此选项将明确允许重试此类请求;offerrortimeoutinvalid_headerhttp_500http_503http_429http_403http_404fastcgi_next_upstream_timeout#
0fastcgi_next_upstream_tries#
0fastcgi_no_cache#
fastcgi_no_cache $cookie_nocache $arg_nocache$arg_comment;
fastcgi_no_cache $http_pragma $http_authorization;
fastcgi_param#
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;
--enable-force-cgi-redirect 配置参数构建,则还应传递值为"200"的 REDIRECT_STATUS 参数:fastcgi_param REDIRECT_STATUS 200;
if_not_empty 指定,则仅当参数值不为空时才会将该参数传递给服务器:fastcgi_param HTTPS $https if_not_empty;
fastcgi_pass#
fastcgi_pass localhost:9000;
fastcgi_pass unix:/tmp/fastcgi.socket;
fastcgi_pass_header#
fastcgi_pass_request_body#
fastcgi_pass_request_headers#
fastcgi_pass_request_headers on | off;fastcgi_pass_request_headers on;fastcgi_read_timeout#
fastcgi_request_buffering#
fastcgi_send_lowat#
fastcgi_send_timeout#
fastcgi_socket_keepalive#
offonfastcgi_split_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 /data/www$original_uri;
Last-Modified 响应头字段设置。响应首先写入临时文件,然后重命名该文件。临时文件和持久存储可以放在不同的文件系统上。但是请注意,在这种情况下,文件将跨两个文件系统复制,而不是廉价的重命名操作。因此建议对于任何给定位置,保存的文件和由 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 users:permissions ...;fastcgi_store_access user:rw;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 size;fastcgi_temp_file_write_size 8k|16k;fastcgi_temp_path#
fastcgi_temp_path path [level1 [level2 [level3]]]`;fastcgi_temp_path fastcgi_temp;
(路径取决于 --http-fastcgi-temp-path 构建参数)fastcgi_temp_path /spool/angie/fastcgi_temp 1 2;
/spool/angie/fastcgi_temp/7/45/00000123457
传递给 FastCGI 服务器的参数#
内置变量#
$fastcgi_script_name#/info/ 请求,使用以下指令fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;
/home/www/scripts/php/info/index.php。$fastcgi_path_info#