模块 ngx_http_scgi_module

ngx_http_scgi_module 模块允许将请求传递到 SCGI 服务器。

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

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

transparent 参数 (1.11.0) 允许到 SCGI 服务器的传出连接源自非本地 IP 地址，例如，源自客户端的真实 IP 地址

scgi_bind $remote_addr transparent;

为了使此参数生效，通常需要使用 超级用户 权限运行 nginx 工作进程。在 Linux 上不需要这样 (1.13.8)，因为如果指定了 transparent 参数，工作进程会从主进程继承 CAP_NET_RAW 功能。还需要配置内核路由表来拦截来自 SCGI 服务器的网络流量。

scgi_buffer_size 4k|8k;

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

scgi_buffering on;

启用或禁用来自 SCGI 服务器的响应缓冲。

启用缓冲时，nginx 会尽快从 SCGI 服务器接收响应，并将其保存到由 scgi_buffer_size 和 scgi_buffers 指令设置的缓冲区中。如果整个响应不适合内存，则可以将其一部分保存到磁盘上的 临时文件 中。写入临时文件由 scgi_max_temp_file_size 和 scgi_temp_file_write_size 指令控制。

禁用缓冲时，响应会立即同步传递给客户端，就像收到响应一样。nginx 不会尝试从 SCGI 服务器读取整个响应。nginx 一次可以从服务器接收的最大数据大小由 scgi_buffer_size 指令设置。

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

scgi_buffers 8 4k|8k;

设置用于从 SCGI 服务器读取响应的缓冲区的 number 和 size，用于单个连接。默认情况下，缓冲区大小等于一个内存页。根据平台的不同，它可能是 4K 或 8K。

scgi_busy_buffers_size 8k|16k;

当启用来自 SCGI 服务器的响应的 缓冲 时，限制可以忙于向客户端发送响应的缓冲区的总 size，而响应尚未完全读取。同时，其余缓冲区可用于读取响应，并在需要时将响应的一部分缓冲到临时文件。默认情况下，size 受 scgi_buffer_size 和 scgi_buffers 指令设置的两个缓冲区大小的限制。

scgi_cache off;

定义用于缓存的共享内存区域。同一个区域可以在多个地方使用。参数值可以包含变量 (1.7.9)。off 参数禁用从先前配置级别继承的缓存。

scgi_cache_background_update off;

允许启动后台子请求以更新过期的缓存项，同时将陈旧的缓存响应返回给客户端。请注意，当更新陈旧的缓存响应时，有必要允许使用它。

定义不会从缓存中获取响应的条件。如果字符串参数的至少一个值不为空且不等于“0”，则不会从缓存中获取响应

scgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment;
scgi_cache_bypass $http_pragma    $http_authorization;

可与 scgi_no_cache 指令一起使用。

定义缓存的键，例如

scgi_cache_key localhost:9000$request_uri;

scgi_cache_lock off;

启用后，一次只允许一个请求通过向 SCGI 服务器传递请求来填充根据 scgi_cache_key 指令确定的新缓存元素。相同缓存元素的其他请求将等待响应出现在缓存中或此元素的缓存锁被释放，最长可达 scgi_cache_lock_timeout 指令设置的时间。

scgi_cache_lock_age 5s;

如果传递给 SCGI 服务器以填充新缓存元素的最后一个请求在指定的时间内尚未完成，则可以将另一个请求传递给 SCGI 服务器。

scgi_cache_lock_timeout 5s;

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

在 1.7.8 之前，可以缓存响应。

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

scgi_cache_methods GET HEAD;

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

scgi_cache_min_uses 1;

设置请求的number，之后将缓存响应。

设置缓存的路径和其他参数。缓存数据存储在文件中。缓存中的文件名是将 MD5 函数应用于缓存键的结果。levels 参数定义缓存的层次结构级别：从 1 到 3，每个级别接受值 1 或 2。例如，在以下配置中

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

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

/data/nginx/cache/c/29/b7f54b2df7773722d382f4809d65029c

