Module ngx_http_uwsgi_module

示例配置
指令
     uwsgi_bind
     uwsgi_buffer_size
     uwsgi_buffering
     uwsgi_buffers
     uwsgi_busy_buffers_size
     uwsgi_cache
     uwsgi_cache_background_update
     uwsgi_cache_bypass
     uwsgi_cache_key
     uwsgi_cache_lock
     uwsgi_cache_lock_age
     uwsgi_cache_lock_timeout
     uwsgi_cache_max_range_offset
     uwsgi_cache_methods
     uwsgi_cache_min_uses
     uwsgi_cache_path
     uwsgi_cache_purge
     uwsgi_cache_revalidate
     uwsgi_cache_use_stale
     uwsgi_cache_valid
     uwsgi_connect_timeout
     uwsgi_force_ranges
     uwsgi_hide_header
     uwsgi_ignore_client_abort
     uwsgi_ignore_headers
     uwsgi_intercept_errors
     uwsgi_limit_rate
     uwsgi_max_temp_file_size
     uwsgi_modifier1
     uwsgi_modifier2
     uwsgi_next_upstream
     uwsgi_next_upstream_timeout
     uwsgi_next_upstream_tries
     uwsgi_no_cache
     uwsgi_param
     uwsgi_pass
     uwsgi_pass_header
     uwsgi_pass_request_body
     uwsgi_pass_request_headers
     uwsgi_read_timeout
     uwsgi_request_buffering
     uwsgi_send_timeout
     uwsgi_socket_keepalive
     uwsgi_ssl_certificate
     uwsgi_ssl_certificate_cache
     uwsgi_ssl_certificate_key
     uwsgi_ssl_ciphers
     uwsgi_ssl_conf_command
     uwsgi_ssl_crl
     uwsgi_ssl_key_log
     uwsgi_ssl_name
     uwsgi_ssl_password_file
     uwsgi_ssl_protocols
     uwsgi_ssl_server_name
     uwsgi_ssl_session_reuse
     uwsgi_ssl_trusted_certificate
     uwsgi_ssl_verify
     uwsgi_ssl_verify_depth
     uwsgi_store
     uwsgi_store_access
     uwsgi_temp_file_write_size
     uwsgi_temp_path

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

示例配置

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

指令

语法 uwsgi_bind address [transparent] | off;
默认值
上下文 http, server, location

使到 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;

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

语法 uwsgi_buffer_size size;
默认值
uwsgi_buffer_size 4k|8k;
上下文 http, server, location

设置用于读取从 uwsgi 服务器接收的响应的第一部分的缓冲区的 大小。这部分通常包含一个小的响应头部。默认情况下,缓冲区大小等于一个内存页。取决于平台,这可以是 4K 或 8K。但也可以设置得更小。

语法 uwsgi_buffering on | off;
默认值
uwsgi_buffering on;
上下文 http, server, location

启用或禁用从 uwsgi 服务器接收的响应的缓冲。

启用缓冲后,nginx 尽快从 uwsgi 服务器接收响应,并将其保存在由 uwsgi_buffer_sizeuwsgi_buffers 指令设置的缓冲区中。如果整个响应无法放入内存,其中一部分可以保存到磁盘上的 临时文件 中。写入临时文件由 uwsgi_max_temp_file_sizeuwsgi_temp_file_write_size 指令控制。

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

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

语法 uwsgi_buffers number size;
默认值
uwsgi_buffers 8 4k|8k;
上下文 http, server, location

设置用于读取从 uwsgi 服务器接收的响应的缓冲区的 数量大小,针对单个连接。默认情况下,缓冲区大小等于一个内存页。取决于平台,这可以是 4K 或 8K。

语法 uwsgi_busy_buffers_size size;
默认值
uwsgi_busy_buffers_size 8k|16k;
上下文 http, server, location

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

语法 uwsgi_cache zone | off;
默认值
uwsgi_cache off;
上下文 http, server, location

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

语法 uwsgi_cache_background_update on | off;
默认值
uwsgi_cache_background_update off;
上下文 http, server, location

此指令出现在 1.11.10 版本中。

