模块 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;

为了使此参数生效，通常需要使用 superuser 权限运行 nginx worker 进程。在 Linux 上则不需要（1.13.8），因为如果指定了 transparent 参数，worker 进程会从 master 进程继承 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_cache_key 指令标识的新的缓存元素，一次只允许一个请求通过将请求传递给 SCGI 服务器来填充它。同一缓存元素的其他请求将等待响应出现在缓存中，或者等待此元素的缓存锁释放，直到达到 scgi_cache_lock_timeout 指令设置的时间。

scgi_cache_lock_age 5s;

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

scgi_cache_lock_timeout 5s;

设置 scgi_cache_lock 的超时时间。当 time 到期时，请求将被传递给 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 版本开始，临时文件和缓存可以放在不同的文件系统上。但是请注意，在这种情况下，文件会跨两个文件系统复制，而不是廉价的重命名操作。因此建议，对于任何给定的 location，缓存和存放临时文件的目录都应放在同一文件系统上。临时文件的目录基于 use_temp_path 参数（1.7.10）设置。如果省略此参数或将其设置为 on，则将使用给定 location 的 scgi_temp_path 指令设置的目录。如果值设置为 off，临时文件将直接放在缓存目录中。

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

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

在 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=number

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

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

定义将请求视为缓存清除请求的条件。如果字符串参数的至少一个值不为空且不等于“0”，则将移除具有相应缓存键的缓存条目。成功操作的结果通过返回 204 (No Content) 响应来指示。

如果清除请求的缓存键以星号（“*”）结尾，则所有与通配符键匹配的缓存条目都将从缓存中移除。但是，这些条目将保留在磁盘上，直到因不活动而被删除，或由缓存清除器（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）。这比使用指令参数的优先级低。

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

为了在填充新的缓存元素时最大程度地减少对 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”头字段以秒为单位设置响应的缓存时间。零值禁用响应的缓存。如果值以 @ 前缀开头，则它设置自 Epoch 以来的绝对时间（以秒为单位），直到该时间响应都可以被缓存。
• 如果头不包含“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;

启用对 SCGI 服务器返回的缓存和未缓存响应的字节范围支持，无论这些响应中是否包含“Accept-Ranges”字段。

默认情况下，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;

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

scgi_limit_rate 0;

限制从 SCGI 服务器读取响应的速度。rate 以字节/秒为单位指定。零值禁用速率限制。限制是针对每个请求设置的，因此如果 nginx 同时打开到 SCGI 服务器的两个连接，总速率将是指定限制的两倍。此限制仅在启用从 SCGI 服务器接收响应的缓冲时有效。参数值可以包含变量（1.27.0）。

scgi_max_temp_file_size 1024m;

当启用从 SCGI 服务器接收响应的缓冲时，如果整个响应不适合由 scgi_buffer_size 和 scgi_buffers 指令设置的缓冲区，则可以将部分响应保存到临时文件中。此指令设置临时文件的最大 size。每次写入临时文件的数据大小由 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 keepalive” 行为。默认情况下，操作系统的设置对此套接字生效。如果指令设置为 “on”，则会为该套接字启用 SO_KEEPALIVE 套接字选项。

scgi_store off;

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

scgi_store /data/www$original_uri;

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

当从 SCGI 服务器到临时文件的响应缓冲被启用时，限制一次写入临时文件的数据的 size。默认情况下，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。