SCGI#

允许将请求传递给 SCGI 服务器。

配置示例#

location / {
    include   scgi_params;
    scgi_pass localhost:9000;
}

指令#

scgi_bind#

语法

scgi_bind address [transparent] | off;

默认

上下文

http, server, location

使发往 SCGI 服务器的出站连接从指定的本地 IP 地址(可选端口)发起。参数值可以包含变量。特殊值 off 取消从前一个配置级别继承的 scgi_bind 指令的效果,这允许系统自动分配本地 IP 地址和端口。

transparent 参数允许发往 SCGI 服务器的出站连接从非本地 IP 地址发起,例如,从客户端的真实 IP 地址:

scgi_bind $remote_addr transparent;

为了使此参数有效,通常需要以 超级用户 权限运行 Angie 工作进程。在 Linux 上则不需要,因为如果指定了 transparent 参数,工作进程会从主进程继承 CAP_NET_RAW 能力。

重要

需要配置内核路由表以拦截来自 SCGI 服务器的网络流量。

scgi_buffer_size#

语法

scgi_buffer_size size;

默认

scgi_buffer_size 4k|8k;

上下文

http, server, location

设置用于读取从 SCGI 服务器接收到的响应第一部分的缓冲区大小。这部分通常包含一个小的响应头。默认情况下,缓冲区大小等于一个内存页面。这是 4K 或 8K,具体取决于平台。虽然可以将其设置得更小。

scgi_buffering#

语法

scgi_buffering size;

默认

scgi_buffering on;

上下文

http, server, location

启用或禁用从 SCGI 服务器返回响应的缓冲。

on

Angie 尽快从 SCGI 服务器接收响应,并将其保存到由 scgi_buffer_sizescgi_buffers 指令设置的缓冲区中。如果整个响应无法全部装入内存,则部分响应可以保存到磁盘上的 temporary file。写入临时文件受 scgi_max_temp_file_sizescgi_temp_file_write_size 指令的控制。

off

响应以同步方式传递给客户端,立即在接收到时传递。Angie 不会尝试从 SCGI 服务器读取整个响应。Angie 一次从服务器可以接收的数据的最大大小由 scgi_buffer_size 指令设置。

缓冲也可以通过在 "X-Accel-Buffering" 响应头字段中传递 "yes" 或 "no" 来启用或禁用。此功能可以使用 scgi_ignore_headers 指令禁用。

scgi_buffers#

语法

scgi_buffers number size;

默认

scgi_buffers 8 4k | 8k;

上下文

http, server, location

设置用于从 SCGI 服务器读取响应的缓冲区的数量和大小,针对单个连接。

默认情况下,缓冲区大小等于一个内存页面。这是 4K 或 8K,具体取决于平台。

scgi_busy_buffers_size#

语法

scgi_busy_buffers_size size;

默认

scgi_busy_buffers_size 8k | 16k;

上下文

http, server, location

buffering 从 SCGI 服务器的响应被启用时,限制可以忙于将响应发送给客户端的缓冲区的总大小,同时响应尚未完全读取。与此同时,其余的缓冲区可以用于读取响应,并在必要时将部分响应缓冲到临时文件。

默认情况下,大小受 scgi_buffer_sizescgi_buffers 指令设置的两个缓冲区的大小限制。

scgi_cache#

语法

scgi_cache zone | off;

默认

scgi_cache off;

上下文

http, server, location

定义用于缓存的共享内存区域。相同的区域可以在多个地方使用。参数值可以包含变量。

off

禁用从前一个配置级别继承的缓存。

scgi_cache_background_update#

语法

scgi_cache_background_update on | off;

默认

scgi_cache_background_update off;

上下文

http, server, location

允许在返回过期缓存项的同时,启动后台子请求以更新该缓存项。

注意

请注意,必须 允许 在更新时使用过期的缓存响应。

scgi_cache_bypass#

语法

scgi_cache_bypass ...;

默认

上下文

http, server, location

定义不从缓存中获取响应的条件。如果字符串参数的至少一个值不为空且不等于 "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 string;

默认

上下文

http, server, location

定义缓存的键,例如:

scgi_cache_key localhost:9000$request_uri;

scgi_cache_lock#

语法

scgi_cache_lock on | off;

默认

scgi_cache_lock off;

上下文

http, server, location

