尝试以扩展 VS Code 中的代理模式！

在远程 Docker 主机上开发

有时您可能希望使用开发容器扩展在位于远程服务器上的容器中进行开发。Docker 不支持将本地文件系统挂载（绑定）到远程开发容器中，因此 Visual Studio Code 默认的 devcontainer.json 行为（使用本地源代码）将不起作用。尽管这是默认行为，但本节将介绍如何连接到远程主机，以便您可以通过使用 Remote - SSH 扩展在容器中打开远程主机上的文件夹，附加到任何正在运行的容器，或使用本地 devcontainer.json 文件作为配置、创建和连接到使用套接字的远程开发容器的方式。

使用 Remote - SSH 扩展连接

如果您使用的是 Linux 或 macOS SSH 主机，可以同时使用 Remote - SSH 和开发容器扩展。您甚至不需要在本地安装 Docker 客户端。为此

  1. 按照 Remote - SSH 扩展的安装和 SSH 主机设置步骤操作。
  2. 可选： 设置 SSH 基于密钥的身份验证到服务器，这样你就不需要多次输入密码。
  3. 在您的 SSH 主机上安装 Docker。您不需要在本地安装 Docker。
  4. 按照 Remote - SSH 扩展的快速入门连接到主机并在那里打开一个文件夹。
  5. 从命令面板 (F1, ⇧⌘P (Windows, Linux Ctrl+Shift+P)) 使用 Dev Containers: Reopen in Container 命令。

开发容器快速入门的其余部分照旧适用。您可以在Remote - SSH 扩展的文档中了解更多信息。

使用 Remote - Tunnels 扩展连接

您可以同时使用 Remote - Tunnels 和开发容器扩展，以在容器中打开远程主机上的文件夹。您甚至不需要在本地安装 Docker 客户端。这类似于上面的 SSH 主机场景，但使用的是 Remote - Tunnels。为此

  1. 按照 Remote - Tunnels 扩展的入门说明操作。
  2. 在您的隧道主机上安装 Docker。您不需要在本地安装 Docker。
  3. 按照 Remote - Tunnels 扩展的步骤连接到隧道主机并在那里打开一个文件夹。
  4. 从命令面板 (F1, ⇧⌘P (Windows, Linux Ctrl+Shift+P)) 使用 Dev Containers: Reopen in Container 命令。

开发容器快速入门的其余部分照旧适用。您可以在Remote - Tunnels 扩展的文档中了解更多信息。

使用 Docker CLI 连接

这种模式仅要求 Docker 引擎在远程主机上运行，并且您的本地 Docker CLI 可以连接到该主机。虽然使用 Remote - SSH 和 Remote - Tunnels 扩展更简单，甚至不需要在本地安装 Docker CLI，但这种模式对于您已经从命令行连接到的主机的情况很有用。如果您希望附加到此远程服务器上已在运行的容器，此方法也很有用。

一个基本的远程示例

将 VS Code 设置为连接到远程 Docker 主机上的容器，可以像在 settings.json 中设置 Container Tools 扩展的 containers.environment 属性并重新启动 VS Code（或重新加载窗口）一样简单。

例如

"containers.environment": {
    "DOCKER_HOST": "ssh://your-remote-user@your-remote-machine-fqdn-or-ip-here"
}

使用 SSH 需要支持的 SSH 客户端，需要为远程主机配置基于密钥的身份验证，并且密钥已导入到您的本地 SSH 代理中。有关配置代理和添加密钥的详细信息，请参阅将 SSH 密钥与 Git 结合使用一文。

此时，您可以附加到远程主机上的容器。我们将在本节稍后介绍如何使用设置和环境变量或Docker 上下文进行连接的更多信息。

对于 devcontainer.json，还有一个额外的步骤：您需要更新任何已配置（或自动配置）的绑定挂载，使其不再指向本地文件系统。

此设置有两种变体。第一种是首先创建远程开发容器，然后将源代码克隆到一个命名卷中，因为这不需要您直接访问远程主机上的文件系统。

以下是此设置的一个基本 devcontainer.json 示例

{
  "image": "node", // Or "dockerFile"
  "workspaceFolder": "/workspace",
  "workspaceMount": "source=remote-workspace,target=/workspace,type=volume"
}

事实上，命令面板 (F1) 中的 Dev Containers: Clone Repository in Container Volume... 命令也使用了相同的技术。如果您在 GitHub 存储库中已有一个引用镜像或 Dockerfile 的 devcontainer.json 文件，该命令将自动使用命名卷而不是绑定挂载——这也适用于远程主机。

第二种方法是将远程机器上的文件夹绑定挂载到您的容器中。这需要您访问远程文件系统，但也允许您使用远程机器上的现有源代码。

更新上述示例中的 workspaceMount 属性以使用此模式

"workspaceMount": "source=/absolute/path/on/remote/machine,target=/workspace,type=bind,consistency=cached"

无论哪种情况，要尝试，请运行 Dev Containers: Open Folder in Container...，然后选择包含 .devcontainer.json 文件的本地文件夹。

有关 Docker Compose 等其他场景的信息，请参阅转换现有或预定义的 devcontainer.json。

使用 VS Code 设置或本地环境变量连接

如果您已经有一个远程 Docker 主机正在运行，您可以使用工作区或用户 settings.json 中的以下属性来指定主机。

SSH 协议

最新版本的 Docker (18.06+) 已添加对 SSH 协议的支持，以连接到远程 Docker 主机。这很容易配置，因为您只需在 settings.json 中设置一个属性即可使用它。

首先，安装支持的 SSH 客户端，配置基于密钥的身份验证），然后将您的密钥导入到本地 SSH 代理中（在 Windows 和 Linux 上通常默认不运行）。有关配置代理和添加密钥的详细信息，请参阅将 SSH 密钥与 Git 结合使用一文。

