Nginx代理模块详解

示例配置

指令

proxy_bind

proxy_buffer_size

proxy_buffering

proxy_buffers

proxy_busy_buffers_size

proxy_cache

proxy_cache_background_update

proxy_cache_bypass

proxy_cache_convert_head

proxy_cache_key

proxy_cache_lock

proxy_cache_lock_age

proxy_cache_lock_timeout

proxy_cache_max_range_offset

proxy_cache_methods

proxy_cache_min_uses

proxy_cache_path

proxy_cache_purge

proxy_cache_revalidate

proxy_cache_use_stale

proxy_cache_valid

proxy_connect_timeout

proxy_cookie_domain

proxy_cookie_flags

proxy_cookie_path

proxy_force_ranges

proxy_headers_hash_bucket_size

proxy_headers_hash_max_size

proxy_hide_header

proxy_http_version

proxy_ignore_client_abort

proxy_ignore_headers

proxy_intercept_errors

proxy_limit_rate

proxy_max_temp_file_size

proxy_method

proxy_next_upstream

proxy_next_upstream_timeout

proxy_next_upstream_tries

proxy_no_cache

proxy_pass

proxy_pass_header

proxy_pass_request_body

proxy_pass_request_headers

proxy_read_timeout

proxy_redirect

proxy_request_buffering

proxy_send_lowat

proxy_send_timeout

proxy_set_body

proxy_set_header

proxy_socket_keepalive

proxy_ssl_certificate

proxy_ssl_certificate_key

proxy_ssl_ciphers

proxy_ssl_conf_command

proxy_ssl_crl

proxy_ssl_name

proxy_ssl_password_file

proxy_ssl_protocols

proxy_ssl_server_name

proxy_ssl_session_reuse

proxy_ssl_trusted_certificate

proxy_ssl_verify

proxy_ssl_verify_depth

proxy_store

proxy_store_access

proxy_temp_file_write_size

proxy_temp_path

嵌入变量

该ngx_http_proxy_module模块允许将请求传递到另一台服务器。

示例配置

location / {

proxy_pass :8000;

proxy_set_header 主机 $host;

proxy_set_header X-Real-IP $remote_addr;

}

句法:proxy_bind address [transparent] | off;

默认:—

语境:http, server,location

该指令出现在 0.8.22 版本中。

使到代理服务器的传出连接源自具有可选端口 (1.11.2) 的指定本地 IP 地址。参数值可以包含变量 (1.3.12)。

特殊值off(1.3.12) 取消了proxy_bind从先前配置级别继承的指令的效果,它允许系统自动分配本地 IP 地址和端口。

transparent参数(1.11.0)允许与代理服务器传出连接从一个非本地的IP地址发起,例如,来自客户端的实际IP地址:

proxy_bind $remote_addr

为了使该参数起作用,通常需要以超级用户权限运行 nginx 工作进程 。

在 Linux 上不需要(1.13.8),就像transparent指定了参数一样,工作进程继承CAP_NET_RAW了主进程的能力。还需要配置内核路由表来拦截来自代理服务器的网络流量。

句法:proxy_buffer_size size;

默认:proxy_buffer_size 4k|8k;

语境:http, server,location

设置size用于读取从代理服务器收到的响应的第一部分的缓冲区的 。这部分通常包含一个小的响应头。默认情况下,缓冲区大小等于一页内存。这是 4K 或 8K,具体取决于平台。然而,它可以做得更小。

句法:proxy_buffering on | off;

默认:

proxy_buffering 开启;

语境: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 number size;

默认:

proxy_buffers 8 4k|8k;

语境:http, server,location

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

句法:proxy_busy_buffers_size size;

默认:

proxy_busy_buffers_size 8k|16k;

语境:http, server,location

当缓冲启用从代理的服务器响应,限制总size的缓冲区,可以是正忙于发送到客户端的响应,而响应尚不充分阅读的。同时,其余缓冲区可用于读取响应,并在需要时将部分响应缓冲到临时文件。默认情况下,size受proxy_buffer_size和proxy_buffers指令设置的两个缓冲区大小的限制 。

句法:proxy_cache zone | off;

默认:

proxy_cache 关闭;

语境:http, server,location

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

句法:proxy_cache_background_update on | off;

默认:

proxy_cache_background_update 关闭;

语境:http, server,location

该指令出现在 1.11.10 版中。

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

