在 Docker Compose 中配置预定义环境变量
Docker Compose 包含几个预定义的环境变量。它还继承了常见的 Docker CLI 环境变量，例如 DOCKER_HOST 和 DOCKER_CONTEXT。有关详细信息，请参阅Docker CLI 环境变量参考。
本页解释如何设置或更改以下预定义环境变量
COMPOSE_PROJECT_NAMECOMPOSE_FILECOMPOSE_PROFILESCOMPOSE_CONVERT_WINDOWS_PATHSCOMPOSE_PATH_SEPARATORCOMPOSE_IGNORE_ORPHANSCOMPOSE_REMOVE_ORPHANSCOMPOSE_PARALLEL_LIMITCOMPOSE_ANSICOMPOSE_STATUS_STDOUTCOMPOSE_ENV_FILESCOMPOSE_DISABLE_ENV_FILECOMPOSE_MENUCOMPOSE_EXPERIMENTALCOMPOSE_PROGRESS
覆盖方法
更改或设置任何环境变量时，请注意环境变量优先级。
配置详情
项目和文件配置
COMPOSE_PROJECT_NAME
设置项目名称。此值在启动时与服务名称一起添加到容器名称的前面。
例如，如果您的项目名称是 myapp 并且它包含两个服务 db 和 web，那么 Compose 会分别启动名为 myapp-db-1 和 myapp-web-1 的容器。
Compose 可以通过不同的方式设置项目名称。每种方法的优先级（从高到低）如下：
-p命令行标志COMPOSE_PROJECT_NAME- 配置文件中的顶级
name:变量（或使用-f指定的一系列配置文件中的最后一个name:） - 包含配置文件的项目目录的
basename（或包含使用-f指定的第一个配置文件的目录） - 如果未指定配置文件，则为当前目录的
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 配置文件的服务以及未指定配置文件的任何服务。
如果指定多个配置文件，请使用逗号作为分隔符。
以下示例启用所有匹配 frontend 和 debug 配置文件的服务以及没有配置文件的服务。
COMPOSE_PROFILES=frontend,debug
另请参阅将配置文件与 Compose 结合使用和--profile 命令行选项。
COMPOSE_PATH_SEPARATOR
为 COMPOSE_FILE 中列出的项指定不同的路径分隔符。
- 默认为
- 在 macOS 和 Linux 上为
: - 在 Windows 上为
;
- 在 macOS 和 Linux 上为
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 文件。
- 支持的值
true或1，Compose 会忽略.env文件false或0，Compose 会在项目目录中查找.env文件
- 默认为：
0
环境处理和容器生命周期
COMPOSE_CONVERT_WINDOWS_PATHS
启用后，Compose 会在卷定义中执行从 Windows 样式到 Unix 样式的路径转换。
- 支持的值
true或1，启用false或0，禁用
- 默认为：
0
COMPOSE_IGNORE_ORPHANS
启用后，Compose 不会尝试检测项目的孤立容器。
- 支持的值
true或1，启用false或0，禁用
- 默认为：
0
COMPOSE_REMOVE_ORPHANS
启用后，Compose 会在更新服务或堆栈时自动删除孤立容器。孤立容器是那些由先前的配置创建但不再在当前 compose.yaml 文件中定义的容器。
- 支持的值
true或1，启用自动删除孤立容器false或0，禁用自动删除。Compose 会改为显示有关孤立容器的警告。
- 默认为：
0
COMPOSE_PARALLEL_LIMIT
指定并发引擎调用的最大并行度。
输出
COMPOSE_ANSI
指定何时打印 ANSI 控制字符。
- 支持的值
auto，Compose 会检测是否可以使用 TTY 模式。否则，使用纯文本模式never，使用纯文本模式always或0，使用 TTY 模式
- 默认为：
auto
COMPOSE_STATUS_STDOUT
启用后，Compose 会将其内部状态和进度消息写入 stdout 而不是 stderr。默认值为 false，以明确区分 Compose 消息和容器日志之间的输出流。
- 支持的值
true或1，启用false或0，禁用
- 默认为：
0
COMPOSE_PROGRESS
定义进度输出的类型，如果未使用 --progress。
支持的值为 auto、tty、plain、json 和 quiet。默认为 auto。
用户体验
COMPOSE_MENU
启用后，Compose 会显示一个导航菜单，您可以在其中选择在 Docker Desktop 中打开 Compose 堆栈，切换到watch 模式，或使用Docker Debug。
- 支持的值
true或1，启用false或0，禁用
- 默认为：如果您通过 Docker Desktop 获取 Docker Compose，则为
1；否则默认为0
COMPOSE_EXPERIMENTAL
这是一个选择退出变量。关闭后会停用实验性功能。
- 支持的值
true或1，启用false或0，禁用
- 默认为：
1
Compose V2 不支持
以下环境变量在 Compose V2 中无效。有关详细信息，请参阅迁移到 Compose V2。
COMPOSE_API_VERSION默认情况下，API 版本与服务器协商。使用DOCKER_API_VERSION。
请参阅Docker CLI 环境变量参考页面。COMPOSE_HTTP_TIMEOUTCOMPOSE_TLS_VERSIONCOMPOSE_FORCE_WINDOWS_HOSTCOMPOSE_INTERACTIVE_NO_CLICOMPOSE_DOCKER_CLI_BUILD使用DOCKER_BUILDKIT选择 BuildKit 和经典构建器。如果DOCKER_BUILDKIT=0，则docker compose build使用经典构建器来构建镜像。