23 Star 5 Fork 6

openKylin / extensions-repo

加入 Gitee
與超過 1200 萬 開發者一起發現、參與優秀開源項目,私有倉庫也完全免費 :)
免費加入
該倉庫未聲明開源許可證文件(LICENSE),使用請關注具體項目描述及其代碼上游依賴。
克隆/下載
远程开发.md 14.12 KB
一鍵複製 編輯 原始數據 按行查看 歷史

远程开发功能使用说明

功能概述

远程开发功能支持通过Linux或Windows操作系统客户端连接到远程机上进行代码开发功能,目前支持x86_64、loongarch64、aarch64三种架构。为用户提供远程编辑、远程编译、远程运行、远程调试等功能,Linux和Windows客户端上使用方法有所不同,具体使用方法如下:

Linux远程开发插件安装使用说明

1、准备工作

  • 获取远程Linux主机的SSH用户和密码,查看远程主机的架构,是否属于x86_64、loongarch64、aarch64的其中一种,目前远程开发支持以上三种架构
  • 检查“远程机”的sshd服务是否正常,“/etc/ssh/sshd_config”中 “AllowTcpForwarding”和“PermitTunnel”为yes,如果“AllowTcpForwarding”和“PermitTunnel”为no,请修改配置,并重启sshd服务
  • 检查在客户机是否能够通过ssh连接到远程机

注:因为远程开发插件需要建立SSH连接,若用户IDE端使用的是麒麟操作系统,请确认'设置'->'网络保护'->'联网控制'开启了Kylin-IDE/KylinCode联网权限。

2、插件安装

  • 本地客户端机器需要先安装IDE基础平台,见简介章节

  • 从插件市场中搜索Kylin remote development远程开发插件并安装

    图2-1

  • 安装完成后,将在左侧活动栏中出现远程开发插件图标,点击图标进入远程资源管理器页面

  • 远程开发环境服务端软件包下载(插件版本>=0.1.10已支持自动下载并初始化环境,不需要以下操作):

    • 根据远程机的架构,从gitee中选择对应架构的软件包进行下载(下载版本 >= v0.1.2)。远程开发服务端软件包
    • 将下载的软件包放在客户机本地环境中用户家目录下的.cache目录下

    如: OpenKylin 操作系统、x86架构下需下载对应kylin-ide-server_0.1.2_x86_64.tar.gz包,并放在客户机家目录下的.cache目录中(操作Kylin-IDE(KylinCode)进行插件安装的机器为客户机,不是要远程的机器)。

注:插件版本>=0.1.10已支持自动下载并初始化环境,不需要以上操作,若低于此版本建议更新插件。

3、远程资源管理

  • 在“远程资源管理器”中提供了查看设置、新建连接、刷新等功能:

  • 查看设置:提供配置文件查看功能,点击后将在编辑区打开配置文件。

  • 新建连接:提供连接添加功能

    • 点击添加按钮,弹出输入框,根据提示输入远程环境用户名@ip (该用户名是远程服务端真实存在的用户)
    • 在“远程资源管理器”中显示新增的连接

    图3-1

4、连接管理

  • 新窗口打开:

    • 点击连接右边的“新窗口打开”图标
    • 在弹出输入框中,输入远程开发环境密码,将在新的窗口中打开远程开发环境(该密码为此连接在新建连接时输入的用户名对应的密码,用户名和密码是远程服务端真实存在的用户和登录密码)

    图4-1

  • 右键菜单:将鼠标放置在连接上,点击鼠标右键,将弹出右键菜单;包括新窗口打开、浏览器打开、删除连接、重命名 图4-2

    • 新窗口打开效果同上步的新窗口打开图标

    • 浏览器打开:点击“浏览器打开”,在输入框中输入远程开发环境密码,将在浏览器中打开远程开发环境

    • 浏览器打开方式可能需要加载证书才能正常使用,具体方法见浏览器导入证书方法

    图4-3

    • 删除连接:将删除当前连接

    • 重命名:连接名默认显示ip地址,点击“重命名”可以对当前连接进行命名,方便用户记忆。

