在 Docker Compose 中配置预定义环境变量

Docker Compose 包含多个预定义环境变量。它还继承了常见的 Docker CLI 环境变量,例如 DOCKER_HOSTDOCKER_CONTEXT。有关详细信息,请参阅 Docker CLI 环境变量参考

本页介绍如何设置或更改以下预定义环境变量:

  • COMPOSE_PROJECT_NAME
  • COMPOSE_FILE
  • COMPOSE_PROFILES
  • COMPOSE_CONVERT_WINDOWS_PATHS
  • COMPOSE_PATH_SEPARATOR
  • COMPOSE_IGNORE_ORPHANS
  • COMPOSE_REMOVE_ORPHANS
  • COMPOSE_PARALLEL_LIMIT
  • COMPOSE_ANSI
  • COMPOSE_STATUS_STDOUT
  • COMPOSE_ENV_FILES
  • COMPOSE_DISABLE_ENV_FILE
  • COMPOSE_MENU
  • COMPOSE_EXPERIMENTAL
  • COMPOSE_PROGRESS

覆盖方法

方法 描述
.env 文件 位于工作目录中。
Shell 在主机操作系统 shell 中定义。
CLI 在运行时通过 --env-e 标志传递。

更改或设置任何环境变量时,请注意环境变量优先级

配置详情

项目和文件配置

COMPOSE_PROJECT_NAME

设置项目名称。该值会与服务名称一起作为容器名称的前缀。

例如,如果您的项目名称是 myapp 并且包含两个服务 dbweb,则 Compose 会分别启动名为 myapp-db-1myapp-web-1 的容器。