允许启动后台子请求来更新过期的缓存项,同时将陈旧的缓存响应返回给客户端。请注意,在缓存响应正在更新时,必须 允许 使用陈旧的缓存响应。

语法 uwsgi_cache_bypass string ...;
默认值
上下文 http, server, location

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

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

可与 uwsgi_no_cache 指令一起使用。

语法 uwsgi_cache_key string;
默认值
上下文 http, server, location

定义缓存键,例如

uwsgi_cache_key localhost:9000$request_uri;

语法 uwsgi_cache_lock on | off;
默认值
uwsgi_cache_lock off;
上下文 http, server, location

此指令出现在 1.1.12 版本中。

启用后,根据 uwsgi_cache_key 指令标识的新缓存元素的填充,每次只允许一个请求通过将请求传递给 uwsgi 服务器来执行。对同一缓存元素的其他请求将等待响应出现在缓存中,或等待该元素的缓存锁释放,等待时间最长为由 uwsgi_cache_lock_timeout 指令设置的时间。

语法 uwsgi_cache_lock_age time;
默认值
uwsgi_cache_lock_age 5s;
上下文 http, server, location

此指令出现在 1.7.8 版本中。

如果上次发送到 uwsgi 服务器用于填充新缓存元素的请求在指定的 时间 内未完成,则可以再向 uwsgi 服务器发送一个请求。

语法 uwsgi_cache_lock_timeout time;
默认值
uwsgi_cache_lock_timeout 5s;
上下文 http, server, location

此指令出现在 1.1.12 版本中。

设置 uwsgi_cache_lock 的超时时间。当 时间 到期时,请求将被传递给 uwsgi 服务器,但响应不会被缓存。

在 1.7.8 之前,响应可能会被缓存。

语法 uwsgi_cache_max_range_offset number;
默认值
上下文 http, server, location

此指令出现在 1.11.6 版本中。

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

语法 uwsgi_cache_methods GET | HEAD | POST ...;
默认值
uwsgi_cache_methods GET HEAD;
上下文 http, server, location

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

语法 uwsgi_cache_min_uses number;
默认值
uwsgi_cache_min_uses 1;
上下文 http, server, location

设置响应将被缓存所需的请求 数量

语法 uwsgi_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] [purger=on|off] [purger_files=number] [purger_sleep=time] [purger_threshold=time];
默认值
上下文 http

设置缓存的路径和其他参数。缓存数据存储在文件中。缓存中的文件名是根据 uwsgi_cache_key 应用 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_filesmanager_thresholdmanager_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 版本后,先前缓存的响应将被视为无效。

语法 uwsgi_cache_purge string ...;
默认值
上下文 http, server, location

此指令出现在 1.5.7 版本中。

定义请求将被视为缓存清除请求的条件。如果字符串参数中至少有一个值不为空且不等于 “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 on | off;
默认值
uwsgi_cache_revalidate off;
上下文 http, server, location

此指令出现在 1.5.7 版本中。

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

语法 uwsgi_cache_use_stale error | timeout | invalid_header | updating | http_500 | http_503 | http_403 | http_404 | http_429 | off ...;
默认值
uwsgi_cache_use_stale off;
上下文 http, server, location

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

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

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

也可以直接在响应头中启用使用陈旧的缓存响应,指定响应变得陈旧后的秒数 (1.11.10)。这比使用指令参数具有较低的优先级。

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

语法 uwsgi_cache_valid [code ...] time;
默认值
上下文 http, server, location

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

uwsgi_cache_valid 200 302 10m;
uwsgi_cache_valid 404      1m;

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

如果只指定缓存 时间

uwsgi_cache_valid 5m;

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

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

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

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

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

语法 uwsgi_connect_timeout time;
默认值
uwsgi_connect_timeout 60s;
上下文 http, server, location

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

语法 uwsgi_force_ranges on | off;
默认值
uwsgi_force_ranges off;
上下文 http, server, location

此指令出现在 1.7.7 版本中。

启用对来自 uwsgi 服务器的已缓存和未缓存响应的字节范围支持,无论这些响应中是否存在 “Accept-Ranges” 字段。

