add COMPOSE_ANSI and COMPOSE_STATUS_STDOUT env variables to Compose E… (#17781)

* add COMPOSE_ANSI and COMPOSE_STATUS_STDOUT env variables to Compose Environment Variables page

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>

* Apply suggestions from code review

* Update compose/environment-variables/envvars.md

---------

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
This commit is contained in:
Guillaume Lours 2023-07-20 18:26:14 +02:00 committed by GitHub
parent 127b062bb6
commit f714021fee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions

View File

@ -19,6 +19,8 @@ This page contains information on how you can change the following pre-defined e
- `COMPOSE_IGNORE_ORPHANS` - `COMPOSE_IGNORE_ORPHANS`
- `COMPOSE_REMOVE_ORPHANS` - `COMPOSE_REMOVE_ORPHANS`
- `COMPOSE_PATH_SEPARATOR` - `COMPOSE_PATH_SEPARATOR`
- `COMPOSE_ANSI`
- `COMPOSE_STATUS_STDOUT`
Compose also inherits common Docker CLI environment variables, such as `DOCKER_HOST` and `DOCKER_CONTEXT`. See [Docker CLI environment variable reference](/engine/reference/commandline/cli/#environment-variables) for details. Compose also inherits common Docker CLI environment variables, such as `DOCKER_HOST` and `DOCKER_CONTEXT`. See [Docker CLI environment variable reference](/engine/reference/commandline/cli/#environment-variables) for details.
@ -119,6 +121,26 @@ When enabled, Compose doesn't try to detect orphaned containers for the project.
Specifies the maximum level of parallelism for concurrent engine calls. Specifies the maximum level of parallelism for concurrent engine calls.
### COMPOSE\_ANSI
Specifies when to print ANSI control characters.
* Supported values:
* `auto`, Compose detects if TTY mode can be used. Otherwise, use plain text mode.
* `never`, use plain text mode.
* `always` or `0`, use TTY mode.
* Defaults to: `auto`.
### COMPOSE\_STATUS\_STDOUT
When enabled, Compose writes its internal status and progress messages to `stdout` instead of `stderr`.
The default value is false to clearly separate the output streams between Compose messages and your container's logs.
* Supported values:
* `true` or `1`, to enable,
* `false` or `0`, to disable.
* Defaults to: `0`.
## Unsupported in Compose V2 ## Unsupported in Compose V2
The environment variables listed below have no effect in Compose V2. The environment variables listed below have no effect in Compose V2.