docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Revisiting Compose CLI Env Vars page (#15063) 

* Revisiting Compose CLI Env Vars page
* Adding feedback from the review and additional restructuring
* Adding relative URLs for the cli
* Removing anchor
* Apply suggestions from code review
Adding suggestions:  an additional default and updating compose file mention.
Co-authored-by: Guillaume Lours <guillaume@lours.me>
This commit is contained in:
Dora Ribeiro 2022-07-26 17:19:25 +01:00 committed by GitHub
parent a34c66dc6d
commit 15e4c88517
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 79 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

168
compose/reference/envvars.md
View File

@ -4,139 +4,129 @@ keywords: fig, composition, compose, docker, orchestration, cli, reference
title: Compose CLI environment variables title: Compose CLI environment variables
--- ---
Several environment variables are available for you to configure the Docker Compose command-line behaviour. In this section you can find the list of pre-defined environment variables you can use to configure the Docker Compose command-line behavior.
**See also** [Declare default environment variables in file](../env-file.md) to check how to declare default environment variables in an environment file named `.env` placed in the project directory.
Variables starting with `DOCKER_` are the same as those used to configure the
Docker command-line client. If you're using `docker-machine`, then the `eval "$(docker-machine env my-docker-vm)"` command should set them to their correct values. (In this example, `my-docker-vm` is the name of a machine you created.)
> **Note**: Some of these variables can also be provided using an
> [environment file](../env-file.md).
## COMPOSE\_PROJECT\_NAME ## COMPOSE\_PROJECT\_NAME
Sets the project name. This value is prepended along with the service name to Sets the project name. This value is prepended along with the service name to
the container on start up. For example, if your project name is `myapp` and it the container's name on startup.
includes two services `db` and `web`, then Compose starts containers named
`myapp-db-1` and `myapp-web-1` respectively.
Setting this is optional. If you do not set this, the `COMPOSE_PROJECT_NAME` For example, if your project name is `myapp` and it includes two services `db` and `web`,
defaults to the `basename` of the project directory. See also the `-p` then Compose starts containers named `myapp-db-1` and `myapp-web-1` respectively.
[command-line option](index.md).
* **Defaults to:** the `basename` of the project directory.
**See also** the [command-line options overview](index.md#command-options-overview-and-help) and [using `-p` to specify a project name](index.md#use--p-to-specify-a-project-name).
## COMPOSE\_FILE ## COMPOSE\_FILE
Specify the path to a Compose file. If not provided, Compose looks for a file named Specifies the path to a Compose file. Specifying multiple Compose files is supported.
`docker-compose.yml` in the current directory and then each parent directory in
succession until a file by that name is found.
This variable supports multiple Compose files separated by a path separator (on * **Default behavior:** If not provided, Compose looks for a file named `compose.yaml` or `docker-compose.yaml` in the current directory and, if not found, then Compose searches each parent directory recursively until a file by that name is found.
Linux and macOS the path separator is `:`, on Windows it is `;`). For example:
`COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml`. The path separator
can also be customized using `COMPOSE_PATH_SEPARATOR`.
See also the `-f` [command-line option](index.md). * **Default separator:** When specifying multiple Compose files, the path separators are, by default, on:
* Mac and Linux: `:` (colon),
* Windows: `;` (semicolon).
The path separator can also be customized using `COMPOSE_PATH_SEPARATOR`.
Example: `COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml`.
**See also** the [command-line options overview](index.md#command-options-overview-and-help) and [using `-f` to specify name and path of one or more Compose files](index.md#use--f-to-specify-name-and-path-of-one-or-more-compose-files).
## COMPOSE\_PROFILES ## COMPOSE\_PROFILES
Specify one or multiple active profiles to enable. Calling `docker-compose up` Specifies one or more profiles to be enabled on `compose up` execution.
with `COMPOSE_PROFILES=frontend` will start the services with the profile Services with matching profiles are started **as well as any services for which no profile has been defined**.
`frontend` and services without specified profiles.
You can specify a list of profiles separated with a comma: For example, calling `docker compose up`with `COMPOSE_PROFILES=frontend` selects services with the
`COMPOSE_PROFILES=frontend,debug` will enable the profiles `frontend` and `frontend` profile as well as any services without a profile specified.
`debug`.
See also [_Using profiles with Compose_](../profiles.md) and the `--profile`
[command-line option](index.md#use---profile-to-specify-one-or-more-active-profiles).
## COMPOSE\_API\_VERSION * **Default separator:** specify a list of profiles using a comma as separator.
Example: `COMPOSE_PROFILES=frontend,debug`
This example would enable all services matching both the `frontend` and `debug` profiles **and services without a profile**.
The Docker API only supports requests from clients which report a specific **See also** [Using profiles with Compose](../profiles.md) and the [`--profile` command-line option](index.md#use---profile-to-specify-one-or-more-active-profiles).
version. If you receive a `client and server don't have same version` error using
`docker-compose`, you can workaround this error by setting this environment
variable. Set the version value to match the server version.
Setting this variable is intended as a workaround for situations where you need
to run temporarily with a mismatch between the client and server version. For
example, if you can upgrade the client but need to wait to upgrade the server.
Running with this variable set and a known mismatch does prevent some Docker
features from working properly. The exact features that fail would depend on the
Docker client and server versions. For this reason, running with this variable
set is only intended as a workaround and it is not officially supported.
If you run into problems running with this set, resolve the mismatch through
upgrade and remove this setting to see if your problems resolve before notifying
support.
## DOCKER\_HOST ## DOCKER\_HOST
Sets the URL of the `docker` daemon. As with the Docker client, defaults to `unix:///var/run/docker.sock`. Sets the URL of the Docker daemon.
* **Defaults to:** `unix:///var/run/docker.sock`(same as with the Docker client).
## DOCKER\_TLS\_VERIFY ## DOCKER\_TLS\_VERIFY
When set to anything other than an empty string, enables TLS communication with See `DOCKER_TLS_VERIFY` on the [Use the Docker command line](../../../engine/reference/commandline/cli/#environment-variables){:target="_blank" rel="noopener" class="_"} page.
the `docker` daemon.
## DOCKER\_CERT\_PATH ## DOCKER\_CERT\_PATH
Configures the path to the `ca.pem`, `cert.pem`, and `key.pem` files used for TLS verification. Defaults to `~/.docker`. Configures the path to the `ca.pem`, `cert.pem`, and `key.pem` files used for TLS verification.
* **Defaults to:** `~/.docker`.
## COMPOSE\_HTTP\_TIMEOUT See, `DOCKER_CERT_PATH` on the [Use the Docker command line](../../../engine/reference/commandline/cli/#environment-variables){:target="_blank" rel="noopener" class="_"} page.
Configures the time (in seconds) a request to the Docker daemon is allowed to hang before Compose considers
it failed. Defaults to 60 seconds.
## COMPOSE\_TLS\_VERSION
Configure which TLS version is used for TLS communication with the `docker`
daemon. Defaults to `TLSv1`.
Supported values are: `TLSv1`, `TLSv1_1`, `TLSv1_2`.
## COMPOSE\_CONVERT\_WINDOWS\_PATHS ## COMPOSE\_CONVERT\_WINDOWS\_PATHS
Enable path conversion from Windows-style to Unix-style in volume definitions. When enabled, Compose performs path conversion from Windows-style to Unix-style in volume definitions.
Users of Docker Machine on Windows should always set this. Defaults to `0`.
Supported values: `true` or `1` to enable, `false` or `0` to disable. * **Supported values:**
* `true` or `1`, to enable,
* `false` or `0`, to disable.
* **Defaults to:** `0`.
## COMPOSE\_PATH\_SEPARATOR ## COMPOSE\_PATH\_SEPARATOR
If set, the value of the `COMPOSE_FILE` environment variable is separated Specifies a different path separator for items listed in `COMPOSE_FILE`.
using this character as path separator.
## COMPOSE\_FORCE\_WINDOWS\_HOST * **Defaults to:**
* On Mac and Linux to `:`,
If set, volume declarations using the [short syntax](../compose-file/compose-file-v3.md#short-syntax-3) * On Windows to`;`.
are parsed assuming the host path is a Windows path, even if Compose is
running on a UNIX-based system.
Supported values: `true` or `1` to enable, `false` or `0` to disable.
## COMPOSE\_IGNORE\_ORPHANS ## COMPOSE\_IGNORE\_ORPHANS
If set, Compose doesn't try to detect orphaned containers for the project. When enabled, Compose doesn't try to detect orphaned containers for the project.
Supported values: `true` or `1` to enable, `false` or `0` to disable.
## COMPOSE\_PARALLEL\_LIMIT * **Supported values:**
* `true` or `1`, to enable,
* `false` or `0`, to disable.
* **Defaults to:** `0`.
Sets a limit for the number of operations Compose can execute in parallel. The ## Deprecated in Compose v2
default value is `64`, and may not be set lower than `2`.
## COMPOSE\_INTERACTIVE\_NO\_CLI >**Important**
>
> The environment variables listed below are deprecated in v2.
If set, Compose doesn't attempt to use the Docker CLI for interactive `run` ### COMPOSE\_API\_VERSION
and `exec` operations. This option is not available on Windows where the CLI
is required for the aforementioned operations.
Supported: `true` or `1` to enable, `false` or `0` to disable.
## COMPOSE\_DOCKER\_CLI\_BUILD Deprecated in v2.
By default the API version is negotiated with the server. Use `DOCKER_API_VERSION`.
See `DOCKER_API_VERSION` on the [Use the Docker command line](../../../engine/reference/commandline/cli/#environment-variables){:target="_blank" rel="noopener" class="_"} page.
Configure whether to use the Compose python client for building images or the ### COMPOSE\_HTTP\_TIMEOUT
native docker cli. By default, Compose uses the `docker` CLI to perform builds,
which allows you to use [BuildKit](../../develop/develop-images/build_enhancements.md#to-enable-buildkit-builds)
to perform builds.
Set `COMPOSE_DOCKER_CLI_BUILD=0` to disable native builds, and to use the built-in Deprecated in v2.
python client.
### COMPOSE\_TLS\_VERSION
Deprecated in v2.
### COMPOSE\_FORCE\_WINDOWS\_HOST
Deprecated in v2.
### COMPOSE\_PARALLEL\_LIMIT
Deprecated in v2.
### COMPOSE\_INTERACTIVE\_NO\_CLI
Deprecated in v2.
As v2 now uses the vendored code of [Docker CLI](https://github.com/docker/cli){:target="_blank" rel="noopener" class="_"}.
### COMPOSE\_DOCKER\_CLI\_BUILDx
Deprecated in v2.
Use `DOCKER_BUILDKIT` to select between BuildKit and the classic builder. If `DOCKER_BUILDKIT=0` then `docker build` uses the classic builder to build images.
## Related information ## Related information