环境变量

您可以通过使用以下选项之一在容器中设置环境变量,而无需更改容器镜像。

您应该验证终端 > 集成:继承环境是否在设置中被勾选,否则您设置的变量可能不会出现在集成终端中。此设置默认是勾选的。

选项1:添加单个变量

根据你在devcontainer.json中引用的内容:

  • Dockerfile 或镜像: 将 containerEnv 属性添加到 devcontainer.json 中,以设置适用于整个容器的变量,或使用 remoteEnv 来设置适用于 VS Code 及其相关子进程(终端、任务、调试等)的变量:

    "containerEnv": {
        "MY_CONTAINER_VAR": "some-value-here",
        "MY_CONTAINER_VAR2": "${localEnv:SOME_LOCAL_VAR}"
    },
    "remoteEnv": {
        "PATH": "${containerEnv:PATH}:/some/other/path",
        "MY_REMOTE_VARIABLE": "some-other-value-here",
        "MY_REMOTE_VARIABLE2": "${localEnv:SOME_LOCAL_VAR}"
    }
    

    如本例所示,containerEnv 可以引用局部变量,而 remoteEnv 可以引用局部变量和现有容器变量。

视频:在开发容器中修改PATH



  • Docker Compose:由于 Docker Compose 内置支持更新容器范围的变量,因此在 devcontainer.json 中仅支持 remoteEnv

    "remoteEnv": {
        "PATH": "${containerEnv:PATH}:/some/other/path",
        "MY_REMOTE_VARIABLE": "some-other-value-here",
        "MY_REMOTE_VARIABLE2": "${localEnv:SOME_LOCAL_VAR}"
    }
    

    如本例所示,remoteEnv 可以引用本地和现有的容器变量。

    要更新适用于整个容器的变量,请使用以下内容更新(或扩展)您的docker-compose.yml文件中的相应服务:

    version: '3'
    services:
      your-service-name-here:
        environment:
          - YOUR_ENV_VAR_NAME=your-value-goes-here
          - ANOTHER_VAR=another-value
         # ...
    

如果您已经构建了容器并连接到它,请从命令面板(F1)运行Dev Containers: Rebuild Container以应用更改。否则,请运行Dev Containers: Open Folder in Container...以连接到容器。

选项2:使用环境文件

如果你需要设置大量的环境变量,你可以使用一个.env文件来代替。

首先,在您的源代码树中的某个位置创建一个环境文件。考虑这个.devcontainer/devcontainer.env文件:

YOUR_ENV_VAR_NAME=your-value-goes-here
ANOTHER_ENV_VAR_NAME=your-value-goes-here

接下来,根据你在devcontainer.json中引用的内容:

  • Dockerfile 或镜像: 编辑 devcontainer.json 并添加一个路径到 devcontainer.env :

    "runArgs": ["--env-file",".devcontainer/devcontainer.env"]
    
  • Docker Compose: 编辑 docker-compose.yml 并添加相对于 Docker Compose 文件的 devcontainer.env 文件的路径:

    version: '3'
    services:
      your-service-name-here:
        env_file: devcontainer.env
        # ...
    

docker compose 会自动读取包含 docker-compose.yml 的文件夹中名为 .env 的文件,但你也可以在另一个位置创建一个。

如果您已经构建了容器并连接到它,请从命令面板(F1)运行Dev Containers: Rebuild Container以应用更改。否则,请运行Dev Containers: Open Folder in Container...以连接到容器。

视频:从.env文件加载变量