模块 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版本中。
使用可选端口 (1.11.2) 从指定的本地 IP 地址发起到代理服务器的传出连接。参数值可以包含变量 (1.3.12)。特殊值(1.3.12)取消了从先前配置级别继承的指令
off
的效果,这允许系统自动分配本地IP地址和端口。proxy_bind
参数transparent
(1.11.0) 允许来自非本地 IP 地址的到代理服务器的传出连接,例如来自客户端的真实 IP 地址:
proxy_bind $remote_addr transparent;
为了使该参数起作用,通常需要以
超级用户权限运行 nginx 工作进程。在 Linux 上,不需要(1.13.8),因为如果transparent
指定了该参数,工作进程会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
”或“ ”
来启用或禁用缓冲。可以使用proxy_ignore_headersno
指令禁用此功能
。
句法: |
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 |
当启用来自代理服务器的响应缓冲size
时,限制在响应尚未完全读取时可能忙于向客户端发送响应的缓冲区总数。同时,其余缓冲区可用于读取响应,并在需要时将部分响应缓冲到临时文件。默认情况下,受proxy_buffer_size和proxy_bufferssize
指令设置的两个缓冲区大小的限制
。
句法: |
proxy_cache |
---|---|
默认: |
proxy_cache off; |
语境: |
http , server ,location |
定义用于缓存的共享内存区域。同一区域可以在多个地方使用。参数值可以包含变量(1.7.9)。该off
参数禁用从先前配置级别继承的缓存。
句法: |
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 版本中。
如果传递到代理服务器用于填充新缓存元素的最后一个请求在指定时间内尚未完成time
,则可能会再传递一个请求到代理服务器。
句法: |
proxy_cache_lock_timeout |
---|---|
默认: |
proxy_cache_lock_timeout 5s; |
语境: |
http , server ,location |
该指令出现在版本 1.1.12 中。
设置proxy_cache_lock
的超时。当time
过期时,请求将被传递到代理服务器,但是,响应将不会被缓存。
在 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 |
设置number
请求的数量,之后将缓存响应。
句法: |
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)设置。如果省略此参数或将其设置为 value ,则将使用proxy_temp_path指令为给定位置on
设置的目录。如果该值设置为,临时文件将直接放入缓存目录中。
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 版本后,之前缓存的响应将被视为无效。
句法: |
proxy_cache_purge string ...; |
---|---|
默认: | — |
语境: |
http , server ,location |
该指令出现在 1.5.7 版本中。
定义请求被视为缓存清除请求的条件。如果字符串参数的至少一个值不为空且不等于“0”,则 移除具有对应缓存键的缓存条目。通过返回204(No Content)响应来表明操作成功。
如果清除请求的缓存键以星号(“ *
”)结尾,则所有与通配符键匹配的缓存条目都将从缓存中删除。但是,这些条目将保留在磁盘上,直到它们因不活动而被删除,或者被缓存清除器(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)。这比使用指令参数的优先级要低。
- “ Cache-Control”标头字段的“ stale-while-revalidate ”扩展允许使用陈旧的缓存响应(如果当前正在更新)。
- “Cache-Control”头字段的 “ stale-if-error ”扩展允许在发生错误时使用陈旧的缓存响应。
为了在填充新的缓存元素时最大限度地减少对代理服务器的访问次数, 可以使用 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”头字段设置响应的缓存时间(以秒为单位)。零值会禁用响应的缓存。如果该值以
@
前缀开头,则它设置自 Epoch 以来的绝对时间(以秒为单位),在此时间之前可以缓存响应。 - 如果头部不包含“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 版本中。
domain
设置应在代理服务器响应的“Set-Cookie”标头字段的属性
中更改的文本。假设代理服务器返回带有属性“ ”的“Set-Cookie”标头字段domain=localhost
。该指令
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]+)$ body;
如果可以将多个指令应用于 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 版本中。
path
设置应在代理服务器响应的“Set-Cookie”标头字段的属性
中更改的文本。假设代理服务器返回带有属性“ ”的“Set-Cookie”标头字段path=/two/some/uri/
。该指令
proxy_cookie_path /two/ /;
会将此属性重写为“ path=/some/uri/
”。
和字符串可以包含变量
path
:replacement
proxy_cookie_path $uri /some$uri;
该指令也可以使用正则表达式来指定。在这种情况下,path
应该从“ ~
”符号开始进行区分大小写的匹配,或者从“ ~*
”符号开始进行不区分大小写的匹配。正则表达式可以包含命名和位置捕获,并且replacement
可以引用它们:
proxy_cookie_path ~*^/user/([^/]+) /u/body;
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_headersize
指令使用的哈希表的存储
桶
。设置哈希表的详细信息在单独的
文档中提供。
句法: |
proxy_headers_hash_max_size |
---|---|
默认: |
proxy_headers_hash_max_size 512; |
语境: |
http , server ,location |
设置proxy_hide_header和proxy_set_headersize
指令使用的哈希表的
最大值
。设置哈希表的详细信息在单独的
文档中提供。
句法: |
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指令设置的缓冲区
时,可以将部分响应保存到临时文件中。size
该指令设置临时文件的最大值。一次写入临时文件的数据大小由proxy_temp_file_write_size指令设置。
零值禁用对临时文件的响应的缓冲。
此限制不适用于将缓存 或存储在磁盘上的响应。
句法: |
proxy_method |
---|---|
默认: | — |
语境: |
http , server ,location |
指定转发到代理服务器的请求中使用的 HTTP method
,而不是客户端请求中的方法。参数值可以包含变量(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
- 通常,
如果请求已发送到上游服务器 (1.9.13),则使用非幂等
方法 (
POST
、LOCK
、 ) 的请求不会传递到下一个服务器;PATCH
明确启用此选项允许重试此类请求; 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 被传递到服务器,如下所示:
-
如果使用 URI 指定指令,则当请求传递到服务器时,
与位置匹配的
规范化
proxy_pass
请求 URI的部分 将替换为指令中指定的 URI:location /name/ { proxy_pass http://127.0.0.1/remote/; }
-
如果
proxy_pass
未指定 URI,则在处理原始请求时,请求 URI 将以与客户端发送的形式相同的形式传递到服务器,或者在处理更改的 URI 时传递完整规范化的请求 URI:location /some/path/ { proxy_pass http://127.0.0.1; }
在版本 1.1.12 之前,如果
proxy_pass
指定时没有指定 URI,则在某些情况下可能会传递原始请求 URI,而不是更改后的 URI。
在某些情况下,无法确定请求 URI 中要替换的部分:
-
当使用正则表达式指定位置时,并且也在命名位置内指定位置。
在这些情况下,
proxy_pass
应在不指定 URI 的情况下指定。 - 当使用重写指令
在代理位置内更改 URI 时
,相同的配置将用于处理请求 (
break
):location /name/ { rewrite /name/([^/]+) /users?name=body 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 |
设置应在代理服务器响应的“位置”和“刷新”标头字段中更改的文本。假设代理服务器返回标头字段“ Location: http://localhost:8000/two/some/uri/
”。该指令
proxy_redirect http://localhost:8000/two/ http://frontend/one/;
会将这个字符串重写为“ Location: http://frontend/one/some/uri/
”。
字符串中可以省略服务器名称replacement
:
proxy_redirect http://localhost:8000/two/ /;
那么主服务器的名称和端口(如果不是 80)将被插入。
参数指定的默认替换使用location和
proxy_passdefault
指令的参数
。因此,下面的两种配置是等效的:
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_passdefault
,则不允许
使用
该参数。
字符串replacement
可以包含变量:
proxy_redirect http://localhost:8000/ http://$host:$server_port/;
Aredirect
还可以包含 (1.1.11) 变量:
proxy_redirect http://$proxy_host:8000/ /;
可以使用正则表达式指定该指令 (1.1.11)。在这种情况下,redirect
应该以“ ~
”符号开头进行区分大小写的匹配,或者以“ ~*
”符号开头进行不区分大小写的匹配。正则表达式可以包含命名和位置捕获,并且replacement
可以引用它们:
proxy_redirect ~^(http://[^:]+):\d+(/.+)$ body; proxy_redirect ~*/user/([^/]+)/(.+)$ http://body.example.com/;
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
size
该指令在 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 |
允许重新定义或附加字段到传递到代理服务器的
请求标头
。可以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 keepalive”行为。默认情况下,操作系统的设置对套接字有效。如果该指令设置为值“ on
”,
SO_KEEPALIVE
则为套接字打开套接字选项。
句法: |
proxy_ssl_certificate |
---|---|
默认: | — |
语境: |
http , server ,location |
该指令出现在 1.7.8 版本中。
指定file
PEM 格式的证书,用于对代理 HTTPS 服务器进行身份验证。
从1.21.0版本开始,名称中可以使用变量file
。
句法: |
proxy_ssl_certificate_key |
---|---|
默认: | — |
语境: |
http , server ,location |
该指令出现在 1.7.8 版本中。
指定file
PEM 格式的密钥,用于对代理 HTTPS 服务器进行身份验证。
可以指定值
engine
: name
:id
来代替(1.7.9),后者使用
OpenSSL 引擎file
指定的密钥加载密钥。
id
name
从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 版本中。
指定file
PEM 格式的已撤销证书 (CRL),用于验证
代理 HTTPS 服务器的证书。
句法: |
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 服务器的请求启用指定协议。
TLSv1.3
从 1.23.4 开始默认使用
该参数。
句法: |
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
with 变量显式设置文件名:
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
当启用从代理服务器到临时文件的响应缓冲时,
限制一次写入临时文件的数据量。默认情况下,受proxy_buffer_size和proxy_bufferssize
指令设置的两个缓冲区的限制
。临时文件的最大大小由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_pathuse_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
变量。