模块 ngx_http_scgi_module

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

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

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

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

scgi_bind $remote_addr transparent;

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

scgi_buffer_size 4k|8k;

设置size用于读取从 SCGI 服务器接收到的响应的第一部分的缓冲区。这部分通常包含一个小的响应头。默认情况下，缓冲区大小等于一页内存。这是 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”或“ ” 来启用或禁用缓冲。可以使用scgi_ignore_headersno指令禁用此功能 。

scgi_buffers 8 4k|8k;

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

scgi_busy_buffers_size 8k|16k;

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

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 服务器的用于填充新缓存元素的最后一个请求在指定时间内尚未完成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版本开始，临时文件和缓存可以放在不同的文件系统上。但是，请注意，在这种情况下，文件是跨两个文件系统复制的，而不是廉价的重命名操作。因此，建议对于任何给定位置，缓存和保存临时文件的目录都放在同一文件系统上。根据use_temp_path参数（1.7.10）设置临时文件的目录。如果省略此参数或将其设置为 value ，则将使用由scgi_temp_pathon指令为给定位置设置的目录。如果该值设置为，临时文件将直接放入缓存目录中。 off

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

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

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

特殊的“缓存管理器”进程监视由参数设置的最大缓存大小，以及由（1.19.1）参数设置的带缓存的文件系统上的max_size最小可用空间量。min_free当超出大小或没有足够的可用空间时，它会删除最近最少使用的数据。数据在由 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;

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

scgi_limit_rate 0;

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

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

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

off

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

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

该指令还定义了什么被视为 与服务器通信的不成功尝试。error、timeout和 的情况invalid_header始终被视为不成功的尝试，即使它们未在指令中指定。仅当指令中指定时http_500， 、http_503、 和 的情况才被视为不成功的尝试。和http_429的案例 永远不会被视为不成功的尝试。 http_403http_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指令 一起使用。

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

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

location / {
    include scgi_params;
    ...
}

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

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参数禁用文件保存。此外，可以使用 stringwith 变量显式设置文件名：

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可以省略权限： alluser

scgi_store_access group:rw all:r;

scgi_temp_file_write_size 8k|16k;

size当启用从 SCGI 服务器到临时文件的响应缓冲时， 限制一次写入临时文件的数据量。默认情况下，受scgi_buffer_size和scgi_bufferssize指令设置的两个缓冲区的限制 。临时文件的最大大小由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_pathuse_temp_path指令的参数 。