语法 uwsgi_hide_header field;
默认值
上下文 http, server, location

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

语法 uwsgi_ignore_client_abort on | off;
默认值
uwsgi_ignore_client_abort off;
上下文 http, server, location

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

语法 uwsgi_ignore_headers field ...;
默认值
上下文 http, server, location

禁用处理来自 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)。

如果不禁用,对这些头部字段的处理具有以下效果:

语法 uwsgi_intercept_errors on | off;
默认值
uwsgi_intercept_errors off;
上下文 http, server, location

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

语法 uwsgi_limit_rate rate;
默认值
uwsgi_limit_rate 0;
上下文 http, server, location

此指令出现在 1.7.7 版本中。

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

语法 uwsgi_max_temp_file_size size;
默认值
uwsgi_max_temp_file_size 1024m;
上下文 http, server, location

启用从 uwsgi 服务器接收的响应的缓冲后,如果整个响应无法放入由 uwsgi_buffer_sizeuwsgi_buffers 指令设置的缓冲区中,响应的一部分可以保存到临时文件。此指令设置临时文件的最大 大小。一次写入临时文件的数据大小由 uwsgi_temp_file_write_size 指令设置。

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

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

语法 uwsgi_modifier1 number;
默认值
uwsgi_modifier1 0;
上下文 http, server, location

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

语法 uwsgi_modifier2 number;
默认值
uwsgi_modifier2 0;
上下文 http, server, location

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

语法 uwsgi_next_upstream error | timeout | invalid_header | http_500 | http_503 | http_403 | http_404 | http_429 | non_idempotent | off ...;
默认值
uwsgi_next_upstream error timeout;
上下文 http, server, location

指定在哪些情况下应将请求传递给下一个服务器:

error
错误:在与服务器建立连接、向其传递请求或读取响应头部时发生错误;
timeout
超时:在与服务器建立连接、向其传递请求或读取响应头部时发生超时;
invalid_header
无效头部:服务器返回空响应或无效响应;
http_500
http_500:服务器返回代码为 500 的响应;
http_503
http_503:服务器返回代码为 503 的响应;
http_403
http_403:服务器返回代码为 403 的响应;
http_404
http_404:服务器返回代码为 404 的响应;
http_429
http_429:服务器返回代码为 429 的响应 (1.11.13);
non_idempotent
非幂等:通常,如果请求已发送到上游服务器 (1.9.13),则带有非幂等方法(POST, LOCK, PATCH)的请求不会传递给下一个服务器;启用此选项明确允许重试此类请求;
off
off:禁用将请求传递给下一个服务器。

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

此指令还定义了哪些情况被视为与服务器通信的不成功尝试。即使未在指令中指定 errortimeoutinvalid_header 的情况,它们始终被视为不成功尝试。仅当在指令中指定了 http_500http_503http_429 的情况时,才将其视为不成功尝试。http_403http_404 的情况永远不会被视为不成功尝试。

将请求传递给下一个服务器可以受到尝试次数时间的限制。

语法 uwsgi_next_upstream_timeout time;
默认值
uwsgi_next_upstream_timeout 0;
上下文 http, server, location

此指令出现在 1.7.5 版本中。

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

语法 uwsgi_next_upstream_tries number;
默认值
uwsgi_next_upstream_tries 0;
上下文 http, server, location

此指令出现在 1.7.5 版本中。

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

语法 uwsgi_no_cache string ...;
默认值
上下文 http, server, location

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

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

可与 uwsgi_cache_bypass 指令一起使用。

语法 uwsgi_param parameter value [if_not_empty];
默认值
上下文 http, server, location

设置应传递给 uwsgi 服务器的 参数 可以包含文本、变量及其组合。这些指令仅在当前级别没有定义 uwsgi_param 指令时,才从上一配置级别继承。

应将标准的 CGI 环境变量 作为 uwsgi 头部提供,请参阅发行版中提供的 uwsgi_params 文件。

location / {
    include uwsgi_params;
    ...
}