缓存的响应首先写入临时文件，然后重命名该文件。从 0.8.9 版本开始，临时文件和缓存可以放在不同的文件系统上。但是，请注意，在这种情况下，文件是跨两个文件系统复制的，而不是进行廉价的重命名操作。因此，建议对于任何给定的位置，缓存和保存临时文件的目录都放在同一文件系统上。临时文件的目录基于use_temp_path参数设置（1.7.10）。如果省略此参数或将其设置为值on，则将使用给定位置的scgi_temp_path指令设置的目录。如果将值设置为off，则临时文件将直接放入缓存目录中。

此外，所有活动键和有关数据的信息都存储在共享内存区域中，其name和size由keys_zone参数配置。一个兆字节的区域可以存储大约 8 千个键。

作为商业订阅的一部分，共享内存区域还存储扩展缓存信息，因此，需要为相同数量的键指定更大的区域大小。例如，一个兆字节的区域可以存储大约 4000 个键。

在由 inactive 参数指定的时间内未访问的缓存数据将从缓存中删除，而不管其新鲜度如何。默认情况下，inactive 设置为 10 分钟。

特殊的“缓存管理器”进程监视由 max_size 参数设置的最大缓存大小，以及由 min_free (1.19.1) 参数设置的缓存文件系统上的最小可用空间量。当大小超标或可用空间不足时，它会删除最近最少使用的的数据。数据删除的迭代由 manager_files、manager_threshold 和 manager_sleep 参数（1.11.5）配置。在一次迭代期间，最多删除 manager_files 项（默认值为 100）。一次迭代的持续时间受 manager_threshold 参数限制（默认值为 200 毫秒）。在迭代之间，会暂停由 manager_sleep 参数配置的时间（默认值为 50 毫秒）。

启动一分钟后，特殊的“缓存加载器”进程被激活。它将存储在文件系统上的先前缓存数据的信息加载到缓存区域中。加载也是以迭代方式进行的。在一次迭代期间，最多加载 loader_files 项（默认值为 100）。此外，一次迭代的持续时间受 loader_threshold 参数限制（默认值为 200 毫秒）。在迭代之间，会暂停由 loader_sleep 参数配置的时间（默认值为 50 毫秒）。

此外，以下参数可作为我们商业订阅的一部分提供

purger=on|off

指示缓存清理器是否会从磁盘中删除与通配符键匹配的缓存条目（1.7.12）。将该参数设置为 on（默认值为 off）将激活“缓存清理器”进程，该进程将永久迭代所有缓存条目并删除与通配符键匹配的条目。

purger_files=number

设置一次迭代期间将扫描的项数（1.7.12）。默认情况下，purger_files 设置为 10。

purger_threshold=number

设置一次迭代的持续时间（1.7.12）。默认情况下，purger_threshold 设置为 50 毫秒。

purger_sleep=数字

设置迭代之间的暂停（1.7.12）。默认情况下，purger_sleep 设置为 50 毫秒。

在版本 1.7.3、1.7.7 和 1.11.10 中，缓存头格式已更改。升级到较新的 nginx 版本后，以前缓存的响应将被视为无效。

定义将请求视为缓存清除请求的条件。如果字符串参数的至少一个值不为空且不等于“0”，则将删除具有相应 缓存密钥 的缓存条目。通过返回 204（无内容）响应来指示操作成功。

如果清除请求的 缓存密钥 以星号（“*”）结尾，则将从缓存中删除与通配符密钥匹配的所有缓存条目。但是，这些条目将保留在磁盘上，直到它们因 不活动 而被删除，或被 缓存清除器（1.7.12）处理，或客户端尝试访问它们。

示例配置

scgi_cache_path /data/nginx/cache keys_zone=cache_zone:10m;

map $request_method $purge_method {
    PURGE   1;
    default 0;
}

server {
    ...
    location / {
        scgi_pass        backend;
        scgi_cache       cache_zone;
        scgi_cache_key   $uri;
        scgi_cache_purge $purge_method;
    }
}

此功能作为我们 商业订阅 的一部分提供。

scgi_cache_revalidate off;

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

scgi_cache_use_stale off;

确定在与 SCGI 服务器通信期间发生错误时可以在哪些情况下使用陈旧的缓存响应。该指令的参数与 scgi_next_upstream 指令的参数匹配。

error 参数还允许在无法选择 SCGI 服务器来处理请求时使用陈旧的缓存响应。

