PhpStorm 2025.2 Help

连接并使用 JetBrains Gateway

您可以使用 SSH 连接连接到远程服务器，以开发、运行和部署您的项目。

先决条件

在开始在远程机器上开发之前，请确保您具备以下条件：

  • 远程机器（作为 IDE 的目标）满足 IDEs articles 中列出的最低推荐要求。

  • 您已在 Linux 平台上安装了兼容的 SSH 服务器。

  • Linux 平台支持任何最近的 Linux AMD64 发行版，例如 Ubuntu 16.04+、RHEL/Centos 7+ 等。 我们建议使用具有 2 个以上核心、4GB 以上内存和 5GB 以上磁盘空间的机器。

  • 您需要在远程主机上启用 sftp 子系统。 在当前实现中，我们将其用于后端部署。

JetBrains Gateway

JetBrains Gateway 是一个轻量级启动器，可将远程服务器与您的本地计算机连接，下载后端所需组件，并在 JetBrains Client 中打开您的项目。

您可以使用 JetBrains Gateway 作为独立的启动器或者从您的 IDE 连接到远程服务器的入口点。

启动 JetBrains Gateway 并连接到远程服务器

  1. 下载并安装 JetBrains Gateway 应用程序。

    或者，您可以通过 IDE 的欢迎屏幕中的 远程开发 选项访问 JetBrains Gateway。

  2. 请点击 新建连接 下的 SSH 连接提供程序。

    JetBrains Gateway

  3. 在向导的下一页中，指定您想通过其连接到远程服务器的 SSH 配置。

    通过 SSH 连接

    或者，点击 SSH 配置 以打开 SSH 配置 对话框并配置SSH设置。

    在 SSH 配置 对话框中，添加以下信息：

    SSH 配置

    • 主机 ：指定您的远程服务器地址。

    • 端口 ：指定 SSH 端口，默认为 22。

    • 用户名 ：指定将用于连接远程服务器的用户名称。

    • 认证类型 ：选择以下身份验证方法之一：

      • 密码 ：以密码访问主机。 要在 PhpStorm 中保存密码，请选择 保存密码 复选框。

      • 密钥对（OpenSSH 或 PuTTY） ：使用 SSH 身份验证与密钥对。 要应用此身份验证方法，您必须在客户端计算机上拥有私钥，并在远程服务器上拥有公钥。 PhpStorm 支持使用 OpenSSH 工具生成的私钥。

        请指定保存了您的 私钥 的文件路径，并在相应字段中输入密码短语（如果有）。 要让 PhpStorm 记住密码短语，请选中 保存密码短语 复选框。

      • 解析配置文件 ~/.ssh/config ：如果您希望 JetBrains Gateway 使用 .ssh/config 文件，请选择此选项。

    • 测试连接 ：点击此按钮以查看连接是否已建立。

    • 连接参数 ：使用此部分配置连接的附加参数。

      有关更多信息，请参见 连接参数。

    • HTTP/SOCKS 代理 ：使用本节配置代理设置。 如需更多信息，请参阅 Proxy settings。

    点击 确定 以保存更改并返回到 欢迎使用 JetBrains Gateway 对话框。

    请点击 检查连接并继续 以检查连接是否已建立。

  4. 在下一页面，指定要下载到远程服务器的 PhpStorm 版本。 JetBrains Gateway 显示可供下载和已安装的 IDE 版本列表。

    您也可以使用“其他选项”来设置 IDE installers 的备用源。

    下载到本地计算机的 JetBrains Client 版本始终与远程 IDE 版本匹配。

IDE 版本

默认情况下，下载的 PhpStorm 位于远程服务器上的以下文件夹中： ~/.cache/JetBrains/RemoteDev/dist 。 但是，您可以按以下步骤更改它并将 PhpStorm 安装到自定义位置：

  1. 点击 其他选项 并选择 自定义安装路径 选项。

  2. 在 安装路径 字段中添加需要的安装位置。

安装到自定义位置

添加项目在远程主机上的路径。

远程项目路径

点击 上传IDE 并连接。

JetBrains Gateway 下载 IDE，并在 JetBrains Client 中打开您的远程项目。 连接显示在 JetBrains Gateway 窗口中，您可以从中连接到其他 IDE 或禁用连接。 该窗口默认隐藏到托盘。

网关窗口

您可以在打开项目之前覆盖后台的 -Xmx 虚拟机选项。

覆盖 -Xmx VM 选项

  1. 启动 JetBrains Gateway.

  2. 请按照向导的步骤操作。 点击 检查连接并继续。

  3. 在打开的页面上，在 IDE 版本 字段下，点击 安装选项。

  4. 从下拉列表中选择 自定义堆大小。

    自定义堆大小

  5. 在 最大堆大小 字段中，根据需要覆盖默认堆大小。

    最大堆大小

    请注意，此字段只能包含数值且不能超过 INT_MAX 的值。

  6. 完成配置后，点击 下载 IDE 并连接 以开始您的项目。

