From e1414ca78fbb52376e689bad54dfea38331ee5e6 Mon Sep 17 00:00:00 2001 From: Guillaume Lours <705411+glours@users.noreply.github.com> Date: Mon, 8 Apr 2024 17:21:09 +0200 Subject: [PATCH] add definitions of COMPOSE_MENU and COMPOSE_EXPERIMENTAL env variables for Compose (#19695) * add definitions of COMPOSE_MENU and COMPOSE_EXPERIMENTAL env variables for Compose Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> * COMPOSE_MENU and COMPOSE_EXPERIMENTAL - Apply suggestions from code review Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> * Update content/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 | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/content/compose/environment-variables/envvars.md b/content/compose/environment-variables/envvars.md index 841f435f72..b79fbcedac 100644 --- a/content/compose/environment-variables/envvars.md +++ b/content/compose/environment-variables/envvars.md @@ -22,6 +22,8 @@ This page contains information on how you can set or change the following pre-de - `COMPOSE_ANSI` - `COMPOSE_STATUS_STDOUT` - `COMPOSE_ENV_FILES` +- `COMPOSE_MENU` +- `COMPOSE_EXPERIMENTAL` ## Methods to override @@ -152,6 +154,32 @@ COMPOSE_ENV_FILES=.env.envfile1, .env.envfile2 If `COMPOSE_ENV_FILES` is not set, and you don't provide `--env-file` in the CLI, Docker Compose uses the default behavior, which is to look for an `.env` file in the project directory. +### COMPOSE\_MENU + +When enabled, Compose displays a navigation menu where you can choose to open the Compose stack in Docker Desktop, switch on [`watch` mode](../file-watch.md), or use [Docker Debug](../../reference/cli/docker/debug.md). + +* Supported values: + * `true` or `1`, to enable, + * `false` or `0`, to disable. +* Defaults to: `0`. + +> **Note** +> +> Available in Docker Compose version 2.26.0 and later, and Docker Desktop version 4.29 and later + +### COMPOSE\_EXPERIMENTAL + +This is an opt-out variable. When turned off it deactivates the experimental features such as the navigation menu or [Synchronized file shares](../../desktop/synchronized-file-sharing.md). + +* Supported values: + * `true` or `1`, to enable, + * `false` or `0`, to disable. +* Defaults to: `1`. + +> **Note** +> +> Available in Docker Compose version 2.26.0 and later, and Docker Desktop version 4.29 and later + ## Unsupported in Compose V2 The environment variables listed below have no effect in Compose V2.