在容器的环境中设置环境变量

在服务配置中没有明确的条目之前,容器的环境不会被设置。使用 Compose,您可以使用 Compose 文件在容器中设置环境变量,有两种方法。

提示

不要使用环境变量将敏感信息(如密码)传递到容器中。请改用 secrets

使用 environment 属性

您可以使用 compose.yml 文件中的 environment 属性 在容器的环境中直接设置环境变量。

它支持列表和映射语法

services:
  webapp:
    environment:
      DEBUG: "true"

等效于

services:
  webapp:
    environment:
      - DEBUG=true

有关如何使用它的更多示例,请参阅 environment 属性

其他信息

  • 您可以选择不设置值,并将 shell 中的环境变量直接传递到容器中。它的工作方式与 docker run -e VARIABLE ... 相同。
    web:
      environment:
        - DEBUG

容器中的 DEBUG 变量的值取自运行 Compose 的 shell 中的相同变量的值。请注意,在这种情况下,如果 shell 环境中未设置 DEBUG 变量,则不会发出警告。

  • 您还可以利用 插值。在以下示例中,结果与上面类似,但 Compose 会在 shell 环境或项目目录中的 .env 文件中未设置 DEBUG 变量时发出警告。

    web:
      environment:
        - DEBUG=${DEBUG}

使用 env_file 属性

容器的环境也可以使用 .env 文件 以及 env_file 属性 来设置。

services:
  webapp:
    env_file: "webapp.env"

使用 .env 文件可以让您将同一个文件用于普通的 docker run --env-file ... 命令,或者在多个服务中共享同一个 .env 文件,而无需复制冗长的 environment YAML 块。

它还可以帮助您将环境变量与主配置文件分开,提供一种更组织和安全的方式来管理敏感信息,因为您不需要将 .env 文件放在项目根目录中。

env_file 属性 还允许您在 Compose 应用程序中使用多个 .env 文件。

env_file 属性中指定的 .env 文件的路径相对于 compose.yml 文件的位置。

重要

.env 文件中的插值是 Docker Compose CLI 功能。

运行 docker run --env-file ... 时不支持它。

其他信息

  • 如果指定了多个文件,则按顺序评估它们,并且可以覆盖之前文件中设置的值。
  • 此外,由于 .env 文件支持 插值,因此可以将它们与 environment 设置的值结合使用。
  • 从 Docker Compose 版本 2.24.0 开始,您可以使用 required 字段将 env_file 属性定义的 .env 文件设置为可选。当 required 设置为 false.env 文件丢失时,Compose 会静默忽略该条目。
    env_file:
      - path: ./default.env
        required: true # default
      - path: ./override.env
        required: false
  • 可以使用 docker compose run -e 从命令行覆盖 .env 文件中的值。

使用 docker compose run --env 设置环境变量

docker run --env 类似,您可以使用 docker compose run --env 或其简写形式 docker compose run -e 临时设置环境变量。

$ docker compose run -e DEBUG=1 web python console.py

其他信息

  • 您还可以通过不为变量指定值来从 shell 传递变量。

    $ docker compose run -e DEBUG web python console.py
    

容器中的 DEBUG 变量的值取自运行 Compose 的 shell 中的相同变量的值。

更多资源