此外，updating 参数允许在当前更新陈旧的缓存响应时使用该响应。这允许在更新缓存数据时最大程度地减少对 SCGI 服务器的访问次数。

还可以在响应头中直接启用使用陈旧的缓存响应，响应变为陈旧后指定秒数（1.11.10）。这比使用指令参数的优先级低。

• “stale-while-revalidate”扩展“Cache-Control”头字段允许在当前更新时使用陈旧的缓存响应。
• “stale-if-error”扩展“Cache-Control”头字段允许在发生错误时使用陈旧的缓存响应。

为在填充新缓存元素时最大程度减少对 SCGI 服务器的访问次数，可以使用 scgi_cache_lock 指令。

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

scgi_cache_valid 200 302 10m;
scgi_cache_valid 404      1m;

为代码 200 和 302 的响应设置 10 分钟的缓存时间，为代码 404 的响应设置 1 分钟的缓存时间。

如果只指定缓存time

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”头字段以秒为单位设置响应的缓存时间。零值禁用响应的缓存。如果值以@前缀开头，则它设置从纪元开始到可以缓存响应的秒数的绝对时间。
• 如果头不包括“X-Accel-Expires”字段，则可以在“Expires”或“Cache-Control”头字段中设置缓存参数。
• 如果头包括“Set-Cookie”字段，则不会缓存此类响应。
• 如果头包括具有特殊值“*”的“Vary”字段，则不会缓存此类响应 (1.7.7)。如果头包括具有其他值的“Vary”字段，则将缓存此类响应，同时考虑相应的请求头字段 (1.7.7)。

可以使用 scgi_ignore_headers 指令禁用处理其中一个或多个这些响应头字段。

scgi_connect_timeout 60s;

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

scgi_force_ranges off;

无论这些响应中的“Accept-Ranges”字段如何，都为来自 SCGI 服务器的缓存和非缓存响应启用字节范围支持。

默认情况下，nginx 不会将 SCGI 服务器响应中的“Status”和“X-Accel-...”头字段传递给客户端。scgi_hide_header 指令设置不会传递的其他字段。相反，如果需要允许传递字段，可以使用 scgi_pass_header 指令。

scgi_ignore_client_abort off;

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

禁用对来自 SCGI 服务器的某些响应头字段的处理。可以忽略以下字段：“X-Accel-Redirect”、“X-Accel-Expires”、“X-Accel-Limit-Rate”（1.1.6）、“X-Accel-Buffering”（1.1.6）、“X-Accel-Charset”（1.1.6）、“Expires”、“Cache-Control”、“Set-Cookie”（0.8.44）和“Vary”（1.7.7）。

如果没有禁用，处理这些头字段的效果如下

• “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 off;

确定是否应将代码大于或等于 300 的 SCGI 服务器响应传递给客户端，或者是否应拦截并重定向到 nginx 以使用 error_page 指令进行处理。

scgi_limit_rate 0;

限制从 SCGI 服务器读取响应的速度。速率以每秒字节数指定。零值禁用速率限制。限制是针对每个请求设置的，因此如果 nginx 同时向 SCGI 服务器打开两个连接，则总体速率将是指定限制的两倍。仅当启用对来自 SCGI 服务器的响应的 缓冲 时，此限制才有效。

scgi_max_temp_file_size 1024m;

当启用对来自 SCGI 服务器的响应的 缓冲 时，并且整个响应不适合 scgi_buffer_size 和 scgi_buffers 指令设置的缓冲区，则响应的一部分可以保存到临时文件。此指令设置临时文件的最大大小。一次写入临时文件的数据大小由 scgi_temp_file_write_size 指令设置。

零值禁用将响应缓冲到临时文件。

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

scgi_next_upstream error timeout;

指定在哪些情况下应将请求传递到下一台服务器

error

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

timeout

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

invalid_header

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

http_500

服务器返回带有代码 500 的响应；

http_503

服务器返回带有代码 503 的响应；

http_403

服务器返回带有代码 403 的响应；

http_404

服务器返回带有代码 404 的响应；

http_429

服务器返回带有代码 429 的响应 (1.11.13)；

non_idempotent

通常，如果已向上一游服务器发送请求，则不会将具有非幂等方法（POST、LOCK、PATCH）的请求传递到下一台服务器 (1.9.13)；启用此选项明确允许重试此类请求；

