add docs description about MYSQL_USER, MYSQL_PASSWORD, MYSQL_HOST, MY…

…SQL_PORT, MYSQL_DATABASE
whywaita · Sep 17, 2024 · d8163a4 · d8163a4
1 parent 80cabb5
commit d8163a4
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/01_01_for_admin_setup.md b/docs/01_01_for_admin_setup.md
@@ -85,6 +85,11 @@ A config variables can set from environment values.
 - `MYSQL_URL`
   - required
   - DataSource Name, ex) `username:password@tcp(localhost:3306)/myshoes`
+  - if `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_HOST`, `MYSQL_PORT`, `MYSQL_DATABASE` all are set, this env value are ignored.
+- `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_HOST`, `MYSQL_PORT`, `MYSQL_DATABASE`
+  - optional
+  - If all environment variables are set, mysql_url is constructed and loaded in the following way, then `MYSQL_URL` env will be ignored.
+  - example) `${MYSQL_USER}:${MYSQL_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/${MYSQL_DATABASE}`
 - `PLUGIN`
   - required
   - set path of myshoes-provider binary.