This is an automated email from the ASF dual-hosted git repository.
juzhiyuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 919ac16d4 docs: move "configuring APISIX" section to "Installation"
docs (#7362)
919ac16d4 is described below
commit 919ac16d4bbb0350b5efc3b5515206dc69acd427
Author: Navendu Pottekkat <[email protected]>
AuthorDate: Mon Jul 4 07:42:27 2022 +0530
docs: move "configuring APISIX" section to "Installation" docs (#7362)
---
docs/en/latest/architecture-design/apisix.md | 32 ---------------------
docs/en/latest/installation-guide.md | 42 ++++++++++++++++++++++++++++
2 files changed, 42 insertions(+), 32 deletions(-)
diff --git a/docs/en/latest/architecture-design/apisix.md
b/docs/en/latest/architecture-design/apisix.md
index 8bef62289..8eff707ba 100644
--- a/docs/en/latest/architecture-design/apisix.md
+++ b/docs/en/latest/architecture-design/apisix.md
@@ -32,35 +32,3 @@ title: APISIX
## Plugin Hierarchy Structure
-
-## Configuring APISIX
-
-Apache APISIX can be configured in two ways:
-
-1. By directly changing `conf/config.yaml`.
-2. Using the `--config` or the `-c` flag to pass in the file path of your
config file while starting APISIX (`apisix start -c <path to config file>`).
-
-Configurations can be added to this YAML file and Apache APISIX will fall back
to the default configurations for anything that is not configured in this file.
-
-For example, to set the default listening port to 8000 while keeping other
configurations as default, your configuration file (`config.yaml`) would look
like:
-
-```yaml
-apisix:
- node_listen: 8000 # APISIX listening port
-```
-
-Similarly, to set the listening port to 8000 and set the etcd address to
`http://foo:2379` while keeping other configurations as default, your
configuration file would look like:
-
-```yaml
-apisix:
- node_listen: 8000 # APISIX listening port
-
-etcd:
- host: "http://foo:2379"; # etcd address
-```
-
-Default configurations of APISIX can be found in the
`conf/config-default.yaml` file.
-
-**Note**: This file is bound to the APISIX source code and should **NOT** be
modified. The configuration should only be changed by the methods mentioned
above.
-
-**Note**: The `conf/nginx.conf` file is automatically generated by APISIX and
should **NOT** be edited.
diff --git a/docs/en/latest/installation-guide.md
b/docs/en/latest/installation-guide.md
index 40d9e44e4..775ceb5b3 100644
--- a/docs/en/latest/installation-guide.md
+++ b/docs/en/latest/installation-guide.md
@@ -214,6 +214,48 @@ brew services start etcd
## Next steps
+### Configuring APISIX
+
+You can configure your APISIX deployment in two ways:
+
+1. By directly changing your configuration file (`conf/config.yaml`).
+2. By using the `--config` or the `-c` flag to pass the path to your
configuration file while starting APISIX.
+
+ ```shell
+ apisix start -c <path to config file>
+ ```
+
+APISIX will use the configurations added in this configuration file and will
fall back to the default configuration if anything is not configured.
+
+For example, to configure the default listening port to be `8000` without
changing other configurations, your configuration file could look like this:
+
+```yaml title="conf/config.yaml"
+apisix:
+ node_listen: 8000
+```
+
+Now, if you decide you want to change the etcd address to `http://foo:2379`,
you can add it to your configuration file. This will not change other
configurations.
+
+```yaml title="conf/config.yaml"
+apisix:
+ node_listen: 8000
+
+etcd:
+ host: "http://foo:2379";
+```
+
+:::warning
+
+APISIX's default configuration can be found in `conf/config-default.yaml` file
and it should not be modified. It is bound to the source code and the
configuration should only be changed by the methods mentioned above.
+
+:::
+
+:::warning
+
+The `conf/nginx.conf` file is automatically generated and should not be
modified.
+
+:::
+
### Updating Admin API key
It is recommended to modify the Admin API key to ensure security.
