You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/09/22 14:17:12 UTC
[GitHub] [apisix] huang-x-h opened a new pull request #5116: docs: add gzip and real-ip zh docs
huang-x-h opened a new pull request #5116:
URL: https://github.com/apache/apisix/pull/5116
### What this PR does / why we need it:
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
https://github.com/apache/apisix-website/issues/544
### Pre-submission checklist:
* [x] Did you explain what problem does this PR solve? Or what new features have been added?
* [ ] Have you added corresponding test cases?
* [x] Have you modified the corresponding document?
* [x] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] tokers commented on a change in pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
tokers commented on a change in pull request #5116:
URL: https://github.com/apache/apisix/pull/5116#discussion_r714409615
##########
File path: docs/zh/latest/plugins/gzip.md
##########
@@ -0,0 +1,108 @@
+---
+title: gzip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`gzip` 插件能动态设置 `Nginx` 的压缩行为。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-apache-apisix-构建-openresty) 上。**
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| --------------------------------------| ------------| -------------- | -------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| types | array[string] or "*" | 可选 | ["text/html"] | | 动态设置 `gzip_types` 指令，特殊值 `"*"` 匹配任何 MIME 类型 |
+| min_length | integer | 可选 | 20 | >= 1 | 动态设置 `gzip_min_length` 指令 |
+| comp_level | integer | 可选 | 1 | [1, 9] | 动态设置 `gzip_comp_level` 指令 |
+| http_version | number | 可选 | 1.1 | 1.1, 1.0 | 动态设置 `gzip_http_version` 指令 |
+| buffers.number | integer | 可选 | 32 | >= 1 | 动态设置 `gzip_buffers` 指令 |
+| buffers.size | integer | 可选 | 4096 | >= 1 | 动态设置 `gzip_buffers` 指令 |
+| vary | boolean | 可选 | false | | 动态设置 `gzip_vary` 指令 |
Review comment:
Should we add a link for the `ngx_http_gzip_module` so that people can get the corresponding meaning of each directive.
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,103 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+The `real-ip` 可以动态改变客户端的 `IP` 和端口。
Review comment:
```suggestion
`real-ip` 插件用于动态改变客户端的 `IP` 和端口。
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] huang-x-h commented on a change in pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
huang-x-h commented on a change in pull request #5116:
URL: https://github.com/apache/apisix/pull/5116#discussion_r716322298
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,102 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`real-ip` 插件用于动态改变传递到 `APISIX` 的客户端的 `IP` 和端口。
+
+它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样，并且更为灵活。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| source | string | 必填 | | 任何 Nginx 变量，如 `arg_realip` 或 `http_x_forwarded_for` | 在 `APISIX` 的视图中，根据变量的值动态设置客户端的 `IP` 和端口。如果. 如果该值不包含端口，则不会更改客户端的端口。 |
+| trusted_addresses| array[string] | 可选 | | `IP` 或 `CIDR` 范围列表 | 动态设置 `set_real_ip_from` 指令 |
+
Review comment:
fixed, review plz
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] huang-x-h commented on pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
huang-x-h commented on pull request #5116:
URL: https://github.com/apache/apisix/pull/5116#issuecomment-928877739
> @huang-x-h ,pls take a look at Doc Lint CI error
ok, fixed 😄
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #5116:
URL: https://github.com/apache/apisix/pull/5116#discussion_r716339637
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,102 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`real-ip` 插件用于动态改变传递到 `APISIX` 的客户端的 `IP` 和端口。
+
+它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样，并且更为灵活。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| source | string | 必填 | | 任何 Nginx 变量，如 `arg_realip` 或 `http_x_forwarded_for` | 在 `APISIX` 的视图中，根据变量的值动态设置客户端的 `IP` 和端口。如果. 如果该值不包含端口，则不会更改客户端的端口。 |
+| trusted_addresses| array[string] | 可选 | | `IP` 或 `CIDR` 范围列表 | 动态设置 `set_real_ip_from` 指令 |
+
Review comment:
```
If the remote address comes from `source` is missing or invalid, this plugin will just let it go and don't change the client address.
```
Still miss this part?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] tzssangglass commented on pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on pull request #5116:
URL: https://github.com/apache/apisix/pull/5116#issuecomment-927885325
@huang-x-h ,pls take a look at Doc Lint CI error
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] tzssangglass commented on a change in pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on a change in pull request #5116:
URL: https://github.com/apache/apisix/pull/5116#discussion_r714702432
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,102 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`real-ip` 插件用于动态改变客户端的 `IP` 和端口。
Review comment:
```suggestion
`real-ip` 插件用于动态改变传递到 APISIX 的客户端的 `IP` 和端口。
```
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,102 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`real-ip` 插件用于动态改变客户端的 `IP` 和端口。
+
+它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样，并且更为灵活。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| source | string | 必填 | | 任何 Nginx 变量，如 `arg_realip` 或 `http_x_forwarded_for` | 在 `APISIX` 的视图中，根据变量的值动态设置客户端的IP和端口。如果. 如果该值不包含端口，则不会更改客户端的端口。 |
Review comment:
```suggestion
| source | string | 必填 | | 任何 Nginx 变量，如 `arg_realip` 或 `http_x_forwarded_for` | 在 `APISIX` 的视图中，根据变量的值动态设置客户端的 IP 和端口。如果. 如果该值不包含端口，则不会更改客户端的端口。 |
```
##########
File path: docs/zh/latest/plugins/gzip.md
##########
@@ -0,0 +1,108 @@
+---
+title: gzip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`gzip` 插件能动态设置 `Nginx` 的压缩行为。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| --------------------------------------| ------------| -------------- | -------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| types | array[string] or "*" | 可选 | ["text/html"] | | 动态设置 [`gzip_types`](https://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_types) 指令，特殊值 `"*"` 匹配任何 MIME 类型 |
+| min_length | integer | 可选 | 20 | >= 1 | 动态设置 [`gzip_min_length`](https://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_min_length) 指令 |
+| comp_level | integer | 可选 | 1 | [1, 9] | 动态设置 [`gzip_comp_level`](https://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_comp_level) 指令 |
+| http_version | number | 可选 | 1.1 | 1.1, 1.0 | 动态设置 [`gzip_http_version`](https://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_http_version) 指令 |
+| buffers.number | integer | 可选 | 32 | >= 1 | 动态设置 [`gzip_buffers`](https://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_buffers) 指令 |
+| buffers.size | integer | 可选 | 4096 | >= 1 | 动态设置 [`gzip_buffers`](https://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_buffers) 指令 |
+| vary | boolean | 可选 | false | | 动态设置 [`gzip_vary`](https://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_vary) 指令 |
+
+## 如何启用
+
+下面是一个示例，在指定的 `route` 上开启了 `gzip` 插件：
+
+```shell
+curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "uri": "/index.html",
+ "plugins": {
+ "gzip": {
+ "buffers": {
+ "number": 8
+ }
+ }
+ },
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ }
+ }
+}'
+```
+
+## 测试插件
+
+使用 `curl` 访问：
+
+```shell
+curl http://127.0.0.1:9080/index.html -i -H "Accept-Encoding: gzip"
+HTTP/1.1 404 Not Found
+Content-Type: text/html; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+Date: Wed, 21 Jul 2021 03:52:55 GMT
+Server: APISIX/2.7
+Content-Encoding: gzip
+
+Warning: Binary output can mess up your terminal. Use "--output -" to tell
+Warning: curl to output it to your terminal anyway, or consider "--output
+Warning: <FILE>" to save to a file.
+```
+
+## 禁用插件
+
+想要禁用该插件时很简单，在路由 `plugins` 配置块中删除对应`JSON`配置，不需要重启服务，即可立即生效禁用该插件。
Review comment:
```suggestion
想要禁用该插件时很简单，在路由 `plugins` 配置块中删除对应 `JSON` 配置，不需要重启服务，即可立即生效禁用该插件。
```
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,102 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`real-ip` 插件用于动态改变客户端的 `IP` 和端口。
+
+它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样，并且更为灵活。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| source | string | 必填 | | 任何 Nginx 变量，如 `arg_realip` 或 `http_x_forwarded_for` | 在 `APISIX` 的视图中，根据变量的值动态设置客户端的IP和端口。如果. 如果该值不包含端口，则不会更改客户端的端口。 |
+| trusted_addresses| array[string] | 可选 | | `IP` 或 `CIDR` 范围列表 | 动态设置 `set_real_ip_from` 指令 |
+
+## 如何启用
+
+下面是一个示例，在指定的 `route` 上开启了 `real-ip` 插件：
+
+```shell
+curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "uri": "/index.html",
+ "plugins": {
+ "real-ip": {
+ "source": "arg_realip",
+ "trusted_addresses": ["127.0.0.0/24"]
+ },
+ "response-rewrite": {
+ "headers": {
+ "remote_addr": "$remote_addr",
+ "remote_port": "$remote_port"
+ }
+ }
+ },
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ }
+ }
+}'
+```
+
+## 测试插件
+
+使用 `curl` 访问：
+
+```shell
+curl 'http://127.0.0.1:9080/index.html?realip=1.2.3.4:9080' -I
+...
+remote-addr: 1.2.3.4
+remote-port: 9080
+```
+
+## 禁用插件
+
+想要禁用该插件时很简单，在路由 `plugins` 配置块中删除对应`JSON`配置，不需要重启服务，即可立即生效禁用该插件。
Review comment:
```suggestion
想要禁用该插件时很简单，在路由 `plugins` 配置块中删除对应 `JSON` 配置，不需要重启服务，即可立即生效禁用该插件。
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] huang-x-h commented on pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
huang-x-h commented on pull request #5116:
URL: https://github.com/apache/apisix/pull/5116#issuecomment-928877739
> @huang-x-h ,pls take a look at Doc Lint CI error
ok, fixed 😄
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #5116:
URL: https://github.com/apache/apisix/pull/5116#discussion_r717265265
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,104 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`real-ip` 插件用于动态改变传递到 `APISIX` 的客户端的 `IP` 和端口。
+
+它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样，并且更为灵活。
+
+**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| source | string | 必填 | | 任何 Nginx 变量，如 `arg_realip` 或 `http_x_forwarded_for` | 根据变量的值 `APISIX` 动态设置客户端的 `IP` 和端口。如果该值不包含端口，则不会更改客户端的端口。 |
+| trusted_addresses| array[string] | 可选 | | `IP` 或 `CIDR` 范围列表 | 动态设置 `set_real_ip_from` 指令 |
+
+如果 `source` 远程地址设置缺失或无效，该插件则直接放行，不会更改客户端地址。
Review comment:
```suggestion
如果 `source` 设置的远程地址缺失或无效，该插件则直接放行，不会更改客户端地址。
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander merged pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #5116:
URL: https://github.com/apache/apisix/pull/5116
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] tzssangglass commented on a change in pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on a change in pull request #5116:
URL: https://github.com/apache/apisix/pull/5116#discussion_r714437984
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,103 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+The `real-ip` 可以动态改变客户端的 `IP` 和端口。
+
+它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样，并且更为灵活。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-apache-apisix-构建-openresty) 上。**
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| source | string | 必填 | | 任何 Nginx 变量，如 `arg_realip` 或 `http_x_forwarded_for` | 在 `APISIX` 的视图中，根据变量的值动态设置客户端的IP和端口。如果. 如果该值不包含端口，则不会更改客户端的端口。 |
+| trusted_addresses| array[string] | 可选 | | `IP` 或 `CIDR` 范围列表 | 动态设置 `set_real_ip_from` 指令 |
+
+
Review comment:
```suggestion
```
##########
File path: docs/zh/latest/plugins/gzip.md
##########
@@ -0,0 +1,108 @@
+---
+title: gzip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`gzip` 插件能动态设置 `Nginx` 的压缩行为。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-apache-apisix-构建-openresty) 上。**
Review comment:
ditto
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,103 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+The `real-ip` 可以动态改变客户端的 `IP` 和端口。
+
+它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样，并且更为灵活。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-apache-apisix-构建-openresty) 上。**
Review comment:
```suggestion
**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander merged pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #5116:
URL: https://github.com/apache/apisix/pull/5116
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #5116:
URL: https://github.com/apache/apisix/pull/5116#discussion_r716293392
##########
File path: docs/zh/latest/plugins/gzip.md
##########
@@ -0,0 +1,108 @@
+---
+title: gzip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`gzip` 插件能动态设置 `Nginx` 的压缩行为。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
Review comment:
```suggestion
**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
```
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,102 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`real-ip` 插件用于动态改变传递到 `APISIX` 的客户端的 `IP` 和端口。
+
+它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样，并且更为灵活。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| source | string | 必填 | | 任何 Nginx 变量，如 `arg_realip` 或 `http_x_forwarded_for` | 在 `APISIX` 的视图中，根据变量的值动态设置客户端的 `IP` 和端口。如果. 如果该值不包含端口，则不会更改客户端的端口。 |
+| trusted_addresses| array[string] | 可选 | | `IP` 或 `CIDR` 范围列表 | 动态设置 `set_real_ip_from` 指令 |
+
Review comment:
Miss some part here?
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,102 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`real-ip` 插件用于动态改变传递到 `APISIX` 的客户端的 `IP` 和端口。
+
+它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样，并且更为灵活。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| source | string | 必填 | | 任何 Nginx 变量，如 `arg_realip` 或 `http_x_forwarded_for` | 在 `APISIX` 的视图中，根据变量的值动态设置客户端的 `IP` 和端口。如果. 如果该值不包含端口，则不会更改客户端的端口。 |
Review comment:
in APISIX's view 应该翻译成 APISIX 眼中
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,102 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`real-ip` 插件用于动态改变传递到 `APISIX` 的客户端的 `IP` 和端口。
+
+它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样，并且更为灵活。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
Review comment:
```suggestion
**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] huang-x-h commented on a change in pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
huang-x-h commented on a change in pull request #5116:
URL: https://github.com/apache/apisix/pull/5116#discussion_r716375722
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,102 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`real-ip` 插件用于动态改变传递到 `APISIX` 的客户端的 `IP` 和端口。
+
+它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样，并且更为灵活。
+
+**该插件依赖 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| source | string | 必填 | | 任何 Nginx 变量，如 `arg_realip` 或 `http_x_forwarded_for` | 在 `APISIX` 的视图中，根据变量的值动态设置客户端的 `IP` 和端口。如果. 如果该值不包含端口，则不会更改客户端的端口。 |
+| trusted_addresses| array[string] | 可选 | | `IP` 或 `CIDR` 范围列表 | 动态设置 `set_real_ip_from` 指令 |
+
Review comment:
i forgot it 😢 , now add the part
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #5116: docs: add gzip and real-ip zh docs
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #5116:
URL: https://github.com/apache/apisix/pull/5116#discussion_r717265265
##########
File path: docs/zh/latest/plugins/real-ip.md
##########
@@ -0,0 +1,104 @@
+---
+title: real-ip
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 目录
+
+- [**简介**](#简介)
+- [**属性**](#属性)
+- [**如何启用**](#如何启用)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 简介
+
+`real-ip` 插件用于动态改变传递到 `APISIX` 的客户端的 `IP` 和端口。
+
+它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样，并且更为灵活。
+
+**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤6：为-Apache-APISIX-构建-OpenResty) 上。**
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| source | string | 必填 | | 任何 Nginx 变量，如 `arg_realip` 或 `http_x_forwarded_for` | 根据变量的值 `APISIX` 动态设置客户端的 `IP` 和端口。如果该值不包含端口，则不会更改客户端的端口。 |
+| trusted_addresses| array[string] | 可选 | | `IP` 或 `CIDR` 范围列表 | 动态设置 `set_real_ip_from` 指令 |
+
+如果 `source` 远程地址设置缺失或无效，该插件则直接放行，不会更改客户端地址。
Review comment:
```suggestion
如果 `source` 设置的远程地址缺失或无效，该插件则直接放行，不会更改客户端地址。
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org