SCGI#
允许将请求传递给 SCGI 服务器。
配置示例#
location / {
include scgi_params;
scgi_pass localhost:9000;
}
指令#
scgi_bind#
使到 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 服务器接收到的响应第一部分的缓冲区大小。此部分通常包含一个小的响应头。默认情况下，缓冲区大小等于一个内存页。这是 4K 或 8K，具体取决于平台。可以将其设置得更小。
scgi_buffering#
启用或禁用来自 SCGI 服务器的响应缓冲。
|
Angie 尽快从 SCGI 服务器接收响应，将其保存到由 scgi_buffer_size 和 scgi_buffers 指令设置的缓冲区中。如果整个响应无法放入内存中，则可以将其一部分保存到磁盘上的 临时文件 中。写入临时文件由 scgi_max_temp_file_size 和 scgi_temp_file_write_size 指令控制。 |
|
响应同步传递给客户端，立即在接收到时传递。Angie 不会尝试从 SCGI 服务器读取整个响应。Angie 从服务器一次可以接收的数据的最大大小由 scgi_buffer_size 指令设置。 |
缓冲还可以通过在 "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_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_cache_key 指令通过将请求传递给 SCGI 服务器来识别。相同缓存元素的其他请求将等待响应出现在缓存中或该元素的缓存锁释放，最多等待 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#
|
|
默认 |
|
http, server, location |
如果客户端请求方法列在此指令中，则响应将被缓存。"GET" 和 "HEAD" 方法总是会添加到列表中，尽管建议明确指定它们。另请参阅 scgi_no_cache 指令。
scgi_cache_min_uses#
设置在响应被缓存之前的请求次数。
scgi_cache_path#
|
|
默认 |
— |
http |
设置缓存的路径和其他参数。缓存数据存储在文件中。缓存中的文件名是将 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，将使用 scgi_temp_path 指令为给定 location 设置的目录。 |
|
临时文件将直接放在缓存目录中。 |
此外，所有活动的键和关于数据的信息都存储在一个共享内存区中，其名称和大小由 keys_zone 参数配置。一个兆字节的区域可以存储大约 8000 个键。
在 inactive 参数指定的时间内没有被访问的缓存数据会被移除，无论其新鲜度如何。
默认情况下，inactive 设置为 10 分钟。
一个特殊的 cache manager 进程监视最大缓存大小和文件系统上的最小可用空间，当大小超过或没有足够的可用空间时，它会删除最近最少使用的数据。数据是在迭代中移除的。
|
最大缓存大小 |
|
文件系统上的最小可用空间 |
|
限制一次迭代中要删除的项目数量 默认情况下， |
|
限制一次迭代的持续时间 默认情况下， |
|
配置迭代之间的暂停 默认情况下， |
Angie 启动一分钟后，特殊的 cache loader 进程被激活。它将之前存储在文件系统上的缓存数据加载到缓存区中。加载也是在迭代中进行的。
|
限制一次迭代中要加载的项目数量 默认情况下， |
|
限制一次迭代的持续时间 默认情况下， |
|
配置迭代之间的暂停 默认情况下， |
scgi_cache_revalidate#
启用使用条件请求（如 "If-Modified-Since" 和 "If-None-Match" 头字段）对过期缓存项的重新验证。
scgi_cache_use_stale#
|
|
默认 |
|
http, server, location |
确定在与 SCGI 服务器通信时可以在哪些情况下使用过时的缓存响应。该指令的参数与 scgi_next_upstream 指令的参数匹配。
|
允许在无法选择处理请求的 SCGI 服务器时使用过时的缓存响应。 |
|
额外参数，允许在缓存响应正在更新时使用过时的缓存响应。这可以在更新缓存数据时最大限度地减少对 SCGI 服务器的访问次数。 |
使用过时的缓存响应还可以在响应头中直接启用，指定响应过时后多少秒内继续使用：
stale-while-revalidate 扩展 "Cache-Control" 头字段允许在响应正在更新时使用过时的缓存响应。
stale-if-error 扩展 "Cache-Control" 头字段允许在发生错误时使用过时的缓存响应。
备注
这比使用指令参数的优先级低。
要在填充新缓存元素时最大限度地减少对 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#
|
|
Default |
|
http, server, location |
启用在代理服务器被从组中移除或被 reresolve 进程或 API 命令 DELETE 标记为永久不可用后终止所有连接。
当为客户端或代理服务器处理下一个读取或写入事件时，连接被终止。
设置 time 启用连接终止 超时；设置为 on 时，连接将立即断开。
scgi_force_ranges#
为来自 SCGI 服务器的缓存和未缓存响应启用字节范围支持，无论这些响应中是否包含 "Accept-Ranges" 字段。
scgi_hide_header#
默认情况下，Angie 不会将来自 SCGI 服务器响应的 "Status" 和 "X-Accel-..." 头字段传递给客户端。scgi_hide_header 指令设置不传递的额外字段。相反，如果需要允许字段传递，可以使用 scgi_pass_header 指令。
scgi_ignore_client_abort#
|
|
Default |
|
http, server, location |
确定在客户端关闭连接而不等待响应时是否应关闭与 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#
|
|
Default |
|
http, server, location |
决定是否将状态码大于或等于300的SCGI响应传递给客户端，还是拦截并重定向到Angie，以使用 error_page 指令进行处理。
scgi_limit_rate#
限制从SCGI服务器读取响应的速度。 rate 以每秒字节数指定，可以包含变量。
|
禁用速率限制 |
备注
限制是针对每个请求设置的，因此如果Angie同时打开两个到SCGI服务器的连接，总体速率将是指定限制的两倍。仅当启用了从SCGI服务器的响应的 buffering 时，限制才有效。
scgi_max_temp_file_size#
|
|
Default |
|
http, server, location |
当启用了从SCGI服务器的响应的 buffering，并且整个响应不适合由 scgi_buffer_size 和 scgi_buffers 指令设置的缓冲区时，响应的一部分可以保存到临时文件中。此指令设置临时文件的最大大小。一次写入临时文件的数据大小由 scgi_temp_file_write_size 指令设置。
|
禁用响应到临时文件的缓冲 |
备注
此限制不适用于将被缓存或 存储在磁盘上 的响应。
scgi_next_upstream#
|
|
Default |
|
http, server, location |
指定在哪些情况下请求应传递到 upstream pool 中的下一个服务器：
|
在与服务器建立连接、传递请求或读取响应头时发生错误； |
|
在与服务器建立连接、传递请求或读取响应头时发生超时； |
|
服务器返回空的或无效的响应； |
|
服务器返回代码为500的响应； |
|
服务器返回代码为503的响应； |
|
服务器返回代码为403的响应； |
|
服务器返回代码为404的响应； |
|
服务器返回代码为429的响应； |
|
通常，使用 非幂等 方法
( |
|
禁止将请求传递到下一个服务器。 |
备注
需要注意的是，只有在尚未向客户端发送任何内容的情况下，才有可能将请求传递到下一个服务器。也就是说，如果在传输响应的中途发生错误或超时，则无法修复。
该指令还定义了与服务器通信的 尝试失败 的标准。
|
|
总是被视为不成功的尝试，即使它们没有在指令中指定 |
|
|
只有在指令中指定时才被视为不成功的尝试 |
|
|
从不被视为不成功的尝试 |
scgi_next_upstream_timeout#
|
|
Default |
|
http, server, location |
限制在将请求传递到 下一个 服务器的时间。
|
关闭此限制 |
scgi_next_upstream_tries#
|
|
Default |
|
http, server, location |
限制将请求传递到 下一个 服务器的尝试次数。
|
关闭此限制 |
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环境变量 <https://datatracker.ietf.org/doc/html/rfc3875#section-4.1>`_应作为SCGI头提供，请参阅分发中提供的scgi_params文件：
location / {
include scgi_params;
# ...
}
如果指令中指定了 if_not_empty，则只有在参数值不为空时，该参数才会传递给服务器：
scgi_param HTTPS $https if_not_empty;
scgi_pass#
设置SCGI服务器的地址。地址可以指定为域名或IP地址，以及可选的端口：
scgi_pass localhost:9000;
或作为用冒号括起来的UNIX域套接字路径，紧跟在 unix 之后：
scgi_pass unix:/tmp/scgi.socket;
如果域名解析为多个地址，则会轮流使用所有地址。此外，地址可以指定为 服务器组。 如果使用组，则不能为其指定端口；而是为组内的每台服务器单独指定端口。
参数值可以包含变量。在这种情况下，如果地址指定为域名，则会在描述的服务器组中搜索该名称，如果未找到，则使用 resolver 确定。
scgi_pass_header#
允许将 否则禁用 的头字段从SCGI服务器传递到客户端。
scgi_pass_request_body#
|
|
Default |
|
http, server, location |
指示是否将原始请求体传递给SCGI服务器。另请参阅 scgi_pass_request_headers 指令。
scgi_pass_request_headers#
指示是否将原始请求的头字段传递给 SCGI 服务器。另请参阅 scgi_pass_request_body 指令。
scgi_read_timeout#
定义从 SCGI 服务器读取响应的超时时间。超时时间仅在两次连续读取操作之间设置，而不是整个响应的传输时间。如果 SCGI 服务器在此时间内未传输任何内容，则连接将关闭。
scgi_request_buffering#
启用或禁用客户端请求体的缓冲。
|
在将请求发送到 SCGI 服务器之前，从客户端读取完整的请求体 client_body_buffer_size。 |
|
请求体在接收到时立即发送到 SCGI 服务器。在这种情况下，如果已经开始发送请求体，则无法将请求传递给 下一个服务器。 |
当使用 HTTP/1.1 分块传输编码发送原始请求体时，无论指令值如何，请求体都会被缓冲。
scgi_send_timeout#
设置将请求传输到 SCGI 服务器的超时时间。超时仅在两次连续写操作之间设置，而不是用于整个请求的传输。如果 SCGI 服务器在此时间内没有接收到任何内容，则连接将关闭。
scgi_socket_keepalive#
配置与 SCGI 服务器的外部连接的 "TCP 保持活动" 行为。
|
默认情况下，操作系统的设置在套接字上生效。 |
|
SO_KEEPALIVE 套接字选项为套接字启用。 |
scgi_store#
启用将文件保存到磁盘。
可以使用带有变量的 字符串 显式设置文件名：
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 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 参数。