模块 ngx_http_proxy_module
ngx_http_proxy_module
模块允许将请求传递到另一台服务器。
示例配置
location / { proxy_pass http://localhost:8000; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; }
指令
语法 |
proxy_bind |
---|---|
默认值 | — |
上下文 |
http , server , location |
此指令出现在 0.8.22 版本中。
使到代理服务器的传出连接源自指定的本地 IP 地址(可选端口 (1.11.2))。参数值可以包含变量 (1.3.12)。特殊值 off
(1.3.12) 会取消从前一个配置级别继承的 proxy_bind
指令的效果,这允许系统自动分配本地 IP 地址和端口。
transparent
参数 (1.11.0) 允许到代理服务器的传出连接源自非本地 IP 地址,例如,源自客户端的真实 IP 地址
proxy_bind $remote_addr transparent;
为了让此参数生效,通常需要使用超级用户权限运行 nginx 工作进程。在 Linux 上,如果指定了 transparent
参数,则不需要这样做 (1.13.8),因为工作进程会从主进程继承 CAP_NET_RAW
功能。还需要配置内核路由表以拦截代理服务器的网络流量。
语法 |
proxy_buffer_size |
---|---|
默认值 |
proxy_buffer_size 4k|8k; |
上下文 |
http , server , location |
设置用于读取从代理服务器接收到的响应的第一部分的缓冲区的size
。此部分通常包含一个小的响应头。默认情况下,缓冲区大小等于一个内存页。根据平台的不同,它可能是 4K 或 8K。但是,可以将其缩小。
语法 |
proxy_buffering |
---|---|
默认值 |
proxy_buffering on; |
上下文 |
http , server , location |
启用或禁用代理服务器响应的缓冲。
启用缓冲后,nginx 会尽快从代理服务器接收响应,并将其保存到由 proxy_buffer_size 和 proxy_buffers 指令设置的缓冲区中。如果整个响应不适合内存,则可以将其一部分保存到磁盘上的临时文件中。写入临时文件受 proxy_max_temp_file_size 和 proxy_temp_file_write_size 指令控制。
禁用缓冲后,响应会立即同步传递给客户端,就像收到响应一样。nginx 不会尝试从代理服务器读取整个响应。nginx 一次可以从服务器接收的最大数据大小由 proxy_buffer_size 指令设置。
还可以通过在“X-Accel-Buffering”响应头字段中传递“yes
”或“no
”来启用或禁用缓冲。可以使用 proxy_ignore_headers 指令禁用此功能。
语法 |
proxy_buffers |
---|---|
默认值 |
proxy_buffers 8 4k|8k; |
上下文 |
http , server , location |
设置用于读取来自代理服务器的响应的缓冲区的number
和size
,针对单个连接。默认情况下,缓冲区大小等于一个内存页。根据平台的不同,它可能是 4K 或 8K。
语法 |
proxy_busy_buffers_size |
---|---|
默认值 |
proxy_busy_buffers_size 8k|16k; |
上下文 |
http , server , location |
当启用对来自代理服务器的响应的缓冲时,限制可以忙于向客户端发送响应的缓冲区的总大小
,而响应尚未完全读取。同时,其余缓冲区可用于读取响应,并且在需要时将响应的一部分缓冲到临时文件中。默认情况下,大小
受proxy_buffer_size和proxy_buffers指令设置的两个缓冲区大小的限制。
语法 |
proxy_cache |
---|---|
默认值 |
proxy_cache off; |
上下文 |
http , server , location |
定义用于缓存的共享内存区域。同一个区域可以在多个地方使用。参数值可以包含变量 (1.7.9)。关闭
参数禁用从上一个配置级别继承的缓存。
语法 |
proxy_cache_background_update |
---|---|
默认值 |
proxy_cache_background_update off; |
上下文 |
http , server , location |
此指令出现在 1.11.10 版本中。
允许启动后台子请求以更新过期的缓存项,同时向客户端返回陈旧的缓存响应。请注意,有必要在更新时允许使用陈旧的缓存响应。
语法 |
proxy_cache_bypass |
---|---|
默认值 | — |
上下文 |
http , server , location |
定义不从缓存中获取响应的条件。如果字符串参数的至少一个值不为空且不等于“0”,则不会从缓存中获取响应
proxy_cache_bypass $cookie_nocache $arg_nocache$arg_comment; proxy_cache_bypass $http_pragma $http_authorization;
可以与proxy_no_cache指令一起使用。
语法 |
proxy_cache_convert_head |
---|---|
默认值 |
proxy_cache_convert_head on; |
上下文 |
http , server , location |
此指令出现在 1.9.7 版本中。
启用或禁用将“HEAD
”方法转换为“GET
”以进行缓存。禁用转换时,应将缓存密钥配置为包含$request_method
。
语法 |
proxy_cache_key |
---|---|
默认值 |
proxy_cache_key $scheme$proxy_host$request_uri; |
上下文 |
http , server , location |
定义缓存的密钥,例如
proxy_cache_key "$host$request_uri $cookie_user";
默认情况下,指令的值接近字符串
proxy_cache_key $scheme$proxy_host$uri$is_args$args;
语法 |
proxy_cache_lock |
---|---|
默认值 |
proxy_cache_lock off; |
上下文 |
http , server , location |
此指令出现在 1.1.12 版本中。
启用后,一次只允许一个请求通过向代理服务器传递请求来填充根据proxy_cache_key指令标识的新缓存元素。相同缓存元素的其他请求将等待响应出现在缓存中或此元素的缓存锁被释放,直到proxy_cache_lock_timeout指令设置的时间为止。
语法 |
proxy_cache_lock_age |
---|---|
默认值 |
proxy_cache_lock_age 5s; |
上下文 |
http , server , location |
此指令出现在 1.7.8 版本中。
如果传递给代理服务器的最后一个请求尚未完成,以填充新的缓存元素,则可以将另一个请求传递给代理服务器,具体时间为指定的 时间
。
语法 |
proxy_cache_lock_timeout |
---|---|
默认值 |
proxy_cache_lock_timeout 5s; |
上下文 |
http , server , location |
此指令出现在 1.1.12 版本中。
为 proxy_cache_lock 设置超时。当 时间
到期时,请求将传递给代理服务器,但不会缓存响应。
在 1.7.8 之前,可以缓存响应。
语法 |
proxy_cache_max_range_offset |
---|---|
默认值 | — |
上下文 |
http , server , location |
此指令出现在 1.11.6 版本中。
为字节范围请求设置字节偏移量。如果范围超出偏移量,则范围请求将传递给代理服务器,并且不会缓存响应。
语法 |
proxy_cache_methods |
---|---|
默认值 |
proxy_cache_methods GET HEAD; |
上下文 |
http , server , location |
此指令出现在 0.7.59 版本中。
如果此指令中列出了客户端请求方法,则将缓存响应。“GET
”和“HEAD
”方法始终添加到列表中,尽管建议明确指定它们。另请参阅 proxy_no_cache 指令。
语法 |
proxy_cache_min_uses |
---|---|
默认值 |
proxy_cache_min_uses 1; |
上下文 |
http , server , location |
设置在缓存响应之前请求的 数字
。
语法 |
proxy_cache_path |
---|---|
默认值 | — |
上下文 |
http |
设置缓存的路径和其他参数。缓存数据存储在文件中。缓存中的文件名是将 MD5 函数应用于 缓存密钥 的结果。levels
参数定义缓存的层次级别:从 1 到 3,每个级别接受值 1 或 2。例如,在以下配置中
proxy_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
值,则将使用针对给定位置的 proxy_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
=数字
-
设置一次迭代中扫描的项目数(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 版本后,以前缓存的响应将被视为无效。
语法 |
proxy_cache_purge 字符串 ...; |
---|---|
默认值 | — |
上下文 |
http , server , location |
此指令出现在版本 1.5.7 中。
定义在什么条件下将请求视为缓存清除请求。如果字符串参数至少有一个值不为空且不等于“0”,则删除具有相应 缓存键 的缓存条目。通过返回 204(无内容)响应指示操作成功的结果。
如果清除请求的 缓存键 以星号(“*
”)结尾,则所有与通配符键匹配的缓存条目都将从缓存中删除。但是,这些条目将保留在磁盘上,直到因 不活动 而删除,或由 缓存清除器(1.7.12)处理,或客户端尝试访问它们。
示例配置
proxy_cache_path /data/nginx/cache keys_zone=cache_zone:10m; map $request_method $purge_method { PURGE 1; default 0; } server { ... location / { proxy_pass http://backend; proxy_cache cache_zone; proxy_cache_key $uri; proxy_cache_purge $purge_method; } }
此功能作为我们 商业订阅 的一部分提供。
语法 |
proxy_cache_revalidate |
---|---|
默认值 |
proxy_cache_revalidate off; |
上下文 |
http , server , location |
此指令出现在版本 1.5.7 中。
使用带有“If-Modified-Since”和“If-None-Match”头字段的条件请求启用过期缓存项的重新验证。
语法 |
proxy_cache_use_stale |
---|---|
默认值 |
proxy_cache_use_stale off; |
上下文 |
http , server , location |
确定在与代理服务器通信期间可以使用陈旧缓存响应的情况。该指令的参数与 proxy_next_upstream 指令的参数匹配。
error
参数还允许在无法选择代理服务器来处理请求的情况下使用陈旧缓存响应。
此外,updating
参数允许使用陈旧的缓存响应(如果它当前正在更新)。这允许在更新缓存数据时最大程度地减少对代理服务器的访问次数。
在响应变为陈旧后,也可以在响应头中直接启用使用陈旧的缓存响应(1.11.10)。这比使用指令参数的优先级低。
- “stale-while-revalidate”扩展了“Cache-Control”头字段,允许使用陈旧的缓存响应(如果它当前正在更新)。
- “stale-if-error”扩展了“Cache-Control”头字段,允许在出现错误的情况下使用陈旧的缓存响应。
为了在填充新缓存元素时最大程度地减少对代理服务器的访问次数,可以使用 proxy_cache_lock 指令。
语法 |
proxy_cache_valid [ |
---|---|
默认值 | — |
上下文 |
http , server , location |
设置不同响应代码的缓存时间。例如,以下指令
proxy_cache_valid 200 302 10m; proxy_cache_valid 404 1m;
为代码为 200 和 302 的响应设置 10 分钟的缓存,为代码为 404 的响应设置 1 分钟的缓存。
如果只指定缓存time
proxy_cache_valid 5m;
则只缓存 200、301 和 302 响应。
此外,可以指定 any
参数来缓存任何响应
proxy_cache_valid 200 302 10m; proxy_cache_valid 301 1h; proxy_cache_valid any 1m;
也可以直接在响应头中设置缓存参数。这比使用指令设置缓存时间具有更高的优先级。
-
“X-Accel-Expires”头字段以秒为单位设置响应的缓存时间。零值禁用对响应的缓存。如果该值以
@
前缀开头,则它设置自纪元以来的绝对时间(以秒为单位),响应可以缓存到该时间。 - 如果头不包含“X-Accel-Expires”字段,则可以在头字段“Expires”或“Cache-Control”中设置缓存参数。
- 如果头包含“Set-Cookie”字段,则不会缓存此类响应。
-
如果头部包含特殊值“
*
”的“Vary”字段,则此类响应将不会被缓存(1.7.7)。如果头部包含具有其他值的“Vary”字段,则此类响应将被缓存,同时考虑相应的请求头部字段(1.7.7)。
可以使用 proxy_ignore_headers 指令禁用一个或多个这些响应头部字段的处理。
语法 |
proxy_connect_timeout |
---|---|
默认值 |
proxy_connect_timeout 60s; |
上下文 |
http , server , location |
定义与代理服务器建立连接的超时时间。应当注意,此超时时间通常不能超过 75 秒。
语法 |
proxy_cookie_domain proxy_cookie_domain |
---|---|
默认值 |
proxy_cookie_domain off; |
上下文 |
http , server , location |
此指令出现在 1.1.15 版中。
设置应在代理服务器响应的“Set-Cookie”头部字段的 domain
属性中更改的文本。假设代理服务器返回带有属性“domain=localhost
”的“Set-Cookie”头部字段。指令
proxy_cookie_domain localhost example.org;
将此属性重写为“domain=example.org
”。
domain
和 replacement
字符串以及 domain
属性开头的点将被忽略。匹配不区分大小写。
domain
和 replacement
字符串可以包含变量
proxy_cookie_domain www.$host $host;
还可以使用正则表达式指定指令。在这种情况下,domain
应从“~
”符号开始。正则表达式可以包含命名和位置捕获,并且 replacement
可以引用它们
proxy_cookie_domain ~\.(?P<sl_domain>[-0-9a-z]+\.[a-z]+)$ $sl_domain;
可以在同一级别指定多个 proxy_cookie_domain
指令
proxy_cookie_domain localhost example.org; proxy_cookie_domain ~\.([a-z]+\.[a-z]+)$ $1;
如果可以将多个指令应用于 cookie,则将选择第一个匹配的指令。
off
参数将取消从先前配置级别继承的 proxy_cookie_domain
指令的影响。
语法 |
proxy_cookie_flags |
---|---|
默认值 |
proxy_cookie_flags off; |
上下文 |
http , server , location |
此指令出现在 1.19.3 版中。
为 cookie 设置一个或多个标志。cookie
可以包含文本、变量及其组合。flag
可以包含文本、变量及其组合(1.19.8)。secure
、httponly
、samesite=strict
、samesite=lax
、samesite=none
参数添加相应的标志。nosecure
、nohttponly
、nosamesite
参数删除相应的标志。
还可以使用正则表达式指定 cookie。在这种情况下,cookie
应从“~
”符号开始。
可以在同一配置级别指定多个 proxy_cookie_flags
指令
proxy_cookie_flags one httponly; proxy_cookie_flags ~ nosecure samesite=strict;
如果可以将多个指令应用于 cookie,则将选择第一个匹配的指令。在示例中,httponly
标志被添加到 cookie one
,对于所有其他 cookie,samesite=strict
标志被添加,而 secure
标志被删除。
off
参数取消从上一级配置继承的 proxy_cookie_flags
指令的效果。
语法 |
proxy_cookie_path proxy_cookie_path |
---|---|
默认值 |
proxy_cookie_path off; |
上下文 |
http , server , location |
此指令出现在 1.1.15 版中。
设置一个文本,该文本应在代理服务器响应的“Set-Cookie”头字段的path
属性中进行更改。假设代理服务器返回了带有属性“path=/two/some/uri/
”的“Set-Cookie”头字段。该指令
proxy_cookie_path /two/ /;
将把该属性重写为“path=/some/uri/
”。
path
和 replacement
字符串可以包含变量
proxy_cookie_path $uri /some$uri;
该指令还可以使用正则表达式指定。在这种情况下,path
应从“~
”符号(用于区分大小写的匹配)或从“~*
”符号(用于不区分大小写的匹配)开始。正则表达式可以包含命名和位置捕获,并且 replacement
可以引用它们
proxy_cookie_path ~*^/user/([^/]+) /u/$1;
可以在同一级别指定多个 proxy_cookie_path
指令
proxy_cookie_path /one/ /; proxy_cookie_path / /two/;
如果可以将多个指令应用于 cookie,则将选择第一个匹配的指令。
off
参数取消从上一级配置继承的 proxy_cookie_path
指令的效果。
语法 |
proxy_force_ranges |
---|---|
默认值 |
proxy_force_ranges off; |
上下文 |
http , server , location |
此指令出现在 1.7.7 版中。
无论代理服务器响应中的“Accept-Ranges”字段如何,都为代理服务器的缓存和非缓存响应启用字节范围支持。
语法 |
proxy_headers_hash_bucket_size |
---|---|
默认值 |
proxy_headers_hash_bucket_size 64; |
上下文 |
http , server , location |
设置 proxy_hide_header 和 proxy_set_header 指令使用的哈希表的桶size
。有关设置哈希表的详细信息,请参阅单独的 文档。
语法 |
proxy_headers_hash_max_size |
---|---|
默认值 |
proxy_headers_hash_max_size 512; |
上下文 |
http , server , location |
设置 proxy_hide_header 和 proxy_set_header 指令使用的哈希表的最大size
。有关设置哈希表的详细信息,请参阅单独的 文档。
语法 |
proxy_hide_header |
---|---|
默认值 | — |
上下文 |
http , server , location |
默认情况下,nginx 不会将代理服务器响应中的“Date”、“Server”、“X-Pad”和“X-Accel-...”头字段传递给客户端。proxy_hide_header
指令设置了不会传递的其他字段。如果相反,需要允许传递字段,则可以使用 proxy_pass_header 指令。
语法 |
proxy_http_version |
---|---|
默认值 |
proxy_http_version 1.0; |
上下文 |
http , server , location |
此指令出现在 1.1.4 版中。
设置代理的 HTTP 协议版本。默认情况下,使用版本 1.0。建议将版本 1.1 与 keepalive 连接和 NTLM 身份验证 配合使用。
语法 |
proxy_ignore_client_abort |
---|---|
默认值 |
proxy_ignore_client_abort off; |
上下文 |
http , server , location |
确定当客户端在不等待响应的情况下关闭连接时,是否应关闭与代理服务器的连接。
语法 |
proxy_ignore_headers |
---|---|
默认值 | — |
上下文 |
http , server , location |
禁用对来自代理服务器的某些响应头字段的处理。可以忽略以下字段:“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”设置响应所需的 字符集。
语法 |
proxy_intercept_errors |
---|---|
默认值 |
proxy_intercept_errors off; |
上下文 |
http , server , location |
确定是否应将代码大于或等于 300 的代理响应传递给客户端,还是应拦截并重定向到 nginx 以使用 error_page 指令进行处理。
语法 |
proxy_limit_rate |
---|---|
默认值 |
proxy_limit_rate 0; |
上下文 |
http , server , location |
此指令出现在 1.7.7 版中。
限制从代理服务器读取响应的速度。rate
以每秒字节数指定。零值禁用速率限制。限制按请求设置,因此如果 nginx 同时向代理服务器打开两个连接,则总体速率将是指定限制的两倍。仅当启用来自代理服务器的响应的 缓冲 时,此限制才有效。
语法 |
proxy_max_temp_file_size |
---|---|
默认值 |
proxy_max_temp_file_size 1024m; |
上下文 |
http , server , location |
当启用来自代理服务器的响应的缓冲,并且整个响应不适合由proxy_buffer_size和proxy_buffers指令设置的缓冲区,则可以将响应的一部分保存到临时文件中。此指令设置临时文件的最大大小
。一次写入临时文件的数据大小由proxy_temp_file_write_size指令设置。
零值禁用对临时文件的响应缓冲。
此限制不适用于将缓存或存储在磁盘上的响应。
语法 |
proxy_method |
---|---|
默认值 | — |
上下文 |
http , server , location |
指定在转发到代理服务器的请求中使用的 HTTP 方法
,而不是来自客户端请求的方法。参数值可以包含变量 (1.11.6)。
语法 |
proxy_next_upstream |
---|---|
默认值 |
proxy_next_upstream error timeout; |
上下文 |
http , server , location |
指定在哪些情况下应将请求传递到下一台服务器
error
- 在建立与服务器的连接、向其传递请求或读取响应标头时发生错误;
timeout
- 在建立与服务器的连接、向其传递请求或读取响应标头时发生超时;
invalid_header
- 服务器返回空或无效的响应;
http_500
- 服务器返回代码为 500 的响应;
http_502
- 服务器返回代码为 502 的响应;
http_503
- 服务器返回代码为 503 的响应;
http_504
- 服务器返回代码为 504 的响应;
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_502
、http_503
、http_504
和http_429
的情况才被视为失败尝试。http_403
和http_404
的情况永远不会被视为失败尝试。
语法 |
proxy_next_upstream_timeout |
---|---|
默认值 |
proxy_next_upstream_timeout 0; |
上下文 |
http , server , location |
此指令出现在 1.7.5 版中。
限制请求可以传递到下一台服务器的时间。0
值将关闭此限制。
语法 |
proxy_next_upstream_tries |
---|---|
默认值 |
proxy_next_upstream_tries 0; |
上下文 |
http , server , location |
此指令出现在 1.7.5 版中。
限制将请求传递到下一台服务器的可能尝试次数。0
值将关闭此限制。
语法 |
proxy_no_cache |
---|---|
默认值 | — |
上下文 |
http , server , location |
定义在哪些条件下不会将响应保存到缓存中。如果字符串参数的至少一个值不为空且不等于“0”,则不会保存响应
proxy_no_cache $cookie_nocache $arg_nocache$arg_comment; proxy_no_cache $http_pragma $http_authorization;
可与proxy_cache_bypass指令一起使用。
语法 |
proxy_pass |
---|---|
默认值 | — |
上下文 |
location 、if in location 、limit_except |
设置代理服务器的协议和地址,以及可选的 URI,其中应映射位置。作为协议,可以指定“http
”或“https
”。地址可以指定为域名或 IP 地址,以及可选的端口
proxy_pass http://localhost:8000/uri/;
或作为在单词“unix
”后指定并用冒号括起来的 UNIX 域套接字路径
proxy_pass http://unix:/tmp/backend.socket:/uri/;
如果域名解析为多个地址,则所有地址都将以循环方式使用。此外,地址可以指定为服务器组。
参数值可以包含变量。在这种情况下,如果地址指定为域名,则在所述服务器组中搜索该名称,如果未找到,则使用解析器确定该名称。
请求 URI 如下传递到服务器
-
如果
proxy_pass
指令指定了 URI,那么当请求传递到服务器时,与位置匹配的 已规范化 请求 URI 的部分将替换为指令中指定的 URIlocation /name/ { proxy_pass http://127.0.0.1/remote/; }
-
如果
proxy_pass
未指定 URI,则在处理原始请求时,请求 URI 将以客户端发送的相同形式传递到服务器,或者在处理更改后的 URI 时传递完整的已规范化请求 URIlocation /some/path/ { proxy_pass http://127.0.0.1; }
在 1.1.12 版本之前,如果
proxy_pass
未指定 URI,则在某些情况下可能会传递原始请求 URI 而不是更改后的 URI。
在某些情况下,无法确定要替换的请求 URI 的部分
-
当使用正则表达式指定位置时,也位于命名的位置内。
在这些情况下,应该不带 URI 指定
proxy_pass
。 -
当使用 rewrite 指令在代理位置内更改 URI,并且将使用此相同配置来处理请求(
break
)时location /name/ { rewrite /name/([^/]+) /users?name=$1 break; proxy_pass http://127.0.0.1; }
在这种情况下,指令中指定的 URI 将被忽略,并且完整的已更改请求 URI 将传递到服务器。
-
当在
proxy_pass
中使用变量时
在这种情况下,如果在指令中指定了 URI,则它将按原样传递到服务器,替换原始请求 URI。location /name/ { proxy_pass http://127.0.0.1$request_uri; }
WebSocket 代理需要特殊配置,并且自 1.3.13 版本起得到支持。
语法 |
proxy_pass_header |
---|---|
默认值 | — |
上下文 |
http , server , location |
允许将 否则禁用 的标头字段从代理服务器传递到客户端。
语法 |
proxy_pass_request_body |
---|---|
默认值 |
proxy_pass_request_body on; |
上下文 |
http , server , location |
指示是否将原始请求正文传递到代理服务器。
location /x-accel-redirect-here/ { proxy_method GET; proxy_pass_request_body off; proxy_set_header Content-Length ""; proxy_pass ... }
另请参阅 proxy_set_header 和 proxy_pass_request_headers 指令。
语法 |
proxy_pass_request_headers |
---|---|
默认值 |
proxy_pass_request_headers on; |
上下文 |
http , server , location |
指示是否将原始请求的标头字段传递到代理服务器。
location /x-accel-redirect-here/ { proxy_method GET; proxy_pass_request_headers off; proxy_pass_request_body off; proxy_pass ... }
另请参阅 proxy_set_header 和 proxy_pass_request_body 指令。
语法 |
proxy_read_timeout |
---|---|
默认值 |
proxy_read_timeout 60s; |
上下文 |
http , server , location |
定义从代理服务器读取响应的超时时间。超时仅在两次连续的读取操作之间设置,而不是针对整个响应的传输。如果代理服务器在此时间内未传输任何内容,则连接将被关闭。
语法 |
proxy_redirect proxy_redirect proxy_redirect |
---|---|
默认值 |
proxy_redirect default; |
上下文 |
http , server , location |
设置代理服务器响应的“位置”和“刷新”头字段中应更改的文本。假设代理服务器返回头字段“位置:http://localhost:8000/two/some/uri/
”。该指令
proxy_redirect http://localhost:8000/two/ http://frontend/one/;
将把此字符串重写为“位置:http://frontend/one/some/uri/
”。
替换
字符串中可以省略服务器名称
proxy_redirect http://localhost:8000/two/ /;
然后将插入主服务器的名称和端口(如果不同于 80)。
default
参数指定的默认替换使用 location 和 proxy_pass 指令的参数。因此,以下两个配置是等效的
location /one/ { proxy_pass http://upstream:port/two/; proxy_redirect default;
location /one/ { proxy_pass http://upstream:port/two/; proxy_redirect http://upstream:port/two/ /one/;
如果使用变量指定 proxy_pass,则不允许使用 default
参数。
替换
字符串可以包含变量
proxy_redirect http://localhost:8000/ http://$host:$server_port/;
重定向
也可以包含 (1.1.11) 变量
proxy_redirect http://$proxy_host:8000/ /;
可以使用正则表达式指定指令 (1.1.11)。在这种情况下,重定向
应以“~
”符号开头(用于区分大小写的匹配),或以“~*
”符号开头(用于不区分大小写的匹配)。正则表达式可以包含命名和位置捕获,并且 替换
可以引用它们
proxy_redirect ~^(http://[^:]+):\d+(/.+)$ $1$2; proxy_redirect ~*/user/([^/]+)/(.+)$ http://$1.example.com/$2;
可以在同一级别指定多个 proxy_redirect
指令
proxy_redirect default; proxy_redirect http://localhost:8000/ /; proxy_redirect http://www.example.com/ /;
如果可以将多个指令应用于代理服务器响应的头字段,则将选择第一个匹配的指令。
off
参数取消从先前配置级别继承的 proxy_redirect
指令的影响。
使用此指令,还可以向代理服务器发出的相对重定向添加主机名
proxy_redirect / /;
语法 |
proxy_request_buffering |
---|---|
默认值 |
proxy_request_buffering on; |
上下文 |
http , server , location |
此指令出现在 1.7.11 版本中。
启用或禁用客户端请求正文的缓冲。
启用缓冲后,在向代理服务器发送请求之前,将从客户端 读取 整个请求正文。
禁用缓冲后,请求正文将立即在收到时发送到代理服务器。在这种情况下,如果 nginx 已开始发送请求正文,则无法将请求传递给 下一个服务器。
当使用 HTTP/1.1 分块传输编码发送原始请求正文时,无论指令值如何,请求正文都将被缓冲,除非为代理启用 HTTP/1.1。
语法 |
proxy_send_lowat |
---|---|
默认值 |
proxy_send_lowat 0; |
上下文 |
http , server , location |
如果该指令设置为非零值,nginx 将尝试使用 kqueue 方法的 NOTE_LOWAT
标志或 SO_SNDLOWAT
套接字选项,以指定的 大小
最小化对代理服务器的传出连接的发送操作数量。
此指令在 Linux、Solaris 和 Windows 上被忽略。
语法 |
proxy_send_timeout |
---|---|
默认值 |
proxy_send_timeout 60s; |
上下文 |
http , server , location |
设置向代理服务器传输请求的超时时间。超时时间仅在两次连续的写入操作之间设置,而不是针对整个请求的传输。如果代理服务器在此时间内未收到任何内容,则连接将关闭。
语法 |
proxy_set_body |
---|---|
默认值 | — |
上下文 |
http , server , location |
允许重新定义传递给代理服务器的请求正文。value
可以包含文本、变量及其组合。
语法 |
proxy_set_header |
---|---|
默认值 |
proxy_set_header Host $proxy_host; proxy_set_header Connection close; |
上下文 |
http , server , location |
允许重新定义或追加字段到传递给代理服务器的请求头 passed。value
可以包含文本、变量及其组合。仅当当前级别上没有定义 proxy_set_header
指令时,这些指令才会从上一个配置级别继承。默认情况下,仅重新定义两个字段
proxy_set_header Host $proxy_host; proxy_set_header Connection close;
如果启用了缓存,则不会将原始请求中的头字段“If-Modified-Since”、“If-Unmodified-Since”、“If-None-Match”、“If-Match”、“Range”和“If-Range”传递给代理服务器。
可以像这样传递未更改的“Host”请求头字段
proxy_set_header Host $http_host;
但是,如果此字段不存在于客户端请求头中,则不会传递任何内容。在这种情况下,最好使用 $host
变量 - 其值等于“Host”请求头字段中的服务器名称,或者如果不存在此字段,则等于主服务器名称
proxy_set_header Host $host;
此外,服务器名称可以与代理服务器的端口一起传递
proxy_set_header Host $host:$proxy_port;
如果头字段的值为空字符串,则此字段不会传递给代理服务器
proxy_set_header Accept-Encoding "";
语法 |
proxy_socket_keepalive |
---|---|
默认值 |
proxy_socket_keepalive off; |
上下文 |
http , server , location |
此指令出现在 1.15.6 版本中。
配置与代理服务器的传出连接的“TCP 保持活动”行为。默认情况下,操作系统的设置对套接字有效。如果将此指令设置为值“on
”,则为套接字启用 SO_KEEPALIVE
套接字选项。
语法 |
proxy_ssl_certificate |
---|---|
默认值 | — |
上下文 |
http , server , location |
此指令出现在 1.7.8 版本中。
指定包含 PEM 格式证书的 file
,用于向代理 HTTPS 服务器进行身份验证。
自版本 1.21.0 起,变量可用于 file
名称。
语法 |
proxy_ssl_certificate_key |
---|---|
默认值 | — |
上下文 |
http , server , location |
此指令出现在 1.7.8 版本中。
指定用于向代理 HTTPS 服务器进行身份验证的 PEM 格式的密钥的 file
。
可以指定值 engine
:name
:id
而不是 file
(1.7.9),它从 OpenSSL 引擎 name
加载具有指定 id
的密钥。
自版本 1.21.0 起,变量可用于 file
名称。
语法 |
proxy_ssl_ciphers |
---|---|
默认值 |
proxy_ssl_ciphers DEFAULT; |
上下文 |
http , server , location |
此指令出现在版本 1.5.6 中。
指定对代理 HTTPS 服务器的请求启用的密码。密码以 OpenSSL 库理解的格式指定。
可以使用“openssl ciphers
”命令查看完整列表。
语法 |
proxy_ssl_conf_command |
---|---|
默认值 | — |
上下文 |
http , server , location |
此指令出现在版本 1.19.4 中。
在与代理 HTTPS 服务器建立连接时设置任意的 OpenSSL 配置 命令。
使用 OpenSSL 1.0.2 或更高版本时支持此指令。
可以在同一级别指定多个 proxy_ssl_conf_command
指令。当且仅当当前级别未定义 proxy_ssl_conf_command
指令时,这些指令才会从上一个配置级别继承。
请注意,直接配置 OpenSSL 可能会导致意外行为。
语法 |
proxy_ssl_crl |
---|---|
默认值 | — |
上下文 |
http , server , location |
此指令出现在版本 1.7.0 中。
指定用于 验证 代理 HTTPS 服务器证书的 PEM 格式的已吊销证书 (CRL) 的 file
。
语法 |
proxy_ssl_name |
---|---|
默认值 |
proxy_ssl_name $proxy_host; |
上下文 |
http , server , location |
此指令出现在版本 1.7.0 中。
允许覆盖用于 验证 代理 HTTPS 服务器证书的服务器名称,并在与代理 HTTPS 服务器建立连接时 通过 SNI 传递。
默认情况下,使用 proxy_pass URL 的主机部分。
语法 |
proxy_ssl_password_file |
---|---|
默认值 | — |
上下文 |
http , server , location |
此指令出现在 1.7.8 版本中。
指定用于 密钥 的密码的 file
,其中每个密码都在单独的行上指定。加载密钥时会依次尝试密码。
语法 |
proxy_ssl_protocols [ |
---|---|
默认值 |
proxy_ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; |
上下文 |
http , server , location |
此指令出现在版本 1.5.6 中。
为对代理 HTTPS 服务器的请求启用指定协议。
自 1.23.4 起,默认使用 TLSv1.3
参数。
语法 |
proxy_ssl_server_name |
---|---|
默认值 |
proxy_ssl_server_name off; |
上下文 |
http , server , location |
此指令出现在版本 1.7.0 中。
启用或禁用在与代理 HTTPS 服务器建立连接时通过 TLS 服务器名称指示扩展 (SNI,RFC 6066) 传递服务器名称。
语法 |
proxy_ssl_session_reuse |
---|---|
默认值 |
proxy_ssl_session_reuse on; |
上下文 |
http , server , location |
确定在使用代理服务器时是否可以重用 SSL 会话。如果日志中出现“SSL3_GET_FINISHED:digest check failed
”错误,请尝试禁用会话重用。
语法 |
proxy_ssl_trusted_certificate |
---|---|
默认值 | — |
上下文 |
http , server , location |
此指令出现在版本 1.7.0 中。
指定一个 file
,其中包含 PEM 格式的受信任 CA 证书,用于 验证 代理 HTTPS 服务器的证书。
语法 |
proxy_ssl_verify |
---|---|
默认值 |
proxy_ssl_verify off; |
上下文 |
http , server , location |
此指令出现在版本 1.7.0 中。
启用或禁用对代理 HTTPS 服务器证书的验证。
语法 |
proxy_ssl_verify_depth |
---|---|
默认值 |
proxy_ssl_verify_depth 1; |
上下文 |
http , server , location |
此指令出现在版本 1.7.0 中。
设置代理 HTTPS 服务器证书链中的验证深度。
语法 |
proxy_store |
---|---|
默认值 |
proxy_store off; |
上下文 |
http , server , location |
启用将文件保存到磁盘。on
参数将文件保存到与指令 alias 或 root 对应的路径中。off
参数禁用文件保存。此外,可以使用带有变量的 string
显式设置文件名
proxy_store /data/www$original_uri;
文件的修改时间根据接收到的“Last-Modified”响应头字段设置。响应首先写入临时文件,然后重命名该文件。从 0.8.9 版本开始,临时文件和持久存储可以放在不同的文件系统上。但是,请注意,在这种情况下,文件会跨两个文件系统复制,而不是进行廉价的重命名操作。因此,建议对于任何给定的位置,由 proxy_temp_path 指令设置的已保存文件和保存临时文件的目录都放在同一个文件系统上。
此指令可用于创建静态不可更改文件的本地副本,例如
location /images/ { root /data/www; error_page 404 = /fetch$uri; } location /fetch/ { internal; proxy_pass http://backend/; proxy_store on; proxy_store_access user:rw group:rw all:r; proxy_temp_path /data/temp; alias /data/www/; }
或类似于此
location /images/ { root /data/www; error_page 404 = @fetch; } location @fetch { internal; proxy_pass http://backend; proxy_store on; proxy_store_access user:rw group:rw all:r; proxy_temp_path /data/temp; root /data/www; }
语法 |
proxy_store_access |
---|---|
默认值 |
proxy_store_access user:rw; |
上下文 |
http , server , location |
设置新创建的文件和目录的访问权限,例如
proxy_store_access user:rw group:rw all:r;
如果指定了任何 group
或 all
访问权限,则可以省略 user
权限
proxy_store_access group:rw all:r;
语法 |
proxy_temp_file_write_size |
---|---|
默认值 |
proxy_temp_file_write_size 8k|16k; |
上下文 |
http , server , location |
当启用对代理服务器响应进行临时文件缓冲时,限制一次写入临时文件的size
数据。默认情况下,size
受proxy_buffer_size和proxy_buffers指令设置的两个缓冲区的限制。临时文件的最大大小由proxy_max_temp_file_size指令设置。
语法 |
proxy_temp_path |
---|---|
默认值 |
proxy_temp_path proxy_temp; |
上下文 |
http , server , location |
定义一个目录,用于存储从代理服务器接收的数据的临时文件。在指定目录下最多可以使用三级子目录层次结构。例如,在以下配置中
proxy_temp_path /spool/nginx/proxy_temp 1 2;
临时文件可能如下所示
/spool/nginx/proxy_temp/7/45/00000123457
另请参阅proxy_cache_path指令的use_temp_path
参数。
嵌入式变量
ngx_http_proxy_module
模块支持嵌入式变量,可用于使用proxy_set_header指令组合标头
$proxy_host
- 代理服务器的名称和端口,如proxy_pass指令中指定;
$proxy_port
- 代理服务器的端口,如proxy_pass指令中指定,或协议的默认端口;
-
$proxy_add_x_forwarded_for
- “X-Forwarded-For”客户端请求标头字段,其中附加了
$remote_addr
变量,用逗号分隔。如果客户端请求标头中不存在“X-Forwarded-For”字段,则$proxy_add_x_forwarded_for
变量等于$remote_addr
变量。