5、项目管理、多语言开发、调试功能使用

  • 通过远程开发插件打开远程开发环境后,其使用方法和Kylin-IDE(KylinCode)编辑器类似。

  • 远程插件市场设置

    • 默认使用OpenVSX插件市场,如果更改插件市场,请在设置中进行修改:点击左下角的设置->在弹出的页面中搜索gallery关键字->在输入框中输入serviceUrl和itemUrl。 图5-1
  • 插件安装

    • 打开远程开发环境后,可通过窗口上方标题显示的ip来区分所连接的远程环境与本地环境。
    • 远程开发环境插件的安装方法和Kylin-IDE(KylinCode)相同
    • 插件安装后,在“LOCALHOST:PORT-已安装”中显示远程开发环境已安装的插件 图5-2
  • 项目管理

  • 多语言开发

6、远程开发环境卸载

  • 服务端卸载

    • 检查远程机“server-main”服务进程是否存在,如果存在请杀死该进程,或等进程自动退出
    • 删除远程机用户目录下~/.kylin-ide-server 目录
  • 客户端卸载

    • 从Kylin-IDE(KylinCode)中卸载远程开发插件,同时删除用户目录下~/.kylin-ide-remote目录和~/.config/kylin-remote-ide目录
  • 注意:卸载操作旨在彻底清除环境中远程开发相关数据,可以用于版本升级或重装等操作,无需在每次使用完后进行卸载操作

7、例子

  • 假设A主机的用户“user1”,想远程到B主机“test”用户进行远程开发,则A主机即为客户端,B主机即为服务端

  • 使用远程开发的准备工作:

    • 登录A主机的“user”用户,启动Kylin-IDE(KylinCode),并安装将远程插件
    • 根据B主机的架构类型,下载对应的远程开发服务端软件包,并将远程开发服务端软件包放在A主机的“user1”用户的.cache目录下(注:插件版本>=0.1.10已支持自动下载并初始化环境,不需要此操作)
    • 检查B主机的sshd服务是否正常,“/etc/ssh/sshd_config”中 “AllowTcpForwarding”和“PermitTunnel ” 为yes
    • 提供B主机的用户名“test”和密码“passwd”,检查在A上是否能够使用用户名test通过ssh连接到B
  • 新建连接

    • 点击新建连接图标,在输入框中输入“test@B主机ip”,该test为B主机中真实存在的用户
  • 新窗口打开

    • 点击新窗口打开图标,在输入框中输入test用户的密码,该密码为B主机中test用户的ssh登录密码
  • 服务端卸载

    • 上步新窗口打开使用的是test用户,则去B主机test用户下删除.kylin-ide-server目录,并确保“server-main”服务进程退出
  • 客户端卸载

    • 卸载Kylin-IDE/Kylin-Code中的远程开发插件,并删除A主机用户“user1”目录下的.kylin-ide-remote目录

8、浏览器导入证书方法

  • 证书导入原因
    • 通过浏览器方式打开远程开发环境时,WebView有时无法加载
      • 浏览器需要通过https方式登录远程开发环境,并使用service worker缓存加载WebView资源;在采用Chrome内核的浏览器中,service worker必须使用受信任的证书才能注册成功,否则WebView就无法加载; Firefox浏览器只需点击前往不信任地址便可直接访问。所以,针对采用Chrome内核的浏览器需要手动导入证书。
  • 国产平台导入证书的方法
    • 证书位置 ~/.kylin-ide-remote/kylinideca.pem,由于打开目录不一定能识别隐藏目录,可先将证书拷贝到非隐藏目录下 如 ~/kylinideca.pem

    • Chrome浏览器

      • 选择'设置' -> '隐私设置和安全性' -> '安全'

      8-1

      • 选择'管理证书'

      8-2

      • 选择'授权机构' -> '导入' -> 选择您另存的kylinideca.pem文件

      8-3

      • 选择'信任该证书,以标识网站的身份'选项

      8-4

      • 重启浏览器并再次打开远程连接

      8-5

    • 火狐浏览器

      • 选择'设置' -> '隐私与安全' -> '查看证书'

      8-6

      • 选择'证书颁发机构' -> '导入'

      8-7

      • 选择您另存的kylinideca.pem证书文件后, 选择信任标识网站,重启浏览器再次打开远程连接即可

      8-8

    • 奇安信浏览器

      • 选择'设置' -> '可信安全' -> '管理可信证书'

      8-9

      • 选择'导入证书',导入后重启浏览器再次打开远程连接即可

      8-10

    • 龙芯浏览器

      • 选择'设置' -> '隐私设置和安全性' -> '安全'

      8-11

      • 选择'管理证书'

      8-12

      • 选择'授权机构' -> '导入' -> 选择您另存的kylinideca.pem文件

      8-13

      • 选择'信任该证书,以标识网站的身份', 重启浏览器并再次打开远程连接

      8-14

    • 360浏览器

      • 选择'设置' -> '安全隐私' -> '证书管理'

      8-15

      • 选择'授权机构' -> '导入' -> 选择您另存的kylinideca.pem文件

      8-16

      • 选择'信任该证书,以标识网站的身份',重启浏览器并再次打开远程连接

      8-17

Windows远程开发使用说明

1、环境部署

  • 获取远程Linux主机的SSH用户和密码,查看远程主机的架构,是否属于x86_64、loongarch64、aarch64的其中一种,目前远程开发支持以上三种架构

  • 检查“远程机”的sshd服务是否正常,“/etc/ssh/sshd_config”中 “AllowTcpForwarding”和“PermitTunnel”为yes,如果“AllowTcpForwarding”和“PermitTunnel”为no,请修改配置,并重启sshd服务

  • 检查在客户机是否能够通过ssh连接到远程机

  • 脚本下载: 从windows远程开发脚本下载地址 下载KylinIDETEeam/remote-dev/目录下的kylin-ide-server-build.sh和kylin-remote-start.exe文件

  • 远程开发环境服务端软件包下载:

    • 根据远程机的架构,从gitee中选择对应架构的软件包进行下载(下载版本 >= v0.1.2)。远程开发服务端软件包 ,如: OpenKylin 操作系统、x86架构下需下载对应kylin-ide-server_0.1.2_x86_64.tar.gz
    • 将下载的软件包和kylin-ide-server-build.sh脚本放在远程机的同一个目录下,如:~/test/
    • 为kylin-ide-server-build.sh脚本设置可执行权限
  • 将kylin-remote-start.exe脚本放在windows客户端目录下

2、脚本执行

  • kylin-remote-start.bat脚本执行:

    • 将脚本放在windows客户端上后,通过cmd启动windows命令终端,进入脚本所在目录执行该脚本,格式如下:

      kylin-remote-start.exe [远程用户名] [远程环境ip] [远程环境kylin-ide-server-build.sh脚本所在目录]

    • 执行脚本后输入远程机密码,如下图所示:

      9-1

    • 根据提示在新的弹窗中再次输入远程机密码,此次输入密码是为了建立隧道,使用过程中请勿关闭该窗口。(如果未弹出窗口或超时,请重新bat执行脚本) 9-2

  • 脚本执行成功后会自动打开浏览器,远程开发环境启动完成

3、项目管理、多语言开发、调试功能使用

1
https://gitee.com/openkylin/extensions-repo.git
git@gitee.com:openkylin/extensions-repo.git
openkylin
extensions-repo
extensions-repo
master

搜索幫助

53164aa7 5694891 3bd8fe86 5694891