<!-- review: finished -->

<a id="stream-realip"></a>

# RealIP

允许将客户端地址和端口更改为在 PROXY 协议头中传递的地址和端口。必须通过在 [listen](https://cn.angie.software//angie/docs/configuration/modules/stream/index.md#s-listen) 指令中设置 `proxy_protocol` 参数来预先启用 PROXY 协议。

当从源代码 [构建](https://cn.angie.software//angie/docs/installation/sourcebuild.md#sourcebuild) 时，默认情况下不会构建此模块；应使用 `‑‑with‑stream_realip_module` [构建选项](https://cn.angie.software//angie/docs/installation/sourcebuild.md#configure) 来启用它。

在 [我们的仓库](https://cn.angie.software//angie/docs/installation/index.md#install-packages) 中的包和镜像中，该模块已包含在构建中。

<a id="configuration-example-67"></a>

## 配置示例

```nginx
listen 12345 proxy_protocol;

set_real_ip_from  192.168.1.0/24;
set_real_ip_from  192.168.2.1;
set_real_ip_from  2001:0db8::/32;
```

<a id="directives-76"></a>

## 指令

<a id="index-0"></a>

<a id="s-set-real-ip-from"></a>

### set_real_ip_from

| [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile)   | `set_real_ip_from` address | CIDR | `unix:`;   |
|--------------------------------------------------------------------------------------|------------------------------------------------|
| 默认值                                                                                  | —                                              |
| [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile)  | stream, server                                 |

定义已知发送正确替换地址的可信地址。如果指定了特殊值 `unix:`，则所有 UNIX 域套接字将被信任。

<a id="built-in-variables-22"></a>

## 内置变量

<a id="v-s-realip-remote-addr"></a>

### `$realip_remote_addr`

保留原始客户端地址

<a id="v-s-realip-remote-port"></a>

### `$realip_remote_port`

保留原始客户端端口
