Merge pull request #103 from martinssipenko/patch-1

Document env vars.
hashicorp · Oct 29, 2019 · 1892127 · 1892127
2 parents c10b167 + 08cae3b
commit 1892127
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown
@@ -76,9 +76,9 @@ $ export all_proxy="socks5://your.proxy:3306"
 
 The following arguments are supported:
 
-* `endpoint` - (Required) The address of the MySQL server to use. Most often a "hostname:port" pair, but may also be an absolute path to a Unix socket when the host OS is Unix-compatible.
-* `username` - (Required) Username to use to authenticate with the server.
-* `password` - (Optional) Password for the given user, if that user has a password.
-* `tls` - (Optional) The TLS configuration. One of `false`, `true`, or `skip-verify`. Defaults to `false`.
+* `endpoint` - (Required) The address of the MySQL server to use. Most often a "hostname:port" pair, but may also be an absolute path to a Unix socket when the host OS is Unix-compatible. Can also be sourced from the `MYSQL_ENDPOINT` environment variable.
+* `username` - (Required) Username to use to authenticate with the server, can also be sourced from the `MYSQL_USERNAME` environment variable.
+* `password` - (Optional) Password for the given user, if that user has a password, can also be sourced from the `MYSQL_PASSWORD` environment variable.
+* `tls` - (Optional) The TLS configuration. One of `false`, `true`, or `skip-verify`. Defaults to `false`. Can also be sourced from the `MYSQL_TLS_CONFIG` environment variable.
 * `max_conn_lifetime_sec` - (Optional) Sets the maximum amount of time a connection may be reused. If d <= 0, connections are reused forever.
 * `max_open_conns` - (Optional) Sets the maximum number of open connections to the database. If n <= 0, then there is no limit on the number of open connections.