tao12345666333 commented on a change in pull request #4535:
URL: https://github.com/apache/apisix/pull/4535#discussion_r663789133
##########
File path: docs/en/latest/FAQ.md
##########
@@ -476,26 +476,26 @@ The route was created successfully. It means that the
modification of `X-API-KEY
## How to allow all IPs to access Admin API
-By default, Apache APISIX only allows the IP range of `127.0.0.0/24` to access
the `Admin API`. If you want to allow all IP access, then you only need to add
the following configuration in the `conf/config.yaml` configuration file.
+By default, Apache Apache APISIX only allows the IP range of `127.0.0.0/24` to
access the `Admin API`. If you want to allow all IP access, then you only need
to add the following configuration in the `conf/config.yaml` configuration file.
```yaml
-apisix:
+Apache APISIX:
allow_admin:
- 0.0.0.0/0
```
-Restart or reload APISIX, all IPs can access the `Admin API`.
+Restart or reload Apache APISIX, all IPs can access the `Admin API`.
-**Note: You can use this method in a non-production environment to allow all
clients from anywhere to access your `Apache APISIX` instances, but it is not
safe to use it in a production environment. In production environment, please
only authorize specific IP addresses or address ranges to access your
instance.**
+**Note: You can use this method in a non-production environment to allow all
clients from anywhere to access your `Apache Apache APISIX` instances, but it
is not safe to use it in a production environment. In production environment,
please only authorize specific IP addresses or address ranges to access your
instance.**
## How to auto renew SSL cert via acme.sh
```bash
-$ curl --output /root/.acme.sh/renew-hook-update-apisix.sh --silent
https://gist.githubusercontent.com/anjia0532/9ebf8011322f43e3f5037bc2af3aeaa6/raw/65b359a4eed0ae990f9188c2afa22bacd8471652/renew-hook-update-apisix.sh
+$ curl --output /root/.acme.sh/renew-hook-update-Apache APISIX.sh --silent
https://gist.githubusercontent.com/anjia0532/9ebf8011322f43e3f5037bc2af3aeaa6/raw/65b359a4eed0ae990f9188c2afa22bacd8471652/renew-hook-update-Apache
APISIX.sh
-$ chmod +x /root/.acme.sh/renew-hook-update-apisix.sh
+$ chmod +x /root/.acme.sh/renew-hook-update-Apache APISIX.sh
Review comment:
ditto
##########
File path: docs/en/latest/FAQ.md
##########
@@ -335,26 +335,26 @@ Example: luarocks install luasec OPENSSL_DIR=/usr/local
make: *** [deps] Error 1
```
-## How to access APISIX Dashboard through APISIX proxy
+## How to access Apache APISIX Dashboard through Apache APISIX proxy
-1. Keep the APISIX proxy port and Admin API port different(or disable Admin
API). For example, do the following configuration in `conf/config.yaml`.
+1. Keep the Apache APISIX proxy port and Admin API port different(or disable
Admin API). For example, do the following configuration in `conf/config.yaml`.
The Admin API use a separate port 9180:
```yaml
-apisix:
+Apache APISIX:
port_admin: 9180 # use a separate port
```
-2. Add proxy route of APISIX Dashboard:
+2. Add proxy route of Apache APISIX Dashboard:
-Note: The APISIX Dashboard service here is listening on `127.0.0.1:9000`.
+Note: The Apache APISIX Dashboard service here is listening on
`127.0.0.1:9000`.
```shell
-curl -i http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+curl -i http://127.0.0.1:9180/Apache APISIX/admin/routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uris":[ "/*" ],
- "name":"apisix_proxy_dashboard",
+ "name":"Apache APISIX_proxy_dashboard",
Review comment:
```suggestion
"name":"apisix_proxy_dashboard",
```
##########
File path: docs/en/latest/FAQ.md
##########
@@ -476,26 +476,26 @@ The route was created successfully. It means that the
modification of `X-API-KEY
## How to allow all IPs to access Admin API
-By default, Apache APISIX only allows the IP range of `127.0.0.0/24` to access
the `Admin API`. If you want to allow all IP access, then you only need to add
the following configuration in the `conf/config.yaml` configuration file.
+By default, Apache Apache APISIX only allows the IP range of `127.0.0.0/24` to
access the `Admin API`. If you want to allow all IP access, then you only need
to add the following configuration in the `conf/config.yaml` configuration file.
```yaml
-apisix:
+Apache APISIX:
allow_admin:
- 0.0.0.0/0
```
-Restart or reload APISIX, all IPs can access the `Admin API`.
+Restart or reload Apache APISIX, all IPs can access the `Admin API`.
-**Note: You can use this method in a non-production environment to allow all
clients from anywhere to access your `Apache APISIX` instances, but it is not
safe to use it in a production environment. In production environment, please
only authorize specific IP addresses or address ranges to access your
instance.**
+**Note: You can use this method in a non-production environment to allow all
clients from anywhere to access your `Apache Apache APISIX` instances, but it
is not safe to use it in a production environment. In production environment,
please only authorize specific IP addresses or address ranges to access your
instance.**
## How to auto renew SSL cert via acme.sh
```bash
-$ curl --output /root/.acme.sh/renew-hook-update-apisix.sh --silent
https://gist.githubusercontent.com/anjia0532/9ebf8011322f43e3f5037bc2af3aeaa6/raw/65b359a4eed0ae990f9188c2afa22bacd8471652/renew-hook-update-apisix.sh
+$ curl --output /root/.acme.sh/renew-hook-update-Apache APISIX.sh --silent
https://gist.githubusercontent.com/anjia0532/9ebf8011322f43e3f5037bc2af3aeaa6/raw/65b359a4eed0ae990f9188c2afa22bacd8471652/renew-hook-update-Apache
APISIX.sh
Review comment:
ditto
##########
File path: docs/en/latest/FAQ.md
##########
@@ -476,26 +476,26 @@ The route was created successfully. It means that the
modification of `X-API-KEY
## How to allow all IPs to access Admin API
-By default, Apache APISIX only allows the IP range of `127.0.0.0/24` to access
the `Admin API`. If you want to allow all IP access, then you only need to add
the following configuration in the `conf/config.yaml` configuration file.
+By default, Apache Apache APISIX only allows the IP range of `127.0.0.0/24` to
access the `Admin API`. If you want to allow all IP access, then you only need
to add the following configuration in the `conf/config.yaml` configuration file.
```yaml
-apisix:
+Apache APISIX:
allow_admin:
- 0.0.0.0/0
```
-Restart or reload APISIX, all IPs can access the `Admin API`.
+Restart or reload Apache APISIX, all IPs can access the `Admin API`.
-**Note: You can use this method in a non-production environment to allow all
clients from anywhere to access your `Apache APISIX` instances, but it is not
safe to use it in a production environment. In production environment, please
only authorize specific IP addresses or address ranges to access your
instance.**
+**Note: You can use this method in a non-production environment to allow all
clients from anywhere to access your `Apache Apache APISIX` instances, but it
is not safe to use it in a production environment. In production environment,
please only authorize specific IP addresses or address ranges to access your
instance.**
## How to auto renew SSL cert via acme.sh
```bash
-$ curl --output /root/.acme.sh/renew-hook-update-apisix.sh --silent
https://gist.githubusercontent.com/anjia0532/9ebf8011322f43e3f5037bc2af3aeaa6/raw/65b359a4eed0ae990f9188c2afa22bacd8471652/renew-hook-update-apisix.sh
+$ curl --output /root/.acme.sh/renew-hook-update-Apache APISIX.sh --silent
https://gist.githubusercontent.com/anjia0532/9ebf8011322f43e3f5037bc2af3aeaa6/raw/65b359a4eed0ae990f9188c2afa22bacd8471652/renew-hook-update-Apache
APISIX.sh
-$ chmod +x /root/.acme.sh/renew-hook-update-apisix.sh
+$ chmod +x /root/.acme.sh/renew-hook-update-Apache APISIX.sh
-$ acme.sh --issue --staging -d demo.domain --renew-hook
"/root/.acme.sh/renew-hook-update-apisix.sh -h http://apisix-admin:port -p
/root/.acme.sh/demo.domain/demo.domain.cer -k
/root/.acme.sh/demo.domain/demo.domain.key -a xxxxxxxxxxxxx"
+$ acme.sh --issue --staging -d demo.domain --renew-hook
"/root/.acme.sh/renew-hook-update-Apache APISIX.sh -h http://Apache
APISIX-admin:port -p /root/.acme.sh/demo.domain/demo.domain.cer -k
/root/.acme.sh/demo.domain/demo.domain.key -a xxxxxxxxxxxxx"
Review comment:
ditto
##########
File path: docs/en/latest/FAQ.md
##########
@@ -476,26 +476,26 @@ The route was created successfully. It means that the
modification of `X-API-KEY
## How to allow all IPs to access Admin API
-By default, Apache APISIX only allows the IP range of `127.0.0.0/24` to access
the `Admin API`. If you want to allow all IP access, then you only need to add
the following configuration in the `conf/config.yaml` configuration file.
+By default, Apache Apache APISIX only allows the IP range of `127.0.0.0/24` to
access the `Admin API`. If you want to allow all IP access, then you only need
to add the following configuration in the `conf/config.yaml` configuration file.
```yaml
-apisix:
+Apache APISIX:
allow_admin:
- 0.0.0.0/0
```
-Restart or reload APISIX, all IPs can access the `Admin API`.
+Restart or reload Apache APISIX, all IPs can access the `Admin API`.
-**Note: You can use this method in a non-production environment to allow all
clients from anywhere to access your `Apache APISIX` instances, but it is not
safe to use it in a production environment. In production environment, please
only authorize specific IP addresses or address ranges to access your
instance.**
+**Note: You can use this method in a non-production environment to allow all
clients from anywhere to access your `Apache Apache APISIX` instances, but it
is not safe to use it in a production environment. In production environment,
please only authorize specific IP addresses or address ranges to access your
instance.**
Review comment:
duplicated
##########
File path: docs/en/latest/FAQ.md
##########
@@ -432,16 +432,16 @@ HTTP/1.1 200 OK
## What is the `X-API-KEY` of Admin API? Can it be modified?
-1. The `X-API-KEY` of Admin API refers to the `apisix.admin_key.key` in the
`config.yaml` file, and the default value is
`edd1c9f034335f136f87ad84b625c8f1`. It is the access token of the Admin API.
+1. The `X-API-KEY` of Admin API refers to the `Apache APISIX.admin_key.key` in
the `config.yaml` file, and the default value is
`edd1c9f034335f136f87ad84b625c8f1`. It is the access token of the Admin API.
Review comment:
ditto
##########
File path: docs/en/latest/FAQ.md
##########
@@ -476,26 +476,26 @@ The route was created successfully. It means that the
modification of `X-API-KEY
## How to allow all IPs to access Admin API
-By default, Apache APISIX only allows the IP range of `127.0.0.0/24` to access
the `Admin API`. If you want to allow all IP access, then you only need to add
the following configuration in the `conf/config.yaml` configuration file.
+By default, Apache Apache APISIX only allows the IP range of `127.0.0.0/24` to
access the `Admin API`. If you want to allow all IP access, then you only need
to add the following configuration in the `conf/config.yaml` configuration file.
Review comment:
duplicated
##########
File path: docs/en/latest/FAQ.md
##########
@@ -432,16 +432,16 @@ HTTP/1.1 200 OK
## What is the `X-API-KEY` of Admin API? Can it be modified?
-1. The `X-API-KEY` of Admin API refers to the `apisix.admin_key.key` in the
`config.yaml` file, and the default value is
`edd1c9f034335f136f87ad84b625c8f1`. It is the access token of the Admin API.
+1. The `X-API-KEY` of Admin API refers to the `Apache APISIX.admin_key.key` in
the `config.yaml` file, and the default value is
`edd1c9f034335f136f87ad84b625c8f1`. It is the access token of the Admin API.
Note: There are security risks in using the default API token. It is
recommended to update it when deploying to a production environment.
2. `X-API-KEY` can be modified.
-For example: make the following changes to the `apisix.admin_key.key` in the
`conf/config.yaml` file and reload APISIX.
+For example: make the following changes to the `Apache APISIX.admin_key.key`
in the `conf/config.yaml` file and reload Apache APISIX.
```yaml
-apisix:
+Apache APISIX:
Review comment:
ditto
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
