指定项目名称

在 Compose 中,默认的项目名称取自项目目录的基名。但是,您可以灵活地设置自定义项目名称。

此页面提供了一些示例场景,说明自定义项目名称在哪些情况下很有用,概述了设置项目名称的各种方法,并按优先级顺序介绍了每种方法。

注意

默认的项目目录是 Compose 文件的基目录。也可以使用 --project-directory 命令行选项 为其设置自定义值。

示例用例

Compose 使用项目名称将环境彼此隔离。在多个上下文中,项目名称都很有用。

  • 在开发主机上:创建单个环境的多个副本,这对运行项目的每个功能分支的稳定副本很有用。
  • 在 CI 服务器上:通过将项目名称设置为唯一的构建编号来防止构建之间相互干扰。
  • 在共享或开发主机上:避免可能共享相同服务名称的不同项目之间相互干扰。

设置项目名称

项目名称只能包含小写字母、十进制数字、破折号和下划线,并且必须以小写字母或十进制数字开头。如果项目目录或当前目录的基名违反了此约束,则可以使用其他机制。

每种方法的优先级顺序(从最高到最低)如下所示

  1. -p 命令行标志。
  2. COMPOSE_PROJECT_NAME 环境变量
  3. Compose 文件中的 顶层 name: 属性。或者,如果您 在命令行中使用 -f 标志指定多个 Compose 文件,则为最后一个 name:
  4. 包含 Compose 文件的项目目录的基名。或者,如果您 在命令行中使用 -f 标志指定多个 Compose 文件,则为第一个 Compose 文件的基名。
  5. 如果没有指定 Compose 文件,则为当前目录的基名。

下一步是什么?