然后，将以下 Container Tools 扩展 containers.environment 属性添加到 settings.json（酌情替换值）

"containers.environment": {
    "DOCKER_HOST": "ssh://your-remote-user@your-remote-machine-fqdn-or-ip-here"
}

重新启动 VS Code（或重新加载窗口）后，您现在将能够附加到远程主机上的任何正在运行的容器。您还可以使用专门的本地 devcontainer.json 文件来创建/连接到远程开发容器。

提示：如果这不适用于您，但您能够从命令行使用 SSH 连接到主机，请确保您已将SSH 代理与您的身份验证密钥一起运行。如果所有其他方法都失败，您可以使用 SSH 隧道作为备用方案。

使用 TCP 协议

虽然 SSH 协议有其自己的内置授权机制，但使用 TCP 协议通常需要在 settings.json 中设置其他 Container Tools 扩展属性。这些是

"containers.environment": {
    "DOCKER_HOST": "tcp://your-remote-machine-fqdn-or-ip-here:port",
    "DOCKER_CERT_PATH": "/optional/path/to/folder/with/certificate/files",
    "DOCKER_TLS_VERIFY": "1" // or "0"
}

与 SSH 一样，重新启动 VS Code（或重新加载窗口）以使设置生效。

使用环境变量而非 settings.json

如果您不喜欢使用 settings.json，也可以在终端中设置环境变量。步骤如下：

  1. 关闭 所有 VS Code 实例。
  2. 确保 VS Code 在您的操作系统 PATH 中。
  3. 在终端/命令提示符中设置环境变量（例如 DOCKER_HOST）。
  4. 在同一个终端/命令提示符中键入 code，以在设置了变量的情况下启动 VS Code。

使用 Docker Contexts 连接

Docker Contexts 允许您与不同的主机进行交互——您可以为每个主机设置上下文并在它们之间切换。

您可以使用 docker context create 创建新的上下文。当前上下文可以使用 docker context use <context> 进行更改。

Container Tools 扩展附带 containers.environment 设置，可以在其中设置 DOCKER_HOST 或 DOCKER_CONTEXT 等环境变量，这些变量也受到开发容器扩展的尊重。

注意：上述设置仅在安装了 Container Tools 扩展时可见。如果没有 Container Tools 扩展，开发容器将使用当前上下文。

转换现有或预定义的 devcontainer.json

要将现有或预定义的本地 devcontainer.json 转换为远程文件，请按照以下步骤操作

  1. 在 VS Code 中打开一个要转换文件的本地文件夹（而不是远程文件夹）。

  2. 如果您没有选择包含 devcontainer.json 的文件夹，可以通过从命令面板 (F1) 运行 Dev Containers: Add Container Configuration File... 来选择一个预定义的。

  3. 根据您的 .devcontainer/devcontainer.json 或 .devcontainer.json 引用，按照以下步骤更改源代码挂载

    Dockerfile 或镜像:

    如果您没有远程主机的登录权限，请为您的源代码使用 Docker“卷”。按照以下方式更新 .devcontainer/devcontainer.json（如果需要，将 remote-workspace 替换为唯一的卷名）

    "workspaceMount": "source=remote-workspace,target=/workspace,type=volume"
"workspaceFolder": "/workspace",

    如果您有登录权限，可以使用远程文件系统绑定挂载代替

    "workspaceMount": "source=/absolute/path/on/remote/machine,target=/workspace,type=bind,consistency=cached"
"workspaceFolder": "/workspace",

    如果您有不同的场景，workspaceMount 属性支持与 Docker CLI --mount 标志相同的值。

    Docker Compose:

    如果您没有远程主机的登录权限，请更新（或扩展）您的 docker-compose.yml。将 your-service-name-here 替换为 devcontainer.json 中 "service" 属性指定的值，并将 remote-workspace 替换为唯一的卷名

    version: '3'
services:
  your-service-name-here:
    volumes:
        - remote-workspace:/workspace
    # ...

volumes:
  remote-workspace:

    如果您有登录权限，可以使用远程文件系统绑定挂载代替

    version: '3'
services:
  your-service-name-here:
    volumes:
      - /absolute/path/on/remote/machine:/workspace:cached
    # ...

    如果您需要支持不同的场景，请参阅 Docker Compose 关于 volumes 的文档。

  4. 从命令面板 (F1) 运行 Dev Containers: Reopen in Container 命令或 Dev Containers: Rebuild Container。

  5. 如果您使用的是卷而不是绑定挂载，请使用 ⌃⇧` (Windows, Linux Ctrl+Shift+`) 在容器内打开终端。您可以在此处运行 git clone 来拉取您的源代码，并使用 文件 > 打开... / 打开文件夹... 来打开克隆的存储库。

下次您想要连接到同一个容器时，运行 Dev Containers: Open Folder in Container... 并在 VS Code 窗口中选择相同的本地文件夹。

可选：在本地提供远程源代码

如果您的源代码存储在远程主机的文件系统而不是 Docker 卷中，您可以通过以下几种方式在本地访问文件

  1. 使用 SSHFS 挂载远程文件系统.
  2. 使用 rsync 将文件从远程主机同步到本地机器.
  3. 如果您使用的是 Docker Machine，请使用 mount 命令。

使用 SSHFS 或 Docker Machine 的 mount 命令是更便捷的选择，并且不需要任何文件同步。然而，性能将明显低于通过 VS Code 工作，因此它们最适合用于单个文件编辑和上传/下载内容。如果您需要使用一个会批量读写大量文件的应用程序（例如本地源代码控制工具），那么 rsync 是更好的选择。

07/09/2025