SCGI#
允许将请求传递给 SCGI 服务器。
当 从源代码构建 时,该模块默认会被构建;可以通过
构建选项 --without-http_scgi_module 禁用它。
在来自 我们的软件仓库 的包和镜像中,该模块已包含在 构建中。
相关指南
Console Light Web 面板:缓存区域填充 Caches 选项卡。
配置示例#
location / {
include scgi_params;
scgi_pass localhost:9000;
}
指令#
scgi_bind#
使到 SCGI 服务器的出站连接源自指定的本地 IP 地址和可选端口。参数值可以包含变量。特殊值 off 取消从上一配置级别继承的 scgi_bind 指令的效果,允许系统自动分配本地 IP 地址和端口。
默认情况下,该值在请求初始化时求值一次,即在选择 SCGI 服务器之前。在 Angie PRO 中,每次选择 SCGI 服务器之后(包括重试)都会重新求值,因此绑定地址可以取决于所选服务器,例如通过 $upstream_current_addr 变量。如果求得的值为空,则不进行绑定。
transparent 参数允许到 SCGI 服务器的出站连接源自非本地 IP 地址,例如来自客户端的真实 IP 地址:
scgi_bind $remote_addr transparent;
为了使此参数生效,通常需要以 超级用户 权限运行 Angie 工作进程。在 Linux 上不需要这样做,因为如果指定了 transparent 参数,工作进程会从主进程继承 CAP_NET_RAW 能力。
备注
需要配置内核路由表以拦截来自 SCGI 服务器的网络流量。
scgi_buffer_size#
设置用于读取从 SCGI 服务器接收的响应的第一部分的缓冲区大小。这部分通常包含一个小的响应头。默认情况下,缓冲区大小等于一个内存页。根据平台不同,这可能是 4K 或 8K。但可以设置得更小。
scgi_buffering#
启用或禁用来自 SCGI 服务器的响应的缓冲。
| Angie 在从 SCGI 服务器读取响应的同时将其发送给客户端;客户端不必等待整个响应。响应被读入由 scgi_buffer_size 和 scgi_buffers 指令设置的缓冲区。缓冲区一旦被完全填满就会被传递用于发送,忙于发送的缓冲区总大小受 scgi_busy_buffers_size 限制。未填满的缓冲区会一直等待,直到被填满或响应结束,因此数据通常以完整缓冲区为单位到达客户端。因此,必须在产生时就送达客户端的响应需要使用 |
| 从 SCGI 服务器读取到的每一部分数据都会立即传递给客户端,没有最小尺寸限制:例如从 4K 缓冲区中读取的 10 字节会被立即发送。Angie 使用由 scgi_buffer_size 指令设置的单个缓冲区,因此每次读取的数据都不会超过该大小。由于不使用临时文件,响应既不会被缓存,也不会被 存储 到磁盘,scgi_limit_rate 和 limit_rate 都不起作用。 |
也可以通过在 X-Accel-Buffering 响应头字段中传递 "yes" 或 "no" 来启用或禁用缓冲。可以使用 scgi_ignore_headers 指令禁用此功能。
scgi_buffers#
设置用于从 SCGI 服务器读取响应的缓冲区的数量和大小,针对单个连接。
默认情况下,缓冲区大小等于一个内存页。根据平台不同,这可能是 4K 或 8K。
scgi_busy_buffers_size#
当启用来自 SCGI 服务器的响应的 缓冲 时,限制在响应尚未完全读取时可以忙于向客户端发送响应的缓冲区的总大小。同时,其余缓冲区可用于读取响应,如果需要,还可以将部分响应缓冲到临时文件中。
默认情况下,大小受 scgi_buffer_size 和 scgi_buffers 指令设置的两个缓冲区大小的限制。
scgi_cache#
定义用于缓存的共享内存区域。同一区域可以在多个地方使用。参数值可以包含变量。
| 禁用从上一配置级别继承的缓存。 |
备注
使用 scgi_cache 时, 通常还需要设置 scgi_cache_valid 指令 来明确指定响应的缓存时间。 如果未设置,Angie 不使用默认值, 而是根据来自服务器的 HTTP 响应头 按以下优先级顺序确定响应缓存时间:
X-Accel-Expires头(最高优先级)。带有
max-age或s-maxage参数的Cache-Control头。Expires头。
如果这些头都不包含有效值或根本不存在, 响应将不会被缓存,因为无法确定其过期时间。
scgi_cache_background_update#
| |
默认值 |
|
http, server, location |
允许启动后台子请求来更新过期的缓存项,同时将陈旧的缓存响应返回给客户端。
警告
注意,必须 允许 在更新时使用陈旧的缓存响应。
scgi_cache_bypass#
定义不从缓存中获取响应的条件。如果字符串参数中至少有一个值不为空且不等于 "0",则不会从缓存中获取响应:
scgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment;
scgi_cache_bypass $http_pragma $http_authorization;
参数值可以包含变量。
可以与 scgi_no_cache 指令一起使用。
scgi_cache_key#
定义缓存的键。键可以包含变量。例如
scgi_cache_key localhost:9000$request_uri;
scgi_cache_lock#
启用后,一次只允许一个请求通过将请求传递给 SCGI 服务器来填充根据 scgi_cache_key 指令标识的新缓存元素。同一缓存元素的其他请求将等待响应出现在缓存中或此元素的缓存锁被释放,最长等待时间由 scgi_cache_lock_timeout 指令设置。
scgi_cache_lock_age#
如果传递给 SCGI 服务器以填充新缓存元素的最后一个请求在指定时间内未完成,则可以再传递一个请求给 SCGI 服务器。
scgi_cache_lock_timeout#
设置 scgi_cache_lock 的超时时间。当时间到期时,请求将被传递给 SCGI 服务器,但响应不会被缓存。
scgi_cache_max_range_offset#
为字节范围请求设置偏移量(以字节为单位)。如果范围超出偏移量,范围请求将被传递给 SCGI 服务器,并且响应不会被缓存。
scgi_cache_methods#
如果客户端请求方法在此指令中列出,则响应将被缓存。"GET" 和 "HEAD" 方法始终会被添加到列表中,但建议显式指定它们。另请参阅 scgi_no_cache 指令。
scgi_cache_min_uses#
设置在多少次请求后响应将被缓存。
警告
缓存元数据存储在共享内存中。手动删除缓存文件不会重置计数器,可能导致不可预测的行为。要完全重置缓存,请停止服务器,删除缓存目录,然后重新启动。
备注
第三方缓存清除模块(例如 Cache Purge)仅删除文件,但不会重置 scgi_cache_min_uses 计数器。该指令旨在保护缓存免受不频繁请求的污染,在清除期间重置计数器可能会对性能产生负面影响。
scgi_cache_path#
| |
默认值 | — |
http |
设置缓存的路径和其他参数。缓存数据存储在文件中。缓存中的文件名是对 缓存键 应用 MD5 函数的结果。
| 定义缓存的层次结构级别:从 1 到 3,每个级别接受值 1 或 2。 |
例如,在以下配置中:
scgi_cache_path /data/angie/cache levels=1:2 keys_zone=one:10m;
缓存中的文件名将如下所示:
/data/angie/cache/c/29/b7f54b2df7773722d382f4809d65029c
缓存的响应首先写入临时文件,然后重命名该文件。临时文件和缓存可以放在不同的文件系统上。但是,请注意,在这种情况下,文件将在两个文件系统之间复制,而不是廉价的重命名操作。因此,建议对于任何给定位置,缓存和保存临时文件的目录都放在同一文件系统上。
| 确定用于临时文件的目录 |
| 如果未指定该参数或设置为 |
| 临时文件将直接放置在缓存目录中 |
| 设置用于存储所有活动键和数据信息的共享内存区域的名称和大小。缓存元数据存储在共享内存中。 区域大小以字节为单位指定,且必须至少为两个系统内存页。
1 兆字节的区域足以存储约 8000 个键。 当使用 如果文件内容不兼容,例如由不兼容的构建写入,
Angie 会为其加上 如果配置中的区域大小与文件中保存的大小不再一致,
配置将无法加载,直到删除该文件或恢复原来的大小。
如果无法在文件中保存的内存地址映射该区域,配置同样无法加载:
若该地址已被占用,Angie 会记录 警告 确保正确指定 file 的路径, 并具有 Angie 使用所需的访问权限, 并受到保护以防止未经授权的访问; 相对路径基于 prefix。 |
| 如果在此参数指定的时间内未访问缓存数据,则无论其新鲜度如何,数据都将被删除;每次访问都会重置此计时器。这与下文所述的、由**缓存管理器**执行的基于大小的清除不同:即使缓存未达到 默认情况下, |
特殊的**缓存管理器**进程监控最大缓存大小和缓存所在文件系统的最小可用空间量,当超出大小或可用空间不足时,它会删除最近最少使用的数据。数据以迭代方式删除。
| 缓存大小的最大阈值 该值以字节为单位指定; |
| 缓存所在文件系统可用空间的最小阈值 该值使用与 在不支持查询文件系统统计信息的平台上,
此参数将被忽略,Angie 会记录警告
|
| 限制一次迭代期间要删除的项目数 默认情况下, |
| 限制一次迭代的持续时间 默认情况下, |
| 配置迭代之间的暂停 默认情况下, |
Angie 启动一分钟后,特殊的**缓存加载器**进程被激活。它将存储在文件系统上的先前缓存数据的信息加载到缓存区域中。加载也以迭代方式完成。
| 限制一次迭代期间要加载的项目数 默认情况下, |
| 限制一次迭代的持续时间 默认情况下, |
| 配置迭代之间的暂停 默认情况下, |
scgi_cache_revalidate#
启用使用带有 If-Modified-Since 和 If-None-Match 头字段的条件请求重新验证过期的缓存项。
scgi_cache_use_stale#
| |
默认值 |
|
http, server, location |
确定在哪些情况下可以使用过期的缓存响应。该指令的参数与 scgi_next_upstream 指令的参数匹配。
| 如果无法选择 SCGI 服务器来处理请求,则允许使用过期的缓存响应。 |
| 附加参数,如果当前正在更新过期的缓存响应,则允许使用它。这可以最大限度地减少更新缓存数据时对 SCGI 服务器的访问次数。 |
| 如果使用 非幂等 方法的请求已经发送到 SCGI 服务器,而随后与该服务器的通信因任何原因失败,则允许使用过期的缓存响应;在非幂等方法中只有 |
也可以在响应头中直接启用使用过期的缓存响应,在响应变为过期后的指定秒数内:
Cache-Control头字段的 stale-while-revalidate 扩展允许在当前正在更新过期的缓存响应时使用它。Cache-Control头字段的 stale-if-error 扩展允许在发生错误时使用过期的缓存响应。
备注
此方法的优先级低于使用指令设置参数。
要在填充新缓存元素时最大限度地减少对 SCGI 服务器的访问次数,可以使用 scgi_cache_lock 指令。
scgi_cache_valid#
为不同的响应代码设置缓存时间。例如,以下指令
scgi_cache_valid 200 302 10m;
scgi_cache_valid 404 1m;
为代码 200 和 302 的响应设置 10 分钟的缓存,为代码 404 的响应设置 1 分钟的缓存。
如果仅指定缓存时间,
scgi_cache_valid 5m;
则仅缓存 200、301 和 302 响应。
此外,可以使用 any 参数指定缓存任何响应:
scgi_cache_valid 200 302 10m;
scgi_cache_valid 301 1h;
scgi_cache_valid any 1m;
备注
缓存参数也可以直接在响应头中设置。这比使用指令设置缓存时间具有更高的优先级。
X-Accel-Expires头字段以秒为单位设置响应的缓存时间。零值将禁用响应的缓存。如果值以 @ 前缀开头,则设置自 Epoch 以来的绝对时间(以秒为单位),响应可以缓存到该时间。如果头不包含
X-Accel-Expires字段,则可以在头字段Expires或Cache-Control中设置缓存参数。如果头包含
Set-Cookie字段,则此类响应将不会被缓存。如果头包含特殊值 "*" 的
Vary字段,则此类响应将不会被缓存。如果头包含其他值的Vary字段,则此类响应将根据相应的请求头字段进行缓存。
可以使用 scgi_ignore_headers 指令禁用对这些响应头字段中的一个或多个的处理。
scgi_connect_timeout#
定义与 SCGI 服务器建立连接的超时时间。需要注意的是,此超时时间通常不能超过 75 秒。
scgi_connection_drop#
启用在代理服务器从组中移除或被 reresolve 进程或 API 命令 DELETE 标记为永久不可用后,终止到该服务器的所有活动连接。
缓存 中的空闲连接不受影响。
当为客户端或代理服务器处理下一个读取或写入事件时,连接将被终止。
设置 time 启用连接终止 超时;设置为 on 时,连接将立即断开。
scgi_force_ranges#
无论 SCGI 服务器响应中的 Accept-Ranges 字段如何,都为来自 SCGI 服务器的缓存和非缓存响应启用字节范围支持。
scgi_hide_header#
默认情况下,Angie 不会将 SCGI 服务器响应中的头字段 Status 和 X-Accel-... 传递给客户端。scgi_hide_header 指令设置不会被传递的其他字段。相反,如果需要允许传递字段,可以使用 scgi_pass_header 指令。
scgi_ignore_client_abort#
确定当客户端在未等待响应的情况下关闭连接时,是否应关闭与 SCGI 服务器的连接。
scgi_ignore_headers#
禁用对来自 SCGI 服务器的某些响应头字段的处理。可以忽略以下字段:X-Accel-Redirect、X-Accel-Expires、X-Accel-Limit-Rate、X-Accel-Buffering、X-Accel-Charset、Expires、Cache-Control、Set-Cookie 和 Vary。
如果未禁用,处理这些头字段将产生以下效果:
scgi_intercept_errors#
确定代码大于或等于 300 的 SCGI 服务器响应应传递给客户端,还是被拦截并重定向到 Angie 以使用 error_page 指令进行处理。
scgi_limit_rate#
限制从 SCGI 服务器读取响应的速度。 rate 以每秒字节数指定;可以使用变量。
| 禁用速率限制 |
备注
限制是针对每个请求设置的,因此如果 Angie 同时打开两个到 SCGI 服务器的连接,则总速率将是指定限制的两倍。该限制仅在启用来自 SCGI 服务器的响应 缓冲 时有效。
scgi_max_temp_file_size#
当启用来自 SCGI 服务器的响应 缓冲 时,如果整个响应不适合 scgi_buffer_size 和 scgi_buffers 指令设置的缓冲区,则响应的一部分可以保存到临时文件中。此指令设置临时文件的最大大小。一次写入临时文件的数据大小由 scgi_temp_file_write_size 指令设置。
| 禁用将响应缓冲到临时文件 |
scgi_next_upstream#
| |
默认值 |
|
http, server, location |
指定在哪些情况下应将请求传递到下一个服务器:
| 与服务器建立连接、向其传递请求或读取响应头时发生错误; |
| 与服务器建立连接、向其传递请求或读取响应头时发生超时; |
| 服务器返回空响应或无效响应; |
| 服务器返回代码为 500 的响应; |
| 服务器返回代码为 503 的响应; |
| 服务器返回代码为 403 的响应; |
| 服务器返回代码为 404 的响应; |
| 服务器返回代码为 429 的响应; |
| 通常,使用 非幂等 方法
( |
| 禁用将请求传递到下一个服务器。 |
备注
需要注意的是,只有在尚未向客户端发送任何内容时,才可能将请求传递到下一个服务器。也就是说,如果在传输响应的过程中发生错误或超时,则无法修复此问题。
该指令还定义了什么被视为与服务器通信的 不成功尝试。
| 始终被视为不成功尝试,即使未在指令中指定 |
| 仅在指令中指定时才被视为不成功尝试 |
| 永远不会被视为不成功尝试 |
scgi_next_upstream_timeout#
限制可以将请求传递到 下一个 服务器的时间。
| 关闭此限制 |
scgi_next_upstream_tries#
限制将请求传递到 下一个 服务器的可能尝试次数。
| 关闭此限制 |
scgi_no_cache#
定义响应不会保存到缓存的条件。如果字符串参数中至少有一个值不为空且不等于 "0",则响应将不会被保存:
scgi_no_cache $cookie_nocache $arg_nocache$arg_comment;
scgi_no_cache $http_pragma $http_authorization;
参数值可以包含变量。
可以与 scgi_cache_bypass 指令一起使用。
scgi_param#
设置应传递给 SCGI 服务器的参数。值可以包含文本、变量及其组合。当且仅当当前级别上没有定义 scgi_param 指令时,这些指令才会从上一级配置继承。
标准 CGI 环境变量 应作为 SCGI 头提供,请参阅发行版中提供的 scgi_params 文件:
location / {
include scgi_params;
# ...
}
在标准 scgi_params 文件中, REQUEST_METHOD 设置为
$upstream_request_method。
如果指令使用 if_not_empty 指定,则仅当参数值不为空时才会将其传递给服务器:
scgi_param HTTPS $https if_not_empty;
scgi_pass#
设置 SCGI 服务器的地址。地址可以指定为域名或 IP 地址,以及端口:
scgi_pass localhost:9000;
或作为 UNIX 域套接字路径:
scgi_pass unix:/tmp/scgi.socket;
如果域名解析为多个地址,则所有地址都将以轮询方式使用。此外,地址可以指定为 服务器组。
参数值可以包含变量。在这种情况下,如果地址指定为域名,则在描述的服务器组中搜索该名称,如果未找到,则使用 resolver 确定。
备注
如果在前缀带有尾部斜杠的 location 中指定了 scgi_pass
(例如 location /name/),
并且 auto_redirect 指令设置为 default,
则不带尾部斜杠的请求将被重定向 (/name -> /name/)。
scgi_pass_header#
允许将 原本被禁用的 头字段从 SCGI 服务器传递给客户端。
scgi_pass_request_body#
指示是否将原始请求体传递给 SCGI 服务器。另请参阅 scgi_pass_request_headers 指令。
scgi_pass_request_headers#
指示是否将原始请求的头字段传递给 SCGI 服务器。另请参阅 scgi_pass_request_body 指令。
scgi_read_timeout#
定义从 SCGI 服务器读取响应的超时时间。超时仅在两次连续的读操作之间设置,而不是用于整个响应的传输。如果 SCGI 服务器在此时间内未传输任何内容,则连接将被关闭。
scgi_request_buffering#
启用或禁用客户端请求体的缓冲。
| 在将请求发送到 SCGI 服务器之前,从客户端完整 读取 请求体。 |
| 请求体在接收时立即发送到 SCGI 服务器。在这种情况下,如果 Angie 已经开始发送请求体,则无法将请求传递到 下一个服务器。 |
当使用 HTTP/1.1 分块传输编码发送原始请求体时,无论指令值如何,请求体都将被缓冲。
scgi_send_timeout#
设置向 SCGI 服务器传输请求的超时时间。超时仅在两次连续的写操作之间设置,而不是用于整个请求的传输。如果 SCGI 服务器在此时间内未接收到任何内容,则连接将被关闭。
scgi_socket_keepalive#
配置到 SCGI 服务器的出站连接的 "TCP keepalive" 行为。
| 默认情况下,套接字使用操作系统的设置。 |
| 为套接字启用 SO_KEEPALIVE 套接字选项。 |
scgi_store#
启用将文件保存到磁盘。
可以使用带变量的 string 显式设置文件名:
scgi_store /data/www$original_uri;
文件的修改时间根据接收到的 Last-Modified 响应头字段设置。响应首先写入临时文件,然后重命名该文件。临时文件和持久存储可以放在不同的文件系统上。但是请注意,在这种情况下,文件将跨两个文件系统复制,而不是进行廉价的重命名操作。因此建议对于任何给定位置,保存的文件和由 scgi_temp_path 指令设置的临时文件目录都放在同一文件系统上。
此指令可用于创建静态不变文件的本地副本,例如:
location /images/ {
root /data/www;
error_page 404 = /fetch$uri;
}
location /fetch/ {
internal;
scgi_pass backend:9000;
...
scgi_store on;
scgi_store_access user:rw group:rw all:r;
scgi_temp_path /data/temp;
alias /data/www/;
}
scgi_store_access#
| |
默认值 |
|
http, server, location |
设置新创建的文件和目录的访问权限,例如:
scgi_store_access user:rw group:rw all:r;
如果指定了任何 group 或 all 访问权限,则可以省略用户权限:
scgi_store_access group:rw all:r;
scgi_temp_file_write_size#
当启用将来自 SCGI 服务器的响应缓冲到临时文件时,限制一次写入临时文件的数据大小。默认情况下,大小受 scgi_buffer_size 和 scgi_buffers 指令设置的两个缓冲区限制。临时文件的最大大小由 scgi_max_temp_file_size 指令设置。
scgi_temp_path#
| |
默认值 |
|
http, server, location |
定义用于存储从 SCGI 服务器接收的数据的临时文件的目录。在指定目录下最多可以使用三级子目录层次结构。例如,在以下配置中
scgi_temp_path /spool/angie/scgi_temp 1 2;
临时文件可能如下所示:
/spool/angie/scgi_temp/7/45/00000123457
另请参阅 scgi_cache_path 指令的 use_temp_path 参数。