Compose 可以通过不同方式设置项目名称。每种方法的优先级(从高到低)如下:

  1. -p 命令行标志
  2. COMPOSE_PROJECT_NAME
  3. 配置文件中的顶层 name: 变量(或使用 -f 指定的一系列配置文件中的最后一个 name:
  4. 包含配置文件的项目目录的 basename(或使用 -f 指定的第一个配置文件所在的目录)
  5. 如果未指定配置文件,则为当前目录的 basename

项目名称必须仅包含小写字母、十进制数字、短横线和下划线,并且必须以小写字母或十进制数字开头。如果项目目录或当前目录的 basename 违反此约束,则必须使用其他机制之一。

另请参阅 命令行选项概述使用 -p 指定项目名称

COMPOSE_FILE

指定 Compose 文件的路径。支持指定多个 Compose 文件。

  • 默认行为:如果未提供,Compose 会在当前目录中查找名为 compose.yaml 的文件,如果未找到,则 Compose 会递归搜索每个父目录,直到找到该名称的文件。
  • 指定多个 Compose 文件时,默认路径分隔符为:
    • Mac 和 Linux::(冒号)

    • Windows:;(分号) 例如:

      COMPOSE_FILE=compose.yaml:compose.prod.yaml
      
    也可以使用 COMPOSE_PATH_SEPARATOR 自定义路径分隔符。

另请参阅 命令行选项概述使用 -f 指定一个或多个 Compose 文件的名称和路径

COMPOSE_PROFILES

指定在运行 docker compose up 时要启用的一个或多个配置文件。

具有匹配配置文件的服务以及任何未定义配置文件的服务都会启动。

例如,使用 COMPOSE_PROFILES=frontend 调用 docker compose up 会选择具有 frontend 配置文件的服务以及任何未指定配置文件的服务。

如果指定多个配置文件,请使用逗号作为分隔符。

以下示例启用了同时匹配 frontenddebug 配置文件的服务以及没有配置文件的服务。

COMPOSE_PROFILES=frontend,debug

另请参阅在 Compose 中使用配置文件--profile 命令行选项

COMPOSE_PATH_SEPARATOR

COMPOSE_FILE 中列出的项目指定不同的路径分隔符。

  • 默认值为:
    • macOS 和 Linux 上为 :
    • Windows 上为 ;

COMPOSE_ENV_FILES

指定在未使用 --env-file 时 Compose 应使用的环境文件。

使用多个环境文件时,请使用逗号作为分隔符。例如:

COMPOSE_ENV_FILES=.env.envfile1,.env.envfile2

如果未设置 COMPOSE_ENV_FILES,并且您未在 CLI 中提供 --env-file,Docker Compose 将使用默认行为,即在项目目录中查找 .env 文件。

COMPOSE_DISABLE_ENV_FILE

允许禁用默认 .env 文件的使用。

  • 支持的值:
    • true1,Compose 忽略 .env 文件
    • false0,Compose 在项目目录中查找 .env 文件
  • 默认值为:0

环境处理和容器生命周期

COMPOSE_CONVERT_WINDOWS_PATHS

启用后,Compose 会将卷定义中的路径从 Windows 风格转换为 Unix 风格。

  • 支持的值:
    • true1,启用
    • false0,禁用
  • 默认值为:0

COMPOSE_IGNORE_ORPHANS

启用后,Compose 不会尝试检测项目的孤立容器。

  • 支持的值:
    • true1,启用
    • false0,禁用
  • 默认值为:0

COMPOSE_REMOVE_ORPHANS

启用后,Compose 会在更新服务或堆栈时自动删除孤立容器。孤立容器是由先前配置创建但在当前 compose.yaml 文件中不再定义的容器。

  • 支持的值:
    • true1,启用自动删除孤立容器
    • false0,禁用自动删除。Compose 会显示有关孤立容器的警告。
  • 默认值为:0

COMPOSE_PARALLEL_LIMIT

指定并发引擎调用的最大并行级别。

输出

COMPOSE_ANSI

指定何时打印 ANSI 控制字符。

  • 支持的值:
    • auto,Compose 检测是否可以使用 TTY 模式。否则,使用纯文本模式
    • never,使用纯文本模式
    • always0,使用 TTY 模式
  • 默认值为:auto

COMPOSE_STATUS_STDOUT

启用后,Compose 会将其内部状态和进度消息写入 stdout 而不是 stderr。 默认值为 false,以清晰地区分 Compose 消息和容器日志之间的输出流。

  • 支持的值:
    • true1,启用
    • false0,禁用
  • 默认值为:0

COMPOSE_PROGRESS

Requires: Docker Compose 2.36.0 and later

定义进度输出的类型(如果未使用 --progress)。

支持的值为 autottyplainjsonquiet。 默认值为 auto

用户体验

COMPOSE_MENU

Requires: Docker Compose 2.26.0 and later

启用后,Compose 会显示一个导航菜单,您可以在其中选择在 Docker Desktop 中打开 Compose 堆栈、开启 watch 模式 或使用 Docker Debug

  • 支持的值:
    • true1,启用
    • false0,禁用
  • 默认值为:如果通过 Docker Desktop 获取 Docker Compose,则为 1,否则默认值为 0

COMPOSE_EXPERIMENTAL

Requires: Docker Compose 2.26.0 and later

这是一个选择退出变量。关闭时,它会停用实验性功能。

  • 支持的值:
    • true1,启用
    • false0,禁用
  • 默认值为:1

在 Compose V2 中不支持

以下环境变量在 Compose V2 中无效。 有关更多信息,请参阅 迁移到 Compose V2

  • COMPOSE_API_VERSION 默认情况下,API 版本会与服务器协商。请使用 DOCKER_API_VERSION。 参见 Docker CLI 环境变量参考 页面。
  • COMPOSE_HTTP_TIMEOUT
  • COMPOSE_TLS_VERSION
  • COMPOSE_FORCE_WINDOWS_HOST
  • COMPOSE_INTERACTIVE_NO_CLI
  • COMPOSE_DOCKER_CLI_BUILD 使用 DOCKER_BUILDKIT 在 BuildKit 和经典构建器之间进行选择。如果 DOCKER_BUILDKIT=0,则 docker compose build 使用经典构建器来构建镜像。