GoLand 2025.2 Help

连接并使用 JetBrains Gateway

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

前提条件

在远程主机上开始开发之前,请确保准备好以下内容:

  • 远程计算机(即 IDE 的目标)满足在 IDE 相关文章中列出的最低推荐要求。

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

  • Linux 平台为支持的 Linux AMD64 发行版,例如 Ubuntu 16.04+、RHEL/CentOS 7+ 等。 建议使用具有 2 核及以上、4GB 或以上内存、5GB 或以上磁盘空间的计算机。

  • 远程主机上必须启用 sftp 子系统。 在当前实现中,我们使用它来部署后端。

JetBrains Gateway

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

请参考快速视频,了解如何开始使用 JetBrains Gateway。

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

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

  1. 下载并安装 JetBrains Gateway 应用

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

  2. SSH 连接提供方下点击 新建连接

    通过 SSH 连接
  3. 在向导的下一页面中,指定用于连接远程服务器的 SSH 配置。

    SSH 设置

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

    SSH 配置 对话框中,添加以下信息:

    SSH 配置
    • 主机 :指定远程服务器地址。

    • 端口 :指定 SSH 端口,默认值为 22

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

    • 认证类型 :选择以下身份验证方式之一:

      • 密码 :使用密码访问主机。 要将密码保存在 GoLand 中,请选择 保存密码 复选框。

      • 密钥对(OpenSSH 或 PuTTY) :使用密钥对进行 SSH authentication。 要应用此身份验证方法,您必须在客户端计算机上拥有一个私钥,并在远程服务器上拥有一个公钥。 GoLand 支持使用 OpenSSH 工具生成的私钥。

        指定存储 私钥 的文件路径,并在相应字段中输入密码短语(如有)。 要使 GoLand 记住密码短语,请选择 保存口令 复选框。

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

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

    • 连接参数 :使用此部分配置连接的其他参数。

      如需了解更多信息,请参阅 连接参数

    • HTTP/SOCKS 代理 :使用此部分配置代理设置。 如需了解更多信息,请参阅 Proxy settings

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

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

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

    您也可以使用“Other options”来设置 IDE installers 的备用来源。

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

IDE 版本

默认情况下,下载的 GoLand 存储在远程服务器上的以下文件夹中: ~/.cache/JetBrains/RemoteDev/dist 。 不过,您可以按以下步骤更改此位置并将 GoLand 安装至自定义路径:

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

  2. 安装路径 字段中添加所需的安装路径。

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

远程项目路径

点击 上传IDE 并连接

JetBrains Gateway 会下载 IDE,并在 JetBrains Client 中打开您的远程项目。 连接显示在 JetBrains Gateway 窗口中,您可以在此窗口连接其他 IDE 或断开连接。 该窗口默认最小化至托盘。

打开项目前,您可以覆盖后端的 -Xmx VM options。

打开最近的项目

  1. JetBrains Gateway 向导中,从左侧选项中选择 SSH

  2. 在搜索框中输入项目名称以快速定位。

    最近的项目

    如果需要快速访问终端,请点击 打开终端

更改后端版本

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

    更改后端版本

    如果无法在列表中找到所需版本,请点击 选择不同的 IDE 并在 IDE 版本 字段中选择期望的 IDE 版本。

    选择 IDE 版本

停止正在运行的实例

  1. JetBrains Gateway 向导中,从左侧选项中选择 SSH

  2. 远程会话处于活动状态时,项目旁将显示 运行中 指示器。

    点击项目旁的 ,然后选择 停止 IDE 后端 以终止该项目的远程会话。

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

卸载后端 IDE 版本

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

    管理 IDE
  2. 在打开的窗口中,点击所需卸载的后端 IDE 版本旁的 关闭图标 ,然后点击 确认操作。

连接到手动启动的远程 IDE 上的远程项目(服务器到客户端模式)

如果远程服务器上已安装 GoLand,您可以手动启动并连接到该 IDE 中启动的远程项目。 其工作方式与从 JetBrains Gateway 启动相同。

如果公司有自定义编排系统,或远程 IDE 能自动启动,请使用此方法。

该过程可以描述如下:

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

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

  3. 在本地计算机上打开该链接。

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

连接到远程 IDE

  1. 请确保已 下载并安装 JetBrains Gateway ,或本地 IDE 中已包含 JetBrains Gateway 插件。

  2. 请确保已使用 GoLand 通过 SSH 连接到远程计算机。

  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

    查看以下示例:

    ~/ideaIU-213.3469/bin/remote-dev-server.sh run ~/spring-boot-example/ --ssh-link-host ec2-11-50-136-85.eu-north-1.compute.amazonaws.com --ssh-link-user ubuntu

    如果未传递参数,脚本将使用默认值:端口为 22、系统用户的用户名,以及从 hostname 命令获取的主机。

  4. 如果项目启动成功,将在终端输出以下 3 个链接:

    • 加入链接: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 字段中,然后点击 连接

    GoLand 会下载所需版本的 JetBrains Client,并在其中打开远程项目。

注册先前安装的远程 IDE

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

请按照以下步骤注册已安装的 IDE,使其显示在可用构建列表中:

  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 插件 可让您连接工作站,并在 GoLand 中使用工作站进行开发。

连接到 Google Cloud 中的工作站

  1. 启动 JetBrains Gateway

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

  3. 安装更多提供方 部分中,找到 Google Cloud 并点击 安装

    Google Cloud

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

  4. 从左侧选项中,找到 云工作站 并点击 连接到 Google Cloud

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

    连接到 Cloud Workstation
  6. 在下一页面,选择在配置文件中设为代码提供者的 IDE 版本和要处理的项目。

    连接建立后,项目所在的工作站会在 JetBrains Client 中打开,您可以在 IDE 中继续开发。

连接到 Gitpod

JetBrains Gateway 支持与 Gitpod 集成,Gitpod 是一个自动化开发环境的开源编排与配置平台。

Gitpod 以插件形式提供于 JetBrains Gateway 中,您可以使用该插件连接已有 Gitpod 工作区,或创建新工作区并在 GoLand 中进行开发。

连接到 Gitpod 中的工作区

  1. 启动 JetBrains Gateway

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

  3. 安装更多提供方 部分中,找到 Gitpod 并点击 安装

    安装 Gitpod

    插件安装完成后,您可以在 远程开发 节点和 安装更多提供方 部分中找到它。

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

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

  6. 点击 新建工作区

    JetBrains Gateway 会在浏览器中将您连接至 Gitpod 工作区。 Gitpod 会准备工作区并显示在 JetBrains Client 中打开工作区的通知。

    在浏览器中打开 JetBrains Gateway

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

    连接建立后,项目所在的工作区会在 JetBrains Client 中打开,您可以在 IDE 中继续开发。

    已创建的工作区将添加到 最近的工作区 部分。 如果已经存在工作区,它们将显示在最近工作区列表中,您可以随时点击所需工作区旁的 连接 来连接。

如果您希望直接从 Gitpod 连接至 JetBrains Gateway,请参阅 Gitpod 文档

连接到 Amazon CodeCatalyst 开发环境

Amazon CodeCatalyst 是一个面向软件开发团队的基于云的协作空间。

您可以使用 JetBrains Gateway 连接到 Amazon CodeCatalyst ,以开发远程项目。 或者,您也可以从 CodeCatalyst 端连接,并在 JetBrains Client 中打开项目。

Amazon CodeCatalyst 通过 AWS Toolkit 插件集成进 JetBrains Gateway,您可以使用该插件连接已有环境或创建新环境,并在 GoLand 中进行开发。

在尝试连接之前,请确保满足以下先决条件:

  • 您必须拥有有效的 AWS Builder ID 和 CodeCatalyst 账户。

  • 您已安装并启用 AWS Toolkit

通过 JetBrains Gateway 连接到您的开发环境

  1. 启动 JetBrains Gateway

  2. 点击屏幕底部的 并选择 管理提供方

  3. 在打开的页面中,切换至 插件市场 选项卡,找到 AWS Toolkit安装并启用 插件。

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

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

  5. 从右侧选项中,找到 Amazon CodeCatalyst 并点击 登录到 AWS Builder ID

  6. 在向导的下一页面中,登录到您的 AWS 账户。

    登录 AWS Builder ID
  7. 选择所需的 IDE,填写创建开发环境所需的信息,然后点击 创建开发环境

    创建新开发环境

    开发环境已创建,项目在 IDE 中打开。

