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 a3484fc85 docs: update docs about redis username and password for
plugin `limit-count` (#9933)
a3484fc85 is described below
commit a3484fc85b1546d890c01ed747142818213598f2
Author: Traky Deng <[email protected]>
AuthorDate: Mon Jul 31 16:17:57 2023 +0800
docs: update docs about redis username and password for plugin
`limit-count` (#9933)
---
docs/en/latest/plugins/limit-count.md | 4 ++--
docs/zh/latest/plugins/limit-count.md | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/en/latest/plugins/limit-count.md
b/docs/en/latest/plugins/limit-count.md
index ae34ad372..24164a756 100644
--- a/docs/en/latest/plugins/limit-count.md
+++ b/docs/en/latest/plugins/limit-count.md
@@ -46,8 +46,8 @@ The `limit-count` Plugin limits the number of requests to
your service by a give
| group | string | False
| | non-empty | Group to share the
counter with. Routes configured with the same group will share the counter.
[...]
| redis_host | string | required when `policy` is `redis`
| | | Address of the
Redis server. Used when the `policy` attribute is set to `redis`.
[...]
| redis_port | integer | False
| 6379 | [1,...] | Port of the Redis
server. Used when the `policy` attribute is set to `redis`.
[...]
-| redis_username | string | False
| | | Username use to
authenticate to the Redis server for version >= 6.0, use only `redis_password`
for the versions prior. Used when the `policy` is set to `redis`.
[...]
-| redis_password | string | False
| | | Password of the
Redis server. Used when the `policy` is set to `redis` or `redis-cluster`.
[...]
+| redis_username | string | False
| | | Username for Redis
authentication if Redis ACL is used (for Redis version >= 6.0). If you use the
legacy authentication method `requirepass` to configure Redis password,
configure only the `redis_password`. Used when the `policy` is set to `redis`.
[...]
+| redis_password | string | False
| | | Password for Redis
authentication. Used when the `policy` is set to `redis` or `redis-cluster`.
[...]
| redis_ssl | boolean | False
| false | | If set to `true`,
then uses SSL to connect to redis instance. Used when the `policy` attribute is
set to `redis`.
[...]
| redis_ssl_verify | boolean | False
| false | | If set to `true`,
then verifies the validity of the server SSL certificate. Used when the
`policy` attribute is set to `redis`. See
[tcpsock:sslhandshake](https://github.com/openresty/lua-nginx-module#tcpsocksslhandshake).
[...]
| redis_database | integer | False
| 0 | redis_database >= 0 | Selected database
of the Redis server (for single instance operation or when using Redis cloud
with a single entrypoint). Used when the `policy` attribute is set to `redis`.
[...]
diff --git a/docs/zh/latest/plugins/limit-count.md
b/docs/zh/latest/plugins/limit-count.md
index 675ecb660..467666b8a 100644
--- a/docs/zh/latest/plugins/limit-count.md
+++ b/docs/zh/latest/plugins/limit-count.md
@@ -47,7 +47,7 @@ description: 本文介绍了 Apache APISIX limit-count 插件的相关操作，
| group | string | 否 | | 非空
| 配置相同 group 的路由将共享相同的限流计数器。 |
| redis_host | string | 否 | |
| 当使用 `redis` 限速策略时，Redis 服务节点的地址。**当 `policy` 属性设置为
`redis` 时必选。**|
| redis_port | integer | 否 | 6379 | [1,...]
| 当使用 `redis` 限速策略时，Redis 服务节点的端口。|
-| redis_username | string | 否 | |
| Redis 服务器的用户名。当 `policy` 设置为 `redis` 时使用。|
+| redis_username | string | 否 | |
| 若使用 Redis ACL 进行身份验证（适用于 Redis 版本 >=6.0），则需要提供 Redis
用户名。若使用 Redis legacy 方式 `requirepass` 进行身份验证，则只需将密码配置在 `redis_password`。当
`policy` 设置为 `redis` 时使用。|
| redis_password | string | 否 | |
| 当使用 `redis` 或者 `redis-cluster` 限速策略时，Redis 服务节点的密码。|
| redis_ssl | boolean | 否 | false |
| 当使用 `redis` 限速策略时，如果设置为 true，则使用 SSL 连接到 `redis` |
| redis_ssl_verify | boolean | 否 | false |
| 当使用 `redis` 限速策略时，如果设置为 true，则验证服务器 SSL 证书的有效性，具体请参考
[tcpsock:sslhandshake](https://github.com/openresty/lua-nginx-module#tcpsocksslhandshake).
|
