模块 ngx_http_uwsgi_module

ngx_http_uwsgi_module 模块允许将请求传递到 uwsgi 服务器。

location / {
    include    uwsgi_params;
    uwsgi_pass localhost:9000;
}

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

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

uwsgi_bind $remote_addr transparent;

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

uwsgi_buffer_size 4k|8k;

设置用于读取从 uwsgi 服务器接收到的响应的第一部分的缓冲区的 size。此部分通常包含一个小的响应头。默认情况下，缓冲区大小等于一个内存页。根据平台的不同，它可能是 4K 或 8K。但是，可以将其缩小。

uwsgi_buffering on;

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

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

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

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

uwsgi_buffers 8 4k|8k;

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

uwsgi_busy_buffers_size 8k|16k;

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

uwsgi_cache off;

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

uwsgi_cache_background_update off;

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

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

uwsgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment;
uwsgi_cache_bypass $http_pragma    $http_authorization;

可与uwsgi_no_cache指令一起使用。

定义缓存键，例如

uwsgi_cache_key localhost:9000$request_uri;

uwsgi_cache_lock off;

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

uwsgi_cache_lock_age 5s;

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

uwsgi_cache_lock_timeout 5s;

为 uwsgi_cache_lock 设置超时。当 time 过期时，请求将传递给 uwsgi 服务器，但是，响应将不会被缓存。

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

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

uwsgi_cache_methods GET HEAD;

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

uwsgi_cache_min_uses 1;

设置在响应将被缓存的请求的 number。

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

uwsgi_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，则将使用给定位置的 uwsgi_temp_path 指令设置的目录。如果将值设置为 off，则临时文件将直接放在缓存目录中。

此外，所有活动键和有关数据的信息都存储在共享内存区域中，其名称和大小由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=数字

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

purger_threshold=数字

设置一次迭代的持续时间（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) 处理，或客户端尝试访问它们。

示例配置

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

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

server {
    ...
    location / {
        uwsgi_pass        backend;
        uwsgi_cache       cache_zone;
        uwsgi_cache_key   $uri;
        uwsgi_cache_purge $purge_method;
    }
}

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

uwsgi_cache_revalidate off;

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

uwsgi_cache_use_stale off;

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

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

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

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

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

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

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

uwsgi_cache_valid 200 302 10m;
uwsgi_cache_valid 404      1m;

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

如果只指定缓存 time

uwsgi_cache_valid 5m;

则只缓存 200、301 和 302 响应。

此外，可以指定 any 参数以缓存任何响应

uwsgi_cache_valid 200 302 10m;
uwsgi_cache_valid 301      1h;
uwsgi_cache_valid any      1m;

也可以直接在响应头中设置缓存参数。这比使用指令设置缓存时间具有更高的优先级。

• “X-Accel-Expires”头字段以秒为单位设置响应的缓存时间。值为零表示禁用对响应的缓存。如果值以 @ 前缀开头，则它设置自 Epoch 以来以秒为单位的绝对时间，响应最多可以缓存到该时间。
• 如果头不包含“X-Accel-Expires”字段，则可以在“Expires”或“Cache-Control”头字段中设置缓存参数。
• 如果头包含“Set-Cookie”字段，则此类响应将不会被缓存。
• 如果头包含带有特殊值“*”的“Vary”字段，则此类响应将不会被缓存 (1.7.7)。如果头包含带有其他值的“Vary”字段，则此类响应将被缓存，同时考虑相应的请求头字段 (1.7.7)。

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

uwsgi_connect_timeout 60s;

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

uwsgi_force_ranges off;

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

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

uwsgi_ignore_client_abort off;

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

禁用对 uwsgi 服务器中特定响应头字段的处理。可以忽略以下字段：“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”设置响应所需的 字符集。

uwsgi_intercept_errors off;

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

uwsgi_limit_rate 0;

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

uwsgi_max_temp_file_size 1024m;

当启用 uwsgi 服务器响应的 缓冲 时，并且整个响应不适合由 uwsgi_buffer_size 和 uwsgi_buffers 指令设置的缓冲区，则可以将响应的一部分保存到临时文件中。此指令设置临时文件的最大 size。一次写入临时文件的数据大小由 uwsgi_temp_file_write_size 指令设置。

零值禁用对临时文件的响应缓冲。

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

uwsgi_modifier1 0;

设置 uwsgi 数据包头 中 modifier1 字段的值。

uwsgi_modifier2 0;

设置 uwsgi 数据包头 中 modifier2 字段的值。

uwsgi_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 的情况永远不被视为失败尝试。

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

uwsgi_next_upstream_timeout 0;

限制将请求传递到下一台服务器的时间。0 值关闭此限制。

uwsgi_next_upstream_tries 0;

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

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

uwsgi_no_cache $cookie_nocache $arg_nocache$arg_comment;
uwsgi_no_cache $http_pragma    $http_authorization;

可与uwsgi_cache_bypass指令一起使用。

设置应传递到 uwsgi 服务器的parameter。value 可以包含文本、变量及其组合。如果当前级别上未定义任何 uwsgi_param 指令，则这些指令仅当且仅当从之前的配置级别继承时才继承。

标准CGI 环境变量应作为 uwsgi 标头提供，请参见发行版中提供的 uwsgi_params 文件