off

禁用将请求传递到下一台服务器。

应记住，仅当尚未向客户端发送任何内容时才有可能将请求传递到下一台服务器。也就是说，如果在传输响应的过程中发生错误或超时，则无法修复此问题。

该指令还定义了哪些被认为是与服务器通信的失败尝试。即使未在指令中指定，error、timeout和invalid_header的情况始终被视为失败尝试。仅当在指令中指定时，http_500、http_503和http_429的情况才被视为失败尝试。http_403和http_404的情况永远不被视为失败尝试。

将请求传递到下一台服务器可以通过尝试次数和时间来限制。

scgi_next_upstream_timeout 0;

限制在将请求传递给下一个服务器期间的时间。0 值关闭此限制。

scgi_next_upstream_tries 0;

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

定义不会将响应保存到缓存中的条件。如果字符串参数的至少一个值不为空且不等于“0”，则不会保存响应

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

可以与scgi_cache_bypass指令一起使用。

设置应传递给 SCGI 服务器的parameter。value 可以包含文本、变量及其组合。当且仅当当前级别上未定义scgi_param指令时，这些指令才会从上一个配置级别继承。

标准CGI 环境变量应作为 SCGI 标头提供，请参阅发行版中提供的scgi_params文件

location / {
    include scgi_params;
    ...
}

如果使用if_not_empty (1.1.11)指定指令，则此类参数仅在其值不为空时才会传递给服务器

scgi_param HTTPS $https if_not_empty;

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

scgi_pass localhost:9000;

或作为 UNIX 域套接字路径

scgi_pass unix:/tmp/scgi.socket;

如果域名解析为多个地址，则所有地址都将以循环方式使用。此外，地址可以指定为服务器组。

参数值可以包含变量。在这种情况下，如果地址指定为域名，则在所述服务器组中搜索名称，如果找不到，则使用解析器确定。

允许将原本禁用的标头字段从 SCGI 服务器传递到客户端。

scgi_pass_request_body on;

指示是否将原始请求正文传递到 SCGI 服务器。另请参阅 scgi_pass_request_headers 指令。

scgi_pass_request_headers on;

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

scgi_read_timeout 60s;

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

scgi_request_buffering on;

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

启用缓冲时，在向 SCGI 服务器发送请求之前，将从客户端读取整个请求正文。

禁用缓冲时，请求正文在接收后会立即发送到 SCGI 服务器。在这种情况下，如果 nginx 已开始发送请求正文，则无法将请求传递到下一个服务器。

当使用 HTTP/1.1 分块传输编码来发送原始请求正文时，无论指令值如何，都将缓冲请求正文。

scgi_send_timeout 60s;

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

scgi_socket_keepalive off;

配置到 SCGI 服务器的传出连接的“TCP 保活”行为。默认情况下，操作系统的设置对套接字有效。如果该指令设置为值“on”，则套接字的 SO_KEEPALIVE 套接字选项将被打开。

scgi_store off;

启用文件保存到磁盘。on 参数使用与指令 alias 或 root 相对应的路径保存文件。off 参数禁用文件保存。此外，可以使用带有变量的 string 显式设置文件名

scgi_store /data/www$original_uri;

文件的修改时间根据收到的“Last-Modified”响应头字段设置。响应首先写入临时文件，然后重命名该文件。从 0.8.9 版本开始，临时文件和持久性存储可以放在不同的文件系统上。但是，请注意，在这种情况下，文件是跨两个文件系统复制的，而不是使用廉价的重命名操作。因此，建议对于任何给定的位置，由 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 user:rw;

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

scgi_store_access user:rw group:rw all:r;

如果指定了任何 group 或 all 访问权限，则可以省略 user 权限

scgi_store_access group:rw all:r;

scgi_temp_file_write_size 8k|16k;

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

scgi_temp_path scgi_temp;

定义一个目录，用于存储从 SCGI 服务器接收的数据的临时文件。在指定目录下最多可以使用三级子目录层次结构。例如，在以下配置中

scgi_temp_path /spool/nginx/scgi_temp 1 2;

临时文件可能如下所示

/spool/nginx/scgi_temp/7/45/00000123457

另请参阅 scgi_cache_path 指令的 use_temp_path 参数。