启用时,将只允许一个请求一次填充由 scgi_cache_key 指令标识的新缓存元素,方法是将请求传递给 SCGI 服务器。同一缓存元素的其他请求将等待响应出现在缓存中或等待此元素的缓存锁释放,直到 scgi_cache_lock_timeout 指令设置的时间为止。

scgi_cache_lock_age#

语法

scgi_cache_lock_age time;

默认

scgi_cache_lock_age 5s;

上下文

http, server, location

如果传递给 SCGI 服务器用于填充新缓存元素的最后一个请求在指定时间内未完成,则可以再向 SCGI 服务器发出一个请求。

scgi_cache_lock_timeout#

语法

scgi_cache_lock_timeout time;

默认

scgi_cache_lock_timeout 5s;

上下文

http, server, location

scgi_cache_lock 设置超时。当时间到达时,请求将被传递给 SCGI 服务器,但响应将不会被缓存。

scgi_cache_max_range_offset#

语法

scgi_cache_max_range_offset number;

默认

上下文

http, server, location

为字节范围请求设置字节偏移量。如果范围超出偏移量,则范围请求将被传递给 SCGI 服务器,响应将不会被缓存。

scgi_cache_methods#

语法

scgi_cache_methods GET | HEAD | POST ...;

默认

scgi_cache_methods GET HEAD;

上下文

http, server, location

如果客户端请求方法在此指令中列出,则响应将被缓存。“GET”和“HEAD” 方法始终被添加到列表中,尽管建议明确指定它们。另见 scgi_no_cache 指令。

scgi_cache_min_uses#

语法

scgi_cache_min_uses number;

默认

scgi_cache_min_uses 1;

上下文

http, server, location

设置在响应被缓存之前的请求数量。

scgi_cache_path#

语法

scgi_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];

默认

上下文

http

设置缓存的路径和其他参数。缓存数据存储在文件中。缓存中的文件名是对 cache key 应用 MD5 函数的结果。

levels 参数定义了缓存的层级,从 1 到 3,每个层级接受值 1 或 2。例如,在以下配置中:

scgi_cache_path /data/angie/cache levels=1:2 keys_zone=one:10m;

缓存中的文件名将如下所示:

/data/angie/cache/c/29/b7f54b2df7773722d382f4809d65029c

缓存响应首先写入一个临时文件,然后该文件被重命名。临时文件和缓存可以放在不同的文件系统上。然而,请注意,在这种情况下,文件是跨两个文件系统复制而不是便宜的重命名操作。因此,建议对于任何给定的位置,缓存和存放临时文件的目录应放在同一个文件系统上。

临时文件的目录是基于 use_temp_path 参数设置的。

on

如果此参数被省略或设置为 on,则将使用为给定 location 设置的 scgi_temp_path 指令所指定的目录。

off

临时文件将直接放入缓存目录中。

此外,所有活动的键和数据的信息存储在一个共享内存区域,其名称和大小由 keys_zone 参数配置。一个兆字节的区域可以存储大约 8000 个键。

inactive 参数指定的时间内未访问的缓存数据将从缓存中移除,而不管其新鲜度。

默认情况下,inactive 设置为 10 分钟。

一个特殊的 缓存管理器 进程监视最大缓存大小和缓存文件系统上最小的可用空间,当大小超出或可用空间不足时,它会移除最少最近使用的数据。数据是以迭代的方式移除的。

max_size

最大缓存大小

min_free

缓存文件系统上最小的可用空间

manager_files

限制在一个迭代中要删除的项目数量

默认值: 100

manager_threshold

限制一个迭代的持续时间

默认值: 200 毫秒

manager_sleep

配置迭代之间的暂停

默认值: 50 毫秒

在 Angie 启动后的一分钟,特殊的 缓存加载器 进程被激活。它将存储在文件系统中的先前缓存的数据的信息加载到缓存区域。加载也是以迭代方式进行的。

loader_files

限制在一个迭代中要加载的项目数量

默认值: 100

loader_threshold

限制一个迭代的持续时间

默认值: 200 毫秒

loader_sleep

配置迭代之间的暂停

默认值: 50 毫秒

scgi_cache_revalidate#

语法

scgi_cache_revalidate on | off;

默认

scgi_cache_revalidate off;

上下文

http, server, location

启用使用 "If-Modified-Since" 和 "If-None-Match" 头字段的条件请求来重新验证过期的缓存项。

scgi_cache_use_stale#