句法:proxy_cache_bypass string ...;

默认:—

语境: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 on | off;

默认:

proxy_cache_convert_head 开启;

语境:http, server,location

该指令出现在 1.9.7 版中。

启用或禁用将“ HEAD”方法转换为“ ”以GET进行缓存。禁用转换时, 应将缓存键配置为包含$request_method.

句法:proxy_cache_key string;

默认:

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 on | off;

默认:

proxy_cache_lock 关闭;

语境:http, server,location

该指令出现在 1.1.12 版中。

启用后,一次只允许 一个请求通过将请求传递给代理服务器来填充根据proxy_cache_key指令标识的新缓存元素。相同缓存元素的其他请求将等待响应出现在缓存中或等待释放该元素的缓存锁,直到proxy_cache_lock_timeout指令设置的时间 。

句法:proxy_cache_lock_age time;

默认:

proxy_cache_lock_age 5s;

语境:http, server,location

该指令出现在 1.7.8 版中。

如果传递给代理服务器以填充指定的新缓存元素的最后一个请求尚未完成,则time可以再将一个请求传递给代理服务器。

句法:proxy_cache_lock_timeout time;

默认:

proxy_cache_lock_timeout 5s;

语境:http, server,location

该指令出现在 1.1.12 版中。

为proxy_cache_lock设置超时。当time过期时,请求将被传递到代理服务器,但是,响应不会被缓存。

在 1.7.8 之前,可以缓存响应。

句法:proxy_cache_max_range_offset number;

默认:—

语境:http, server,location

该指令出现在 1.11.6 版中。

为字节范围请求设置以字节为单位的偏移量。如果范围超出偏移量,则范围请求将传递给代理服务器,并且不会缓存响应。

句法:proxy_cache_methods GET | HEAD | POST ...;

默认:

proxy_cache_methods GET HEAD;

语境:http, server,location

该指令出现在 0.7.59 版本中。

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

句法:proxy_cache_min_uses number;

默认:

proxy_cache_min_uses 1;

语境:http, server,location

设置number请求数,之后响应将被缓存。

句法:proxy_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

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

proxy_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m;

缓存中的文件名将如下所示:

/data/nginx/cache/ c / 29 /b7f54b2dfd382f4809d650 29c

缓存的响应首先写入临时文件,然后重命名该文件。从 0.8.9 版本开始,临时文件和缓存可以放在不同的文件系统上。但是,请注意,在这种情况下,文件是跨两个文件系统复制的,而不是廉价的重命名操作。因此,建议对于任何给定位置,缓存和保存临时文件的目录都放在同一个文件系统上。临时文件的目录根据use_temp_path参数 (1.7.10) 设置。如果此参数被省略或设置为 value on,则将使用proxy_temp_path指令为给定位置设置的目录。如果该值设置为off,临时文件将直接放在缓存目录中。

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

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

在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=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(无内容)响应来指示。

如果清除请求的缓存键以星号(“ *”)结尾,则所有匹配通配符键的缓存条目都将从缓存中删除。但是,这些条目将保留在磁盘上,直到它们因不活动或被缓存清除程序(1.7.12) 处理或客户端尝试访问它们而被删除。

示例配置:

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

地图 $request_method $purge_method {

清除 1;

默认 0;

}

服务器 {

...

地点 / {

proxy_pass ;

proxy_cache cache_zone;

proxy_cache_key $uri;

proxy_cache_purge $purge_method;

}

}

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

句法:proxy_cache_revalidate on | off;

默认:

proxy_cache_revalidate 关闭;

语境:http, server,location

该指令出现在 1.5.7 版中。

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

句法:proxy_cache_use_stale error | timeout | invalid_header | updating | http_500 | http_502 | http_503 | http_504 | http_403 | http_404 | http_429 | off ...;

默认:

proxy_cache_use_stale 关闭;

语境: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 [code ...] time;

默认:—

语境: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 任意 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 time;

默认:

proxy_connect_timeout 60s;

语境:http, server,location

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

句法:proxy_cookie_domain off;

proxy_cookie_domain domain replacement;

默认:

proxy_cookie_domain 关闭;

语境:http, server,location

该指令出现在 1.1.15 版中。

设置应在domain 代理服务器响应的“Set-Cookie”标头字段的属性中更改的文本。假设代理服务器返回带有属性“ 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]+\.[az]+)$ $sl_domain;

