This is an automated email from the ASF dual-hosted git repository.
spacewander 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 0d1280cde docs: replace all apisix-openresty to apisix-base (#6998)
0d1280cde is described below
commit 0d1280cde7fcd463f2e86941935e053561bcf331
Author: oil欧呦 <[email protected]>
AuthorDate: Sun May 8 19:40:10 2022 +0800
docs: replace all apisix-openresty to apisix-base (#6998)
---
apisix/plugins/client-control.lua | 2 +-
apisix/plugins/gzip.lua | 2 +-
apisix/plugins/proxy-control.lua | 2 +-
apisix/plugins/real-ip.lua | 2 +-
apisix/upstream.lua | 4 ++--
apisix/wasm.lua | 2 +-
conf/config-default.yaml | 2 +-
docs/en/latest/admin-api.md | 2 +-
docs/en/latest/mtls.md | 4 ++--
docs/en/latest/plugins/client-control.md | 2 +-
docs/en/latest/plugins/gzip.md | 2 +-
docs/en/latest/plugins/proxy-control.md | 2 +-
docs/en/latest/plugins/real-ip.md | 2 +-
docs/en/latest/wasm.md | 2 +-
docs/zh/latest/admin-api.md | 4 ++--
docs/zh/latest/mtls.md | 4 ++--
docs/zh/latest/plugins/client-control.md | 2 +-
docs/zh/latest/plugins/gzip.md | 2 +-
docs/zh/latest/plugins/proxy-control.md | 2 +-
docs/zh/latest/plugins/real-ip.md | 2 +-
20 files changed, 24 insertions(+), 24 deletions(-)
diff --git a/apisix/plugins/client-control.lua
b/apisix/plugins/client-control.lua
index 89e7e8b36..c72ee4190 100644
--- a/apisix/plugins/client-control.lua
+++ b/apisix/plugins/client-control.lua
@@ -49,7 +49,7 @@ end
function _M.rewrite(conf, ctx)
if not ok then
- core.log.error("need to build APISIX-OpenResty to support client
control")
+ core.log.error("need to build APISIX-Base to support client control")
return 501
end
diff --git a/apisix/plugins/gzip.lua b/apisix/plugins/gzip.lua
index 0c70801fd..d9f319d01 100644
--- a/apisix/plugins/gzip.lua
+++ b/apisix/plugins/gzip.lua
@@ -102,7 +102,7 @@ end
function _M.header_filter(conf, ctx)
if not is_apisix_or then
- core.log.error("need to build APISIX-OpenResty to support setting
gzip")
+ core.log.error("need to build APISIX-Base to support setting gzip")
return 501
end
diff --git a/apisix/plugins/proxy-control.lua b/apisix/plugins/proxy-control.lua
index 93ddc0ffc..9b9246b2f 100644
--- a/apisix/plugins/proxy-control.lua
+++ b/apisix/plugins/proxy-control.lua
@@ -47,7 +47,7 @@ end
-- we want to control proxy behavior before auth, so put the code under
rewrite method
function _M.rewrite(conf, ctx)
if not ok then
- core.log.error("need to build APISIX-OpenResty to support proxy
control")
+ core.log.error("need to build APISIX-Base to support proxy control")
return 501
end
diff --git a/apisix/plugins/real-ip.lua b/apisix/plugins/real-ip.lua
index 95af58f9d..7b6600f2a 100644
--- a/apisix/plugins/real-ip.lua
+++ b/apisix/plugins/real-ip.lua
@@ -100,7 +100,7 @@ end
function _M.rewrite(conf, ctx)
if not is_apisix_or then
- core.log.error("need to build APISIX-OpenResty to support setting real
ip")
+ core.log.error("need to build APISIX-Base to support setting real ip")
return 501
end
diff --git a/apisix/upstream.lua b/apisix/upstream.lua
index da88e06e2..93c591c50 100644
--- a/apisix/upstream.lua
+++ b/apisix/upstream.lua
@@ -36,7 +36,7 @@ if ok then
set_upstream_tls_client_param = apisix_ngx_upstream.set_cert_and_key
else
set_upstream_tls_client_param = function ()
- return nil, "need to build APISIX-OpenResty to support upstream mTLS"
+ return nil, "need to build APISIX-Base to support upstream mTLS"
end
end
@@ -47,7 +47,7 @@ if not is_http then
set_stream_upstream_tls = apisix_ngx_stream_upstream.set_tls
else
set_stream_upstream_tls = function ()
- return nil, "need to build APISIX-OpenResty to support TLS over
TCP upstream"
+ return nil, "need to build APISIX-Base to support TLS over TCP
upstream"
end
end
end
diff --git a/apisix/wasm.lua b/apisix/wasm.lua
index 56a44b857..a27641504 100644
--- a/apisix/wasm.lua
+++ b/apisix/wasm.lua
@@ -148,7 +148,7 @@ end
function _M.require(attrs)
if not support_wasm then
- return nil, "need to build APISIX-OpenResty to support wasm"
+ return nil, "need to build APISIX-Base to support wasm"
end
local name = attrs.name
diff --git a/conf/config-default.yaml b/conf/config-default.yaml
index 2d266b5b7..0888743dd 100644
--- a/conf/config-default.yaml
+++ b/conf/config-default.yaml
@@ -284,7 +284,7 @@ etcd:
#user: root # root username for etcd
#password: 5tHkHhYkjr6cQY # root password for etcd
tls:
- # To enable etcd client certificate you need to build APISIX-OpenResty, see
+ # To enable etcd client certificate you need to build APISIX-Base, see
#
https://apisix.apache.org/docs/apisix/how-to-build/#step-6-build-openresty-for-apache-apisix
#cert: /path/to/cert # path of certificate used by the etcd client
#key: /path/to/key # path of key used by the etcd client
diff --git a/docs/en/latest/admin-api.md b/docs/en/latest/admin-api.md
index d4f0c8dab..6b8450623 100644
--- a/docs/en/latest/admin-api.md
+++ b/docs/en/latest/admin-api.md
@@ -564,7 +564,7 @@ The following should be considered when setting the
`hash_on` value:
- When set to `vars_combinations`, the `key` is required. The value of the key
can be a combination of any of the [Nginx
variables](http://nginx.org/en/docs/varindex.html) like
`$request_uri$remote_addr`.
- When no value is set for either `hash_on` or `key`, the key defaults to
`remote_addr`.
-The features described below requires APISIX to be run on
[APISIX-OpenResty](./how-to-build.md#step-6-build-openresty-for-apache-apisix):
+The features described below requires APISIX to be run on
[APISIX-Base](./how-to-build.md#step-6-build-openresty-for-apache-apisix):
You can set the `scheme` to `tls`, which means "TLS over TCP".
diff --git a/docs/en/latest/mtls.md b/docs/en/latest/mtls.md
index 70db59cc2..8bedef225 100644
--- a/docs/en/latest/mtls.md
+++ b/docs/en/latest/mtls.md
@@ -66,7 +66,7 @@ curl --cacert /data/certs/mtls_ca.crt --key
/data/certs/mtls_client.key --cert /
### How to configure
-You need to [build
APISIX-OpenResty](./how-to-build.md#step-6-build-openresty-for-apache-apisix)
and configure `etcd.tls` section if you want APISIX to work on an etcd cluster
with mTLS enabled.
+You need to [build
APISIX-Base](./how-to-build.md#step-6-build-openresty-for-apache-apisix) and
configure `etcd.tls` section if you want APISIX to work on an etcd cluster with
mTLS enabled.
```yaml
etcd:
@@ -154,7 +154,7 @@ Sometimes the upstream requires mTLS. In this situation,
the APISIX acts as the
When configuring `upstreams`, we could use parameter `tls.client_cert` and
`tls.client_key` to configure the client certificate APISIX used to communicate
with upstreams. Please refer to [Admin API](./admin-api.md#upstream) for
details.
-This feature requires APISIX to run on
[APISIX-OpenResty](./how-to-build.md#step-6-build-openresty-for-apache-apisix).
+This feature requires APISIX to run on
[APISIX-Base](./how-to-build.md#step-6-build-openresty-for-apache-apisix).
Here is a similar Python script to patch a existed upstream with mTLS (changes
admin API url if needed):
diff --git a/docs/en/latest/plugins/client-control.md
b/docs/en/latest/plugins/client-control.md
index c6a20dfd3..1252fec86 100644
--- a/docs/en/latest/plugins/client-control.md
+++ b/docs/en/latest/plugins/client-control.md
@@ -26,7 +26,7 @@ title: client-control
The `client-control` plugin dynamically controls the behavior of Nginx to
handle the client request.
-**This plugin requires APISIX to run on
[APISIX-OpenResty](../how-to-build.md#step-6-build-openresty-for-apache-apisix).**
+**This plugin requires APISIX to run on
[APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix).**
## Attributes
diff --git a/docs/en/latest/plugins/gzip.md b/docs/en/latest/plugins/gzip.md
index 4daf85966..dc35d151c 100644
--- a/docs/en/latest/plugins/gzip.md
+++ b/docs/en/latest/plugins/gzip.md
@@ -32,7 +32,7 @@ The `gzip` Plugin dynamically sets the behavior of [gzip in
Nginx](https://docs.
:::info IMPORTANT
-This Plugin requires APISIX to run on
[APISIX-OpenResty](../how-to-build.md#step-6-build-openresty-for-apache-apisix).
+This Plugin requires APISIX to run on
[APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix).
:::
diff --git a/docs/en/latest/plugins/proxy-control.md
b/docs/en/latest/plugins/proxy-control.md
index 6c021c3b5..77748a58c 100644
--- a/docs/en/latest/plugins/proxy-control.md
+++ b/docs/en/latest/plugins/proxy-control.md
@@ -25,7 +25,7 @@ title: proxy-control
The `proxy-control` plugin dynamically controls the behavior of Nginx to proxy.
-**This plugin requires APISIX to run on
[APISIX-OpenResty](../how-to-build.md#step-6-build-openresty-for-apache-apisix).**
+**This plugin requires APISIX to run on
[APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix).**
## Attributes
diff --git a/docs/en/latest/plugins/real-ip.md
b/docs/en/latest/plugins/real-ip.md
index 2daf8c453..45c4ceb67 100644
--- a/docs/en/latest/plugins/real-ip.md
+++ b/docs/en/latest/plugins/real-ip.md
@@ -35,7 +35,7 @@ This is more flexible but functions similarly to Nginx's
[ngx_http_realip_module
:::info IMPORTANT
-This Plugin requires APISIX to run on
[APISIX-OpenResty](../how-to-build.md#step-6-build-openresty-for-apache-apisix).
+This Plugin requires APISIX to run on
[APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix).
:::
diff --git a/docs/en/latest/wasm.md b/docs/en/latest/wasm.md
index f0579c5bb..188d08c62 100644
--- a/docs/en/latest/wasm.md
+++ b/docs/en/latest/wasm.md
@@ -23,7 +23,7 @@ title: Wasm
APISIX supports Wasm plugins written with [Proxy Wasm
SDK](https://github.com/proxy-wasm/spec#sdks).
-This plugin requires APISIX to run on
[APISIX-OpenResty](../how-to-build.md#step-6-build-openresty-for-apache-apisix),
and is under construction.
+This plugin requires APISIX to run on
[APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix), and
is under construction.
Currently, only a few APIs are implemented. Please follow
[wasm-nginx-module](https://github.com/api7/wasm-nginx-module) to know the
progress.
## Programming model
diff --git a/docs/zh/latest/admin-api.md b/docs/zh/latest/admin-api.md
index a5c8c3941..60427aec1 100644
--- a/docs/zh/latest/admin-api.md
+++ b/docs/zh/latest/admin-api.md
@@ -571,7 +571,7 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外，还支持对上
4. 设为 `consumer` 时，`key` 不需要设置。此时哈希算法采用的 `key` 为认证通过的 `consumer_name`。
5. 如果指定的 `hash_on` 和 `key` 获取不到值时，就是用默认值：`remote_addr`。
-以下特性需要 APISIX 运行于
[APISIX-OpenResty](./how-to-build.md#步骤-6-为-apache-apisix-构建-openresty)：
+以下特性需要 APISIX 运行于
[APISIX-Base](./how-to-build.md#步骤-6-为-apache-apisix-构建-openresty)：
`scheme` 可以设置成 `tls`，表示 "TLS over TCP"。
@@ -580,7 +580,7 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外，还支持对上
`keepalive_pool` 允许 upstream 对象有自己单独的连接池。
它下属的字段，比如 `requests`，可以用了配置上游连接保持的参数。
-这个特性需要 APISIX 运行于
[APISIX-OpenResty](./how-to-build.md#步骤-6-为-apache-apisix-构建-openresty)。
+这个特性需要 APISIX 运行于
[APISIX-Base](./how-to-build.md#步骤-6-为-apache-apisix-构建-openresty)。
**upstream 对象 json 配置内容：**
diff --git a/docs/zh/latest/mtls.md b/docs/zh/latest/mtls.md
index fb5b72703..a9ab836f9 100644
--- a/docs/zh/latest/mtls.md
+++ b/docs/zh/latest/mtls.md
@@ -66,7 +66,7 @@ curl --cacert /data/certs/mtls_ca.crt --key
/data/certs/mtls_client.key --cert /
### 如何配置
-你需要构建
[APISIX-OpenResty](./how-to-build.md#步骤-6-为-apache-apisix-构建-openresty)，并且需要在配置文件中设定
`etcd.tls` 来使 ETCD 的双向认证功能正常工作。
+你需要构建
[APISIX-Base](./how-to-build.md#步骤-6-为-apache-apisix-构建-openresty)，并且需要在配置文件中设定
`etcd.tls` 来使 ETCD 的双向认证功能正常工作。
```yaml
etcd:
@@ -154,7 +154,7 @@ curl --resolve
'mtls.test.com:<APISIX_HTTPS_PORT>:<APISIX_URL>' "https://<APISIX
在配置 upstream 资源时，可以使用参数 `tls.client_cert` 和 `tls.client_key` 来配置 APISIX
用于与上游进行通讯时使用的证书。可参考 [Upstream API 文档](./admin-api.md#upstream)。
-该功能需要 APISIX 运行在
[APISIX-OpenResty](./how-to-build.md#步骤-6-为-apache-apisix-构建-openresty) 上。
+该功能需要 APISIX 运行在
[APISIX-Base](./how-to-build.md#步骤-6-为-apache-apisix-构建-openresty) 上。
下面是一个与配置 SSL 时相似的 Python 脚本，可为一个已存在的 upstream 资源配置双向认证。如果需要，可修改 API 地址和 API
Key。
diff --git a/docs/zh/latest/plugins/client-control.md
b/docs/zh/latest/plugins/client-control.md
index dff796dad..6a52ba207 100644
--- a/docs/zh/latest/plugins/client-control.md
+++ b/docs/zh/latest/plugins/client-control.md
@@ -25,7 +25,7 @@ title: client-control
`client-control` 插件能够动态地控制 Nginx 处理客户端的请求的行为。
-**这个插件需要 APISIX 在
[APISIX-OpenResty](../how-to-build.md#step-6-build-openresty-for-apache-apisix)
上运行。**
+**这个插件需要 APISIX 在
[APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix)
上运行。**
## 属性
diff --git a/docs/zh/latest/plugins/gzip.md b/docs/zh/latest/plugins/gzip.md
index 6048ec93c..96bda06d4 100644
--- a/docs/zh/latest/plugins/gzip.md
+++ b/docs/zh/latest/plugins/gzip.md
@@ -32,7 +32,7 @@ description: 本文介绍了关于 Apache APISIX `gzip` 插件的基本信息及
:::info IMPORTANT
-该插件要求 Apache APISIX 运行在
[APISIX-OpenResty](../how-to-build.md#步骤-6-为-apache-apisix-构建-openresty) 上。
+该插件要求 Apache APISIX 运行在
[APISIX-Base](../how-to-build.md#步骤-6-为-apache-apisix-构建-openresty) 上。
:::
diff --git a/docs/zh/latest/plugins/proxy-control.md
b/docs/zh/latest/plugins/proxy-control.md
index 4572b4491..d2296ad71 100644
--- a/docs/zh/latest/plugins/proxy-control.md
+++ b/docs/zh/latest/plugins/proxy-control.md
@@ -25,7 +25,7 @@ title: proxy-control
`proxy-control` 能够动态地控制 Nginx 代理的行为。
-**这个插件需要 APISIX 在
[APISIX-OpenResty](../how-to-build.md#步骤-6-为-apache-apisix-构建-openresty) 上运行。**
+**这个插件需要 APISIX 在
[APISIX-Base](../how-to-build.md#步骤-6-为-apache-apisix-构建-openresty) 上运行。**
## 属性
diff --git a/docs/zh/latest/plugins/real-ip.md
b/docs/zh/latest/plugins/real-ip.md
index 6ac810871..9e16e5ff5 100644
--- a/docs/zh/latest/plugins/real-ip.md
+++ b/docs/zh/latest/plugins/real-ip.md
@@ -35,7 +35,7 @@ description: 本文介绍了关于 Apache APISIX `real-ip` 插件的基本信息
:::info IMPORTANT
-该插件要求 APISIX 运行在
[APISIX-OpenResty](../how-to-build.md#步骤-6-为-apache-apisix-构建-openresty) 上。
+该插件要求 APISIX 运行在
[APISIX-Base](../how-to-build.md#步骤-6-为-apache-apisix-构建-openresty) 上。
:::