语法

scgi_cache_use_stale error | timeout | invalid_header | updating | http_500 | http_502 | http_503 | http_504 | http_403 | http_404 | http_429 | off ...;

默认

scgi_cache_use_stale off;

上下文

http, server, location

确定在与 SCGI 服务器通信时可以在何种情况下使用过期的缓存响应。指令的参数与 scgi_next_upstream 指令的参数相匹配。

error

如果无法选择处理请求的 SCGI 服务器,则允许使用过期的缓存响应。

updating

额外参数,允许使用过期的缓存响应如果它正在被更新。这允许在更新缓存数据时最小化对 SCGI 服务器的访问。

使用过期的缓存响应也可以在响应头中直接启用,指定响应变得过期后允许的秒数:

  • "Cache-Control" 头字段的 stale-while-revalidate 扩展允许在其当前被更新时使用过期的缓存响应。

  • "Cache-Control" 头字段的 stale-if-error 扩展允许在发生错误时使用过期的缓存响应。

备注

这优先级低于使用指令参数。

为了最小化在填充新缓存元素时对 SCGI 服务器的访问,可以使用 scgi_cache_lock 指令。

scgi_cache_valid#

语法

scgi_cache_valid [code ...] time;

默认

上下文

http, server, location

为不同的响应代码设置缓存时间。例如,以下指令

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_connect_timeout time;

默认

scgi_connect_timeout 60s;

上下文

http, server, location

定义与 SCGI 服务器建立连接的超时时间。需要注意的是,此超时时间通常不能超过 75 秒。

scgi_connection_drop#

语法

scgi_connection_drop time | on | off;

默认

scgi_connection_drop off;

上下文

http, server, location

在代理服务器被移除出组或被 reresolve 进程或 API 命令 DELETE 标记为永久不可用后,启用终止与代理服务器的所有连接。

在处理客户端或代理服务器的下一个读或写事件时,连接将被终止。

设置 time 启用连接终止 超时;设置为 on 时,连接将立即被断开。

scgi_force_ranges#

语法

scgi_force_ranges off;

默认

scgi_force_ranges off;

上下文

http, server, location

启用对 SCGI 服务器的缓存和未缓存响应的字节范围支持,而不管这些响应中的 "Accept-Ranges" 字段。

scgi_hide_header#

语法

scgi_hide_header field;

默认

上下文

http, server, location