如果指令指定了 if_not_empty (1.1.11),则只有在参数值不为空时,才会将其传递给服务器。

uwsgi_param HTTPS $https if_not_empty;

语法 uwsgi_pass [protocol://]address;
默认值
上下文 location, if in location

设置 uwsgi 服务器的协议和地址。作为 协议,可以指定 “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;

如果域名解析到多个地址,所有这些地址将以轮询方式使用。此外,地址可以指定为服务器组

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

安全 uwsgi 协议从 1.5.8 版本开始支持。

语法 uwsgi_pass_header field;
默认值
上下文 http, server, location

允许将 uwsgi 服务器中原先被禁用的头部字段传递给客户端。

语法 uwsgi_pass_request_body on | off;
默认值
uwsgi_pass_request_body on;
上下文 http, server, location

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

语法 uwsgi_pass_request_headers on | off;
默认值
uwsgi_pass_request_headers on;
上下文 http, server, location

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

语法 uwsgi_read_timeout time;
默认值
uwsgi_read_timeout 60s;
上下文 http, server, location

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

语法 uwsgi_request_buffering on | off;
默认值
uwsgi_request_buffering on;
上下文 http, server, location

此指令出现在 1.7.11 版本中。

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

启用缓冲时,整个请求体会在请求发送到 uwsgi 服务器之前从客户端读取

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

当使用 HTTP/1.1 分块传输编码发送原始请求体时,无论指令值如何,请求体都会被缓冲。

语法 uwsgi_send_timeout time;
默认值
uwsgi_send_timeout 60s;
上下文 http, server, location

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

语法 uwsgi_socket_keepalive on | off;
默认值
uwsgi_socket_keepalive off;
上下文 http, server, location

此指令出现在 1.15.6 版本中。

配置与 uwsgi 服务器建立的出站连接的“TCP keepalive”行为。默认情况下,套接字使用操作系统的设置。如果将指令设置为“on”值,则会为套接字启用 SO_KEEPALIVE 套接字选项。

语法 uwsgi_ssl_certificate file;
默认值
上下文 http, server, location

此指令出现在 1.7.8 版本中。

指定一个包含 PEM 格式证书的文件,用于向安全的 uwsgi 服务器进行身份验证。

自 1.21.0 版本起,变量可用于文件名中。

语法 uwsgi_ssl_certificate_cache off;
uwsgi_ssl_certificate_cache max=N [inactive=time] [valid=time];
默认值
uwsgi_ssl_certificate_cache off;
上下文 http, server, location

此指令出现在 1.27.4 版本中。

定义一个缓存,用于存储通过变量指定的SSL 证书密钥

此指令具有以下参数

max
设置缓存中的最大元素数量;当缓存溢出时,会移除最近最少使用 (LRU) 的元素;
inactive
定义一个时间,如果在此时间内未访问元素,则会从缓存中移除该元素;默认值为 10 秒;
valid
定义一个时间,在此时间内缓存中的元素被视为有效且可以重用;默认值为 60 秒。超出此时间的证书将被重新加载或重新验证;
off
禁用缓存。

示例

uwsgi_ssl_certificate       $uwsgi_ssl_server_name.crt;
uwsgi_ssl_certificate_key   $uwsgi_ssl_server_name.key;
uwsgi_ssl_certificate_cache max=1000 inactive=20s valid=1m;

语法 uwsgi_ssl_certificate_key file;
默认值
上下文 http, server, location

此指令出现在 1.7.8 版本中。

指定一个包含 PEM 格式密钥的文件,用于向安全的 uwsgi 服务器进行身份验证。

可以指定值 engine:name:id 来代替文件 (1.7.9),该值从 OpenSSL 引擎 name 中加载具有指定 id 的密钥。

自 1.21.0 版本起,变量可用于文件名中。

语法 uwsgi_ssl_ciphers ciphers;
默认值
uwsgi_ssl_ciphers DEFAULT;
上下文 http, server, location

此指令出现在 1.5.8 版本中。

指定与安全 uwsgi 服务器建立请求时启用的密码套件。密码套件的格式应为 OpenSSL 库所能理解的格式。

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

语法 uwsgi_ssl_conf_command name value;
默认值
上下文 http, server, location

此指令出现在 1.19.4 版本中。

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

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

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

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

语法 uwsgi_ssl_crl file;
默认值
上下文 http, server, location

此指令出现在 1.7.0 版本中。

指定一个包含 PEM 格式的吊销证书列表 (CRL) 的文件,用于验证安全 uwsgi 服务器的证书。

语法 uwsgi_ssl_key_log path;
默认值
上下文 http, server, location

此指令出现在 1.27.2 版本中。

启用记录与安全 uwsgi 服务器连接的 SSL 密钥,并指定密钥日志文件的路径。密钥将以与 Wireshark 兼容的 SSLKEYLOGFILE 格式记录。

此指令是我们的商业订阅的一部分。

语法 uwsgi_ssl_name name;
默认值
uwsgi_ssl_name host from uwsgi_pass;
上下文 http, server, location

此指令出现在 1.7.0 版本中。

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

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

语法 uwsgi_ssl_password_file file;
默认值
上下文 http, server, location

此指令出现在 1.7.8 版本中。

指定一个包含密钥密码短语的文件,其中每个密码短语单独占一行。加载密钥时,密码短语会按顺序尝试。

语法 uwsgi_ssl_protocols [SSLv2] [SSLv3] [TLSv1] [TLSv1.1] [TLSv1.2] [TLSv1.3];
默认值
uwsgi_ssl_protocols TLSv1.2 TLSv1.3;
上下文 http, server, location

此指令出现在 1.5.8 版本中。

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

自 1.23.4 版本起,默认使用 TLSv1.3 参数。

语法 uwsgi_ssl_server_name on | off;
默认值
uwsgi_ssl_server_name off;
上下文 http, server, location

此指令出现在 1.7.0 版本中。

建立与安全 uwsgi 服务器的连接时,启用或禁用通过 TLS 服务器名称指示扩展 (SNI, RFC 6066) 传递服务器名称。

语法 uwsgi_ssl_session_reuse on | off;
默认值
uwsgi_ssl_session_reuse on;
上下文 http, server, location

此指令出现在 1.5.8 版本中。

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

语法 uwsgi_ssl_trusted_certificate file;
默认值
上下文 http, server, location

此指令出现在 1.7.0 版本中。

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

语法 uwsgi_ssl_verify on | off;
默认值
uwsgi_ssl_verify off;
上下文 http, server, location

此指令出现在 1.7.0 版本中。

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

语法 uwsgi_ssl_verify_depth number;
默认值
uwsgi_ssl_verify_depth 1;
上下文 http, server, location

此指令出现在 1.7.0 版本中。

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

语法 uwsgi_store on | off | string;
默认值
uwsgi_store off;
上下文 http, server, location

启用将文件保存到磁盘。on 参数会将文件保存到与 aliasroot 指令对应的路径。off 参数会禁用文件保存。此外,可以使用包含变量的string 显式设置文件名

uwsgi_store /data/www$original_uri;

文件修改时间根据接收到的“Last-Modified”响应头字段设置。响应首先写入临时文件,然后重命名该文件。从 0.8.9 版本开始,临时文件和持久存储可以放在不同的文件系统上。但请注意,在这种情况下,文件会在两个文件系统之间复制,而不是廉价的重命名操作。因此,建议在任何给定 location 中,保存的文件和由 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 users:permissions ...;
默认值
uwsgi_store_access user:rw;
上下文 http, server, location

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

uwsgi_store_access user:rw group:rw all:r;

如果指定了任何 groupall 访问权限,则可以省略 user 权限

uwsgi_store_access group:rw all:r;

语法 uwsgi_temp_file_write_size size;
默认值
uwsgi_temp_file_write_size 8k|16k;
上下文 http, server, location

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

语法 uwsgi_temp_path path [level1 [level2 [level3]]];
默认值
uwsgi_temp_path uwsgi_temp;
上下文 http, server, location

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

uwsgi_temp_path /spool/nginx/uwsgi_temp 1 2;

临时文件可能如下所示

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

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