This is an automated email from the ASF dual-hosted git repository.
monkeydluffy 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 1e15629e8 docs: add info about env var usage (#10755)
1e15629e8 is described below
commit 1e15629e80e27dd866a2df22e40c470183451dbe
Author: Abhishek Choudhary <[email protected]>
AuthorDate: Wed Jan 10 08:24:05 2024 +0545
docs: add info about env var usage (#10755)
---
docs/en/latest/deployment-modes.md | 17 +++++++++++++++++
docs/en/latest/profile.md | 2 ++
2 files changed, 19 insertions(+)
diff --git a/docs/en/latest/deployment-modes.md
b/docs/en/latest/deployment-modes.md
index edf705a89..90ae0cded 100644
--- a/docs/en/latest/deployment-modes.md
+++ b/docs/en/latest/deployment-modes.md
@@ -151,6 +151,23 @@ routes:
*WARNING*: APISIX will not load the rules into memory from file
`conf/apisix.yaml` if there is no `#END` at the end.
+Environment variables can also be used like so:
+
+```yaml
+routes:
+ -
+ uri: /hello
+ upstream:
+ nodes:
+ "${{UPSTREAM_ADDR}}": 1
+ type: roundrobin
+#END
+```
+
+*WARNING*: When using docker to deploy APISIX in standalone mode. New
environment variables added to `apisix.yaml` while APISIX has been initialized
will only take effect after a reload.
+
+More information about using environment variables can be found
[here](./admin-api.md#using-environment-variables).
+
### How to configure Route
Single Routeļ¼
diff --git a/docs/en/latest/profile.md b/docs/en/latest/profile.md
index 63913a438..8c0eaa311 100644
--- a/docs/en/latest/profile.md
+++ b/docs/en/latest/profile.md
@@ -103,6 +103,8 @@ routes:
Initialize and start APISIX in standalone mode, requests to `/anything` should
now be forwarded to `httpbin.org:80/anything`.
+*WARNING*: When using docker to deploy APISIX in standalone mode. New
environment variables added to `apisix.yaml` while APISIX has been initialized
will only take effect after a reload.
+
## Using the `APISIX_PROFILE` environment variable
If you have multiple configuration changes for multiple environments, it might
be better to have a different configuration file for each.