您也可以从 Amazon CodeCatalyst 控制台创建开发环境,并使用 JetBrains Gateway 连接。

从 Amazon CodeCatalyst 连接

  1. 登录您的 Amazon CodeCatalyst 账户。

  2. 在已创建的 Space 中,定位并打开您的项目。

  3. 如果尚未设置 Dev 环境,请点击 创建开发环境

  4. 在可用 IDE 列表中,选择所需的 IDE,填写必要信息后点击 创建

    Dev 环境已创建,并显示其活动状态。

  5. 点击 恢复于 以在 JetBrains Gateway 中打开 JetBrains Client 中的项目。

    Dev 环境准备就绪后,项目将在 IDE 中打开,您可以继续进行开发。

连接到 Coder

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

Coder 作为插件在 JetBrains Gateway 中提供,您可以使用它连接到现有环境或创建新环境,并在 GoLand 中进行开发。

连接到 Coder 工作区

  1. 启动 JetBrains Gateway

  2. 点击屏幕底部的 ,然后选择 管理提供方

  3. 在打开的页面中,转到 插件市场 选项卡,找到 Coder安装并启用插件。

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

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

    全部提供方
  5. 请确保您已在 Coder 中配置 workspace,并复制访问 URL。

    Coder 工作区
  6. 在 JetBrains Gateway 中,点击 连接到 Coder

  7. 在向导的下一页中,将 复制的 URL 粘贴到 URL 字段中,然后点击 连接

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

    会话令牌

    点击 确定

  9. 身份验证成功后,您将看到已配置的 workspace 列表,请选择所需的 workspace 并点击 选择 IDE 和项目

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

    选择完成后,点击 启动 IDE 并连接

    选定项目的 Coder 开发环境将在 JetBrains Client 中打开,您可在 IDE 内进一步开发。

连接到 JetBrains CodeCanvas

JetBrains CodeCanvas 是一项解决方案,可帮助企业将软件开发从本地计算机迁移至远程开发环境。

您可以使用 JetBrains Gateway 连接到 CodeCanvas ,以在远程项目上开展工作。 或者,您也可从 CodeCanvas 端连接,并在 JetBrains Client 中打开项目。

JetBrains CodeCanvas 通过 CodeCanvas 插件在 JetBrains Gateway 中提供,您可使用该插件连接到现有环境或创建新环境,并在 GoLand 中开展工作。

连接到 Code Canvas 开发环境

  1. 启动 JetBrains Gateway

    CodeCanvas 插件默认启用。

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

    全部提供方
  3. 在 JetBrains Gateway 中,点击 连接到 CodeCanvas

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

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

  6. 点击 新建环境 并配置新的 dev 环境(如果您的项目已有所需 dev 环境,可跳过此步骤):

    • 选择要用于 dev 环境的 模板

    • 环境名称 将自动选中。

    • 选择所需的分支和热启动快照(如有)。

    点击 创建环境

    创建环境
  7. 创建 dev 环境后,您的项目将在 JetBrains Client 中打开,您可立即开始编码。

    在 JetBrains Gateway 欢迎界面的 连接 节点下,选择 JetBrains CodeCanvas 以查看现有 dev 环境的列表。

连接到运行在 WSL2 上的项目

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

在开始连接 WSL 前,请确保满足以下先决条件:

  • 您的计算机上已安装 Windows 10 或 11,并在 WSL2 下部署了 Ubuntu 20.04 版本。

  • 您的 Windows 设备上已配置 WSL2。 有关更多信息,请参阅 WSL2 配置 部分。

  • 您的计算机至少具备 200 GB 可用空间、8 GB 内存和 4 核 CPU。

  • 您使用的是最新的 JetBrains Gateway EAP 版本。

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

连接到 WSL

  1. 启动 JetBrains Gateway

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

  3. 在右侧选项中点击 新建连接

    新建连接
  4. 在下一页中选择 WSL 实例,然后点击 下一步

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

    选择 IDE 版本和项目

    连接建立后,将下载后端 IDE,并在 JetBrains Client 中打开项目。

最后修改日期: 2025年 9月 26日