# SCGI 允许将请求传递给 SCGI 服务器。 ## 配置示例 ```nginx location / { include scgi_params; scgi_pass localhost:9000; } ``` ## 指令 ### scgi_bind | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_bind` address [`transparent`] | `off`; | |--------------------------------------------------------------------------------------|------------------------------------------------| | 默认值 | — | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 使到 SCGI 服务器的出站连接源自指定的本地 IP 地址和可选端口。参数值可以包含变量。特殊值 `off` 取消从上一配置级别继承的 scgi_bind 指令的效果,允许系统自动分配本地 IP 地址和端口。 `transparent` 参数允许到 SCGI 服务器的出站连接源自非本地 IP 地址,例如来自客户端的真实 IP 地址: ```nginx scgi_bind $remote_addr transparent; ``` 为了使此参数生效,通常需要以 [超级用户](https://cn.angie.software//angie/docs/configuration/modules/core.md#user) 权限运行 Angie 工作进程。在 Linux 上不需要这样做,因为如果指定了 `transparent` 参数,工作进程会从主进程继承 CAP_NET_RAW 能力。 #### NOTE 需要配置内核路由表以拦截来自 SCGI 服务器的网络流量。 ### scgi_buffer_size | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_buffer_size` size; | |--------------------------------------------------------------------------------------|----------------------------| | 默认值 | `scgi_buffer_size 4k|8k;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 设置用于读取从 SCGI 服务器接收的响应的第一部分的缓冲区大小。这部分通常包含一个小的响应头。默认情况下,缓冲区大小等于一个内存页。根据平台不同,这可能是 4K 或 8K。但可以设置得更小。 ### scgi_buffering | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_buffering` `on` | `off`; | |--------------------------------------------------------------------------------------|----------------------------------| | 默认值 | `scgi_buffering on;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 启用或禁用来自 SCGI 服务器的响应的缓冲。 | `on` | Angie 尽快从 SCGI 服务器接收响应,将其保存到由 [scgi_buffer_size](#scgi-buffer-size) 和 [scgi_buffers](#scgi-buffers) 指令设置的缓冲区中。向客户端发送会并行进行: 已填满的缓冲区会被传递用于发送,但总量不超过 [scgi_busy_buffers_size](#scgi-busy-buffers-size)。如果缓冲区未被完全填满,则不会被传递用于发送,除非这是响应的最后一部分。因此,当需要即时传输每隔几个字节时,缓冲读取模式并不适合。如果整个响应无法放入内存,可以将其中一部分保存到磁盘上的 [临时文件](#scgi-temp-path) 中。写入临时文件由 [scgi_max_temp_file_size](#scgi-max-temp-file-size) 和 [scgi_temp_file_write_size](#scgi-temp-file-write-size) 指令控制。 | |--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `off` | 响应在接收到时立即传递给客户端。Angie 以"读取 — 发送"的循环工作,不会等待缓冲区被填满: 例如从 4K 缓冲区读取到 10 字节时就会立即发送。同时,如果整个响应可以放入缓冲区,Angie 也可能一次读完。Angie 一次可以从服务器接收的最大数据量由 [scgi_buffer_size](#scgi-buffer-size) 指令设置。使用 `off` 时,:ref:scgi_limit_rate 不生效。 | 也可以通过在 `X-Accel-Buffering` 响应头字段中传递 "yes" 或 "no" 来启用或禁用缓冲。可以使用 [scgi_ignore_headers](#scgi-ignore-headers) 指令禁用此功能。 ### scgi_buffers | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_buffers` number size; | |--------------------------------------------------------------------------------------|-------------------------------| | 默认值 | `scgi_buffers 8 4k | 8k;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 设置用于从 SCGI 服务器读取响应的缓冲区的数量和大小,针对单个连接。 默认情况下,缓冲区大小等于一个内存页。根据平台不同,这可能是 4K 或 8K。 ### scgi_busy_buffers_size | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_busy_buffers_size` size; | |--------------------------------------------------------------------------------------|------------------------------------| | 默认值 | `scgi_busy_buffers_size 8k | 16k;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 当启用来自 SCGI 服务器的响应的 [缓冲](#scgi-buffering) 时,限制在响应尚未完全读取时可以忙于向客户端发送响应的缓冲区的总大小。同时,其余缓冲区可用于读取响应,如果需要,还可以将部分响应缓冲到临时文件中。 默认情况下,大小受 [scgi_buffer_size](#scgi-buffer-size) 和 [scgi_buffers](#scgi-buffers) 指令设置的两个缓冲区大小的限制。 ### scgi_cache | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache` zone | `off`; | |--------------------------------------------------------------------------------------|------------------------------| | 默认值 | `scgi_cache off;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 定义用于缓存的共享内存区域。同一区域可以在多个地方使用。参数值可以包含变量。 | `off` | 禁用从上一配置级别继承的缓存。 | |---------|-------------------| ### scgi_cache_background_update | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache_background_update` `on` | `off`; | |--------------------------------------------------------------------------------------|------------------------------------------------| | 默认值 | `scgi_cache_background_update off;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 允许启动后台子请求来更新过期的缓存项,同时将陈旧的缓存响应返回给客户端。 #### WARNING 注意,必须 [允许](#scgi-cache-use-stale-updating) 在更新时使用陈旧的缓存响应。 ### scgi_cache_bypass | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache_bypass` string ...; | |--------------------------------------------------------------------------------------|-----------------------------------| | 默认值 | — | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 定义不从缓存中获取响应的条件。如果字符串参数中至少有一个值不为空且不等于 "0",则不会从缓存中获取响应: ```nginx scgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment; scgi_cache_bypass $http_pragma $http_authorization; ``` 可以与 [scgi_no_cache](#scgi-no-cache) 指令一起使用。 ### scgi_cache_key | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache_key` string; | |--------------------------------------------------------------------------------------|----------------------------| | 默认值 | — | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 定义缓存的键,例如 ```nginx scgi_cache_key localhost:9000$request_uri; ``` ### scgi_cache_lock | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache_lock` `on` | `off`; | |--------------------------------------------------------------------------------------|-----------------------------------| | 默认值 | `scgi_cache_lock off;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 启用后,一次只允许一个请求通过将请求传递给 SCGI 服务器来填充根据 [scgi_cache_key](#scgi-cache-key) 指令标识的新缓存元素。同一缓存元素的其他请求将等待响应出现在缓存中或此元素的缓存锁被释放,最长等待时间由 [scgi_cache_lock_timeout](#scgi-cache-lock-timeout) 指令设置。 ### scgi_cache_lock_age | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache_lock_age` time; | |--------------------------------------------------------------------------------------|-------------------------------| | 默认值 | `scgi_cache_lock_age 5s;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 如果传递给 SCGI 服务器以填充新缓存元素的最后一个请求在指定时间内未完成,则可以再传递一个请求给 SCGI 服务器。 ### scgi_cache_lock_timeout | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache_lock_timeout` time; | |--------------------------------------------------------------------------------------|-----------------------------------| | 默认值 | `scgi_cache_lock_timeout 5s;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 设置 [scgi_cache_lock](#scgi-cache-lock) 的超时时间。当时间到期时,请求将被传递给 SCGI 服务器,但响应不会被缓存。 ### scgi_cache_max_range_offset | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache_max_range_offset` number; | |--------------------------------------------------------------------------------------|-----------------------------------------| | 默认值 | — | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 为字节范围请求设置偏移量(以字节为单位)。如果范围超出偏移量,范围请求将被传递给 SCGI 服务器,并且响应不会被缓存。 ### scgi_cache_methods | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache_methods` `GET` | `HEAD` | `POST` ...; | |--------------------------------------------------------------------------------------|-----------------------------------------------------| | 默认值 | `scgi_cache_methods GET HEAD;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 如果客户端请求方法在此指令中列出,则响应将被缓存。"GET" 和 "HEAD" 方法始终会被添加到列表中,但建议显式指定它们。另请参阅 [scgi_no_cache](#scgi-no-cache) 指令。 ### scgi_cache_min_uses | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache_min_uses` number; | |--------------------------------------------------------------------------------------|---------------------------------| | 默认值 | `scgi_cache_min_uses 1;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 设置在多少次请求后响应将被缓存。 #### WARNING 缓存元数据存储在共享内存中。手动删除缓存文件不会重置计数器，可能导致不可预测的行为。要完全重置缓存，请停止服务器，删除缓存目录，然后重新启动。 #### NOTE 第三方缓存清除模块（例如 [缓存清除](https://cn.angie.software//angie/docs/installation/external-modules/cache-purge.md#external-cache-purge)）仅删除文件，但不会重置 scgi_cache_min_uses 计数器。该指令旨在保护缓存免受不频繁请求的污染，在清除期间重置计数器可能会对性能产生负面影响。 ### scgi_cache_path | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `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]; | |--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 默认值 | — | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http | 设置缓存的路径和其他参数。缓存数据存储在文件中。缓存中的文件名是对 [缓存键](#scgi-cache-key) 应用 MD5 函数的结果。 `levels` 参数定义缓存的层次结构级别：从 1 到 3，每个级别接受值 1 或 2。例如，在以下配置中： ```nginx scgi_cache_path /data/angie/cache levels=1:2 keys_zone=one:10m; ``` 缓存中的文件名将如下所示： ```nginx /data/angie/cache/c/29/b7f54b2df7773722d382f4809d65029c ``` 缓存的响应首先写入临时文件，然后重命名该文件。临时文件和缓存可以放在不同的文件系统上。但是，请注意，在这种情况下，文件将在两个文件系统之间复制，而不是廉价的重命名操作。因此，建议对于任何给定位置，缓存和保存临时文件的目录都放在同一文件系统上。 临时文件的目录根据 `use_temp_path` 参数设置。 | `on` | 如果省略此参数或将其设置为值 on，则将使用由给定位置的 [scgi_temp_path](#scgi-temp-path) 指令设置的目录。 | |--------|---------------------------------------------------------------------------| | `off` | 临时文件将直接放在缓存目录中。 | 此外，所有活动键和有关数据的信息都存储在共享内存区域中，其名称和大小由 `keys_zone` 参数配置。一兆字节的区域可以存储大约 8 千个键。缓存元数据存储在共享内存中。 在 `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 | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache_revalidate` `on` | `off`; | |--------------------------------------------------------------------------------------|-----------------------------------------| | 默认值 | `scgi_cache_revalidate off;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 启用使用带有 `If-Modified-Since` 和 `If-None-Match` 头字段的条件请求重新验证过期的缓存项。 ### scgi_cache_use_stale | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache_use_stale` `error` | `timeout` | `invalid_header` | `updating` | `http_500` | `http_503` | `http_403` | `http_404` | `http_429` | `off` ...; | |--------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| | 默认值 | `scgi_cache_use_stale off;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 确定在哪些情况下可以使用过期的缓存响应。该指令的参数与 [scgi_next_upstream](#scgi-next-upstream) 指令的参数匹配。 | `error` | 如果无法选择 SCGI 服务器来处理请求，则允许使用过期的缓存响应。 | |------------|---------------------------------------------------------------| | `updating` | 附加参数，如果当前正在更新过期的缓存响应，则允许使用它。这可以最大限度地减少更新缓存数据时对 SCGI 服务器的访问次数。 | 也可以在响应头中直接启用使用过期的缓存响应，在响应变为过期后的指定秒数内： * `Cache-Control` 头字段的 [stale-while-revalidate](https://datatracker.ietf.org/doc/html/rfc5861#section-3) 扩展允许在当前正在更新过期的缓存响应时使用它。 * `Cache-Control` 头字段的 [stale-if-error](https://datatracker.ietf.org/doc/html/rfc5861#section-4) 扩展允许在发生错误时使用过期的缓存响应。 #### NOTE 此方法的优先级低于使用指令设置参数。 要在填充新缓存元素时最大限度地减少对 SCGI 服务器的访问次数，可以使用 [scgi_cache_lock](#scgi-cache-lock) 指令。 ### scgi_cache_valid | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_cache_valid` [code ...] time; | |--------------------------------------------------------------------------------------|---------------------------------------| | 默认值 | — | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 为不同的响应代码设置缓存时间。例如，以下指令 ```nginx scgi_cache_valid 200 302 10m; scgi_cache_valid 404 1m; ``` 为代码 200 和 302 的响应设置 10 分钟的缓存，为代码 404 的响应设置 1 分钟的缓存。 如果仅指定缓存时间， ```nginx scgi_cache_valid 5m; ``` 则仅缓存 200、301 和 302 响应。 此外，可以使用 `any` 参数指定缓存任何响应： ```nginx scgi_cache_valid 200 302 10m; scgi_cache_valid 301 1h; scgi_cache_valid any 1m; ``` #### NOTE 缓存参数也可以直接在响应头中设置。这比使用指令设置缓存时间具有更高的优先级。 * `X-Accel-Expires` 头字段以秒为单位设置响应的缓存时间。零值将禁用响应的缓存。如果值以 @ 前缀开头，则设置自 Epoch 以来的绝对时间（以秒为单位），响应可以缓存到该时间。 * 如果头不包含 `X-Accel-Expires` 字段，则可以在头字段 `Expires` 或 `Cache-Control` 中设置缓存参数。 * 如果头包含 `Set-Cookie` 字段，则此类响应将不会被缓存。 * 如果头包含特殊值 "\*" 的 `Vary` 字段，则此类响应将不会被缓存。如果头包含其他值的 `Vary` 字段，则此类响应将根据相应的请求头字段进行缓存。 可以使用 [scgi_ignore_headers](#scgi-ignore-headers) 指令禁用对这些响应头字段中的一个或多个的处理。 ### scgi_connect_timeout | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_connect_timeout` time; | |--------------------------------------------------------------------------------------|--------------------------------| | 默认值 | `scgi_connect_timeout 60s;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 定义与 SCGI 服务器建立连接的超时时间。需要注意的是，此超时时间通常不能超过 75 秒。 ### scgi_connection_drop | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_connection_drop` time | `on` | `off`; | |--------------------------------------------------------------------------------------|-----------------------------------------------| | 默认值 | `scgi_connection_drop off;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 启用在代理服务器从组中移除或被 [reresolve](https://cn.angie.software//angie/docs/configuration/modules/http/http_upstream.md#reresolve) 进程或 [API 命令](https://cn.angie.software//angie/docs/configuration/modules/http/http_api.md#api-config-methods) `DELETE` 标记为永久不可用后，终止到该服务器的所有连接。 当为客户端或代理服务器处理下一个读取或写入事件时，连接将被终止。 设置 time 启用连接终止 [超时](https://cn.angie.software//angie/docs/configuration/configfile.md#syntax)；设置为 `on` 时，连接将立即断开。 ### scgi_force_ranges | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_force_ranges` `on` | `off`; | |--------------------------------------------------------------------------------------|-------------------------------------| | 默认值 | `scgi_force_ranges off;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 无论 SCGI 服务器响应中的 `Accept-Ranges` 字段如何，都为来自 SCGI 服务器的缓存和非缓存响应启用字节范围支持。 ### scgi_hide_header | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_hide_header` field; | |--------------------------------------------------------------------------------------|-----------------------------| | 默认值 | — | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 默认情况下，Angie 不会将 SCGI 服务器响应中的头字段 `Status` 和 `X-Accel-...` 传递给客户端。`scgi_hide_header` 指令设置不会被传递的其他字段。相反，如果需要允许传递字段，可以使用 [scgi_pass_header](#scgi-pass-header) 指令。 ### scgi_ignore_client_abort | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_ignore_client_abort` `on` | `off`; | |--------------------------------------------------------------------------------------|--------------------------------------------| | 默认值 | `scgi_ignore_client_abort off;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 确定当客户端在未等待响应的情况下关闭连接时,是否应关闭与 SCGI 服务器的连接。 ### scgi_ignore_headers | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_ignore_headers` field ...; | |--------------------------------------------------------------------------------------|------------------------------------| | 默认值 | — | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | 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` 设置响应 [缓存](#scgi-cache-valid) 的参数; * `X-Accel-Redirect` 执行到指定 URI 的 [内部重定向](https://cn.angie.software//angie/docs/configuration/modules/http/index.md#internal); * `X-Accel-Limit-Rate` 设置向客户端传输响应的 [速率限制](https://cn.angie.software//angie/docs/configuration/modules/http/index.md#limit-rate); * `X-Accel-Buffering` 启用或禁用响应的 [缓冲](#scgi-buffering); * `X-Accel-Charset` 设置响应所需的 [字符集](https://cn.angie.software//angie/docs/configuration/modules/http/http_charset.md#id3)。 ### scgi_intercept_errors | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_intercept_errors` `on` | `off`; | |--------------------------------------------------------------------------------------|-----------------------------------------| | 默认值 | `scgi_intercept_errors off;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 确定代码大于或等于 300 的 SCGI 服务器响应应传递给客户端,还是被拦截并重定向到 Angie 以使用 [error_page](https://cn.angie.software//angie/docs/configuration/modules/http/index.md#error-page) 指令进行处理。 ### scgi_limit_rate | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_limit_rate` rate; | |--------------------------------------------------------------------------------------|---------------------------| | 默认值 | `scgi_limit_rate 0;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 限制从 SCGI 服务器读取响应的速度。 rate 以每秒字节数指定;可以使用变量。 | `0` | 禁用速率限制 | |-------|----------| #### NOTE 限制是针对每个请求设置的,因此如果 Angie 同时打开两个到 SCGI 服务器的连接,则总速率将是指定限制的两倍。该限制仅在启用来自 SCGI 服务器的响应 [缓冲](#scgi-buffering) 时有效。 ### scgi_max_temp_file_size | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_max_temp_file_size` size; | |--------------------------------------------------------------------------------------|-----------------------------------| | 默认值 | `scgi_max_temp_file_size 1024m;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 当启用来自 SCGI 服务器的响应 [缓冲](#scgi-buffering) 时,如果整个响应不适合 [scgi_buffer_size](#scgi-buffer-size) 和 [scgi_buffers](#scgi-buffers) 指令设置的缓冲区,则响应的一部分可以保存到临时文件中。此指令设置临时文件的最大大小。一次写入临时文件的数据大小由 [scgi_temp_file_write_size](#scgi-temp-file-write-size) 指令设置。 | `0` | 禁用将响应缓冲到临时文件 | |-------|----------------| #### NOTE 此限制不适用于将被 [缓存](#scgi-cache) 或 [存储](#scgi-store) 到磁盘的响应。 ### scgi_next_upstream | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `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;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 指定在哪些情况下应将请求传递到下一个服务器: | `error` | 与服务器建立连接、向其传递请求或读取响应头时发生错误; | |------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| | `timeout` | 与服务器建立连接、向其传递请求或读取响应头时发生超时; | | `invalid_header` | 服务器返回空响应或无效响应; | | `http_500` | 服务器返回代码为 500 的响应; | | `http_503` | 服务器返回代码为 503 的响应; | | `http_403` | 服务器返回代码为 403 的响应; | | `http_404` | 服务器返回代码为 404 的响应; | | `http_429` | 服务器返回代码为 429 的响应; | | `non_idempotent` | 通常,使用 [非幂等](https://datatracker.ietf.org/doc/html/rfc7231#section-4.2.2) 方法
(`POST`、`LOCK`、`PATCH`) 的请求如果已经发送到上游服务器,则不会传递到下一个服务器;启用此选项将明确允许重试此类请求; | | `off` | 禁用将请求传递到下一个服务器。 | #### NOTE 需要注意的是,只有在尚未向客户端发送任何内容时,才可能将请求传递到下一个服务器。也就是说,如果在传输响应的过程中发生错误或超时,则无法修复此问题。 该指令还定义了什么被视为与服务器通信的 [不成功尝试](https://cn.angie.software//angie/docs/configuration/modules/http/http_upstream.md#max-fails)。 | `error`

