模块 ngx_http_realip_module

示例配置
指令
     set_real_ip_from
     real_ip_header
     real_ip_recursive
嵌入式变量

模块 ngx_http_realip_module 用于将客户端地址和可选端口更改为指定头字段中发送的地址。

此模块不是默认构建的,应使用 --with-http_realip_module 配置参数启用。

示例配置

set_real_ip_from  192.168.1.0/24;
set_real_ip_from  192.168.2.1;
set_real_ip_from  2001:0db8::/32;
real_ip_header    X-Forwarded-For;
real_ip_recursive on;

指令

语法: set_real_ip_from address | CIDR | unix:;
默认:
上下文: http, server, location

定义已知发送正确替换地址的受信任地址。如果指定了特殊值 unix:,则所有 UNIX 域套接字将受信任。也可以使用主机名(1.13.1)指定受信任的地址。

从版本 1.3.0 和 1.2.1 开始支持 IPv6 地址。

语法: real_ip_header field | X-Real-IP | X-Forwarded-For | proxy_protocol;
默认:
real_ip_header X-Real-IP;
上下文: http, server, location

定义将用于替换客户端地址的请求头字段值。

包含可选端口的请求头字段值也将用于替换客户端端口(1.11.0)。地址和端口应根据 RFC 3986 指定。

参数 proxy_protocol(1.5.12)将客户端地址更改为 PROXY 协议头中的地址。必须通过在 listen 指令中设置 proxy_protocol 参数来先前启用 PROXY 协议。

语法: real_ip_recursive on | off;
默认:
real_ip_recursive off;
上下文: http, server, location

此指令出现在版本 1.3.0 和 1.2.1 中。

如果禁用递归搜索,则与受信任地址之一匹配的原始客户端地址将被定义的 real_ip_header 指令所定义的请求头字段中发送的最后地址替换。如果启用递归搜索,则与受信任地址之一匹配的原始客户端地址将被请求头字段中发送的最后一个非受信任地址替换。

嵌入式变量

$realip_remote_addr
保留原始客户端地址(1.9.7)
$realip_remote_port
保留原始客户端端口(1.11.0)