proxy_cookie_domain可以在同一级别指定 多个指令:

proxy_cookie_domain localhost example.org;

proxy_cookie_domain ~\.([az]+\.[az]+)$$1;

如果可以对 cookie 应用多个指令,则将选择第一个匹配的指令。

该off参数取消了proxy_cookie_domain从先前配置级别继承的指令的效果。

句法:proxy_cookie_flags off | cookie [flag ...];

默认:

proxy_cookie_flags 关闭;

语境: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 一个 httponly;

proxy_cookie_flags ~ nosecure samesite=strict;

如果可以对 cookie 应用多个指令,则将选择第一个匹配的指令。在示例中,httponly标志被添加到 cookie one,对于所有其他 cookie,samesite=strict标志被添加并被secure删除。

该off参数取消了proxy_cookie_flags从先前配置级别继承的指令的效果。

句法:proxy_cookie_path off;

proxy_cookie_path path replacement;

默认:

proxy_cookie_path 关闭;

语境:http, server,location

该指令出现在 1.1.15 版中。

设置应在path 代理服务器响应的“Set-Cookie”标头字段的属性中更改的文本。假设代理服务器返回带有属性“ 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 //两个/;

如果可以对 cookie 应用多个指令,则将选择第一个匹配的指令。

该off参数取消了proxy_cookie_path从先前配置级别继承的指令的效果。

句法:proxy_force_ranges on | off;

默认:

proxy_force_ranges 关闭;

语境:http, server,location

该指令出现在 1.7.7 版中。

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

句法:proxy_headers_hash_bucket_size size;

默认:

proxy_headers_hash_bucket_size 64;

语境:http, server,location

size为proxy_hide_header和proxy_set_header 指令使用的哈希表 设置桶。设置哈希表的详细信息在单独的文档中提供 。

句法:proxy_headers_hash_max_size size;

默认:

proxy_headers_hash_max_size 512;

语境:http, server,location

设置proxy_hide_header和proxy_set_header 指令size使用的最大哈希表。设置哈希表的详细信息在单独的文档中提供 。

句法:proxy_hide_header field;

默认:—

语境:http, server,location

默认情况下,nginx 不会将头字段“Date”、“Server”、“X-Pad”和“X-Accel-...”从代理服务器的响应传递给客户端。该proxy_hide_header指令设置了不会被传递的附加字段。相反,如果需要允许传递字段,则可以使用proxy_pass_header指令。

句法:proxy_http_version 1.0 | 1.1;

默认:

proxy_http_version 1.0;

语境:http, server,location

该指令出现在 1.1.4 版中。

设置代理的 HTTP 协议版本。默认情况下,使用版本 1.0。建议将 1.1 版与 keepalive 连接和 NTLM 身份验证一起使用。

句法:proxy_ignore_client_abort on | off;

默认:

proxy_ignore_client_abort 关闭;

语境:http, server,location

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

句法:proxy_ignore_headers field ...;

默认:—

语境: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 on | off;

默认:

proxy_intercept_errors 关闭;

语境:http, server,location

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

句法:proxy_limit_rate rate;

默认:

proxy_limit_rate 0;

语境:http, server,location

该指令出现在 1.7.7 版中。

限制从代理服务器读取响应的速度。在rate被以每秒字节数指定。零值禁用速率限制。该限制是针对每个请求设置的,因此如果 nginx 同时打开到代理服务器的两个连接,则总体速率将是指定限制的两倍。只有在启用了来自代理服务器的响应缓冲时,此限制才有效 。

句法:proxy_max_temp_file_size size;

默认:

proxy_max_temp_file_size 1024m;

语境:http, server,location

当来自代理服务器的响应缓冲被启用,并且整个响应不适合由proxy_buffer_size和proxy_buffers 指令设置的缓冲区时,响应的一部分可以保存到临时文件中。该指令设置size临时文件的最大值。一次写入临时文件的数据大小由proxy_temp_file_write_size指令设置。

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

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

句法:proxy_method method;

默认:—

语境:http, server,location

指定method在转发到代理服务器的请求中使用的 HTTP ,而不是来自客户端请求的方法。参数值可以包含变量 (1.11.6)。

句法:proxy_next_upstream error | timeout | invalid_header | http_500 | http_502 | http_503 | http_504 | http_403 | http_404 | http_429 | non_idempotent | off ...;

默认:

proxy_next_upstream 错误超时;

语境: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 time;

默认:

proxy_next_upstream_timeout 0;

语境:http, server,location

该指令出现在 1.7.5 版中。

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

句法:proxy_next_upstream_tries number;

默认:

proxy_next_upstream_tries 0;

语境:http, server,location

该指令出现在 1.7.5 版中。

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

句法:proxy_no_cache string ...;

默认:—

语境: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 URL;

默认:—

语境:location, if in location,limit_except

设置代理服务器的协议和地址以及位置应映射到的可选 URI。作为协议,可以指定“ http”或“ https”。地址可以指定为域名或 IP 地址,以及可选的端口:

proxy_pass :8000/uri/;

或作为 UNIX 域套接字路径在单词“ unix”后指定并用冒号括起来:

proxy_pass :/tmp/backend.socket:/uri/;

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

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

请求 URI 被传递到服务器,如下所示:

如果proxy_pass使用 URI 指定指令,则当请求传递到服务器时, 与位置匹配的规范化请求 URI部分 将被指令中指定的 URI 替换:

地点名称/ {

proxy_pass ;

}

如果proxy_pass未指定 URI,则在处理原始请求时将请求 URI 以与客户端发送的相同形式传递给服务器,或者在处理更改的 URI 时传递完整的规范化请求 URI:

位置/一些/路径/ {

proxy_pass ;

}

在 1.1.12 版本之前,如果proxy_pass不指定 URI,则在某些情况下可能会传递原始请求 URI 而不是更改的 URI。

在某些情况下,无法确定要替换的请求 URI 部分:

当使用正则表达式指定位置时,也在命名位置内。

在这些情况下,proxy_pass应该在没有 URI 的情况下 指定。

当使用rewrite指令在代理位置内更改 URI 时 ,将使用相同的配置来处理请求 ( break):

地点名称/ {

重写 /name/([^/]+) /users?name=$1 break;

proxy_pass ;

}

在这种情况下,指令中指定的 URI 将被忽略,并将完整更改的请求 URI 传递给服务器。

当变量用于proxy_pass:

地点名称/ {

proxy_pass $request_uri;

}

在这种情况下,如果在指令中指定了 URI,它将按原样传递给服务器,替换原始请求 URI。

WebSocket代理需要特殊配置,从 1.3.13 版开始支持。

句法:proxy_pass_header field;

默认:—

语境:http, server,location

允许将其他禁用的标头字段从代理服务器传递到客户端。

句法:proxy_pass_request_body on | off;

默认:

proxy_pass_request_body 开启;

语境:http, server,location

指示是否将原始请求正文传递给代理服务器。

位置 /x-accel-redirect-here/ {

proxy_method GET;

proxy_pass_request_body 关闭;

proxy_set_header 内容长度“”;

proxy_pass ...

}

另请参阅proxy_set_header和 proxy_pass_request_headers指令。

句法:proxy_pass_request_headers on | off;

默认:

proxy_pass_request_headers 开启;

语境:http, server,location

指示是否将原始请求的头字段传递给代理服务器。

位置 /x-accel-redirect-here/ {

proxy_method GET;

proxy_pass_request_headers 关闭;

proxy_pass_request_body 关闭;

proxy_pass ...

}

另请参阅proxy_set_header和 proxy_pass_request_body指令。

句法:proxy_read_timeout time;

默认:

proxy_read_timeout 60s;

语境:http, server,location

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

句法:proxy_redirect default;

proxy_redirect off;

proxy_redirect redirect replacement;

默认:

proxy_redirect 默认;

语境:http, server,location

设置应在代理服务器响应的“位置”和“刷新”标头字段中更改的文本。假设代理服务器返回标头字段“ Location: :8000/two/some/uri/”。该指令

proxy_redirect :8000/two/ ;

将此字符串重写为“ Location: some/uri/”。

服务器名称可以在replacement字符串中省略:

proxy_redirect :8000/two/;

然后将插入主服务器的名称和端口(如果与 80 不同)。

default参数 指定的默认替换使用 location和 proxy_pass指令的参数。因此,下面的两个配置是等效的:

位置/一个/ {

proxy_pass :port/two/;

proxy_redirect 默认;

位置/一个/ {

proxy_pass :port/two/;

proxy_redirect :port/two/ /one/;

default如果使用变量指定了proxy_pass,则不允许使用 该参数 。

一个replacement字符串可以包含变量:

proxy_redirect :8000/ :$server_port/;

Aredirect还可以包含 (1.1.11) 变量:

proxy_redirect :8000/ /;

可以使用正则表达式指定指令 (1.1.11)。在这种情况下,redirect应该以“ ~”符号开头以进行区分大小写的匹配,或者以“ ~*”符号开头以进行不区分大小写的匹配。正则表达式可以包含命名和位置捕获,并且replacement可以引用它们:

proxy_redirect ~^(http://[^:]+):\d+(/.+)$ $1$2;

proxy_redirect ~*/user/([^/]+)/(.+)$ ;

proxy_redirect可以在同一级别指定 多个指令:

proxy_redirect 默认;

proxy_redirect :8000//;

proxy_redirect ;

如果可以将多个指令应用于代理服务器响应的标头字段,则将选择第一个匹配的指令。

该off参数取消了proxy_redirect从先前配置级别继承的指令的效果。

使用此指令,还可以将主机名添加到代理服务器发出的相对重定向中:

proxy_redirect //;

句法:proxy_request_buffering on | off;

默认:

proxy_request_buffering on;

语境:http, server,location

该指令出现在 1.7.11 版中。

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

启用缓冲后, 在将请求发送到代理服务器之前,将从客户端读取整个请求正文 。

当缓冲被禁用时,请求正文会在收到时立即发送到代理服务器。在这种情况下, 如果 nginx 已经开始发送请求正文,则请求无法传递到 下一个服务器。

当使用 HTTP/1.1 分块传输编码发送原始请求正文时,除非为代理启用HTTP/1.1,否则无论指令值如何,请求正文都将被缓冲。

句法:proxy_send_lowat size;

默认:

proxy_send_lowat 0;

语境:http, server,location

如果该指令设置为非零值,nginx 将尝试通过使用 kqueue方法的NOTE_LOWAT标志 或套接字选项以及指定的. SO_SNDLOWATsize

该指令在 Linux、Solaris 和 Windows 上被忽略。

句法:proxy_send_timeout time;

默认:

proxy_send_timeout 60s;

语境:http, server,location

设置将请求传输到代理服务器的超时时间。超时仅设置在两次连续的写操作之间,而不是针对整个请求的传输。如果代理服务器在这段时间内没有收到任何信息,连接就会关闭。

句法:proxy_set_body value;

默认:—

语境:http, server,location

允许重新定义传递给代理服务器的请求正文。该value可以包含文本,变量,他们的组合。

句法:proxy_set_header field value;

默认:

proxy_set_header 主机 $proxy_host;

proxy_set_header 连接关闭;

语境:http, server,location

允许重新定义或附加字段到传递给代理服务器的请求标头 。该value可以包含文本,变量,以及它们的组合。当且仅当proxy_set_header当前级别上没有定义任何指令时,这些指令才从先前的配置级别继承。默认情况下,只重新定义了两个字段:

proxy_set_header 主机 $proxy_host;

proxy_set_header 连接关闭;

如果启用缓存,标题字段“If-Modified-Since”、“If-Unmodified-Since”、“If-None-Match”、“If-Match”、“Range”和“If-Range”来自原始请求不会传递到代理服务器。

可以像这样传递未更改的“Host”请求标头字段:

proxy_set_header 主机 $http_host;

但是,如果客户端请求标头中不存在此字段,则不会传递任何内容。在这种情况下,最好使用该$host变量 - 如果该字段不存在,它的值等于“Host”请求标头字段中的服务器名称或主服务器名称:

proxy_set_header 主机 $host;

此外,服务器名称可以与代理服务器的端口一起传递:

proxy_set_header 主机 $host:$proxy_port;

如果头字段的值是空字符串,则该字段不会传递给代理服务器:

proxy_set_header Accept-Encoding "";

句法:proxy_socket_keepalive on | off;

默认:

proxy_socket_keepalive 关闭;

语境:http, server,location

该指令出现在 1.15.6 版中。

为到代理服务器的传出连接配置“TCP keepalive”行为。默认情况下,操作系统的设置对套接字有效。如果指令设置为值“ on”, SO_KEEPALIVE则为套接字打开套接字选项。

句法:proxy_ssl_certificate file;

默认:—

语境:http, server,location

该指令出现在 1.7.8 版中。

file使用 PEM 格式的证书 指定一个,用于对代理的 HTTPS 服务器进行身份验证。

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

句法:proxy_ssl_certificate_key file;

默认:—

语境:http, server,location

该指令出现在 1.7.8 版中。

file使用用于对代理 HTTPS 服务器进行身份验证的 PEM 格式的密钥 指定 a 。

值 engine:name:id 可以指定代替file(1.7.9),其负载与指定的秘密密钥id 从OpenSSL的发动机name。

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

句法:proxy_ssl_ciphers ciphers;

默认:

proxy_ssl_ciphers DEFAULT;

语境:http, server,location

该指令出现在 1.5.6 版中。

为对代理 HTTPS 服务器的请求指定启用的密码。密码以 OpenSSL 库理解的格式指定。

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

句法:proxy_ssl_conf_command 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 file;

默认:—

语境:http, server,location

该指令出现在 1.7.0 版中。

指定file用于验证 代理 HTTPS 服务器证书的 PEM 格式的撤销证书 (CRL) 。

句法:proxy_ssl_name name;

默认:

proxy_ssl_name $proxy_host;

语境:http, server,location

该指令出现在 1.7.0 版中。

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

默认情况下,使用proxy_pass URL的主机部分。

句法:proxy_ssl_password_file file;

默认:—

语境:http, server,location

该指令出现在 1.7.8 版中。

file为密钥 指定带密码短语, 其中每个密码短语在单独的行中指定。加载密钥时依次尝试密码短语。

句法:proxy_ssl_protocols [SSLv2] [SSLv3] [TLSv1] [TLSv1.1] [TLSv1.2] [TLSv1.3];

默认:

proxy_ssl_protocols TLSv1 TLSv1.1 TLSv1.2;

语境:http, server,location

该指令出现在 1.5.6 版中。

为对代理 HTTPS 服务器的请求启用指定的协议。

句法:proxy_ssl_server_name on | off;

默认:

proxy_ssl_server_name 关闭;

语境:http, server,location

该指令出现在 1.7.0 版中。

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

句法:proxy_ssl_session_reuse on | off;

默认:

proxy_ssl_session_reuse on;

语境:http, server,location

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

句法:proxy_ssl_trusted_certificate file;

默认:—

语境:http, server,location

该指令出现在 1.7.0 版中。

指定file用于验证 代理 HTTPS 服务器证书的 PEM 格式的受信任 CA 证书。

句法:proxy_ssl_verify on | off;

默认:

proxy_ssl_verify 关闭;

语境:http, server,location

该指令出现在 1.7.0 版中。

启用或禁用代理 HTTPS 服务器证书的验证。

句法:proxy_ssl_verify_depth number;

默认:

proxy_ssl_verify_depth 1;

语境:http, server,location

该指令出现在 1.7.0 版中。

设置代理 HTTPS 服务器证书链中的验证深度。

句法:proxy_store on | off | string;

默认:

proxy_store 关闭;

语境:http, server,location

启用将文件保存到磁盘。该on参数使用与指令alias或 root对应的路径保存文件 。该off参数禁止保存文件。此外,可以使用stringwith 变量显式设置文件名 :

proxy_store /data/www$original_uri;

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

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

位置/图像/ {

根/数据/www;

error_page 404 = /fetch$uri;

}

位置/获取/ {

内部的;

proxy_pass /;

proxy_store 开启;

proxy_store_access 用户:rw 组:rw 全部:r;

proxy_temp_path /data/temp;

别名 /data/www/;

}

或者像这样:

位置/图像/ {

根/数据/www;

error_page 404 = @fetch;

}

位置@fetch {

内部的;

proxy_pass ;

proxy_store 开启;

proxy_store_access 用户:rw 组:rw 全部:r;

proxy_temp_path /data/temp;

根/数据/www;

}

句法:proxy_store_access users:permissions ...;

默认:

proxy_store_access 用户:rw;

语境:http, server,location

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

proxy_store_access 用户:rw 组:rw 全部:r;

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

proxy_store_access group:rw all:r;

句法:proxy_temp_file_write_size 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 path [level1 [level2 [level3]]];

默认:

proxy_temp_path proxy_temp;

语境:http, server,location

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

proxy_temp_path /spool/nginx/proxy_temp 1 2;

临时文件可能如下所示:

/spool/nginx/proxy_temp/ 7 / 45 / 457

另请参阅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变量。