打开最近的项目

  1. 在 JetBrains Gateway 向导中，从左侧选项中选择 SSH。

  2. 在搜索字段中输入您的项目名称以快速导航到它。

    最近项目

    如果您需要快速访问终端，请点击 打开终端。

更改后端版本

  • 在 JetBrains Gateway 向导中，点击 更多 按钮 旁边的最近项目名称，然后选择您要用来打开项目的后端版本。

    更改后端版本

    如果在列表中找不到所需的版本，请点击 选择其他 IDE 并在 IDE 版本 字段中选择所需的 IDE 版本。

    选择 IDE 版本

停止运行中的实例

  1. 在 JetBrains Gateway 向导中，从左侧选项中选择 SSH。

  2. 当您的远程会话处于激活状态时， 运行中 指示器将显示在项目旁边。

    最近项目

    点击 旁边的项目，并选择 停止 IDE Backend 以停止该项目的远程会话。

    最近项目

    您也可以选择 从最近项目中移除 从页面上完全删除列出的项目。

卸载 后端 IDE 版本

  1. 在 JetBrains Gateway 向导中，点击 显示选项菜单图标 旁边的远程服务器名称，然后选择 管理 IDE 后端 以打开已安装的 IDE 版本列表。

    管理 IDE

  2. 在打开的窗口中，点击所需卸载的 backend IDE version 旁边的 关闭图标 ，然后点击 是 以确认操作。

在手动启动的远程开发环境上连接远程项目（服务器到客户端流程）

如果您的远程服务器上已经安装了 PhpStorm，您可以手动启动它，并连接到在该 IDE 中启动的远程项目。 它的工作方式与从 JetBrains Gateway 一样。

如果您的公司有自定义编排，或者您的 remote IDE 会在其端自动启动，请使用此方法。

该过程可以描述如下：

  1. 在远程 IDE 中启动后端项目。

  2. 选择后端生成的一个连接链接。

  3. 在您的本地机器上打开该链接。

运行远程 IDE 的主脚本是 remote-dev-server.sh ，位于解压后 IDE 的 bin 子目录中。

连接到远程 IDE

  1. 确保您已 下载并安装了 JetBrains Gateway ，或者您的本地机器上有一个带有 JetBrains Gateway 插件的 IDE。

  2. 确保您已通过 SSH 连接到远程机器 PhpStorm。

  3. 在远程服务器的终端中运行以下命令：

    remote-dev-server.sh run /path_to_project/ --ssh-link-host host_server_address --ssh-link-user remote_side_user --ssh-link-port ssh_connection_port

    请查看以下示例：

    如果您不传递参数，脚本将使用默认参数：端口 22、系统用户的用户名以及来自 hostname 命令的主机。

    ~/.cache/JetBrains/RemoteDev/dist/f8a03266ddbb1_PhpStorm-213.5744.147/bin/remote-dev-server.sh run ~/PhpstormProjects/phpstorm-workshop/ --ssh-link-host ec2-13-50-136-85.eu-north-1.compute.amazonaws.com

  4. 如果项目成功启动，您将在终端中收到以下三个链接：

    • 加入链接：tcp://127.0.0.1:5990...[ ] ：包含远程 IDE 现在监听的本地地址和端口。

      示例：

      tcp://127.0.0.1:5991#jt=71e779a1-070e-4fd3-a4e6-83c1f8cb65a5&p=IU&fp=A42F6041C2878D7A22339ECABF4A9C294F643BG05E91E3DFC06035E03DB71BF8&cb=222.4167.29&jb=17.0.4b469.53

      要使用它，确保远程机器可以通过此本地地址访问。 例如，对于转发/开放端口的 Docker 内部 IDE。

    • Http 链接：https://code-with-me.jetbrains.com/remoteDev...[ ] ：包含有关您的主机、端口、用户、IDE及其版本的信息。

      示例：

      https://code-with-me.jetbrains.com/remoteDev#idePath=%2Fhome%2Fubuntu%2F.cache%2FJetBrains%2FRemoteDev%2Fdist%2F3e4cd27bfbb95_ideaIU-2022.2.2&projectPath=%2Fhome%2Fubuntu%2Fdevelopment%2Fspring-petclinic&host=ec2-xx-xx-xxx-xx.eu-north-1.compute.amazonaws.com&port=22&user=ubuntu&type=ssh&deploy=false

      在本地浏览器中打开时，它会显示欢迎页面，并尝试使用预填充的连接设置值调用本地 Gateway 应用程序。

      如果未在本地机器上找到 JetBrains Gateway 应用程序，您将可以从欢迎页面下载它。

    • Gateway 链接：jetbrains-gateway://connect#idePath... [ ] ：还包含有关您的主机、端口、用户，IDE 及其版本的信息。

      示例：

      jetbrains-gateway://connect#idePath=%2Fhome%2Fubuntu%2F.cache%2FJetBrains%2FRemoteDev%2Fdist%2F3e4cd27bfbb95_ideaIU-2022.2.2&projectPath=%2Fhome%2Fubuntu%2Fdevelopment%2Fspring-petclinic&host=ec2-xx-xx-xxx-xx.eu-north-1.compute.amazonaws.com&port=22&user=ubuntu&type=ssh&deploy=false

      在您的本地浏览器中打开时，它会直接启动本地 JetBrains Gateway 应用程序，而不会显示欢迎页面。

  5. 将生成的链接复制并粘贴到您的本地浏览器以允许其 打开 JetBrains Gateway。

  6. 所有这些链接都可以在已启动的 JetBrains Gateway 中打开。

    为此，在 JetBrains Gateway 欢迎屏幕中，在 连接到运行中的 IDE 字段中粘贴链接，点击 连接。

    PhpStorm 将下载所需版本的 JetBrains Client，并在其中打开远程项目。

