🚀 在 VS Code 中

环境变量

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

您应该验证终端 > 集成:继承 Env 在设置中是否已选中,否则您设置的变量可能不会出现在集成终端中。此设置默认情况下已选中。

选项 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 文件

如果您有大量需要设置的环境变量,则可以使用 .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 文件加载变量