默认情况下,Angie 不会将 SCGI 服务器响应中的 "Status" 和 "X-Accel-..." 头字段传递给客户端。:samp:`scgi_hide_header 指令设置将不会被传递的其他字段。如果需要允许传递字段,则可以使用 scgi_pass_header 指令。

scgi_ignore_client_abort#

语法

scgi_ignore_client_abort on | off;

默认

scgi_ignore_client_abort off;

上下文

http, server, location

确定当客户端在等待响应时关闭连接时,是否应关闭与 SCGI 服务器的连接。

scgi_ignore_headers#

语法

scgi_ignore_headers field ...;

默认

上下文

http, server, location

禁用处理来自 SCGI 服务器的某些响应头字段。可以忽略的字段包括: "X-Accel-Redirect"、"X-Accel-Expires"、"X-Accel-Limit-Rate"、"X-Accel-Buffering"、"X-Accel-Charset"、"Expires"、"Cache-Control"、"Set-Cookie" 和 "Vary"。

如果没有被禁用,这些头字段的处理将产生以下效果:

  • "X-Accel-Expires"、"Expires"、"Cache-Control"、"Set-Cookie" 和 "Vary" 设置响应 缓存 的参数;

  • "X-Accel-Redirect" 执行对指定 URI 的 内部 重定向;

  • "X-Accel-Limit-Rate" 设置响应传输到客户端的 速率限制

  • "X-Accel-Buffering" 启用或禁用响应的 缓冲

  • "X-Accel-Charset" 设置响应的期望 字符集

      • 语法

      • scgi_intercept_errors on | off;

      • 默认值

      • scgi_intercept_errors off;

确定是否应该将状态码大于或等于300的SCGI响应传递给客户端,或者拦截并重定向到Angie进行处理,使用 error_page 指令。

scgi_limit_rate#

语法

scgi_limit_rate rate;

默认值

scgi_limit_rate 0;

上下文

http, server, location

限制从SCGI服务器读取响应的速度。 rate 以每秒字节为单位,并且可以包含变量。

0

禁用速率限制

备注

限制是按请求设置的,因此如果Angie同时打开两个与SCGI服务器的连接,则整体速率将是指定限制的两倍。该限制仅在启用SCGI服务器响应的 buffering 时有效。

scgi_max_temp_file_size#

语法

scgi_max_temp_file_size size;

默认值

scgi_max_temp_file_size 1024m;

上下文

http, server, location

当启用SCGI服务器响应的 buffering 时,如果整个响应无法适合由 scgi_buffer_sizescgi_buffers 指令设置的缓冲区,则响应的一部分可以保存到临时文件中。此指令设置临时文件的最大大小。一次写入临时文件的数据大小由 scgi_temp_file_write_size 指令设置。

0

禁用响应缓冲到临时文件

备注

此限制不适用于将被缓存或 存储在磁盘 的响应。

scgi_next_upstream#

语法

scgi_next_upstream error | timeout | invalid_header | http_500 | http_503 | http_403 | http_404 | http_429 | non_idempotent | off ...;

默认值

scgi_next_upstream error timeout;

上下文

http, server, location

指定在何种情况下请求应传递给 upstream pool 中的下一个服务器:

error

在与服务器建立连接、传递请求或读取响应头时发生错误;

timeout

在与服务器建立连接、传递请求或读取响应头时发生超时;

invalid_header

服务器返回了空的或无效的响应;

http_500

服务器返回了状态码500的响应;

http_503

服务器返回了状态码503的响应;

http_403

服务器返回了状态码403的响应;

http_404

服务器返回了状态码404的响应;

http_429

服务器返回了状态码429的响应;

non_idempotent

通常,带有 非幂等 方法的请求(POSTLOCKPATCH)在向上游服务器发送请求后不会传递给下一个服务器;启用此选项明确允许重试此类请求;

off

禁用将请求传递给下一个服务器。

备注

应注意,只有在尚未向客户端发送任何内容时,才能将请求传递给下一个服务器。也就是说,如果在响应传输过程中发生错误或超时,则无法进行修复。

该指令还定义了什么被视为与服务器通信的:ref:不成功尝试 <max_fails>

error

timeout

invalid_header

始终被视为不成功的尝试,即使在指令中未指定

http_500

http_503

http_429

仅在指令中指定时被视为不成功的尝试

http_403

http_404

永远不被视为不成功的尝试

将请求传递给下一个服务器可能会受到 尝试次数时间 的限制。

scgi_next_upstream_timeout#

语法

scgi_next_upstream_timeout time;

默认值

scgi_next_upstream_timeout 0;

上下文

http, server, location

限制可以传递给 下一个 服务器的请求的时间。

0

关闭此限制

scgi_next_upstream_tries#

语法

scgi_next_upstream_tries number;

默认值

scgi_next_upstream_tries 0;

上下文

http, server, location

限制将请求传递给 下一个 服务器的可能尝试次数。

0

关闭此限制

scgi_no_cache#

语法

scgi_no_cache string ...;

默认值

上下文

http, server, location

定义在何种情况下响应将不会被保存到缓存。如果字符串参数的至少一个值不为空并且不等于"0",则响应将不会被保存:

scgi_no_cache $cookie_nocache $arg_nocache$arg_comment;
scgi_no_cache $http_pragma    $http_authorization;

可以与 scgi_cache_bypass 指令一起使用。

scgi_param#

语法

scgi_param parameter value [if_not_empty];

默认值

上下文

http, server, location

设置应传递给SCGI服务器的参数。值可以包含文本、变量及其组合。这些指令仅在当前级别没有定义scgi_param指令的情况下从上一个配置级别继承。

标准 CGI环境变量 应作为SCGI头提供,请参见分发中提供的scgi_params文件:

location / {
    include scgi_params;
#    ...
}

如果指令与 if_not_empty 一起指定,则仅当该参数的值不为空时,才会将该参数传递给服务器:

scgi_param HTTPS $https if_not_empty;

scgi_pass#

语法

scgi_pass uri;

默认值

上下文

location, if in location, limit_except

设置SCGI服务器的地址。地址可以指定为域名或IP地址,以及一个可选的端口:

scgi_pass localhost:9000;

或指定为在单词 unix 之后并用冒号括起来的UNIX域套接字路径:

scgi_pass unix:/tmp/scgi.socket;

如果一个域名解析到多个地址,则将以轮询的方式使用它们。此外,地址可以指定为 服务器组。 如果使用了组,则不能与其一起指定端口;相反,单独为组内的每个服务器指定端口。

参数值可以包含变量。在这种情况下,如果将地址指定为域名,则将在描述的服务器组中搜索该名称,如果未找到,则使用 resolver 确定。

scgi_pass_header#

语法

scgi_pass_header field ...;

默认值

上下文

http, server, location

允许将来自SCGI服务器的 否则被禁用 的头字段传递给客户端。

scgi_pass_request_body#

语法

scgi_pass_request_body on | off;

默认值

scgi_pass_request_body on;

上下文

http, server, location

指示是否将原始请求体传递给SCGI服务器。另请参见 scgi_pass_request_headers 指令。

scgi_pass_request_headers#

语法

scgi_pass_request_headers on | off;

默认值

scgi_pass_request_headers on;

上下文

http, server, location

指示是否将原始请求的头字段传递给SCGI服务器。另请参见 scgi_pass_request_body 指令。

scgi_read_timeout#

语法

scgi_read_timeout time;

默认值

scgi_read_timeout 60s;

上下文

http, server, location

定义从SCGI服务器读取响应的超时时间。超时仅在两个连续读取操作之间设定,而不是针对整个响应的传输。如果SCGI服务器在此时间内没有传输任何内容,则连接将关闭。

scgi_request_buffering#

语法

scgi_request_buffering on | off;

默认值

scgi_request_buffering on;

上下文

http, server, location

启用或禁用客户端请求体的缓冲。

on

在将请求发送到 SCGI 服务器之前,从客户端 读取 整个请求体。

off

请求体在接收时立即发送到 SCGI 服务器。在这种情况下,如果 Angie 已经开始发送请求体,则请求无法传递给 下一个服务器

当使用 HTTP/1.1 分块传输编码发送原始请求体时,无论指令值如何,请求体都会被缓冲。

scgi_send_timeout#

语法

scgi_send_timeout 时间;

默认

scgi_send_timeout 60s;

上下文

http, server, location

设置向 SCGI 服务器传输请求的超时。超时仅在两个连续的写操作之间设置,而不是针对整个请求的传输。如果 SCGI 服务器在此时间内未接收到任何内容,则连接将被关闭。

scgi_socket_keepalive#

语法

scgi_socket_keepalive on | off;

默认

scgi_socket_keepalive off;

上下文

http, server, location

配置与 SCGI 服务器的出站连接的 "TCP keepalive" 行为。

""

默认情况下,操作系统的设置对套接字生效。

on

为套接字开启 SO_KEEPALIVE 套接字选项。

scgi_store#

语法

scgi_store on | off | 字符串;

默认

scgi_store off;

上下文

http, server, location

启用将文件保存到磁盘。

on

保存与指令 aliasroot 相对应的路径的文件。

off

禁用保存文件。

文件名可以通过使用带有变量的 字符串 显式设置:

scgi_store /data/www$original_uri;

文件的修改时间根据收到的 "Last-Modified" 响应头字段设置。响应首先写入临时文件,然后重命名该文件。临时文件和持久存储可以放在不同的文件系统上。然而,请注意,在这种情况下,文件是在两个文件系统之间复制,而不是便宜的重命名操作。因此,建议对于任何给定的 location,保存的文件和由 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#

语法

scgi_store_access 用户:权限 ...;

默认

scgi_store_access user:rw;

上下文

http, server, location

设置新创建的文件和目录的访问权限,例如:

scgi_store_access user:rw group:rw all:r;

如果指定了任何 groupall 访问权限,则用户权限可以省略:

scgi_store_access group:rw all:r;

scgi_temp_file_write_size#

语法

scgi_temp_file_write_size 大小;

默认

scgi_temp_file_write_size 8k|16k;

上下文

http, server, location

限制在启用从 SCGI 服务器到临时文件的响应缓冲时,一次写入临时文件的数据大小。默认情况下,大小由 scgi_buffer_sizescgi_buffers 指令设置的两个缓冲区限制。临时文件的最大大小由 scgi_max_temp_file_size 指令设置。

scgi_temp_path#

语法

scgi_temp_path 路径 [level1 [level2 [level3]]]`;

默认

scgi_temp_path scgi_temp; (路径取决于 --http-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 参数。