`timeout`

`invalid_header` | 始终被视为不成功尝试,即使未在指令中指定 | |--------------------------------------------------------|------------------------| | `http_500`

`http_503`

`http_429` | 仅在指令中指定时才被视为不成功尝试 | | `http_403`

`http_404` | 永远不会被视为不成功尝试 | 将请求传递到下一个服务器可以通过 [尝试次数](#scgi-next-upstream-tries) 和 [时间](#scgi-next-upstream-timeout) 进行限制。 ### scgi_next_upstream_timeout | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_next_upstream_timeout` time; | |--------------------------------------------------------------------------------------|--------------------------------------| | 默认值 | `scgi_next_upstream_timeout 0;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 限制可以将请求传递到 [下一个](#scgi-next-upstream) 服务器的时间。 | `0` | 关闭此限制 | |-------|---------| ### scgi_next_upstream_tries | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_next_upstream_tries` number; | |--------------------------------------------------------------------------------------|--------------------------------------| | 默认值 | `scgi_next_upstream_tries 0;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 限制将请求传递到 [下一个](#scgi-next-upstream) 服务器的可能尝试次数。 | `0` | 关闭此限制 | |-------|---------| ### scgi_no_cache | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_no_cache` string ...; | |--------------------------------------------------------------------------------------|-------------------------------| | 默认值 | — | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 定义响应不会保存到缓存的条件。如果字符串参数中至少有一个值不为空且不等于 "0",则响应将不会被保存: ```nginx scgi_no_cache $cookie_nocache $arg_nocache$arg_comment; scgi_no_cache $http_pragma $http_authorization; ``` 可以与 [scgi_cache_bypass](#scgi-cache-bypass) 指令一起使用。 ### scgi_param | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_param` parameter value [`if_not_empty`]; | |--------------------------------------------------------------------------------------|--------------------------------------------------| | 默认值 | — | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 设置应传递给 SCGI 服务器的参数。值可以包含文本、变量及其组合。当且仅当当前级别上没有定义 scgi_param 指令时,这些指令才会从上一级配置继承。 标准 [CGI 环境变量](https://datatracker.ietf.org/doc/html/rfc3875#section-4.1) 应作为 SCGI 头提供,请参阅发行版中提供的 scgi_params 文件: ```nginx location / { include scgi_params; # ... } ``` 在标准 `scgi_params` 文件中,:samp:REQUEST_METHOD 设置为 `$upstream_request_method`。 如果指令使用 `if_not_empty` 指定,则仅当参数值不为空时才会将其传递给服务器: ```nginx scgi_param HTTPS $https if_not_empty; ``` ### scgi_pass | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_pass` uri; | |--------------------------------------------------------------------------------------|--------------------------| | 默认值 | — | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | location, if in location | 设置 SCGI 服务器的地址。地址可以指定为域名或 IP 地址,以及可选的端口: ```nginx scgi_pass localhost:9000; ``` 或作为 UNIX 域套接字路径: ```nginx scgi_pass unix:/tmp/scgi.socket; ``` 如果域名解析为多个地址,则所有地址都将以轮询方式使用。此外,地址可以指定为 [服务器组](https://cn.angie.software//angie/docs/configuration/modules/http/http_upstream.md#http-upstream)。 参数值可以包含变量。在这种情况下,如果地址指定为域名,则在描述的服务器组中搜索该名称,如果未找到,则使用 [resolver](https://cn.angie.software//angie/docs/configuration/modules/http/index.md#resolver) 确定。 #### NOTE 如果在前缀带有尾部斜杠的 `location` 中指定了 `scgi_pass` (例如 `location /name/`), 并且 [auto_redirect](https://cn.angie.software//angie/docs/configuration/modules/http/index.md#auto-redirect) 指令设置为 `default`, 则不带尾部斜杠的请求将被重定向 (`/name -> /name/`)。 ### scgi_pass_header | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_pass_header` field ...; | |--------------------------------------------------------------------------------------|---------------------------------| | 默认值 | — | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 允许将 [原本被禁用的](#scgi-hide-header) 头字段从 SCGI 服务器传递给客户端。 ### scgi_pass_request_body | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_pass_request_body` `on` | `off`; | |--------------------------------------------------------------------------------------|------------------------------------------| | 默认值 | `scgi_pass_request_body on;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 指示是否将原始请求体传递给 SCGI 服务器。另请参阅 [scgi_pass_request_headers](#scgi-pass-request-headers) 指令。 ### scgi_pass_request_headers | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_pass_request_headers` `on` | `off`; | |--------------------------------------------------------------------------------------|---------------------------------------------| | 默认值 | `scgi_pass_request_headers on;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 指示是否将原始请求的头字段传递给 SCGI 服务器。另请参阅 [scgi_pass_request_body](#scgi-pass-request-body) 指令。 ### scgi_read_timeout | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_read_timeout` time; | |--------------------------------------------------------------------------------------|-----------------------------| | 默认值 | `scgi_read_timeout 60s;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 定义从 SCGI 服务器读取响应的超时时间。超时仅在两次连续的读操作之间设置,而不是用于整个响应的传输。如果 SCGI 服务器在此时间内未传输任何内容,则连接将被关闭。 ### scgi_request_buffering | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_request_buffering` `on` | `off`; | |--------------------------------------------------------------------------------------|------------------------------------------| | 默认值 | `scgi_request_buffering on;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 启用或禁用客户端请求体的缓冲。 | `on` | 在将请求发送到 SCGI 服务器之前,从客户端完整 [读取](https://cn.angie.software//angie/docs/configuration/modules/http/index.md#client-body-buffer-size) 请求体。 | |--------|------------------------------------------------------------------------------------------------------------------------------------------| | `off` | 请求体在接收时立即发送到 SCGI 服务器。在这种情况下,如果 Angie 已经开始发送请求体,则无法将请求传递到 [下一个服务器](#scgi-next-upstream)。 | 当使用 HTTP/1.1 分块传输编码发送原始请求体时,无论指令值如何,请求体都将被缓冲。 ### scgi_send_timeout | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_send_timeout` time; | |--------------------------------------------------------------------------------------|-----------------------------| | 默认值 | `scgi_send_timeout 60s;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 设置向 SCGI 服务器传输请求的超时时间。超时仅在两次连续的写操作之间设置,而不是用于整个请求的传输。如果 SCGI 服务器在此时间内未接收到任何内容,则连接将被关闭。 ### scgi_socket_keepalive | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_socket_keepalive` `on` | `off`; | |--------------------------------------------------------------------------------------|-----------------------------------------| | 默认值 | `scgi_socket_keepalive off;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 配置到 SCGI 服务器的出站连接的 "TCP keepalive" 行为。 | `off` | 默认情况下,套接字使用操作系统的设置。 | |---------|----------------------------| | `on` | 为套接字启用 SO_KEEPALIVE 套接字选项。 | ### scgi_store | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_store` `on` | `off` | string; | |--------------------------------------------------------------------------------------|---------------------------------------| | 默认值 | `scgi_store off;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 启用将文件保存到磁盘。 | `on` | 使用与 [alias](https://cn.angie.software//angie/docs/configuration/modules/http/index.md#alias) 或 [root](https://cn.angie.software//angie/docs/configuration/modules/http/index.md#root) 指令对应的路径保存文件 | |--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `off` | 禁用保存文件 | 可以使用带变量的 string 显式设置文件名： ```nginx scgi_store /data/www$original_uri; ``` 文件的修改时间根据接收到的 `Last-Modified` 响应头字段设置。响应首先写入临时文件,然后重命名该文件。临时文件和持久存储可以放在不同的文件系统上。但是请注意,在这种情况下,文件将跨两个文件系统复制,而不是进行廉价的重命名操作。因此建议对于任何给定位置,保存的文件和由 [scgi_temp_path](#scgi-temp-path) 指令设置的临时文件目录都放在同一文件系统上。 此指令可用于创建静态不变文件的本地副本,例如： ```nginx 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 | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_store_access` users:permissions ...; | |--------------------------------------------------------------------------------------|----------------------------------------------| | 默认值 | `scgi_store_access user:rw;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 设置新创建的文件和目录的访问权限,例如： ```nginx scgi_store_access user:rw group:rw all:r; ``` 如果指定了任何 `group` 或 `all` 访问权限,则可以省略用户权限： ```nginx scgi_store_access group:rw all:r; ``` ### scgi_temp_file_write_size | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_temp_file_write_size` size; | |--------------------------------------------------------------------------------------|-------------------------------------| | 默认值 | `scgi_temp_file_write_size 8k|16k;` | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 当启用将来自 SCGI 服务器的响应缓冲到临时文件时,限制一次写入临时文件的数据大小。默认情况下,大小受 [scgi_buffer_size](#scgi-buffer-size) 和 [scgi_buffers](#scgi-buffers) 指令设置的两个缓冲区限制。临时文件的最大大小由 [scgi_max_temp_file_size](#scgi-max-temp-file-size) 指令设置。 ### scgi_temp_path | [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | `scgi_temp_path` path [level1 [level2 [level3]]]\`; | |--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| | 默认值 | `scgi_temp_path scgi_temp;`
(路径取决于 `--http-scgi-temp-path` [构建选项](https://cn.angie.software//angie/docs/installation/sourcebuild.md#paths)) | | [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | 定义用于存储从 SCGI 服务器接收的数据的临时文件的目录。在指定目录下最多可以使用三级子目录层次结构。例如,在以下配置中 ```nginx scgi_temp_path /spool/angie/scgi_temp 1 2; ``` 临时文件可能如下所示： ```nginx /spool/angie/scgi_temp/7/45/00000123457 ``` 另请参阅 [scgi_cache_path](#scgi-cache-path) 指令的 `use_temp_path` 参数。