You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/06/30 10:08:33 UTC
[GitHub] [apisix] navendu-pottekkat opened a new pull request, #7362: docs: Add "configuring APISIX" section to "Installation" docs
navendu-pottekkat opened a new pull request, #7362:
URL: https://github.com/apache/apisix/pull/7362
Signed-off-by: Navendu Pottekkat <na...@gmail.com>
### Description
This PR moves the "Configuring APISIX" section to the "Installation" docs from the "Architecture Design" page.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] hf400159 commented on a diff in pull request #7362: docs: Add "configuring APISIX" section to "Installation" docs
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #7362:
URL: https://github.com/apache/apisix/pull/7362#discussion_r911634781
##########
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.
+
+:::2
Review Comment:
Extra `2`?
##########
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.
+
+:::2
Review Comment:
```suggestion
:::
```
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan merged pull request #7362: docs: Add "configuring APISIX" section to "Installation" docs
Posted by GitBox <gi...@apache.org>.
juzhiyuan merged PR #7362:
URL: https://github.com/apache/apisix/pull/7362
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] navendu-pottekkat commented on a diff in pull request #7362: docs: Add "configuring APISIX" section to "Installation" docs
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on code in PR #7362:
URL: https://github.com/apache/apisix/pull/7362#discussion_r911680601
##########
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.
+
+:::2
Review Comment:
Typo!
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org