location / {
    include uwsgi_params;
    ...
}

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

uwsgi_param HTTPS $https if_not_empty;

设置 uwsgi 服务器的协议和地址。作为protocol，可以指定“uwsgi”或“suwsgi”（安全 uwsgi，SSL 上的 uwsgi）。地址可以指定为域名或 IP 地址以及端口

uwsgi_pass localhost:9000;
uwsgi_pass uwsgi://localhost:9000;
uwsgi_pass suwsgi://[2001:db8::1]:9090;

或作为 UNIX 域套接字路径

uwsgi_pass unix:/tmp/uwsgi.socket;

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

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

自版本 1.5.8 起支持安全 uwsgi 协议。

允许将 否则禁用 的标头字段从 uwsgi 服务器传递到客户端。

uwsgi_pass_request_body on;

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

uwsgi_pass_request_headers on;

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

uwsgi_read_timeout 60s;

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

uwsgi_request_buffering on;

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

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

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

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

uwsgi_send_timeout 60s;

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

uwsgi_socket_keepalive off;

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

使用 PEM 格式中的证书指定一个 file，用于对安全 uwsgi 服务器进行身份验证。

从 1.21.0 版本开始，可以在 file 名称中使用变量。

使用 PEM 格式中的密钥指定一个 file，用于对安全 uwsgi 服务器进行身份验证。

可以指定值 engine:name:id 而不是 file (1.7.9)，它从 OpenSSL 引擎 name 中加载具有指定 id 的密钥。

从 1.21.0 版本开始，可以在 file 名称中使用变量。

uwsgi_ssl_ciphers DEFAULT;

指定对安全 uwsgi 服务器的请求启用的密码。密码以 OpenSSL 库理解的格式指定。

可以使用“openssl ciphers”命令查看完整列表。

在与安全 uwsgi 服务器建立连接时，设置任意 OpenSSL 配置 命令。

使用 OpenSSL 1.0.2 或更高版本时支持此指令。

可以在同一级别上指定多个 uwsgi_ssl_conf_command 指令。仅当当前级别上未定义 uwsgi_ssl_conf_command 指令时，这些指令才会从以前的配置级别继承。

请注意，直接配置 OpenSSL 可能会导致意外行为。

使用 PEM 格式中的吊销证书 (CRL) 指定一个 file，用于 验证 安全 uwsgi 服务器的证书。

uwsgi_ssl_name host from uwsgi_pass;

允许覆盖用于验证安全 uwsgi 服务器证书的服务器名称，并在与安全 uwsgi 服务器建立连接时通过 SNI 传递。

默认情况下，使用 uwsgi_pass 中的主机部分。

指定一个包含用于密钥的密码的文件，其中每条密码都在单独一行中指定。加载密钥时会依次尝试密码。

uwsgi_ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;

为对安全 uwsgi 服务器的请求启用指定的协议。

自 1.23.4 起，默认使用 TLSv1.3 参数。

uwsgi_ssl_server_name off;

在与安全 uwsgi 服务器建立连接时，启用或禁用通过TLS 服务器名称指示扩展（SNI，RFC 6066）传递服务器名称。

uwsgi_ssl_session_reuse on;

确定在使用安全 uwsgi 服务器时是否可以重用 SSL 会话。如果日志中出现错误“SSL3_GET_FINISHED:digest check failed”，请尝试禁用会话重用。

指定一个包含用于验证安全 uwsgi 服务器证书的 PEM 格式可信 CA 证书的文件。

uwsgi_ssl_verify off;

启用或禁用对安全 uwsgi 服务器证书的验证。

uwsgi_ssl_verify_depth 1;

设置安全 uwsgi 服务器证书链中的验证深度。

uwsgi_store off;

启用将文件保存到磁盘。on 参数使用对应于指令 alias 或 root 的路径保存文件。off 参数禁用文件保存。此外，可以使用包含变量的字符串显式设置文件名

uwsgi_store /data/www$original_uri;

文件的修改时间根据接收到的“Last-Modified”响应头字段设置。响应首先写入临时文件，然后重命名该文件。从 0.8.9 版本开始，临时文件和持久性存储可以放在不同的文件系统上。但是，请注意，在这种情况下，文件是跨两个文件系统复制的，而不是廉价的重命名操作。因此，建议对于任何给定的位置，由 uwsgi_temp_path 指令设置的已保存文件和包含临时文件的目录都放在同一个文件系统上。

此指令可用于创建静态不可更改文件的本地副本，例如

location /images/ {
    root               /data/www;
    error_page         404 = /fetch$uri;
}

location /fetch/ {
    internal;

    uwsgi_pass         backend:9000;
    ...

    uwsgi_store        on;
    uwsgi_store_access user:rw group:rw all:r;
    uwsgi_temp_path    /data/temp;

    alias              /data/www/;
}

uwsgi_store_access user:rw;

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

uwsgi_store_access user:rw group:rw all:r;

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

uwsgi_store_access group:rw all:r;

uwsgi_temp_file_write_size 8k|16k;

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

uwsgi_temp_path uwsgi_temp;

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

uwsgi_temp_path /spool/nginx/uwsgi_temp 1 2;

临时文件可能如下所示

/spool/nginx/uwsgi_temp/7/45/00000123457

另请参见 uwsgi_cache_path 指令的 use_temp_path 参数。