diff --git a/docs/configuration/environment-variables.md b/docs/configuration/environment-variables.md index 7b119b8d1..1eac93ad0 100644 --- a/docs/configuration/environment-variables.md +++ b/docs/configuration/environment-variables.md @@ -5,11 +5,13 @@ Typically an application will require some configuration to run properly. Dokku The `config` plugin provides the following commands to manage your variables: ``` -config (|--global) Display all global or app-specific config vars -config:get (|--global) KEY Display a global or app-specific config value -config:set (|--global) KEY1=VALUE1 [KEY2=VALUE2 ...] Set one or more config vars -config:unset (|--global) KEY1 [KEY2 ...] Unset one or more config vars -config:export [--format=FORMAT] [--merged] (|--global) Export all global or app-specific configuration +config (|--global) Pretty-print an app or global environment +config:get (|--global) KEY Display a global or app-specific config value +config:set [--encoded] [--no-restart] (|--global) KEY1=VALUE1 [KEY2=VALUE2 ...] Set one or more config vars +config:unset [--no-restart] (|--global) KEY1 [KEY2 ...] Unset one or more config vars +config:export (|--global) [--envfile] Export a global or app environment +config:keys (|--global) [--merged] Show keys set in environment +config:bundle (|--global) [--merged] Bundle environment into tarfile ``` The variables are available both at run time and during the application build/compilation step for buildpack-based deploys. For security reasons - and as per [docker recommendations](https://github.com/docker/docker/issues/13490) - Dockerfile-based deploys have variables available *only* during runtime, as noted in [this issue](https://github.com/dokku/dokku/issues/1860). @@ -119,4 +121,4 @@ The following list config variables have special meaning and can be set in a var | `DOKKU_SKIP_DEPLOY` | | `dokku config:set` | | | `DOKKU_SYSTEM_GROUP` | `dokku` | `/etc/environment`
`~dokku/.dokkurc`
`~dokku/.dokkurc/*` | System group to chown files as. | | `DOKKU_SYSTEM_USER` | `dokku` | `/etc/environment`
`~dokku/.dokkurc`
`~dokku/.dokkurc/*` | System user to chown files as. | -| `DOKKU_WAIT_TO_RETIRE` | `60` | `dokku config:set` | After a successful deploy, the grace period given to old containers before they are stopped/terminated. This is useful for ensuring completion of long-running http connections. | \ No newline at end of file +| `DOKKU_WAIT_TO_RETIRE` | `60` | `dokku config:set` | After a successful deploy, the grace period given to old containers before they are stopped/terminated. This is useful for ensuring completion of long-running http connections. |