连接到开发容器

最后修改时间：2023 年 12 月 5 日

开发容器（dev 容器）是一个配置为用作全功能开发环境的 Docker 容器。

PyCharm 允许您使用此类容器来编辑、构建和运行您的项目。PyCharm 还支持可以使用Docker Compose属性进行配置的多个容器连接。

提示
您可以使用它快速查看创建开发容器的过程。

先决条件

在开始之前，请确保满足以下先决条件：

您有一个项目，其中包含带有描述实际开发容器的文件的.devcontainer文件夹。devcontainer.json
笔记
目前，我们不支持该devcontainer.json文件的代码完成，因此从头开始创建此类文件可能会很复杂。
您可以访问 GitHub。
您的计算机上安装了 Git 2.25 版本或更高版本。
您已将Docker安装在将驻留开发容器的计算机上。
您的 Docker 资源满足后端的最低系统要求。

您可以在 IDE 中启动开发容器。您还可以从 JetBrains Gateway 或 PyCharm 在本地或远程启动它。

您可以打开一个项目，该项目的.devcontainer文件夹devcontainer.json位于 PyCharm 的根目录中，并使用 Docker从 IDE启动一个开发容器。

devcontainer.json使用 IDE 中的文件打开您的项目。
您可以在本地或远程打开该项目。
devcontainer.json在编辑器中打开文件。
在左侧装订线中，单击并选择Create Dev Container 和 Mount Sources。
上下文菜单中还提供以下选项：
- 创建开发容器和克隆源：使用此选项将项目克隆到开发容器中。
- 显示开发容器：使用此选项检查现有开发容器的列表。您可以查看哪些是活动的并且正在运行，停止它们或重新启动它们。
- 管理开发容器后端：使用此选项来管理开发容器后端，例如从开发容器中选择和删除不必要的后端。
创建开发容器后，单击“继续”。
容器已创建，项目已在 JetBrains Client 中打开。

您可以在本地从 JetBrains Gateway 启动开发容器，也可以使用 SSH 连接到远程服务器。

启动JetBrains 网关。
从右侧的可用选项中，单击Create Dev Container。
如果要在远程计算机上构建开发容器，请单击docker 字段旁边的来打开Docker对话框。
指定必要的配置并单击“确定”。
笔记
请记住，docker 连接仅支持密钥对 ssh 授权。如果使用密码连接到远程服务器，请在本地生成密钥对，然后将其转发到远程服务器。
在Git 存储库字段中，指定 GitHub 上项目的路径。
您引用的项目应该有一个devcontainer.json包含开发容器配置的文件。
如果您想在本地构建开发容器，请单击“构建容器”并“继续”。
开发容器构建完成后，单击“继续”以使用 JetBrains 客户端打开项目。
此时，您可以进一步处理您的项目。

您可以直接从 PyCharm 在本地或通过 SSH 远程启动开发容器。

启动 PyCharm。
在欢迎屏幕中，单击Remote Development，然后单击Dev Containers。
单击新建开发容器。
在Git 存储库字段中，指定 GitHub 上项目的路径。
您引用的项目应该有一个devcontainer.json包含开发容器配置的文件。
如果您想在本地构建开发容器，请单击“构建容器”并“继续”。
如果要在远程计算机上构建开发容器，请打开“通过 SSH 连接”部分，指定必要的配置，然后单击“构建容器并继续”。
开发容器构建完成后，单击“继续”以使用 JetBrains 客户端打开项目。
此时，您可以进一步处理您的项目。