This is an automated email from the ASF dual-hosted git repository.
juzhiyuan pushed a commit to branch release/3.0
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/release/3.0 by this push:
new 2ca335467 docs: add missing `kubectl exec` step in the installation
guide. (#8536)
2ca335467 is described below
commit 2ca3354671cb15c75a2e481d9b8763939d7bfb82
Author: Abhishek Choudhary <[email protected]>
AuthorDate: Wed Dec 28 08:39:38 2022 +0530
docs: add missing `kubectl exec` step in the installation guide. (#8536)
Co-authored-by: 琚致远 / Zhiyuan Ju <[email protected]>
---
docs/en/latest/installation-guide.md | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/docs/en/latest/installation-guide.md
b/docs/en/latest/installation-guide.md
index 837a34b7f..06821f1fc 100644
--- a/docs/en/latest/installation-guide.md
+++ b/docs/en/latest/installation-guide.md
@@ -225,6 +225,22 @@ You can configure your APISIX deployment in two ways:
apisix start -c <path to config file>
```
+:::note
+
+If you have done the Docker based installation, you need to exec into the
`apisix` docker container to run the `apisix` command:
+
+```shell
+docker exec -it <name-of-container/container-id> sh
+```
+
+If you have installed via helm, you need to exec into the `apisix` kubernetes
pod to run the `apisix` command:
+
+```shell
+kubectl exec -it <name-of-apisix-pod> -n <namespace-running-apisix> -- sh
+```
+
+:::
+
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:
