From ec03ce8e1dced5d58e9eb737028299ccf3b01d87 Mon Sep 17 00:00:00 2001 From: Ashish Tiwari Date: Tue, 2 Apr 2024 12:57:52 +0530 Subject: [PATCH] apply doc suggestion --- docs/en/latest/FAQ.md | 3 +-- docs/en/latest/admin-api.md | 3 +-- docs/en/latest/batch-processor.md | 3 +-- docs/en/latest/benchmark.md | 3 +-- docs/en/latest/certificate.md | 3 +-- docs/en/latest/debug-function.md | 3 +-- docs/en/latest/discovery.md | 3 +-- docs/en/latest/discovery/consul.md | 3 +-- docs/en/latest/discovery/consul_kv.md | 3 +-- docs/en/latest/discovery/nacos.md | 3 +-- docs/en/latest/grpc-proxy.md | 3 +-- docs/en/latest/mtls.md | 3 +-- docs/en/latest/plugin-develop.md | 3 +-- docs/en/latest/plugins/api-breaker.md | 3 +-- docs/en/latest/plugins/authz-casbin.md | 3 +-- docs/en/latest/plugins/authz-casdoor.md | 3 +-- docs/en/latest/plugins/authz-keycloak.md | 3 +-- docs/en/latest/plugins/aws-lambda.md | 3 +-- docs/en/latest/plugins/azure-functions.md | 3 +-- docs/en/latest/plugins/basic-auth.md | 3 +-- docs/en/latest/plugins/batch-requests.md | 3 +-- docs/en/latest/plugins/body-transformer.md | 3 +-- docs/en/latest/plugins/brotli.md | 3 +-- docs/en/latest/plugins/cas-auth.md | 3 +-- docs/en/latest/plugins/chaitin-waf.md | 3 +-- docs/en/latest/plugins/clickhouse-logger.md | 3 +-- docs/en/latest/plugins/client-control.md | 3 +-- docs/en/latest/plugins/consumer-restriction.md | 3 +-- docs/en/latest/plugins/cors.md | 3 +-- docs/en/latest/plugins/csrf.md | 3 +-- docs/en/latest/plugins/datadog.md | 3 +-- docs/en/latest/plugins/degraphql.md | 3 +-- docs/en/latest/plugins/dubbo-proxy.md | 3 +-- docs/en/latest/plugins/echo.md | 3 +-- docs/en/latest/plugins/elasticsearch-logger.md | 3 +-- docs/en/latest/plugins/error-log-logger.md | 3 +-- docs/en/latest/plugins/ext-plugin-post-resp.md | 3 +-- docs/en/latest/plugins/ext-plugin-pre-req.md | 3 +-- docs/en/latest/plugins/fault-injection.md | 3 +-- docs/en/latest/plugins/file-logger.md | 3 +-- docs/en/latest/plugins/forward-auth.md | 3 +-- docs/en/latest/plugins/google-cloud-logging.md | 3 +-- docs/en/latest/plugins/grpc-transcode.md | 3 +-- docs/en/latest/plugins/grpc-web.md | 3 +-- docs/en/latest/plugins/gzip.md | 3 +-- docs/en/latest/plugins/hmac-auth.md | 3 +-- docs/en/latest/plugins/http-logger.md | 3 +-- docs/en/latest/plugins/inspect.md | 3 +-- docs/en/latest/plugins/ip-restriction.md | 3 +-- docs/en/latest/plugins/jwe-decrypt.md | 3 +-- docs/en/latest/plugins/jwt-auth.md | 3 +-- docs/en/latest/plugins/kafka-logger.md | 3 +-- docs/en/latest/plugins/key-auth.md | 3 +-- docs/en/latest/plugins/ldap-auth.md | 3 +-- docs/en/latest/plugins/limit-conn.md | 3 +-- docs/en/latest/plugins/limit-count.md | 3 +-- docs/en/latest/plugins/limit-req.md | 3 +-- docs/en/latest/plugins/loggly.md | 3 +-- docs/en/latest/plugins/loki-logger.md | 3 +-- docs/en/latest/plugins/mocking.md | 3 +-- docs/en/latest/plugins/mqtt-proxy.md | 3 +-- docs/en/latest/plugins/multi-auth.md | 3 +-- docs/en/latest/plugins/node-status.md | 3 +-- docs/en/latest/plugins/ocsp-stapling.md | 3 +-- docs/en/latest/plugins/opa.md | 3 +-- docs/en/latest/plugins/openfunction.md | 3 +-- docs/en/latest/plugins/openid-connect.md | 3 +-- docs/en/latest/plugins/opentelemetry.md | 3 +-- docs/en/latest/plugins/openwhisk.md | 3 +-- docs/en/latest/plugins/prometheus.md | 3 +-- docs/en/latest/plugins/proxy-cache.md | 3 +-- docs/en/latest/plugins/proxy-control.md | 3 +-- docs/en/latest/plugins/proxy-mirror.md | 3 +-- docs/en/latest/plugins/proxy-rewrite.md | 3 +-- docs/en/latest/plugins/public-api.md | 3 +-- docs/en/latest/plugins/real-ip.md | 3 +-- docs/en/latest/plugins/redirect.md | 3 +-- docs/en/latest/plugins/referer-restriction.md | 3 +-- docs/en/latest/plugins/request-id.md | 3 +-- docs/en/latest/plugins/request-validation.md | 3 +-- docs/en/latest/plugins/response-rewrite.md | 3 +-- docs/en/latest/plugins/rocketmq-logger.md | 3 +-- docs/en/latest/plugins/serverless.md | 3 +-- docs/en/latest/plugins/skywalking-logger.md | 3 +-- docs/en/latest/plugins/skywalking.md | 3 +-- docs/en/latest/plugins/sls-logger.md | 3 +-- docs/en/latest/plugins/splunk-hec-logging.md | 3 +-- docs/en/latest/plugins/syslog.md | 3 +-- docs/en/latest/plugins/tcp-logger.md | 3 +-- docs/en/latest/plugins/tencent-cloud-cls.md | 3 +-- docs/en/latest/plugins/traffic-split.md | 3 +-- docs/en/latest/plugins/ua-restriction.md | 3 +-- docs/en/latest/plugins/udp-logger.md | 3 +-- docs/en/latest/plugins/uri-blocker.md | 3 +-- docs/en/latest/plugins/wolf-rbac.md | 3 +-- docs/en/latest/plugins/workflow.md | 3 +-- docs/en/latest/plugins/zipkin.md | 3 +-- docs/en/latest/router-radixtree.md | 3 +-- docs/en/latest/ssl-protocol.md | 3 +-- docs/en/latest/stream-proxy.md | 3 +-- docs/en/latest/terminology/consumer-group.md | 3 +-- docs/en/latest/terminology/consumer.md | 3 +-- docs/en/latest/terminology/global-rule.md | 3 +-- docs/en/latest/terminology/plugin-config.md | 3 +-- docs/en/latest/terminology/plugin-metadata.md | 3 +-- docs/en/latest/terminology/plugin.md | 3 +-- docs/en/latest/terminology/route.md | 3 +-- docs/en/latest/terminology/secret.md | 3 +-- docs/en/latest/terminology/service.md | 3 +-- docs/en/latest/terminology/upstream.md | 3 +-- docs/en/latest/tutorials/cache-api-responses.md | 3 +-- docs/en/latest/tutorials/client-to-apisix-mtls.md | 3 +-- docs/en/latest/tutorials/health-check.md | 3 +-- docs/en/latest/tutorials/manage-api-consumers.md | 3 +-- docs/en/latest/tutorials/observe-your-api.md | 3 +-- docs/en/latest/tutorials/protect-api.md | 3 +-- docs/en/latest/wasm.md | 3 +-- docs/en/latest/xrpc/redis.md | 3 +-- docs/zh/latest/FAQ.md | 2 +- docs/zh/latest/admin-api.md | 2 +- docs/zh/latest/batch-processor.md | 2 +- docs/zh/latest/benchmark.md | 2 +- docs/zh/latest/certificate.md | 2 +- docs/zh/latest/debug-function.md | 2 +- docs/zh/latest/discovery.md | 2 +- docs/zh/latest/discovery/nacos.md | 2 +- docs/zh/latest/grpc-proxy.md | 2 +- docs/zh/latest/mtls.md | 2 +- docs/zh/latest/plugin-develop.md | 2 +- docs/zh/latest/plugins/api-breaker.md | 2 +- docs/zh/latest/plugins/authz-casbin.md | 2 +- docs/zh/latest/plugins/authz-casdoor.md | 2 +- docs/zh/latest/plugins/authz-keycloak.md | 2 +- docs/zh/latest/plugins/aws-lambda.md | 2 +- docs/zh/latest/plugins/azure-functions.md | 2 +- docs/zh/latest/plugins/basic-auth.md | 2 +- docs/zh/latest/plugins/batch-requests.md | 2 +- docs/zh/latest/plugins/brotli.md | 2 +- docs/zh/latest/plugins/chaitin-waf.md | 2 +- docs/zh/latest/plugins/clickhouse-logger.md | 2 +- docs/zh/latest/plugins/client-control.md | 2 +- docs/zh/latest/plugins/consumer-restriction.md | 2 +- docs/zh/latest/plugins/cors.md | 2 +- docs/zh/latest/plugins/csrf.md | 2 +- docs/zh/latest/plugins/datadog.md | 2 +- docs/zh/latest/plugins/dubbo-proxy.md | 2 +- docs/zh/latest/plugins/echo.md | 4 ++-- docs/zh/latest/plugins/elasticsearch-logger.md | 2 +- docs/zh/latest/plugins/error-log-logger.md | 2 +- docs/zh/latest/plugins/ext-plugin-post-resp.md | 2 +- docs/zh/latest/plugins/ext-plugin-pre-req.md | 2 +- docs/zh/latest/plugins/fault-injection.md | 2 +- docs/zh/latest/plugins/file-logger.md | 2 +- docs/zh/latest/plugins/forward-auth.md | 2 +- docs/zh/latest/plugins/google-cloud-logging.md | 2 +- docs/zh/latest/plugins/grpc-transcode.md | 2 +- docs/zh/latest/plugins/grpc-web.md | 2 +- docs/zh/latest/plugins/gzip.md | 2 +- docs/zh/latest/plugins/hmac-auth.md | 2 +- docs/zh/latest/plugins/http-logger.md | 2 +- docs/zh/latest/plugins/ip-restriction.md | 2 +- docs/zh/latest/plugins/jwe-decrypt.md | 2 +- docs/zh/latest/plugins/jwt-auth.md | 2 +- docs/zh/latest/plugins/kafka-logger.md | 2 +- docs/zh/latest/plugins/key-auth.md | 2 +- docs/zh/latest/plugins/ldap-auth.md | 2 +- docs/zh/latest/plugins/limit-conn.md | 2 +- docs/zh/latest/plugins/limit-count.md | 2 +- docs/zh/latest/plugins/limit-req.md | 2 +- docs/zh/latest/plugins/loggly.md | 2 +- docs/zh/latest/plugins/loki-logger.md | 2 +- docs/zh/latest/plugins/mocking.md | 2 +- docs/zh/latest/plugins/mqtt-proxy.md | 2 +- docs/zh/latest/plugins/multi-auth.md | 4 ++-- docs/zh/latest/plugins/node-status.md | 2 +- docs/zh/latest/plugins/ocsp-stapling.md | 2 +- docs/zh/latest/plugins/opa.md | 2 +- docs/zh/latest/plugins/openfunction.md | 2 +- docs/zh/latest/plugins/openid-connect.md | 2 +- docs/zh/latest/plugins/opentelemetry.md | 2 +- docs/zh/latest/plugins/openwhisk.md | 2 +- docs/zh/latest/plugins/prometheus.md | 2 +- docs/zh/latest/plugins/proxy-cache.md | 2 +- docs/zh/latest/plugins/proxy-control.md | 2 +- docs/zh/latest/plugins/proxy-mirror.md | 2 +- docs/zh/latest/plugins/proxy-rewrite.md | 2 +- docs/zh/latest/plugins/public-api.md | 2 +- docs/zh/latest/plugins/real-ip.md | 2 +- docs/zh/latest/plugins/redirect.md | 2 +- docs/zh/latest/plugins/referer-restriction.md | 2 +- docs/zh/latest/plugins/request-id.md | 2 +- docs/zh/latest/plugins/request-validation.md | 2 +- docs/zh/latest/plugins/response-rewrite.md | 2 +- docs/zh/latest/plugins/rocketmq-logger.md | 2 +- docs/zh/latest/plugins/serverless.md | 2 +- docs/zh/latest/plugins/skywalking-logger.md | 2 +- docs/zh/latest/plugins/skywalking.md | 2 +- docs/zh/latest/plugins/sls-logger.md | 2 +- docs/zh/latest/plugins/splunk-hec-logging.md | 2 +- docs/zh/latest/plugins/syslog.md | 2 +- docs/zh/latest/plugins/tcp-logger.md | 2 +- docs/zh/latest/plugins/tencent-cloud-cls.md | 2 +- docs/zh/latest/plugins/traffic-split.md | 2 +- docs/zh/latest/plugins/ua-restriction.md | 2 +- docs/zh/latest/plugins/udp-logger.md | 2 +- docs/zh/latest/plugins/uri-blocker.md | 2 +- docs/zh/latest/plugins/wolf-rbac.md | 2 +- docs/zh/latest/plugins/workflow.md | 2 +- docs/zh/latest/plugins/zipkin.md | 2 +- docs/zh/latest/router-radixtree.md | 4 ++-- docs/zh/latest/ssl-protocol.md | 2 +- docs/zh/latest/stream-proxy.md | 2 +- docs/zh/latest/terminology/consumer-group.md | 2 +- docs/zh/latest/terminology/consumer.md | 2 +- docs/zh/latest/terminology/global-rule.md | 2 +- docs/zh/latest/terminology/plugin-config.md | 2 +- docs/zh/latest/terminology/plugin-metadata.md | 2 +- docs/zh/latest/terminology/plugin.md | 2 +- docs/zh/latest/terminology/route.md | 2 +- docs/zh/latest/terminology/secret.md | 2 +- docs/zh/latest/terminology/service.md | 2 +- docs/zh/latest/terminology/upstream.md | 2 +- docs/zh/latest/tutorials/client-to-apisix-mtls.md | 2 +- docs/zh/latest/tutorials/health-check.md | 2 +- docs/zh/latest/tutorials/observe-your-api.md | 2 +- docs/zh/latest/tutorials/protect-api.md | 2 +- 226 files changed, 229 insertions(+), 347 deletions(-) diff --git a/docs/en/latest/FAQ.md b/docs/en/latest/FAQ.md index 5f265f4b7ccd..3a4baac6d6b5 100644 --- a/docs/en/latest/FAQ.md +++ b/docs/en/latest/FAQ.md @@ -121,8 +121,7 @@ Let's take an example query `foo.com/product/index.html?id=204&page=2` and consi There are two different ways to achieve this in Apache APISIX: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/admin-api.md b/docs/en/latest/admin-api.md index ee57926b92c0..f9ac264a86c3 100644 --- a/docs/en/latest/admin-api.md +++ b/docs/en/latest/admin-api.md @@ -123,8 +123,7 @@ By default, the Admin API checks for references between resources and will refus You can make a force deletion by adding the request argument `force=true` to the delete request, for example: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/batch-processor.md b/docs/en/latest/batch-processor.md index b21bdf521aab..80173818abd8 100644 --- a/docs/en/latest/batch-processor.md +++ b/docs/en/latest/batch-processor.md @@ -83,8 +83,7 @@ The batch processor's configuration will be set inside the plugin's configuratio For example: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/benchmark.md b/docs/en/latest/benchmark.md index a59e4b982015..26b4a146ebb3 100644 --- a/docs/en/latest/benchmark.md +++ b/docs/en/latest/benchmark.md @@ -53,8 +53,7 @@ The result of Flame Graph: And if you want to run the benchmark test in your machine, you should run another Nginx to listen 80 port. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/certificate.md b/docs/en/latest/certificate.md index d2a089f908e1..0029518a4abf 100644 --- a/docs/en/latest/certificate.md +++ b/docs/en/latest/certificate.md @@ -36,8 +36,7 @@ The following is an example of configuring an SSL certificate with a single SNI Create an SSL object with the certificate and key valid for the SNI: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/debug-function.md b/docs/en/latest/debug-function.md index a0fea27c7aa3..c4db4803b9b3 100644 --- a/docs/en/latest/debug-function.md +++ b/docs/en/latest/debug-function.md @@ -32,8 +32,7 @@ In the response header of the request, through the response header of `X-APISIX- ## Example :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/discovery.md b/docs/en/latest/discovery.md index e68b3203a4ef..c12931779b90 100644 --- a/docs/en/latest/discovery.md +++ b/docs/en/latest/discovery.md @@ -187,8 +187,7 @@ discovery: Here is an example of routing a request with a URL of "/user/*" to a service which named "user-service" and use eureka discovery client in the registry : :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/discovery/consul.md b/docs/en/latest/discovery/consul.md index 4ccd9675c4dc..100a2ad34022 100644 --- a/docs/en/latest/discovery/consul.md +++ b/docs/en/latest/discovery/consul.md @@ -162,8 +162,7 @@ To avoid confusion, use the full consul key url path as service name in practice Here is an example of routing a request with a URL of "/*" to a service which named "service_a" and use consul discovery client in the registry : :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/discovery/consul_kv.md b/docs/en/latest/discovery/consul_kv.md index d783242e426e..0c0f852cee13 100644 --- a/docs/en/latest/discovery/consul_kv.md +++ b/docs/en/latest/discovery/consul_kv.md @@ -137,8 +137,7 @@ To avoid confusion, use the full consul key url path as service name in practice Here is an example of routing a request with a URL of "/*" to a service which named "http://127.0.0.1:8500/v1/kv/upstreams/webpages/" and use consul_kv discovery client in the registry : :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/discovery/nacos.md b/docs/en/latest/discovery/nacos.md index b47ef9af82a4..878f46fc17f2 100644 --- a/docs/en/latest/discovery/nacos.md +++ b/docs/en/latest/discovery/nacos.md @@ -63,8 +63,7 @@ discovery: Here is an example of routing a request with an URI of "/nacos/*" to a service which named "http://192.168.33.1:8848/nacos/v1/ns/instance/list?serviceName=APISIX-NACOS" and use nacos discovery client in the registry: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/grpc-proxy.md b/docs/en/latest/grpc-proxy.md index a6f9c0e020b9..d0a221c10d4c 100644 --- a/docs/en/latest/grpc-proxy.md +++ b/docs/en/latest/grpc-proxy.md @@ -41,8 +41,7 @@ Here's an example, to proxying gRPC service by specified route: * the grpc server example：[grpc_server_example](https://github.com/api7/grpc_server_example) :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/mtls.md b/docs/en/latest/mtls.md index 1bd8e1f6abfd..53d69eb48aa7 100644 --- a/docs/en/latest/mtls.md +++ b/docs/en/latest/mtls.md @@ -66,8 +66,7 @@ Please replace the following certificate paths and domain name with your real on * Note: The same CA certificate as the server needs to be used * :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugin-develop.md b/docs/en/latest/plugin-develop.md index 68402643042f..896d79241c6a 100644 --- a/docs/en/latest/plugin-develop.md +++ b/docs/en/latest/plugin-develop.md @@ -371,8 +371,7 @@ end Write the logic of the plugin in the corresponding phase. There are two parameters `conf` and `ctx` in the phase method, take the `limit-conn` plugin configuration as an example. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/api-breaker.md b/docs/en/latest/plugins/api-breaker.md index 35dc2dce1f2c..267705b07482 100644 --- a/docs/en/latest/plugins/api-breaker.md +++ b/docs/en/latest/plugins/api-breaker.md @@ -58,8 +58,7 @@ In an unhealthy state, if the Upstream service responds with a status code from The example below shows how you can configure the Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/authz-casbin.md b/docs/en/latest/plugins/authz-casbin.md index 8369a935fc8c..e364f3604d7b 100644 --- a/docs/en/latest/plugins/authz-casbin.md +++ b/docs/en/latest/plugins/authz-casbin.md @@ -66,8 +66,7 @@ You can enable the Plugin on a Route by either using the model/policy file paths The example below shows setting up Casbin authentication from your model/policy configuration file: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/authz-casdoor.md b/docs/en/latest/plugins/authz-casdoor.md index c9269af00756..4a4b21a6ae9f 100644 --- a/docs/en/latest/plugins/authz-casdoor.md +++ b/docs/en/latest/plugins/authz-casdoor.md @@ -94,8 +94,7 @@ Once this is done, the user is redirected to the original URL they wanted to vis To remove the `authz-casdoor` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/authz-keycloak.md b/docs/en/latest/plugins/authz-keycloak.md index 9a0da83b4bf2..af44d0347a2e 100644 --- a/docs/en/latest/plugins/authz-keycloak.md +++ b/docs/en/latest/plugins/authz-keycloak.md @@ -148,8 +148,7 @@ curl --location --request POST 'http://127.0.0.1:9080/api/token' \ The example below shows how you can enable the `authz-keycloak` Plugin on a specific Route. `${realm}` represents the realm name in Keycloak. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/aws-lambda.md b/docs/en/latest/plugins/aws-lambda.md index f0ddc206db08..e820ca3e9a99 100644 --- a/docs/en/latest/plugins/aws-lambda.md +++ b/docs/en/latest/plugins/aws-lambda.md @@ -63,8 +63,7 @@ This Plugin supports authorization via AWS API key and AWS IAM secrets. The example below shows how you can configure the Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/azure-functions.md b/docs/en/latest/plugins/azure-functions.md index 72104a3184bb..abad58037149 100644 --- a/docs/en/latest/plugins/azure-functions.md +++ b/docs/en/latest/plugins/azure-functions.md @@ -65,8 +65,7 @@ The relative order priority is as follows: To add a new master API key, you can make a request to `/apisix/admin/plugin_metadata` with the required metadata as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/basic-auth.md b/docs/en/latest/plugins/basic-auth.md index 6557764576b4..a8f8c80e18c1 100644 --- a/docs/en/latest/plugins/basic-auth.md +++ b/docs/en/latest/plugins/basic-auth.md @@ -56,8 +56,7 @@ For Route: To enable the Plugin, you have to create a Consumer object with the authentication configuration: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/batch-requests.md b/docs/en/latest/plugins/batch-requests.md index 6391c50ad244..1f42ae161037 100644 --- a/docs/en/latest/plugins/batch-requests.md +++ b/docs/en/latest/plugins/batch-requests.md @@ -72,8 +72,7 @@ plugins: By default, the maximum body size that can be sent to `/apisix/batch-requests` can't be larger than 1 MiB. You can change this configuration of the Plugin through the endpoint `apisix/admin/plugin_metadata/batch-requests`: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/body-transformer.md b/docs/en/latest/plugins/body-transformer.md index e50f757bb09b..95fa5385e044 100644 --- a/docs/en/latest/plugins/body-transformer.md +++ b/docs/en/latest/plugins/body-transformer.md @@ -56,8 +56,7 @@ Use cases: You can enable the Plugin on a specific Route as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/brotli.md b/docs/en/latest/plugins/brotli.md index ab81bb450a07..3e317a5d9da8 100644 --- a/docs/en/latest/plugins/brotli.md +++ b/docs/en/latest/plugins/brotli.md @@ -71,8 +71,7 @@ If the upstream is returning a compressed response, then the Brotli plugin won't The example below enables the `brotli` Plugin on the specified Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/cas-auth.md b/docs/en/latest/plugins/cas-auth.md index 76e796477500..67f3a9016678 100644 --- a/docs/en/latest/plugins/cas-auth.md +++ b/docs/en/latest/plugins/cas-auth.md @@ -46,8 +46,7 @@ to do authentication, from the SP (service provider) perspective. You can enable the Plugin on a specific Route as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/chaitin-waf.md b/docs/en/latest/plugins/chaitin-waf.md index 0b8d72d27698..c1ae87b2c20d 100644 --- a/docs/en/latest/plugins/chaitin-waf.md +++ b/docs/en/latest/plugins/chaitin-waf.md @@ -71,8 +71,7 @@ The response headers are listed below: An example configuration is as follows. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/clickhouse-logger.md b/docs/en/latest/plugins/clickhouse-logger.md index 970b7a146c60..62575338a194 100644 --- a/docs/en/latest/plugins/clickhouse-logger.md +++ b/docs/en/latest/plugins/clickhouse-logger.md @@ -114,8 +114,7 @@ Configuring the Plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/client-control.md b/docs/en/latest/plugins/client-control.md index 7d9c302b96d5..50ee0e3ae4d4 100644 --- a/docs/en/latest/plugins/client-control.md +++ b/docs/en/latest/plugins/client-control.md @@ -47,8 +47,7 @@ This Plugin requires APISIX to run on APISIX-Runtime. See [apisix-build-tools](h The example below enables the Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/consumer-restriction.md b/docs/en/latest/plugins/consumer-restriction.md index 44ab4256a77d..5ee4d67a26da 100644 --- a/docs/en/latest/plugins/consumer-restriction.md +++ b/docs/en/latest/plugins/consumer-restriction.md @@ -63,8 +63,7 @@ The example below shows how you can use the `consumer-restriction` Plugin on a R You can first create two consumers `jack1` and `jack2`: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/cors.md b/docs/en/latest/plugins/cors.md index bf144d7991ec..d8ca037538f2 100644 --- a/docs/en/latest/plugins/cors.md +++ b/docs/en/latest/plugins/cors.md @@ -81,8 +81,7 @@ So, you have to set the CORS headers first, then access the `domain-B.com` URL, You can enable the Plugin on a specific Route or Service: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/csrf.md b/docs/en/latest/plugins/csrf.md index 0b97741c522e..e7a079b5f27d 100644 --- a/docs/en/latest/plugins/csrf.md +++ b/docs/en/latest/plugins/csrf.md @@ -49,8 +49,7 @@ NOTE: `encrypt_fields = {"key"}` is also defined in the schema, which means that The example below shows how you can enable the Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/datadog.md b/docs/en/latest/plugins/datadog.md index c47f200748f8..7564820db964 100644 --- a/docs/en/latest/plugins/datadog.md +++ b/docs/en/latest/plugins/datadog.md @@ -67,8 +67,7 @@ See [defining tags](https://docs.datadoghq.com/getting_started/tagging/#defining By default, the Plugin expects the DogStatsD service to be available at `127.0.0.1:8125`. If you want to change this, you can update the Plugin metadata as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/degraphql.md b/docs/en/latest/plugins/degraphql.md index f63e42279241..d9fb070097e1 100644 --- a/docs/en/latest/plugins/degraphql.md +++ b/docs/en/latest/plugins/degraphql.md @@ -313,8 +313,7 @@ In the GET request, the variables are passed in the query string. To remove the `degraphql` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/dubbo-proxy.md b/docs/en/latest/plugins/dubbo-proxy.md index 488f61efe2fb..89044d03a059 100644 --- a/docs/en/latest/plugins/dubbo-proxy.md +++ b/docs/en/latest/plugins/dubbo-proxy.md @@ -65,8 +65,7 @@ plugins: Now, when APISIX is reloaded, you can add it to a specific Route as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/echo.md b/docs/en/latest/plugins/echo.md index ad5fd1ae6469..b17f64a4a7e8 100644 --- a/docs/en/latest/plugins/echo.md +++ b/docs/en/latest/plugins/echo.md @@ -55,8 +55,7 @@ At least one of `before_body`, `body`, and `after_body` must be specified. The example below shows how you can enable the `echo` Plugin for a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/elasticsearch-logger.md b/docs/en/latest/plugins/elasticsearch-logger.md index 2e9d0844210b..e5ea392fdbb9 100644 --- a/docs/en/latest/plugins/elasticsearch-logger.md +++ b/docs/en/latest/plugins/elasticsearch-logger.md @@ -104,8 +104,7 @@ This Plugin supports using batch processors to aggregate and process entries (lo The example below shows a complete configuration of the Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/error-log-logger.md b/docs/en/latest/plugins/error-log-logger.md index 321850a2a071..4354968c36e6 100644 --- a/docs/en/latest/plugins/error-log-logger.md +++ b/docs/en/latest/plugins/error-log-logger.md @@ -94,8 +94,7 @@ Once you have enabled the Plugin, you can configure it through the Plugin metada You can set the TCP server address by configuring the Plugin metadata as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/ext-plugin-post-resp.md b/docs/en/latest/plugins/ext-plugin-post-resp.md index a19312d01255..05f41e613435 100644 --- a/docs/en/latest/plugins/ext-plugin-post-resp.md +++ b/docs/en/latest/plugins/ext-plugin-post-resp.md @@ -55,8 +55,7 @@ Execution of External Plugins will affect the response of the current request. The example below enables the `ext-plugin-post-resp` Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/ext-plugin-pre-req.md b/docs/en/latest/plugins/ext-plugin-pre-req.md index 68a2efa4a075..022ef15ee233 100644 --- a/docs/en/latest/plugins/ext-plugin-pre-req.md +++ b/docs/en/latest/plugins/ext-plugin-pre-req.md @@ -51,8 +51,7 @@ Execution of External Plugins will affect the behavior of the current request. The example below enables the `ext-plugin-pre-req` Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/fault-injection.md b/docs/en/latest/plugins/fault-injection.md index a4671749d86e..017a903e2fae 100644 --- a/docs/en/latest/plugins/fault-injection.md +++ b/docs/en/latest/plugins/fault-injection.md @@ -80,8 +80,7 @@ This means that the relationship between the first two expressions is AND, and t You can enable the `fault-injection` Plugin on a specific Route as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/file-logger.md b/docs/en/latest/plugins/file-logger.md index cf1d5169549a..bce8c363f521 100644 --- a/docs/en/latest/plugins/file-logger.md +++ b/docs/en/latest/plugins/file-logger.md @@ -108,8 +108,7 @@ You can also set the format of the logs by configuring the Plugin metadata. The The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/forward-auth.md b/docs/en/latest/plugins/forward-auth.md index 4cabaf69f3f9..e248ab6db6b5 100644 --- a/docs/en/latest/plugins/forward-auth.md +++ b/docs/en/latest/plugins/forward-auth.md @@ -64,8 +64,7 @@ APISIX will generate and send the request headers listed below to the authorizat First, you need to setup your external authorization service. The example below uses Apache APISIX's [serverless](./serverless.md) Plugin to mock the service: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/google-cloud-logging.md b/docs/en/latest/plugins/google-cloud-logging.md index 3bc6ad2690df..4838fb737df7 100644 --- a/docs/en/latest/plugins/google-cloud-logging.md +++ b/docs/en/latest/plugins/google-cloud-logging.md @@ -100,8 +100,7 @@ Configuring the Plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/grpc-transcode.md b/docs/en/latest/plugins/grpc-transcode.md index 40b6dbfdb76a..e47f61ab66b6 100644 --- a/docs/en/latest/plugins/grpc-transcode.md +++ b/docs/en/latest/plugins/grpc-transcode.md @@ -64,8 +64,7 @@ Before enabling the Plugin, you have to add the content of your `.proto` or `.pb You can use the `/admin/protos/id` endpoint and add the contents of the file to the `content` field: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/grpc-web.md b/docs/en/latest/plugins/grpc-web.md index 38df49977113..b846a50861eb 100644 --- a/docs/en/latest/plugins/grpc-web.md +++ b/docs/en/latest/plugins/grpc-web.md @@ -43,8 +43,7 @@ The `grpc-web` Plugin is a proxy Plugin that can process [gRPC Web](https://gith You can enable the `grpc-web` Plugin on a specific Route as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/gzip.md b/docs/en/latest/plugins/gzip.md index c1f131835378..6baf8f1bf043 100644 --- a/docs/en/latest/plugins/gzip.md +++ b/docs/en/latest/plugins/gzip.md @@ -55,8 +55,7 @@ This Plugin requires APISIX to run on [APISIX-Runtime](../FAQ.md#how-do-i-build- The example below enables the `gzip` Plugin on the specified Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/hmac-auth.md b/docs/en/latest/plugins/hmac-auth.md index a52f7e6964bb..6b548e716f29 100644 --- a/docs/en/latest/plugins/hmac-auth.md +++ b/docs/en/latest/plugins/hmac-auth.md @@ -55,8 +55,7 @@ NOTE: `encrypt_fields = {"secret_key"}` is also defined in the schema, which mea First we enable the Plugin on a Consumer object as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/http-logger.md b/docs/en/latest/plugins/http-logger.md index f26907070f1a..f4337b881fdb 100644 --- a/docs/en/latest/plugins/http-logger.md +++ b/docs/en/latest/plugins/http-logger.md @@ -115,8 +115,7 @@ Configuring the Plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/inspect.md b/docs/en/latest/plugins/inspect.md index 890a2c0343d7..06195225a4ae 100644 --- a/docs/en/latest/plugins/inspect.md +++ b/docs/en/latest/plugins/inspect.md @@ -102,8 +102,7 @@ plugin_attr: ## Example usage :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/ip-restriction.md b/docs/en/latest/plugins/ip-restriction.md index 0a0943013c54..bff32c4cd838 100644 --- a/docs/en/latest/plugins/ip-restriction.md +++ b/docs/en/latest/plugins/ip-restriction.md @@ -53,8 +53,7 @@ Either one of `whitelist` or `blacklist` attribute must be specified. They canno You can enable the Plugin on a Route or a Service as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/jwe-decrypt.md b/docs/en/latest/plugins/jwe-decrypt.md index f376860a09b0..6a3c4fc2551c 100644 --- a/docs/en/latest/plugins/jwe-decrypt.md +++ b/docs/en/latest/plugins/jwe-decrypt.md @@ -63,8 +63,7 @@ For Route: First, create a Consumer with `jwe-decrypt` and configure the decryption key: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/jwt-auth.md b/docs/en/latest/plugins/jwt-auth.md index c09d6e53cc36..61c49af6e925 100644 --- a/docs/en/latest/plugins/jwt-auth.md +++ b/docs/en/latest/plugins/jwt-auth.md @@ -79,8 +79,7 @@ To enable the Plugin, you have to create a Consumer object with the JWT token an First, you can create a Consumer object through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/kafka-logger.md b/docs/en/latest/plugins/kafka-logger.md index 45dcd579a4f5..c95f580121de 100644 --- a/docs/en/latest/plugins/kafka-logger.md +++ b/docs/en/latest/plugins/kafka-logger.md @@ -147,8 +147,7 @@ Configuring the Plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/key-auth.md b/docs/en/latest/plugins/key-auth.md index 0a8b70046947..ba2590d2512e 100644 --- a/docs/en/latest/plugins/key-auth.md +++ b/docs/en/latest/plugins/key-auth.md @@ -59,8 +59,7 @@ To enable the Plugin, you have to create a Consumer object with an authenticatio First you can create a Consumer object through the [Admin API](../admin-api.md) with a unique key: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/ldap-auth.md b/docs/en/latest/plugins/ldap-auth.md index e251db65f4dd..0ee503716e6f 100644 --- a/docs/en/latest/plugins/ldap-auth.md +++ b/docs/en/latest/plugins/ldap-auth.md @@ -59,8 +59,7 @@ For Route: First, you have to create a Consumer and enable the `ldap-auth` Plugin on it: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/limit-conn.md b/docs/en/latest/plugins/limit-conn.md index 1a3a1136072b..802d2dc0d63f 100644 --- a/docs/en/latest/plugins/limit-conn.md +++ b/docs/en/latest/plugins/limit-conn.md @@ -62,8 +62,7 @@ The `limit-conn` Plugin limits the number of concurrent requests to your service You can enable the Plugin on a Route as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/limit-count.md b/docs/en/latest/plugins/limit-count.md index a55fdf9da34c..3e6b86e7b5f7 100644 --- a/docs/en/latest/plugins/limit-count.md +++ b/docs/en/latest/plugins/limit-count.md @@ -62,8 +62,7 @@ The `limit-count` Plugin limits the number of requests to your service by a give You can enable the Plugin on a Route as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/limit-req.md b/docs/en/latest/plugins/limit-req.md index ad6ef8d6f5e0..113e571867fd 100644 --- a/docs/en/latest/plugins/limit-req.md +++ b/docs/en/latest/plugins/limit-req.md @@ -62,8 +62,7 @@ The `limit-req` Plugin limits the number of requests to your service using the [ You can enable the Plugin on a Route as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/loggly.md b/docs/en/latest/plugins/loggly.md index 51faf98ebd87..157387513e15 100644 --- a/docs/en/latest/plugins/loggly.md +++ b/docs/en/latest/plugins/loggly.md @@ -78,8 +78,7 @@ We support [Syslog](https://documentation.solarwinds.com/en/success_center/loggl APISIX supports [Syslog](https://documentation.solarwinds.com/en/success_center/loggly/content/admin/streaming-syslog-without-using-files.htm) and [HTTP/S](https://documentation.solarwinds.com/en/success_center/loggly/content/admin/http-bulk-endpoint.htm) protocols to send data to Loggly. Syslog lets you send RFC5424 compliant syslog events with fine-grained control. But, HTTP/S bulk endpoint is better while sending large batches of logs at a fast transmission speed. You can configure the metadata to update the protocol as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/loki-logger.md b/docs/en/latest/plugins/loki-logger.md index 3cdcddce1a80..59cfef19c3a1 100644 --- a/docs/en/latest/plugins/loki-logger.md +++ b/docs/en/latest/plugins/loki-logger.md @@ -114,8 +114,7 @@ Configuring the plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/mocking.md b/docs/en/latest/plugins/mocking.md index 049ddc3edefe..39e7a070dea4 100644 --- a/docs/en/latest/plugins/mocking.md +++ b/docs/en/latest/plugins/mocking.md @@ -127,8 +127,7 @@ This is the response generated by the Plugin from this JSON schema: The example below configures the `mocking` Plugin for a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/mqtt-proxy.md b/docs/en/latest/plugins/mqtt-proxy.md index 9ba6a4001a15..1289a961b177 100644 --- a/docs/en/latest/plugins/mqtt-proxy.md +++ b/docs/en/latest/plugins/mqtt-proxy.md @@ -61,8 +61,7 @@ You can now send the MQTT request to port `9100`. You can now create a stream Route and enable the `mqtt-proxy` Plugin: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/multi-auth.md b/docs/en/latest/plugins/multi-auth.md index aeae13ab2ae4..3038de1a185b 100644 --- a/docs/en/latest/plugins/multi-auth.md +++ b/docs/en/latest/plugins/multi-auth.md @@ -49,8 +49,7 @@ To enable the Plugin, you have to create two or more Consumer objects with diffe First create a Consumer using basic authentication: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/node-status.md b/docs/en/latest/plugins/node-status.md index 7a595a4b7569..3404f8f2ff77 100644 --- a/docs/en/latest/plugins/node-status.md +++ b/docs/en/latest/plugins/node-status.md @@ -57,8 +57,7 @@ plugins: You have to the setup the Route for the status API and expose it using the [public-api](public-api.md) Plugin. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/ocsp-stapling.md b/docs/en/latest/plugins/ocsp-stapling.md index 06b0e6f3f687..763140e8e49d 100644 --- a/docs/en/latest/plugins/ocsp-stapling.md +++ b/docs/en/latest/plugins/ocsp-stapling.md @@ -43,8 +43,7 @@ plugins: After modifying the config file, reload APISIX or send an hot-loaded HTTP request through the Admin API to take effect: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/opa.md b/docs/en/latest/plugins/opa.md index 1aad3a81fd49..bdd426c2d46a 100644 --- a/docs/en/latest/plugins/opa.md +++ b/docs/en/latest/plugins/opa.md @@ -303,8 +303,7 @@ curl -X GET 127.0.0.1:9080/get To remove the `opa` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/openfunction.md b/docs/en/latest/plugins/openfunction.md index 21558e5f9165..6bb90eaf2ebb 100644 --- a/docs/en/latest/plugins/openfunction.md +++ b/docs/en/latest/plugins/openfunction.md @@ -77,8 +77,7 @@ kubectl create secret docker-registry push-secret \ You can now configure the Plugin on a specific Route and point to this running OpenFunction service: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/openid-connect.md b/docs/en/latest/plugins/openid-connect.md index d4b23d3d4252..635700a8a54b 100644 --- a/docs/en/latest/plugins/openid-connect.md +++ b/docs/en/latest/plugins/openid-connect.md @@ -119,8 +119,7 @@ The image below shows an example token introspection flow via a Gateway: The example below shows how you can enable the Plugin on Route. The Route below will protect the Upstream by introspecting the token provided in the request header: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/opentelemetry.md b/docs/en/latest/plugins/opentelemetry.md index bd20e9b9d99b..3b638c0d555e 100644 --- a/docs/en/latest/plugins/opentelemetry.md +++ b/docs/en/latest/plugins/opentelemetry.md @@ -123,8 +123,7 @@ plugins: Now, you can enable the Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/openwhisk.md b/docs/en/latest/plugins/openwhisk.md index f5d722adde81..199777fa1297 100644 --- a/docs/en/latest/plugins/openwhisk.md +++ b/docs/en/latest/plugins/openwhisk.md @@ -83,8 +83,7 @@ wsk action update test <(echo 'function main(){return {"ready":true}}') --kind n You can now configure the Plugin on a specific Route and point to this running OpenWhisk service: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/prometheus.md b/docs/en/latest/plugins/prometheus.md index d919fee030ca..7b789597a608 100644 --- a/docs/en/latest/plugins/prometheus.md +++ b/docs/en/latest/plugins/prometheus.md @@ -138,8 +138,7 @@ The `prometheus` Plugin can be enabled with an empty table. The example below shows how you can configure the Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/proxy-cache.md b/docs/en/latest/plugins/proxy-cache.md index c6bf92b515f4..024460642e7b 100644 --- a/docs/en/latest/plugins/proxy-cache.md +++ b/docs/en/latest/plugins/proxy-cache.md @@ -83,8 +83,7 @@ apisix: You can enable the Plugin on a Route as shown below. The Plugin uses the disk-based `cache_strategy` and `disk_cache_one` as the `cache_zone` by default: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/proxy-control.md b/docs/en/latest/plugins/proxy-control.md index da78671fb61a..6504bf8a7c0e 100644 --- a/docs/en/latest/plugins/proxy-control.md +++ b/docs/en/latest/plugins/proxy-control.md @@ -47,8 +47,7 @@ This Plugin requires APISIX to run on [APISIX-Runtime](../FAQ.md#how-do-i-build- The example below enables the Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/proxy-mirror.md b/docs/en/latest/plugins/proxy-mirror.md index 8d44d913d1c8..b2234c0cf3b1 100644 --- a/docs/en/latest/plugins/proxy-mirror.md +++ b/docs/en/latest/plugins/proxy-mirror.md @@ -66,8 +66,7 @@ plugin_attr: You can enable the Plugin on a specific Route as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/proxy-rewrite.md b/docs/en/latest/plugins/proxy-rewrite.md index 44134322f7c9..beb8fc992a44 100644 --- a/docs/en/latest/plugins/proxy-rewrite.md +++ b/docs/en/latest/plugins/proxy-rewrite.md @@ -57,8 +57,7 @@ Header configurations are executed according to the following priorities: The example below enables the `proxy-rewrite` Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/public-api.md b/docs/en/latest/plugins/public-api.md index 8d84fc3ae0fd..6415c5b55324 100644 --- a/docs/en/latest/plugins/public-api.md +++ b/docs/en/latest/plugins/public-api.md @@ -139,8 +139,7 @@ HTTP/1.1 401 Unauthorized To remove the `public-api` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/real-ip.md b/docs/en/latest/plugins/real-ip.md index 392b78918427..dfe59ae32c38 100644 --- a/docs/en/latest/plugins/real-ip.md +++ b/docs/en/latest/plugins/real-ip.md @@ -58,8 +58,7 @@ If the address specified in `source` is missing or invalid, the Plugin would not The example below enables the `real-ip` Plugin on the specified Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/redirect.md b/docs/en/latest/plugins/redirect.md index 565ea4929311..351ecd323a66 100644 --- a/docs/en/latest/plugins/redirect.md +++ b/docs/en/latest/plugins/redirect.md @@ -58,8 +58,7 @@ The `redirect` Plugin can be used to configure redirects. The example below shows how you can enable the `redirect` Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/referer-restriction.md b/docs/en/latest/plugins/referer-restriction.md index d77f8468fb90..3c7b4c2b7673 100644 --- a/docs/en/latest/plugins/referer-restriction.md +++ b/docs/en/latest/plugins/referer-restriction.md @@ -50,8 +50,7 @@ Only one of `whitelist` or `blacklist` attribute must be specified. They cannot You can enable the Plugin on a specific Route or a Service as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/request-id.md b/docs/en/latest/plugins/request-id.md index 7ffc0afdf637..4642c3726b1f 100644 --- a/docs/en/latest/plugins/request-id.md +++ b/docs/en/latest/plugins/request-id.md @@ -53,8 +53,7 @@ The Plugin will not add a unique ID if the request already has a header with the The example below enables the Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/request-validation.md b/docs/en/latest/plugins/request-validation.md index 0b2f1df114e0..b8aa9d747f01 100644 --- a/docs/en/latest/plugins/request-validation.md +++ b/docs/en/latest/plugins/request-validation.md @@ -50,8 +50,7 @@ At least one of `header_schema` or `body_schema` should be filled in. You can configure the Plugin on a specific Route as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/response-rewrite.md b/docs/en/latest/plugins/response-rewrite.md index 190982731c05..24b023ad2a3c 100644 --- a/docs/en/latest/plugins/response-rewrite.md +++ b/docs/en/latest/plugins/response-rewrite.md @@ -72,8 +72,7 @@ Only one of `body` or `filters` can be configured. The example below enables the `response-rewrite` Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/rocketmq-logger.md b/docs/en/latest/plugins/rocketmq-logger.md index f00bcb19d5f4..1dec604ad35a 100644 --- a/docs/en/latest/plugins/rocketmq-logger.md +++ b/docs/en/latest/plugins/rocketmq-logger.md @@ -192,8 +192,7 @@ Configuring the Plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/serverless.md b/docs/en/latest/plugins/serverless.md index acb9fd02b2e6..d8d2d0336cd8 100644 --- a/docs/en/latest/plugins/serverless.md +++ b/docs/en/latest/plugins/serverless.md @@ -84,8 +84,7 @@ Prior to v2.12.0, the phase `before_proxy` was called `balancer`. This was updat The example below enables the Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/skywalking-logger.md b/docs/en/latest/plugins/skywalking-logger.md index 17f9f0066a8c..23cd5f60ce7e 100644 --- a/docs/en/latest/plugins/skywalking-logger.md +++ b/docs/en/latest/plugins/skywalking-logger.md @@ -124,8 +124,7 @@ Configuring the Plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/skywalking.md b/docs/en/latest/plugins/skywalking.md index 32d48c1b73b8..a352a0523a8f 100644 --- a/docs/en/latest/plugins/skywalking.md +++ b/docs/en/latest/plugins/skywalking.md @@ -109,8 +109,7 @@ Once you do this, a background timer will be created to report data to the SkyWa Now, you can enable the Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/sls-logger.md b/docs/en/latest/plugins/sls-logger.md index 25103fadc24f..e4fa1453f407 100644 --- a/docs/en/latest/plugins/sls-logger.md +++ b/docs/en/latest/plugins/sls-logger.md @@ -99,8 +99,7 @@ Configuring the Plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/splunk-hec-logging.md b/docs/en/latest/plugins/splunk-hec-logging.md index aa81d38d6651..6761bd453051 100644 --- a/docs/en/latest/plugins/splunk-hec-logging.md +++ b/docs/en/latest/plugins/splunk-hec-logging.md @@ -96,8 +96,7 @@ Configuring the Plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/syslog.md b/docs/en/latest/plugins/syslog.md index a222b4ea4594..09d1aa6c4645 100644 --- a/docs/en/latest/plugins/syslog.md +++ b/docs/en/latest/plugins/syslog.md @@ -76,8 +76,7 @@ Configuring the Plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/tcp-logger.md b/docs/en/latest/plugins/tcp-logger.md index 9c82b4411d86..462b1b680666 100644 --- a/docs/en/latest/plugins/tcp-logger.md +++ b/docs/en/latest/plugins/tcp-logger.md @@ -110,8 +110,7 @@ Configuring the Plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/tencent-cloud-cls.md b/docs/en/latest/plugins/tencent-cloud-cls.md index 528a188ef6cf..7a30117d815a 100644 --- a/docs/en/latest/plugins/tencent-cloud-cls.md +++ b/docs/en/latest/plugins/tencent-cloud-cls.md @@ -109,8 +109,7 @@ Configuring the Plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/traffic-split.md b/docs/en/latest/plugins/traffic-split.md index 99c77d983a1f..96ae50c95c13 100644 --- a/docs/en/latest/plugins/traffic-split.md +++ b/docs/en/latest/plugins/traffic-split.md @@ -82,8 +82,7 @@ If only the `weight` attribute is configured, it corresponds to the weight of th You can configure the Plugin on a Route as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/ua-restriction.md b/docs/en/latest/plugins/ua-restriction.md index dc4a2ed4b96b..d523ad87ebae 100644 --- a/docs/en/latest/plugins/ua-restriction.md +++ b/docs/en/latest/plugins/ua-restriction.md @@ -52,8 +52,7 @@ A common scenario is to set crawler rules. `User-Agent` is the identity of the c You can enable the Plugin on a Route or a Service as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/udp-logger.md b/docs/en/latest/plugins/udp-logger.md index 7240a491495c..f31ccd794be0 100644 --- a/docs/en/latest/plugins/udp-logger.md +++ b/docs/en/latest/plugins/udp-logger.md @@ -108,8 +108,7 @@ Configuring the Plugin metadata is global in scope. This means that it will take The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/uri-blocker.md b/docs/en/latest/plugins/uri-blocker.md index fd9f185d90e5..f158f43ac2fa 100644 --- a/docs/en/latest/plugins/uri-blocker.md +++ b/docs/en/latest/plugins/uri-blocker.md @@ -44,8 +44,7 @@ The `uri-blocker` Plugin intercepts user requests with a set of `block_rules`. The example below enables the `uri-blocker` Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/wolf-rbac.md b/docs/en/latest/plugins/wolf-rbac.md index 9703f6d622b1..2430d528f181 100644 --- a/docs/en/latest/plugins/wolf-rbac.md +++ b/docs/en/latest/plugins/wolf-rbac.md @@ -65,8 +65,7 @@ Once you have done that you need to add `application`, `admin`, `normal user`, ` You need to first configure the Plugin on a Consumer: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/workflow.md b/docs/en/latest/plugins/workflow.md index d1236dfec051..db2de71458ae 100644 --- a/docs/en/latest/plugins/workflow.md +++ b/docs/en/latest/plugins/workflow.md @@ -66,8 +66,7 @@ In `rules`, match `case` in order according to the index of the `rules`, and exe You can configure the `workflow` plugin on a Route as shown below: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/plugins/zipkin.md b/docs/en/latest/plugins/zipkin.md index 26a50a311dd8..b0386aa78e7d 100644 --- a/docs/en/latest/plugins/zipkin.md +++ b/docs/en/latest/plugins/zipkin.md @@ -111,8 +111,7 @@ func main(){ The example below enables the Plugin on a specific Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/router-radixtree.md b/docs/en/latest/router-radixtree.md index 36da237f30d2..647d92248402 100644 --- a/docs/en/latest/router-radixtree.md +++ b/docs/en/latest/router-radixtree.md @@ -78,8 +78,7 @@ Note: In the matching rules, the `priority` field takes precedence over other ru Create two routes with different `priority` values ​​(the larger the value, the higher the priority). :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/ssl-protocol.md b/docs/en/latest/ssl-protocol.md index 55113f1c3527..038ebe9184bd 100644 --- a/docs/en/latest/ssl-protocol.md +++ b/docs/en/latest/ssl-protocol.md @@ -80,8 +80,7 @@ apisix: ``` :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/stream-proxy.md b/docs/en/latest/stream-proxy.md index 7ec076d849a0..2fd01eb6638c 100644 --- a/docs/en/latest/stream-proxy.md +++ b/docs/en/latest/stream-proxy.md @@ -58,8 +58,7 @@ If `apisix.stream_proxy` is undefined in `conf/config.yaml`, you will encounter You can create a stream route using the Admin API `/stream_routes` endpoint. For example: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/terminology/consumer-group.md b/docs/en/latest/terminology/consumer-group.md index 5d8b9fd4927b..6e7f2e355bb0 100644 --- a/docs/en/latest/terminology/consumer-group.md +++ b/docs/en/latest/terminology/consumer-group.md @@ -40,8 +40,7 @@ The example below illustrates how to create a Consumer Group and bind it to a Co Create a Consumer Group which shares the same rate limiting quota: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/terminology/consumer.md b/docs/en/latest/terminology/consumer.md index efe33305d041..30d9ce2df574 100644 --- a/docs/en/latest/terminology/consumer.md +++ b/docs/en/latest/terminology/consumer.md @@ -75,8 +75,7 @@ For more information about the Consumer object, you can refer to the [Admin API The example below shows how you can enable a Plugin for a specific Consumer. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/terminology/global-rule.md b/docs/en/latest/terminology/global-rule.md index a5d1bae0d49d..ec9d73b77025 100644 --- a/docs/en/latest/terminology/global-rule.md +++ b/docs/en/latest/terminology/global-rule.md @@ -37,8 +37,7 @@ Compared with the plugin configuration in Route, Service, Plugin Config, and Con The example below shows how you can use the `limit-count` Plugin on all requests: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/terminology/plugin-config.md b/docs/en/latest/terminology/plugin-config.md index 4d07966d7473..91bc873ba99f 100644 --- a/docs/en/latest/terminology/plugin-config.md +++ b/docs/en/latest/terminology/plugin-config.md @@ -37,8 +37,7 @@ While configuring the same plugin, only one copy of the configuration is valid. The example below illustrates how to create a Plugin Config and bind it to a Route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/terminology/plugin-metadata.md b/docs/en/latest/terminology/plugin-metadata.md index b7a52d635b44..b5ab009d2896 100644 --- a/docs/en/latest/terminology/plugin-metadata.md +++ b/docs/en/latest/terminology/plugin-metadata.md @@ -51,8 +51,7 @@ Plugin metadata objects should only be used for plugins that have metadata field The example below shows how you can configure through the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/terminology/plugin.md b/docs/en/latest/terminology/plugin.md index 2fbcd7a7980d..e0b053ff9ba0 100644 --- a/docs/en/latest/terminology/plugin.md +++ b/docs/en/latest/terminology/plugin.md @@ -294,8 +294,7 @@ curl -v /dev/null http://127.0.0.1:9080/get?version=v2 -H"host:httpbin.org" APISIX Plugins are hot-loaded. This means that there is no need to restart the service if you add, delete, modify plugins, or even if you update the plugin code. To hot-reload, you can send an HTTP request through the [Admin API](../admin-api.md): :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/terminology/route.md b/docs/en/latest/terminology/route.md index 04660eea1108..3d40ed47e032 100644 --- a/docs/en/latest/terminology/route.md +++ b/docs/en/latest/terminology/route.md @@ -51,8 +51,7 @@ These shortcomings are independently abstracted in APISIX by two concepts: [Serv The Route example shown below proxies the request with the URL `/index.html` to the Upstream service with the address `127.0.0.1:1980`. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/terminology/secret.md b/docs/en/latest/terminology/secret.md index c5c37a562fb5..10c67875773f 100644 --- a/docs/en/latest/terminology/secret.md +++ b/docs/en/latest/terminology/secret.md @@ -100,8 +100,7 @@ export JACK_AUTH_KEY=abc Step 2: Reference the environment variable in the `key-auth` plugin :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/terminology/service.md b/docs/en/latest/terminology/service.md index 126dadd9306c..30b467c5f725 100644 --- a/docs/en/latest/terminology/service.md +++ b/docs/en/latest/terminology/service.md @@ -38,8 +38,7 @@ For more information about Service, please refer to [Admin API Service object](. The following example creates a Service that enables the `limit-count` Plugin and then binds it to the Routes with the ids `100` and `101`. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/terminology/upstream.md b/docs/en/latest/terminology/upstream.md index a1f7bd277ccc..6a01052ec2ee 100644 --- a/docs/en/latest/terminology/upstream.md +++ b/docs/en/latest/terminology/upstream.md @@ -46,8 +46,7 @@ In addition to the equalization algorithm selections, Upstream also supports pas To create an Upstream object, you can use the Admin API as shown below. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/tutorials/cache-api-responses.md b/docs/en/latest/tutorials/cache-api-responses.md index 1b97b00df711..fa3b688a4682 100644 --- a/docs/en/latest/tutorials/cache-api-responses.md +++ b/docs/en/latest/tutorials/cache-api-responses.md @@ -101,8 +101,7 @@ proxy_cache: Next, we can directly run `apisix reload` command to reload the latest plugin code without restarting Apache APISIX. See the command to reload the newly added plugin: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/tutorials/client-to-apisix-mtls.md b/docs/en/latest/tutorials/client-to-apisix-mtls.md index d3ec6782dfae..699a0c92bb83 100644 --- a/docs/en/latest/tutorials/client-to-apisix-mtls.md +++ b/docs/en/latest/tutorials/client-to-apisix-mtls.md @@ -207,8 +207,7 @@ instead of alert error in the SSL handshake phase, if the client certificate is ### Example :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/tutorials/health-check.md b/docs/en/latest/tutorials/health-check.md index 4b95a653fb45..7c763d1cbc2b 100644 --- a/docs/en/latest/tutorials/health-check.md +++ b/docs/en/latest/tutorials/health-check.md @@ -89,8 +89,7 @@ Since unhealthy nodes cannot receive requests, nodes cannot be re-marked as heal You can enable health checks in routes via the Admin API: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/tutorials/manage-api-consumers.md b/docs/en/latest/tutorials/manage-api-consumers.md index 8ea2a68df038..7a1a12e17e8e 100644 --- a/docs/en/latest/tutorials/manage-api-consumers.md +++ b/docs/en/latest/tutorials/manage-api-consumers.md @@ -72,8 +72,7 @@ The above steps can be achieved by running simple two [curl commands](https://en The first `cmd` creates a **new Consumer** with API Key based authentication enabled where the API consumer can only make 2 requests against the Product API within 60 seconds. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/tutorials/observe-your-api.md b/docs/en/latest/tutorials/observe-your-api.md index 5e4d600be0f4..a0ae0135e852 100644 --- a/docs/en/latest/tutorials/observe-your-api.md +++ b/docs/en/latest/tutorials/observe-your-api.md @@ -87,8 +87,7 @@ You can generate a mock HTTP server at [mockbin.com](https://mockbin.org/) to re The following is an example of how to enable the http-logger for a specific route. :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/tutorials/protect-api.md b/docs/en/latest/tutorials/protect-api.md index 983e1a74f3c4..060882d0af56 100644 --- a/docs/en/latest/tutorials/protect-api.md +++ b/docs/en/latest/tutorials/protect-api.md @@ -64,8 +64,7 @@ APISIX provides several plugins for limiting current and speed, including [limit Next, we will use the `limit-count` plugin as an example to show you how to protect your API with a rate limit plugin: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/wasm.md b/docs/en/latest/wasm.md index e5d16b9a4e07..26987ef682ea 100644 --- a/docs/en/latest/wasm.md +++ b/docs/en/latest/wasm.md @@ -72,8 +72,7 @@ That's all. Now you can use the wasm plugin as a regular plugin. For example, enable this plugin on the specified route: :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/en/latest/xrpc/redis.md b/docs/en/latest/xrpc/redis.md index 127a625ee465..0562c5ee655e 100644 --- a/docs/en/latest/xrpc/redis.md +++ b/docs/en/latest/xrpc/redis.md @@ -83,8 +83,7 @@ Fields under an entry of `faults`: ## Example usage :::note - -You can get the get the admin_key from config.yaml like this. +You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/FAQ.md b/docs/zh/latest/FAQ.md index 34635ebde320..a9e72521e389 100644 --- a/docs/zh/latest/FAQ.md +++ b/docs/zh/latest/FAQ.md @@ -128,7 +128,7 @@ make deps ENV_LUAROCKS_SERVER=https://luarocks.cn :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/admin-api.md b/docs/zh/latest/admin-api.md index 826eed6fdde1..2933bb75207c 100644 --- a/docs/zh/latest/admin-api.md +++ b/docs/zh/latest/admin-api.md @@ -126,7 +126,7 @@ routes: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/batch-processor.md b/docs/zh/latest/batch-processor.md index dab0c646aff8..8cef9c690681 100644 --- a/docs/zh/latest/batch-processor.md +++ b/docs/zh/latest/batch-processor.md @@ -81,7 +81,7 @@ end :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/benchmark.md b/docs/zh/latest/benchmark.md index ea6c445ae927..8b2764779276 100644 --- a/docs/zh/latest/benchmark.md +++ b/docs/zh/latest/benchmark.md @@ -53,7 +53,7 @@ title: 压力测试 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/certificate.md b/docs/zh/latest/certificate.md index 105d892af2ff..bbbf14c8b6a9 100644 --- a/docs/zh/latest/certificate.md +++ b/docs/zh/latest/certificate.md @@ -37,7 +37,7 @@ SNI（Server Name Indication）是用来改善 SSL 和 TLS 的一项特性，它 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/debug-function.md b/docs/zh/latest/debug-function.md index cc2539f57762..ba1262ec5341 100644 --- a/docs/zh/latest/debug-function.md +++ b/docs/zh/latest/debug-function.md @@ -35,7 +35,7 @@ title: 调试功能 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/discovery.md b/docs/zh/latest/discovery.md index 6301802b75d3..bed792f9f6f3 100644 --- a/docs/zh/latest/discovery.md +++ b/docs/zh/latest/discovery.md @@ -192,7 +192,7 @@ APISIX 是通过 `upstream.discovery_type` 选择使用的服务发现，`upstre :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/discovery/nacos.md b/docs/zh/latest/discovery/nacos.md index c313f4407184..353d2afc9cef 100644 --- a/docs/zh/latest/discovery/nacos.md +++ b/docs/zh/latest/discovery/nacos.md @@ -63,7 +63,7 @@ discovery: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/grpc-proxy.md b/docs/zh/latest/grpc-proxy.md index 6f014cc34dfc..2bfdaa622d84 100644 --- a/docs/zh/latest/grpc-proxy.md +++ b/docs/zh/latest/grpc-proxy.md @@ -41,7 +41,7 @@ title: gRPC 代理 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/mtls.md b/docs/zh/latest/mtls.md index 8a8858720f10..08b7f5717f8c 100644 --- a/docs/zh/latest/mtls.md +++ b/docs/zh/latest/mtls.md @@ -62,7 +62,7 @@ apisix reload :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugin-develop.md b/docs/zh/latest/plugin-develop.md index 65e524b0ac2f..64d2cfca6ff2 100644 --- a/docs/zh/latest/plugin-develop.md +++ b/docs/zh/latest/plugin-develop.md @@ -341,7 +341,7 @@ end :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/api-breaker.md b/docs/zh/latest/plugins/api-breaker.md index f34ee6d1ed1b..cf9db7c531a9 100644 --- a/docs/zh/latest/plugins/api-breaker.md +++ b/docs/zh/latest/plugins/api-breaker.md @@ -61,7 +61,7 @@ description: 本文介绍了 Apache APISIX api-breaker 插件的相关操作， :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/authz-casbin.md b/docs/zh/latest/plugins/authz-casbin.md index 64ee49146a31..942cd28ce442 100644 --- a/docs/zh/latest/plugins/authz-casbin.md +++ b/docs/zh/latest/plugins/authz-casbin.md @@ -67,7 +67,7 @@ description: 本文介绍了关于 Apache APISIX `authz-casbin` 插件的基本 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/authz-casdoor.md b/docs/zh/latest/plugins/authz-casdoor.md index b20d9440e817..45339039518d 100644 --- a/docs/zh/latest/plugins/authz-casdoor.md +++ b/docs/zh/latest/plugins/authz-casdoor.md @@ -91,7 +91,7 @@ curl "http://127.0.0.1:9180/apisix/admin/routes/1" -H "X-API-KEY: edd1c9f034335f :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/authz-keycloak.md b/docs/zh/latest/plugins/authz-keycloak.md index 321ab8515135..003d52cbfa6b 100644 --- a/docs/zh/latest/plugins/authz-keycloak.md +++ b/docs/zh/latest/plugins/authz-keycloak.md @@ -133,7 +133,7 @@ description: 本文介绍了关于 Apache APISIX `authz-keycloak` 插件的基 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/aws-lambda.md b/docs/zh/latest/plugins/aws-lambda.md index 2ab29ab54da0..b5db7f1fe4a3 100644 --- a/docs/zh/latest/plugins/aws-lambda.md +++ b/docs/zh/latest/plugins/aws-lambda.md @@ -64,7 +64,7 @@ description: 本文介绍了关于 Apache APISIX aws-lambda 插件的基本信 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/azure-functions.md b/docs/zh/latest/plugins/azure-functions.md index 17887827edf9..8478d56d6896 100644 --- a/docs/zh/latest/plugins/azure-functions.md +++ b/docs/zh/latest/plugins/azure-functions.md @@ -70,7 +70,7 @@ description: 本文介绍了关于 API 网关 Apache APISIX azure-functions 插 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/basic-auth.md b/docs/zh/latest/plugins/basic-auth.md index 738202ee42af..e22a784e102f 100644 --- a/docs/zh/latest/plugins/basic-auth.md +++ b/docs/zh/latest/plugins/basic-auth.md @@ -57,7 +57,7 @@ Route 端： :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/batch-requests.md b/docs/zh/latest/plugins/batch-requests.md index 5b27b8542696..55eaf7db7bb5 100644 --- a/docs/zh/latest/plugins/batch-requests.md +++ b/docs/zh/latest/plugins/batch-requests.md @@ -73,7 +73,7 @@ plugins: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/brotli.md b/docs/zh/latest/plugins/brotli.md index f9600bda1335..fbe3313e79c1 100644 --- a/docs/zh/latest/plugins/brotli.md +++ b/docs/zh/latest/plugins/brotli.md @@ -66,7 +66,7 @@ sudo ldconfig :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/chaitin-waf.md b/docs/zh/latest/plugins/chaitin-waf.md index 7d29573ed8bc..07c1ee411230 100644 --- a/docs/zh/latest/plugins/chaitin-waf.md +++ b/docs/zh/latest/plugins/chaitin-waf.md @@ -71,7 +71,7 @@ description: 本文介绍了关于 Apache APISIX `chaitin-waf` 插件的基本 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/clickhouse-logger.md b/docs/zh/latest/plugins/clickhouse-logger.md index 4a232bbcaac0..1b169d4d2afc 100644 --- a/docs/zh/latest/plugins/clickhouse-logger.md +++ b/docs/zh/latest/plugins/clickhouse-logger.md @@ -107,7 +107,7 @@ description: 本文介绍了 API 网关 Apache APISIX 如何使用 clickhouse-lo :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/client-control.md b/docs/zh/latest/plugins/client-control.md index d832419e901f..1398e6f8efe8 100644 --- a/docs/zh/latest/plugins/client-control.md +++ b/docs/zh/latest/plugins/client-control.md @@ -48,7 +48,7 @@ description: 本文介绍了 Apache APISIX proxy-control 插件的相关操作 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/consumer-restriction.md b/docs/zh/latest/plugins/consumer-restriction.md index 8e57af874bc3..1fd3656b4736 100644 --- a/docs/zh/latest/plugins/consumer-restriction.md +++ b/docs/zh/latest/plugins/consumer-restriction.md @@ -62,7 +62,7 @@ description: Consumer Restriction 插件允许用户根据 Route、Service 或 C :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/cors.md b/docs/zh/latest/plugins/cors.md index 3aa640f56c49..42aebbca3edf 100644 --- a/docs/zh/latest/plugins/cors.md +++ b/docs/zh/latest/plugins/cors.md @@ -64,7 +64,7 @@ description: 本文介绍了 Apache APISIX cors 插件的基本信息及使用 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/csrf.md b/docs/zh/latest/plugins/csrf.md index 9d4d3568bb96..cb93e27c43ba 100644 --- a/docs/zh/latest/plugins/csrf.md +++ b/docs/zh/latest/plugins/csrf.md @@ -51,7 +51,7 @@ description: CSRF 插件基于 Double Submit Cookie 的方式，帮助用户阻 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/datadog.md b/docs/zh/latest/plugins/datadog.md index 436bc0e248cd..43140d37babd 100644 --- a/docs/zh/latest/plugins/datadog.md +++ b/docs/zh/latest/plugins/datadog.md @@ -90,7 +90,7 @@ docker run -d --name dogstatsd-agent -e DD_API_KEY= -p :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/dubbo-proxy.md b/docs/zh/latest/plugins/dubbo-proxy.md index 8cec33aaecc1..92030482135c 100644 --- a/docs/zh/latest/plugins/dubbo-proxy.md +++ b/docs/zh/latest/plugins/dubbo-proxy.md @@ -60,7 +60,7 @@ plugins: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/echo.md b/docs/zh/latest/plugins/echo.md index 16af66cbe69f..fee3c870c3f2 100644 --- a/docs/zh/latest/plugins/echo.md +++ b/docs/zh/latest/plugins/echo.md @@ -61,7 +61,7 @@ description: 本文介绍了关于 Apache APISIX `echo` 插件的基本信息及 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') @@ -71,7 +71,7 @@ description: 本文介绍了关于 Apache APISIX `echo` 插件的基本信息及 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/elasticsearch-logger.md b/docs/zh/latest/plugins/elasticsearch-logger.md index ff72f1a0d011..c7c4d512b824 100644 --- a/docs/zh/latest/plugins/elasticsearch-logger.md +++ b/docs/zh/latest/plugins/elasticsearch-logger.md @@ -106,7 +106,7 @@ description: 本文介绍了 API 网关 Apache APISIX 的 elasticsearch-logger :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/error-log-logger.md b/docs/zh/latest/plugins/error-log-logger.md index 379c2b1ec079..ee5cc86a341f 100644 --- a/docs/zh/latest/plugins/error-log-logger.md +++ b/docs/zh/latest/plugins/error-log-logger.md @@ -101,7 +101,7 @@ plugins: # plugin list :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/ext-plugin-post-resp.md b/docs/zh/latest/plugins/ext-plugin-post-resp.md index b7dbc2ca61a0..b664aa3b0f13 100644 --- a/docs/zh/latest/plugins/ext-plugin-post-resp.md +++ b/docs/zh/latest/plugins/ext-plugin-post-resp.md @@ -61,7 +61,7 @@ External Plugin 执行的结果会影响当前请求的响应。 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/ext-plugin-pre-req.md b/docs/zh/latest/plugins/ext-plugin-pre-req.md index 324fe5f9459a..dac751d167f6 100644 --- a/docs/zh/latest/plugins/ext-plugin-pre-req.md +++ b/docs/zh/latest/plugins/ext-plugin-pre-req.md @@ -52,7 +52,7 @@ External Plugin 执行的结果会影响当前请求的行为。 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/fault-injection.md b/docs/zh/latest/plugins/fault-injection.md index 99ab96709aed..07f3b0a42a1f 100644 --- a/docs/zh/latest/plugins/fault-injection.md +++ b/docs/zh/latest/plugins/fault-injection.md @@ -81,7 +81,7 @@ description: 本文介绍了关于 Apache APISIX `fault-injection` 插件的基 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/file-logger.md b/docs/zh/latest/plugins/file-logger.md index db527104955f..dab81bc7730d 100644 --- a/docs/zh/latest/plugins/file-logger.md +++ b/docs/zh/latest/plugins/file-logger.md @@ -115,7 +115,7 @@ description: API 网关 Apache APISIX file-logger 插件可用于将日志数据 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/forward-auth.md b/docs/zh/latest/plugins/forward-auth.md index b199fa93b527..04d902653274 100644 --- a/docs/zh/latest/plugins/forward-auth.md +++ b/docs/zh/latest/plugins/forward-auth.md @@ -64,7 +64,7 @@ APISIX 将生成并发送如下所示的请求头到认证服务： :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/google-cloud-logging.md b/docs/zh/latest/plugins/google-cloud-logging.md index a4e60f4508eb..51df4ad5ac18 100644 --- a/docs/zh/latest/plugins/google-cloud-logging.md +++ b/docs/zh/latest/plugins/google-cloud-logging.md @@ -99,7 +99,7 @@ description: API 网关 Apache APISIX 的 google-cloud-logging 插件可用于 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/grpc-transcode.md b/docs/zh/latest/plugins/grpc-transcode.md index e9a6488229d5..52deafd8f234 100644 --- a/docs/zh/latest/plugins/grpc-transcode.md +++ b/docs/zh/latest/plugins/grpc-transcode.md @@ -65,7 +65,7 @@ APISIX 接收 HTTP 请求后，首先对请求进行转码，并将转码后的 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/grpc-web.md b/docs/zh/latest/plugins/grpc-web.md index 40c6062d2fb9..0bcfe8a44451 100644 --- a/docs/zh/latest/plugins/grpc-web.md +++ b/docs/zh/latest/plugins/grpc-web.md @@ -44,7 +44,7 @@ description: 本文介绍了关于 Apache APISIX `grpc-web` 插件的基本信 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/gzip.md b/docs/zh/latest/plugins/gzip.md index 12330544931f..7d9bb9ced65e 100644 --- a/docs/zh/latest/plugins/gzip.md +++ b/docs/zh/latest/plugins/gzip.md @@ -56,7 +56,7 @@ description: 本文介绍了关于 Apache APISIX `gzip` 插件的基本信息及 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/hmac-auth.md b/docs/zh/latest/plugins/hmac-auth.md index 9138655ed0a6..519206d8f2aa 100644 --- a/docs/zh/latest/plugins/hmac-auth.md +++ b/docs/zh/latest/plugins/hmac-auth.md @@ -56,7 +56,7 @@ description: 本文介绍了关于 Apache APISIX `hmac-auth` 插件的基本信 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/http-logger.md b/docs/zh/latest/plugins/http-logger.md index 20e460fc7170..daba13cb3777 100644 --- a/docs/zh/latest/plugins/http-logger.md +++ b/docs/zh/latest/plugins/http-logger.md @@ -110,7 +110,7 @@ description: 本文介绍了 API 网关 Apache APISIX 的 http-logger 插件。 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/ip-restriction.md b/docs/zh/latest/plugins/ip-restriction.md index 5cf9e61c97ac..efb79899cac3 100644 --- a/docs/zh/latest/plugins/ip-restriction.md +++ b/docs/zh/latest/plugins/ip-restriction.md @@ -54,7 +54,7 @@ description: 本文介绍了 Apache APISIX ip-restriction 插件的基本信息 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/jwe-decrypt.md b/docs/zh/latest/plugins/jwe-decrypt.md index 4bf4230c678f..3bd49472d0a0 100644 --- a/docs/zh/latest/plugins/jwe-decrypt.md +++ b/docs/zh/latest/plugins/jwe-decrypt.md @@ -64,7 +64,7 @@ Route 配置： :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/jwt-auth.md b/docs/zh/latest/plugins/jwt-auth.md index 592d8d002212..5f5df067bb4a 100644 --- a/docs/zh/latest/plugins/jwt-auth.md +++ b/docs/zh/latest/plugins/jwt-auth.md @@ -80,7 +80,7 @@ Route 端： :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/kafka-logger.md b/docs/zh/latest/plugins/kafka-logger.md index ed4f4ba79487..7a200ace6b76 100644 --- a/docs/zh/latest/plugins/kafka-logger.md +++ b/docs/zh/latest/plugins/kafka-logger.md @@ -144,7 +144,7 @@ description: API 网关 Apache APISIX 的 kafka-logger 插件用于将日志作 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/key-auth.md b/docs/zh/latest/plugins/key-auth.md index 6969e4c29f46..9a2d21873d7a 100644 --- a/docs/zh/latest/plugins/key-auth.md +++ b/docs/zh/latest/plugins/key-auth.md @@ -60,7 +60,7 @@ Router 端： :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/ldap-auth.md b/docs/zh/latest/plugins/ldap-auth.md index a7f19a5e22e7..d754953a7e5f 100644 --- a/docs/zh/latest/plugins/ldap-auth.md +++ b/docs/zh/latest/plugins/ldap-auth.md @@ -58,7 +58,7 @@ Route 端： :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/limit-conn.md b/docs/zh/latest/plugins/limit-conn.md index 4fdd880537be..31fad1fe1143 100644 --- a/docs/zh/latest/plugins/limit-conn.md +++ b/docs/zh/latest/plugins/limit-conn.md @@ -63,7 +63,7 @@ description: 本文介绍了 Apache APISIX limit-conn 插件的相关操作， :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/limit-count.md b/docs/zh/latest/plugins/limit-count.md index 8aa65e21957a..636d6fcf4a74 100644 --- a/docs/zh/latest/plugins/limit-count.md +++ b/docs/zh/latest/plugins/limit-count.md @@ -64,7 +64,7 @@ description: 本文介绍了 Apache APISIX limit-count 插件的相关操作， :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/limit-req.md b/docs/zh/latest/plugins/limit-req.md index 221d3338773f..49860a8fbdc6 100644 --- a/docs/zh/latest/plugins/limit-req.md +++ b/docs/zh/latest/plugins/limit-req.md @@ -65,7 +65,7 @@ description: limit-req 插件使用漏桶算法限制对用户服务的请求速 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/loggly.md b/docs/zh/latest/plugins/loggly.md index b81b6ac9d861..495d274000df 100644 --- a/docs/zh/latest/plugins/loggly.md +++ b/docs/zh/latest/plugins/loggly.md @@ -77,7 +77,7 @@ Syslog 协议允许你发送符合 RFC5424 的 syslog 事件并进行细粒度 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/loki-logger.md b/docs/zh/latest/plugins/loki-logger.md index bd5e02308c28..f2240f213273 100644 --- a/docs/zh/latest/plugins/loki-logger.md +++ b/docs/zh/latest/plugins/loki-logger.md @@ -115,7 +115,7 @@ description: 本文件包含关于 Apache APISIX loki-logger 插件的信息。 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/mocking.md b/docs/zh/latest/plugins/mocking.md index 19b219c52ba6..82d647f792db 100644 --- a/docs/zh/latest/plugins/mocking.md +++ b/docs/zh/latest/plugins/mocking.md @@ -128,7 +128,7 @@ JSON Schema 在其字段中支持以下类型： :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/mqtt-proxy.md b/docs/zh/latest/plugins/mqtt-proxy.md index f3c0c8f80f7b..8fc082af2e4d 100644 --- a/docs/zh/latest/plugins/mqtt-proxy.md +++ b/docs/zh/latest/plugins/mqtt-proxy.md @@ -62,7 +62,7 @@ description: 本文档介绍了 Apache APISIX mqtt-proxy 插件的信息，通 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/multi-auth.md b/docs/zh/latest/plugins/multi-auth.md index 9ddba1e5d54e..10aecbf57f76 100644 --- a/docs/zh/latest/plugins/multi-auth.md +++ b/docs/zh/latest/plugins/multi-auth.md @@ -50,7 +50,7 @@ For Route: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') @@ -60,7 +60,7 @@ For Route: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/node-status.md b/docs/zh/latest/plugins/node-status.md index 33fb43dcc0b5..16dc615ca0d0 100644 --- a/docs/zh/latest/plugins/node-status.md +++ b/docs/zh/latest/plugins/node-status.md @@ -56,7 +56,7 @@ plugins: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/ocsp-stapling.md b/docs/zh/latest/plugins/ocsp-stapling.md index 4e70a9994e32..9eb4c1ebbb00 100644 --- a/docs/zh/latest/plugins/ocsp-stapling.md +++ b/docs/zh/latest/plugins/ocsp-stapling.md @@ -45,7 +45,7 @@ plugins: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/opa.md b/docs/zh/latest/plugins/opa.md index 55ba8152dd19..4ae479ce1b12 100644 --- a/docs/zh/latest/plugins/opa.md +++ b/docs/zh/latest/plugins/opa.md @@ -305,7 +305,7 @@ curl -X GET 127.0.0.1:9080/get :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/openfunction.md b/docs/zh/latest/plugins/openfunction.md index 373278052016..cdcd7fae0859 100644 --- a/docs/zh/latest/plugins/openfunction.md +++ b/docs/zh/latest/plugins/openfunction.md @@ -78,7 +78,7 @@ kubectl create secret docker-registry push-secret \ :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/openid-connect.md b/docs/zh/latest/plugins/openid-connect.md index c6c6d35c0037..0017f09f5774 100644 --- a/docs/zh/latest/plugins/openid-connect.md +++ b/docs/zh/latest/plugins/openid-connect.md @@ -118,7 +118,7 @@ description: OpenID Connect（OIDC）是基于 OAuth 2.0 的身份认证协议 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/opentelemetry.md b/docs/zh/latest/plugins/opentelemetry.md index 0bb87ba8061d..c89970a4551e 100644 --- a/docs/zh/latest/plugins/opentelemetry.md +++ b/docs/zh/latest/plugins/opentelemetry.md @@ -125,7 +125,7 @@ plugins: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/openwhisk.md b/docs/zh/latest/plugins/openwhisk.md index 7475700e76d2..366dff074d7d 100644 --- a/docs/zh/latest/plugins/openwhisk.md +++ b/docs/zh/latest/plugins/openwhisk.md @@ -90,7 +90,7 @@ wsk action update test <(echo 'function main(){return {"ready":true}}') --kind n :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/prometheus.md b/docs/zh/latest/plugins/prometheus.md index 2743ae6b0e75..f52bae0d1d2f 100644 --- a/docs/zh/latest/plugins/prometheus.md +++ b/docs/zh/latest/plugins/prometheus.md @@ -121,7 +121,7 @@ plugin_attr: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/proxy-cache.md b/docs/zh/latest/plugins/proxy-cache.md index 4d430a1ef7a2..d0bee3b2fc1a 100644 --- a/docs/zh/latest/plugins/proxy-cache.md +++ b/docs/zh/latest/plugins/proxy-cache.md @@ -82,7 +82,7 @@ apisix: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/proxy-control.md b/docs/zh/latest/plugins/proxy-control.md index b40346853f80..2d5b744759fa 100644 --- a/docs/zh/latest/plugins/proxy-control.md +++ b/docs/zh/latest/plugins/proxy-control.md @@ -48,7 +48,7 @@ description: 本文介绍了 Apache APISIX proxy-control 插件的相关操作 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/proxy-mirror.md b/docs/zh/latest/plugins/proxy-mirror.md index fe02b35318b2..343a00752746 100644 --- a/docs/zh/latest/plugins/proxy-mirror.md +++ b/docs/zh/latest/plugins/proxy-mirror.md @@ -51,7 +51,7 @@ description: 本文介绍了 Apache APISIX proxy-mirror 插件的相关操作， :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/proxy-rewrite.md b/docs/zh/latest/plugins/proxy-rewrite.md index 32c7c680a3c7..22ca5b9f86df 100644 --- a/docs/zh/latest/plugins/proxy-rewrite.md +++ b/docs/zh/latest/plugins/proxy-rewrite.md @@ -58,7 +58,7 @@ Header 头的相关配置，遵循如下优先级进行执行： :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/public-api.md b/docs/zh/latest/plugins/public-api.md index cd23c1890879..74a0a0130a83 100644 --- a/docs/zh/latest/plugins/public-api.md +++ b/docs/zh/latest/plugins/public-api.md @@ -56,7 +56,7 @@ description: 本文介绍了 public-api 的相关操作，你可以使用 public :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/real-ip.md b/docs/zh/latest/plugins/real-ip.md index ccc5dcef9e66..6672af22a518 100644 --- a/docs/zh/latest/plugins/real-ip.md +++ b/docs/zh/latest/plugins/real-ip.md @@ -59,7 +59,7 @@ description: 本文介绍了关于 Apache APISIX `real-ip` 插件的基本信息 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/redirect.md b/docs/zh/latest/plugins/redirect.md index 0e82eb7f495e..b533d1415e6a 100644 --- a/docs/zh/latest/plugins/redirect.md +++ b/docs/zh/latest/plugins/redirect.md @@ -59,7 +59,7 @@ description: 本文介绍了关于 Apache APISIX `redirect` 插件的基本信 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/referer-restriction.md b/docs/zh/latest/plugins/referer-restriction.md index 4e26dbd8c4b5..399c63d4632e 100644 --- a/docs/zh/latest/plugins/referer-restriction.md +++ b/docs/zh/latest/plugins/referer-restriction.md @@ -51,7 +51,7 @@ description: 本文介绍了 Apache APISIX referer-restriction 插件的使用 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/request-id.md b/docs/zh/latest/plugins/request-id.md index ea8f930bc5b4..95df0293f377 100644 --- a/docs/zh/latest/plugins/request-id.md +++ b/docs/zh/latest/plugins/request-id.md @@ -52,7 +52,7 @@ description: 本文介绍了 Apache APISIX request-id 插件的相关操作， :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/request-validation.md b/docs/zh/latest/plugins/request-validation.md index 0bfc9afd573d..066e81fd4bf4 100644 --- a/docs/zh/latest/plugins/request-validation.md +++ b/docs/zh/latest/plugins/request-validation.md @@ -51,7 +51,7 @@ description: 本文介绍了 Apache APISIX request-validation 插件的相关操 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/response-rewrite.md b/docs/zh/latest/plugins/response-rewrite.md index 8ffe6d3f6588..d6dbbcc1859d 100644 --- a/docs/zh/latest/plugins/response-rewrite.md +++ b/docs/zh/latest/plugins/response-rewrite.md @@ -73,7 +73,7 @@ description: 本文介绍了关于 Apache APISIX `response-rewrite` 插件的基 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/rocketmq-logger.md b/docs/zh/latest/plugins/rocketmq-logger.md index 30bc45e39d71..16561adaada8 100644 --- a/docs/zh/latest/plugins/rocketmq-logger.md +++ b/docs/zh/latest/plugins/rocketmq-logger.md @@ -134,7 +134,7 @@ description: API 网关 Apache APISIX 的 rocketmq-logger 插件用于将日志 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/serverless.md b/docs/zh/latest/plugins/serverless.md index e93eaf0efbaf..678dc40f3a5b 100644 --- a/docs/zh/latest/plugins/serverless.md +++ b/docs/zh/latest/plugins/serverless.md @@ -85,7 +85,7 @@ ngx.say(count) :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/skywalking-logger.md b/docs/zh/latest/plugins/skywalking-logger.md index 84a678c7b169..9cf5f8130df5 100644 --- a/docs/zh/latest/plugins/skywalking-logger.md +++ b/docs/zh/latest/plugins/skywalking-logger.md @@ -127,7 +127,7 @@ description: 本文将介绍 API 网关 Apache APISIX 如何通过 skywalking-lo :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/skywalking.md b/docs/zh/latest/plugins/skywalking.md index fa9fa710b3ec..c12c0b1708ce 100644 --- a/docs/zh/latest/plugins/skywalking.md +++ b/docs/zh/latest/plugins/skywalking.md @@ -120,7 +120,7 @@ plugins: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/sls-logger.md b/docs/zh/latest/plugins/sls-logger.md index 1813e3233a9d..1772a79309ad 100644 --- a/docs/zh/latest/plugins/sls-logger.md +++ b/docs/zh/latest/plugins/sls-logger.md @@ -89,7 +89,7 @@ title: sls-logger :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/splunk-hec-logging.md b/docs/zh/latest/plugins/splunk-hec-logging.md index e6bbc7560137..0401dc7e5be0 100644 --- a/docs/zh/latest/plugins/splunk-hec-logging.md +++ b/docs/zh/latest/plugins/splunk-hec-logging.md @@ -95,7 +95,7 @@ description: API 网关 Apache APISIX 的 splunk-hec-logging 插件可用于将 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/syslog.md b/docs/zh/latest/plugins/syslog.md index 288674e1320f..2c9fbc42bf89 100644 --- a/docs/zh/latest/plugins/syslog.md +++ b/docs/zh/latest/plugins/syslog.md @@ -80,7 +80,7 @@ description: API 网关 Apache APISIX syslog 插件可用于将日志推送到 S :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/tcp-logger.md b/docs/zh/latest/plugins/tcp-logger.md index d87213611ef1..eed67fb8852b 100644 --- a/docs/zh/latest/plugins/tcp-logger.md +++ b/docs/zh/latest/plugins/tcp-logger.md @@ -106,7 +106,7 @@ description: 本文介绍了 API 网关 Apache APISIX 如何使用 tcp-logger :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/tencent-cloud-cls.md b/docs/zh/latest/plugins/tencent-cloud-cls.md index 8cec48e7afea..fdc59bec3608 100644 --- a/docs/zh/latest/plugins/tencent-cloud-cls.md +++ b/docs/zh/latest/plugins/tencent-cloud-cls.md @@ -108,7 +108,7 @@ description: API 网关 Apache APISIX tencent-cloud-cls 插件可用于将日志 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/traffic-split.md b/docs/zh/latest/plugins/traffic-split.md index a702db27c469..c62f62acec49 100644 --- a/docs/zh/latest/plugins/traffic-split.md +++ b/docs/zh/latest/plugins/traffic-split.md @@ -79,7 +79,7 @@ description: 本文介绍了 Apache APISIX traffic-split 插件的相关操作 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/ua-restriction.md b/docs/zh/latest/plugins/ua-restriction.md index 791b23dbd678..28a7e36e08d9 100644 --- a/docs/zh/latest/plugins/ua-restriction.md +++ b/docs/zh/latest/plugins/ua-restriction.md @@ -53,7 +53,7 @@ description: 本文介绍了 Apache APISIX ua-restriction 插件的使用方法 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/udp-logger.md b/docs/zh/latest/plugins/udp-logger.md index 23d7a04ef74f..f0ab2dd5be82 100644 --- a/docs/zh/latest/plugins/udp-logger.md +++ b/docs/zh/latest/plugins/udp-logger.md @@ -105,7 +105,7 @@ description: 本文介绍了 API 网关 Apache APISIX 如何使用 udp-logger :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/uri-blocker.md b/docs/zh/latest/plugins/uri-blocker.md index 7301ade560ee..fd95b95c4138 100644 --- a/docs/zh/latest/plugins/uri-blocker.md +++ b/docs/zh/latest/plugins/uri-blocker.md @@ -45,7 +45,7 @@ description: 本文介绍了 Apache APISIX uri-blocker 插件的基本信息及 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/wolf-rbac.md b/docs/zh/latest/plugins/wolf-rbac.md index a4ad8183fd1c..e8386f5acbac 100644 --- a/docs/zh/latest/plugins/wolf-rbac.md +++ b/docs/zh/latest/plugins/wolf-rbac.md @@ -66,7 +66,7 @@ description: 本文介绍了关于 Apache APISIX `wolf-rbac` 插件的基本信 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/workflow.md b/docs/zh/latest/plugins/workflow.md index 6563d7d6977f..6989a6979807 100644 --- a/docs/zh/latest/plugins/workflow.md +++ b/docs/zh/latest/plugins/workflow.md @@ -67,7 +67,7 @@ description: 本文介绍了关于 Apache APISIX `workflow` 插件的基本信 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/plugins/zipkin.md b/docs/zh/latest/plugins/zipkin.md index 7835e2ed8065..9c8585233db7 100644 --- a/docs/zh/latest/plugins/zipkin.md +++ b/docs/zh/latest/plugins/zipkin.md @@ -112,7 +112,7 @@ func main(){ :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/router-radixtree.md b/docs/zh/latest/router-radixtree.md index 3365c979995e..63e89a6d220f 100644 --- a/docs/zh/latest/router-radixtree.md +++ b/docs/zh/latest/router-radixtree.md @@ -84,7 +84,7 @@ title: 路由 RadixTree :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') @@ -94,7 +94,7 @@ title: 路由 RadixTree :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/ssl-protocol.md b/docs/zh/latest/ssl-protocol.md index 7130d3ed17f9..1835b83bf3c0 100644 --- a/docs/zh/latest/ssl-protocol.md +++ b/docs/zh/latest/ssl-protocol.md @@ -83,7 +83,7 @@ apisix: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/stream-proxy.md b/docs/zh/latest/stream-proxy.md index 106b9ea7246e..5e1d83a0fd75 100644 --- a/docs/zh/latest/stream-proxy.md +++ b/docs/zh/latest/stream-proxy.md @@ -46,7 +46,7 @@ apisix: :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/terminology/consumer-group.md b/docs/zh/latest/terminology/consumer-group.md index 00bcb534628f..fcf39511de78 100644 --- a/docs/zh/latest/terminology/consumer-group.md +++ b/docs/zh/latest/terminology/consumer-group.md @@ -38,7 +38,7 @@ description: 本文介绍了 Apache APISIX Consumer Group 对象的概念及使 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/terminology/consumer.md b/docs/zh/latest/terminology/consumer.md index 6373c09f36ad..0b4ab1a6759c 100644 --- a/docs/zh/latest/terminology/consumer.md +++ b/docs/zh/latest/terminology/consumer.md @@ -74,7 +74,7 @@ Consumer 是某类服务的消费者，需要与用户认证配合才可以使 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/terminology/global-rule.md b/docs/zh/latest/terminology/global-rule.md index 2b1f958684ec..d700e30f3aa4 100644 --- a/docs/zh/latest/terminology/global-rule.md +++ b/docs/zh/latest/terminology/global-rule.md @@ -41,7 +41,7 @@ description: 本文介绍了全局规则的概念以及如何启用全局规则 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/terminology/plugin-config.md b/docs/zh/latest/terminology/plugin-config.md index ae18d3cdeea6..a2c12a8a2d73 100644 --- a/docs/zh/latest/terminology/plugin-config.md +++ b/docs/zh/latest/terminology/plugin-config.md @@ -41,7 +41,7 @@ description: Plugin Config 对象，可以用于创建一组通用的插件配 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/terminology/plugin-metadata.md b/docs/zh/latest/terminology/plugin-metadata.md index e522c36dcd2e..ad843b788ba4 100644 --- a/docs/zh/latest/terminology/plugin-metadata.md +++ b/docs/zh/latest/terminology/plugin-metadata.md @@ -53,7 +53,7 @@ description: APISIX 的插件元数据 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/terminology/plugin.md b/docs/zh/latest/terminology/plugin.md index b7d6afa3c917..100352283ba8 100644 --- a/docs/zh/latest/terminology/plugin.md +++ b/docs/zh/latest/terminology/plugin.md @@ -296,7 +296,7 @@ APISIX 的插件是热加载的，不管你是新增、删除还是修改插件 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/terminology/route.md b/docs/zh/latest/terminology/route.md index 297bd93e4fa6..c8ab4bec61e3 100644 --- a/docs/zh/latest/terminology/route.md +++ b/docs/zh/latest/terminology/route.md @@ -47,7 +47,7 @@ Route（也称为路由）是 APISIX 中最基础和最核心的资源对象，A :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/terminology/secret.md b/docs/zh/latest/terminology/secret.md index e7a96d3a6836..2bda5cdc5a7a 100644 --- a/docs/zh/latest/terminology/secret.md +++ b/docs/zh/latest/terminology/secret.md @@ -101,7 +101,7 @@ export JACK_AUTH_KEY=abc :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/terminology/service.md b/docs/zh/latest/terminology/service.md index cfc2c0d60ac0..39776170f791 100644 --- a/docs/zh/latest/terminology/service.md +++ b/docs/zh/latest/terminology/service.md @@ -42,7 +42,7 @@ Service（也称之为服务）是某类 API 的抽象（也可以理解为一 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/terminology/upstream.md b/docs/zh/latest/terminology/upstream.md index 49529c9d6de6..7b684c7edd75 100644 --- a/docs/zh/latest/terminology/upstream.md +++ b/docs/zh/latest/terminology/upstream.md @@ -45,7 +45,7 @@ APISIX 的 Upstream 对象除了基本的负载均衡算法外，还支持对上 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/tutorials/client-to-apisix-mtls.md b/docs/zh/latest/tutorials/client-to-apisix-mtls.md index 8adb4aa9a4a6..55175468723d 100644 --- a/docs/zh/latest/tutorials/client-to-apisix-mtls.md +++ b/docs/zh/latest/tutorials/client-to-apisix-mtls.md @@ -207,7 +207,7 @@ APISIX 允许配置 URI 白名单以便绕过 MTLS。如果请求的 URI 在白 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/tutorials/health-check.md b/docs/zh/latest/tutorials/health-check.md index 94c860ea4d84..5a828dfe47d0 100644 --- a/docs/zh/latest/tutorials/health-check.md +++ b/docs/zh/latest/tutorials/health-check.md @@ -89,7 +89,7 @@ description: 本文介绍了如何使用 API 网关 Apache APISIX 的健康检 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/tutorials/observe-your-api.md b/docs/zh/latest/tutorials/observe-your-api.md index 6896268ebb70..5f298476d79e 100644 --- a/docs/zh/latest/tutorials/observe-your-api.md +++ b/docs/zh/latest/tutorials/observe-your-api.md @@ -66,7 +66,7 @@ APISIX 中提供了很多具有丰富功能的可观测性插件。你可以通 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g') diff --git a/docs/zh/latest/tutorials/protect-api.md b/docs/zh/latest/tutorials/protect-api.md index 3c05d7c4ae29..ec2af5230844 100644 --- a/docs/zh/latest/tutorials/protect-api.md +++ b/docs/zh/latest/tutorials/protect-api.md @@ -69,7 +69,7 @@ description: 本文介绍了如何通过 Apache APISIX 发布服务和路由。 :::note -您可以像这样从 config.yaml 中获取 admin_key。 +您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ```bash admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')