注册先前安装的远程 IDE

从版本 221.5481 开始，您可以手动注册远程服务器上现有的后端 IDE，并使其对 Gateway 可见。

若要注册已安装的 IDE 并使其显示在可用 build 列表中，请执行以下步骤：

  1. 通过 SSH 连接到远程服务器。

  2. 找到解压后的 IDE 文件夹并打开 bin 目录。

  3. 请使用命令行运行以下命令：

    remote-dev-server.sh registerBackendLocationForGateway

    示例：

    sh WebStorm-221.5591.52/bin/remote-dev-server.sh registerBackendLocationForGateway

连接到 Google Cloud

您可以使用 JetBrains Gateway 连接到 Google Cloud 以处理远程项目。

在连接 Google Cloud 之前，请确保您已完成以下操作：

  • 设置 Cloud Workstations 配置文件和集群（由您或管理员完成）

  • 创建 一台工作站

  • 访问了工作站

Cloud Workstations plugin 允许您连接工作站并在 PhpStorm 中使用。

连接到您在 Google Cloud 的工作站

  1. 启动 JetBrains Gateway。

  2. 从左侧选项中选择 所有提供商。

  3. 在 安装更多 Providers 部分，找到 Google Cloud 并点击 安装。

    Google Cloud

    插件安装完成后，您可以在 远程运行 IDE 部分找到它。

  4. 从左侧的选项中找到 Cloud Workstations 并点击 连接到 Google Cloud。

  5. 在打开的窗口中，选择首选工作站并点击 下一个。

    连接到 Cloud Workstation

  6. 在下一页，选择您在配置文件中选择的 IDE 版本作为代码提供者，以及您想要处理的项目。

    IDE 版本和项目

    连接已建立，带有项目的工作站在 JetBrains Client 中打开，您可以在 IDE 中继续工作。

连接到 Gitpod

JetBrains Gateway 支持与 Gitpod 集成，后者是一个用于自动化开发环境的开源编排和供应平台。

Gitpod 可以作为插件在 JetBrains Gateway 中使用，您可以使用它连接到现有的 Gitpod workspaces 或创建一个新的并在 PhpStorm 中进行工作。

连接到 您在 Gitpod 上的工作区

  1. 启动 JetBrains Gateway。

  2. 从左侧选项中选择 远程开发。

  3. 在 安装更多 Providers 部分，找到 Gitpod 并点击 安装。

    安装 Gitpod

    插件安装完成后，您可以在 远程开发 节点以及 安装更多 Providers 部分找到它。

  4. 从右侧的选项中找到 Gitpod 并点击 连接到 Gitpod。

    欢迎屏幕：安装了 Gitpod 插件

    . 。

  5. 在打开的窗口中，选择您想要使用的 IDE。

  6. 点击 新建 Workspace。

    JetBrains Gateway 通过浏览器连接到您的 Gitpod 工作区。 Gitpod 准备工作区并显示有关在 JetBrains Client 内部打开工作区的通知。

    在浏览器中打开 JetBrains Gateway

    点击 允许 然后 是 在身份验证对话框中。

    已建立连接，带有项目的工作区已在 JetBrains Client 中打开，您可以在 IDE 中继续工作。

    创建的工作区已添加到 最近工作区 部分。 如果您有现有的工作区，它们会被添加到最近工作区列表中，您可以随时点击 连接 连接到所需的工作区。

