From f714021fee6fdb68e237b3bbbae686a9906b8587 Mon Sep 17 00:00:00 2001 From: Guillaume Lours <705411+glours@users.noreply.github.com> Date: Thu, 20 Jul 2023 18:26:14 +0200 Subject: [PATCH] =?UTF-8?q?add=20COMPOSE=5FANSI=20and=20COMPOSE=5FSTATUS?= =?UTF-8?q?=5FSTDOUT=20env=20variables=20to=20Compose=20E=E2=80=A6=20(#177?= =?UTF-8?q?81)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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> --- compose/environment-variables/envvars.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/compose/environment-variables/envvars.md b/compose/environment-variables/envvars.md index a9986aa387..c5d2bbb371 100644 --- a/compose/environment-variables/envvars.md +++ b/compose/environment-variables/envvars.md @@ -19,6 +19,8 @@ This page contains information on how you can change the following pre-defined e - `COMPOSE_IGNORE_ORPHANS` - `COMPOSE_REMOVE_ORPHANS` - `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. @@ -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. +### 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 The environment variables listed below have no effect in Compose V2.