# Real IP 配置选项

real-ip 插件使 API 网关能够从 HTTP 请求头或查询字符串中的 IP 地址获取客户端真实 IP，从而提高数据质量。<!-- --> <!-- -->配置涵盖插件参数。

## 参数[​](#参数 "参数的直接链接")

请参阅插件[通用配置](https://docs.apiseven.com/apisix/reference/plugin-common-configurations.md)，了解所有插件通用的配置选项。

* source

  string

  必填

  ***

  一个 [内置变量](https://docs.apiseven.com/apisix/reference/built-in-variables.md)，例如 `http_x_forwarded_for` 或 `arg_realip`。变量值应为代表客户端真实 IP 地址的有效 IP 地址，可选择带有端口。

* trusted\_addresses

  array\[string]

  有效值：

  IPv4 或 IPv6 地址数组（支持 CIDR 表示法）

  ***

  可通过 `source` 提供替换地址的受信任代理地址。

  配置此列表时，仅当当前连接地址与列表匹配时，插件才会更改客户端地址。

  当 `recursive` 为 true 且 `source` 为 `http_x_forwarded_for` 时，插件还会使用此列表跳过转发链中的受信任中间代理，并选择最后一个不受信任的地址。

  如果省略此项，则插件会接受任何对等方连接提供的 `source` 值。当不受信任的客户端可以控制来源值时，请配置受信任地址。

* recursive

  boolean

  默认值：`false`

  ***

  如果为 false，则将与受信任地址之一匹配的原始客户端地址替换为配置的 `source` 中发送的最后一个地址。

  如果为 true，则将与受信任地址之一匹配的原始客户端地址替换为配置的 `source` 中发送的最后一个非受信任地址。
