This is an automated email from the ASF dual-hosted git repository.
monkeydluffy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new e2d5e4028 docs: update source description in the `real-ip` plugin doc
(#9905)
e2d5e4028 is described below
commit e2d5e40285c19798e2cbfe93a11467e7fe72afb6
Author: Traky Deng <[email protected]>
AuthorDate: Wed Jul 26 20:48:20 2023 +0800
docs: update source description in the `real-ip` plugin doc (#9905)
---
docs/en/latest/plugins/real-ip.md | 2 +-
docs/zh/latest/plugins/real-ip.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/en/latest/plugins/real-ip.md
b/docs/en/latest/plugins/real-ip.md
index 1ee464540..115fc29b2 100644
--- a/docs/en/latest/plugins/real-ip.md
+++ b/docs/en/latest/plugins/real-ip.md
@@ -43,7 +43,7 @@ This Plugin requires APISIX to run on
[APISIX-Base](../FAQ.md#how-do-i-build-the
| Name | Type | Required | Valid values
| Description
|
|-------------------|---------------|----------|-----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| source | string | True | Any Nginx variable like
`arg_realip` or `http_x_forwarded_for`. | Dynamically sets the client's IP
address and an optional port from APISIX's view.
|
+| source | string | True | Any Nginx variable like
`arg_realip` or `http_x_forwarded_for`. | Dynamically sets the client's IP
address and an optional port, or the client's host name, from APISIX's view.
|
| trusted_addresses | array[string] | False | List of IPs or CIDR ranges.
| Dynamically sets the `set_real_ip_from`
field.
|
| recursive | boolean | False | True to enable, false to
disable, default is false | If recursive search is disabled, the
original client address that matches one of the trusted addresses is replaced
by the last address sent in the configured `source`. If recursive search is
enabled, the original client address that matches one of the trusted addresses
is replaced by the last non-trusted address sent in the configured `source`. |
diff --git a/docs/zh/latest/plugins/real-ip.md
b/docs/zh/latest/plugins/real-ip.md
index b01291787..0922541af 100644
--- a/docs/zh/latest/plugins/real-ip.md
+++ b/docs/zh/latest/plugins/real-ip.md
@@ -43,7 +43,7 @@ description: 本文介绍了关于 Apache APISIX `real-ip` 插件的基本信息
| 名称 | 类型 | 必选项 | 有效值
| 描述
|
|-------------------|---------------|--|-------------------------------------------------------------|----------------------------------------------------------------------|
-| source | string | 是 | 任何 NGINX 变量，如 `arg_realip` 或
`http_x_forwarded_for` 。 | 动态设置客户端的 IP 地址和端口。如果该值不包含端口，则不会更改客户端的端口。|
+| source | string | 是 | 任何 NGINX 变量，如 `arg_realip` 或
`http_x_forwarded_for` 。 | 动态设置客户端的 IP 地址和端口，或主机名。如果该值不包含端口，则不会更改客户端的端口。 |
| trusted_addresses | array[string] | 否 | IP 或 CIDR 范围列表。
| 动态设置 `set_real_ip_from` 字段。
|
| recursive | boolean | 否 | true 或者 false，默认是 false
|
如果禁用递归搜索，则与受信任地址之一匹配的原始客户端地址将替换为配置的`source`中发送的最后一个地址。如果启用递归搜索，则与受信任地址之一匹配的原始客户端地址将替换为配置的`source`中发送的最后一个非受信任地址。
|