如果您想直接从 Gitpod 连接到 JetBrains Gateway，请参阅 Gitpod 文档。

连接到 Coder

您可以使用 JetBrains Gateway 连接到 Coder ，以在远程项目上工作。

JetBrains Gateway 中提供了 Coder 插件，您可以使用它连接到现有环境或创建新环境，并在 PhpStorm 中进行工作。

连接到 Coder 工作区

  1. 启动 JetBrains Gateway。

  2. 请点击 在屏幕底部，并选择 管理提供商。

  3. 在打开的页面中，在 插件市场 选项卡上，找到 编码器， 安装并启用插件。

    插件已添加到 连接 列表中。

  4. 从左侧选项中选择 所有提供商。

    所有提供者

  5. 请确保您已在 Coder 中配置了工作区，并复制访问 URL。

    Coder Workspace

  6. 在 JetBrains Gateway 中，点击 连接到 Coder。

  7. 在向导的下一页，在 URL 字段中，粘贴 已复制的 URL并点击 连接。

    连接到 Coder

  8. 从浏览器中复制会话令牌，并将其粘贴到 会话令牌 字段中的 JetBrains Gateway。 点击

    会话令牌

    确定。

  9. 当所有内容都已认证完毕，您将看到已配置的工作区列表，选择所需的一个并点击 选择 IDE 和项目。

  10. 在向导的下一页中，选择必要的 IDE 并指定工作区中项目的路径。 如果您需要使用工作区终端，请点击 使用终端。

    IDE 和项目路径

    当所有内容都选中后，请点击 启动 IDE 并连接。

    在 JetBrains Client 中打开包含所选项目的 Coder 开发环境，您可以在 IDE 中继续工作。

连接到 JetBrains CodeCanvas

JetBrains CodeCanvas 是一种解决方案，可以让公司将软件开发从个人用户机器转移到远程开发环境。

您可以使用 JetBrains Gateway 连接到 CodeCanvas ，以处理您的远程项目。 或者，您可以从 CodeCanvas 端连接并在 JetBrains Client 中打开您的项目。

JetBrains CodeCanvas 在 JetBrains Gateway 中通过 CodeCanvas 插件提供，您可以使用它连接到现有环境或创建一个新的环境并在 PhpStorm 中使用它。

连接到 Code Canvas 开发环境

  1. 启动 JetBrains Gateway。

    CodeCanvas 插件默认已启用。

  2. 从左侧选项中选择 所有提供商。

    所有提供者

  3. 在 JetBrains Gateway 中，点击 连接到 CodeCanvas。

  4. 在向导的下一页中，输入访问 URL 并点击 继续在浏览器中。

  5. 在打开的浏览器窗口中，点击 接受 以授予所需的权限。 如果您尚未登录到 CodeCanvas Web 应用程序，系统还会提示您输入用户名和密码。 然后将把您重定向回 JetBrains Gateway。

  6. 点击 新环境 并配置新的开发环境（如果您的项目已经有必要的开发环境，请跳过此步骤）：

    • 选择您想要用于开发环境的 模板。

    • 环境名称 会自动选择。

    • 选择必要的分支和可用的预热快照。

    点击 创建环境。

    创建环境

  7. 开发环境创建后，您的项目将在 JetBrains Client 中打开，您可以开始编码。

    在 JetBrains Gateway 欢迎屏幕的 连接 节点下选择 JetBrains CodeCanvas ，以查看现有开发环境的列表。

    CodeCanvas 开发环境

连接到在 WSL2 上运行的项目

您可以配置您的 IDE 后端直接在 WSL2 中启动。

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

  • 您的机器上安装了 Windows 10 或 11 版本，同时在 WSL2 下安装了 Ubuntu 20.04 版本。

  • 您已在 Windows 计算机上配置 WSL2。 如需更多信息，请参阅 WSL2 配置 部分。

  • 您至少有 200 GB 的可用空间、8 GB 内存和 4 个 CPU。

  • 您使用了最新的 JetBrains Gateway EAP 构建版本。

  • 您使用最新的 EAP 版本的后端 IDE。

连接到 WSL

  1. 启动 JetBrains Gateway。

  2. 在 所有提供商 列表中选择 WSL。

  3. 从右侧的选项中，点击 新项目。

    新建连接

  4. 在下一个页面中，选择 WSL 实例并点击 下一个。

    选择 WSL 实例

  5. 在下一页中，选择 您想要打开的 IDE 版本和项目。 点击 启动 IDE 并连接。

    选择 IDE 版本和项目

    已建立连接，后端 IDE 已下载，并在 JetBrains Client 中打开了项目。

最后修改日期： 2025年 9月 26日
安装 JetBrains Gateway完全离线模式