修改远程开发WebIDE版和远程开发插件版
This commit is contained in:
muruichao
parent
9b03918a5a
commit
18cae472e6
Binary file not shown.
|
After Width: | Height: | Size: 1.6 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 33 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 149 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 162 KiB |
|
|
@ -1,39 +1,54 @@
|
|||
# 远程开发功能使用说明
|
||||
## 功能概述
|
||||
远程开发功能支持通过Linux或Windows操作系统客户端连接到远程机上进行代码开发功能，目前支持x86_64、loongarch64、aarch64三种架构。为用户提供远程编辑、远程编译、远程运行、远程调试等功能，Linux和Windows客户端上使用方法有所不同，具体使用方法如下：
|
||||
- [Linux远程开发插件安装使用说明](#linux远程开发插件安装使用说明)
|
||||
# 远程开发插件版
|
||||
- [功能概述](#功能概述)
|
||||
- [安装使用说明](#安装使用说明)
|
||||
- [准备工作](#1准备工作)
|
||||
- [插件安装](#2插件安装)
|
||||
- [远程资源管理](#3远程资源管理)
|
||||
- [连接管理](#4连接管理)
|
||||
- [项目管理、多语言开发、调试功能使用](#5项目管理多语言开发调试功能使用)
|
||||
- [远程开发环境卸载](#6远程开发环境卸载)
|
||||
- [插件安装、多语言开发、调试功能使用](#5插件安装多语言开发调试功能使用)
|
||||
- [卸载](#6卸载)
|
||||
- [例子](#7例子)
|
||||
- [浏览器导入证书方法](#8浏览器导入证书方法)
|
||||
- [Windows远程开发使用说明](#windows远程开发使用说明)
|
||||
- [环境部署](#1环境部署)
|
||||
- [脚本执行](#2脚本执行)
|
||||
## Linux远程开发插件安装使用说明
|
||||
|
||||
## 功能概述
|
||||
- 远程开发插件版，提供Kylin Remote Development插件，类微软Remote SSH（非完全开源），为用户提供跨机器、跨平台远程编辑、远程编译、远程运行、远程调试等功能。插件能够安装在桌面版Kylin-IDE、VSCode、VSCodium中，用法和Remote SSH插件类似
|
||||
- 用法举例
|
||||
* 跨机器、跨平台：在X86、银河麒麟桌面操作系统上安装桌面版Kylin-IDE，在Kylin-IDE中安装Kylin Remote Development插件，远程开发飞腾或LoongArch机器上的应用
|
||||
* 跨系统：在Windows上安装VSCodium，然后安装Kylin Remote Development插件，远程开发银河麒麟操作系统上的软件（Windows客户端正在开发中）
|
||||
* 无界面系统：银河麒麟服务器操作系统上未安装图形界面的情况，在银河麒麟桌面系统或Windows上安装Kylin-IDE或VSCodium，然后安装Kylin Remote Development插件，可以使用图形化的界面编辑、调试代码
|
||||
- 整体结构如下图所示。
|
||||
|
||||
- 分为远程开发插件(Kylin Remote Development)和服务端(kylin-ide-server)
|
||||
* Kylin Remote Development
|
||||
- 安装在桌面版Kylin-IDE或VSCode上
|
||||
- 根据远程机器架构自动部署服务端，或引导用户手动部署服务端
|
||||
- 用户连接远程机器时，在开发机和远程机之间建立ssh隧道，进行ssh登录认证
|
||||
- 登录认证后，提供界面访问服务端
|
||||
- 获取途径：OpenVSX插件市场，或[extensions-repo仓库](https://gitee.com/openkylin/extensions-repo/tree/master/KylinIDETeam/remote-dev)
|
||||
* kylin-ide-server
|
||||
- 服务端是IDE基础平台的Web服务版本，改造自开源项目Code-OSS
|
||||
- 服务端通常由客户端自动部署，在某些无网络环境下，可在客户端引导下手动部署。[手动下载地址](https://gitee.com/mcy-kylin/kylin-ide-server/releases)
|
||||
- 支持的平台：见[支持的平台章节](./支持的平台.md)
|
||||
|
||||
## 安装使用说明
|
||||
### 1、准备工作
|
||||
- 获取远程Linux主机的SSH用户和密码，查看远程主机的架构，是否属于x86_64、loongarch64、aarch64的其中一种，目前远程开发支持以上三种架构
|
||||
- 获取远程主机的SSH用户和密码，查看远程主机的架构，是否属于x86_64、loongarch64、aarch64的其中一种，目前远程开发支持以上三种架构
|
||||
- 检查“远程机”的sshd服务是否正常，“/etc/ssh/sshd_config”中 “AllowTcpForwarding”和“PermitTunnel”为yes，如果“AllowTcpForwarding”和“PermitTunnel”为no，请修改配置，并重启sshd服务
|
||||
- 检查在客户机是否能够通过ssh连接到远程机
|
||||
>注：因为远程开发插件需要建立SSH连接，若用户IDE端使用的是麒麟操作系统，请确认'设置'->'网络保护'->'联网控制'开启了Kylin-IDE/KylinCode联网权限。
|
||||
>注：因为远程开发插件需要建立SSH连接，若用户IDE端使用的是麒麟操作系统，请确认'设置'->'网络保护'->'联网控制'开启了Kylin-IDE/KylinCode联网权限
|
||||
### 2、插件安装
|
||||
- 本地客户端机器需要先安装IDE基础平台，见[简介章节](./简介.md)
|
||||
- 本地客户端机器需要先安装IDE基础平台
|
||||
- 从插件市场中搜索`Kylin remote development`远程开发插件并安装
|
||||
|
||||
|
||||
|
||||
- 安装完成后，将在左侧活动栏中出现远程开发插件图标，点击图标进入远程资源管理器页面
|
||||
- 远程开发环境服务端软件包下载(插件版本>=0.1.10已支持自动下载并初始化环境，不需要以下操作)：
|
||||
- 远程开发环境服务端软件包下载
|
||||
* 通常情况下，不需要手动部署，由插件根据远程机器平台自动部署(插件版本>=0.1.10已支持自动下载并初始化环境)
|
||||
* 在无网络情况下，可以手动下载部署
|
||||
- 根据远程机的架构，从gitee中选择对应架构的软件包进行下载(**下载版本 >= v0.1.2**)。[远程开发服务端软件包](https://gitee.com/mcy-kylin/kylin-ide-server/releases/)
|
||||
- 将下载的软件包放在客户机本地环境中用户家目录下的.cache目录下
|
||||
|
||||
如： OpenKylin 操作系统、x86架构下需下载对应[kylin-ide-server_0.1.2_x86_64.tar.gz](https://gitee.com/mcy-kylin/kylin-ide-server/releases/download/v0.1.2/kylin-ide-server_0.1.2_x86_64.tar.gz)包，并放在客户机家目录下的.cache目录中(操作Kylin-IDE(KylinCode)进行插件安装的机器为客户机，不是要远程的机器)。
|
||||
>注：插件版本>=0.1.10已支持自动下载并初始化环境，不需要以上操作，若低于此版本建议更新插件。
|
||||
|
||||
|
||||
### 3、远程资源管理
|
||||
|
||||
- 在“远程资源管理器”中提供了查看设置、新建连接、刷新等功能：
|
||||
|
|
@ -64,7 +79,7 @@
|
|||
|
||||
- 重命名：连接名默认显示ip地址，点击“重命名”可以对当前连接进行命名，方便用户记忆。
|
||||
|
||||
### 5、项目管理、多语言开发、调试功能使用
|
||||
### 5、插件安装、多语言开发、调试功能使用
|
||||
- 通过远程开发插件打开远程开发环境后，其使用方法和Kylin-IDE(KylinCode)编辑器类似。
|
||||
- 远程插件市场设置
|
||||
- 默认使用OpenVSX插件市场，如果更改插件市场，请在设置中进行修改：点击左下角的设置->在弹出的页面中搜索gallery关键字->在输入框中输入serviceUrl和itemUrl。
|
||||
|
|
@ -75,13 +90,11 @@
|
|||
- 远程开发环境插件的安装方法和Kylin-IDE(KylinCode)相同
|
||||
- 插件安装后，在“LOCALHOST:PORT-已安装”中显示远程开发环境已安装的插件
|
||||
|
||||
- 项目管理
|
||||
- 项目管理功能使用方法请参见[项目管理章节](%E9%A1%B9%E7%9B%AE%E7%AE%A1%E7%90%86)
|
||||
|
||||
- 多语言开发
|
||||
- 提供C、C++、Java、Python、Go、JavaScript语言的代码开发功能，包括代码编辑、编译、调试、运行等功能，具体使用条件和方法请参见[C-C++开发章节](./C-C%2B%2B%E5%BC%80%E5%8F%91.md)、[Java开发章节](./Java%E5%BC%80%E5%8F%91.md)、[Python开发章节](./Python%E5%BC%80%E5%8F%91.md)、[Go开发章节](./Go%E5%BC%80%E5%8F%91.md)、[JavaScript开发章节](./JavaScript%E5%BC%80%E5%8F%91.md)。
|
||||
|
||||
### 6、远程开发环境卸载
|
||||
### 6、卸载
|
||||
- 服务端卸载
|
||||
- 检查远程机“server-main”服务进程是否存在，如果存在请杀死该进程，或等进程自动退出
|
||||
- 删除远程机用户目录下~/.kylin-ide-server 目录
|
||||
|
|
|
|||
|
|
@ -1,36 +1,55 @@
|
|||
# 远程开发客户端功能使用说明
|
||||
## 功能概述
|
||||
远程开发客户端作为一个小巧的图形化的远程开发管理软件，能够在未安装Kylin-IDE的系统中为用户提供远程开发功能。通过远程开发客户端可以完成远程开发连接管理、服务部署等功能，并使用系统浏览器访问远程开发环境。功能支持通过Linux或Windows操作系统客户端连接到远程机上进行代码开发功能，目前支持x86_64、loongarch64、aarch64三种架构。为用户提供远程编辑、远程编译、远程运行、远程调试等功能，具体使用方法如下：
|
||||
- [Linux远程开发插件安装使用说明](#linux远程开发插件安装使用说明)
|
||||
- [准备工作](#1准备工作)
|
||||
- [远程客户端安装](#2远程客户端安装)
|
||||
- [客户端主页面](#3客户端主页面)
|
||||
- [客户端设置页面](#4客户端设置页面)
|
||||
# 远程开发WebIDE版
|
||||
- [功能概述](#功能概述)
|
||||
- [安装使用说明](#安装使用说明)
|
||||
- [远程机SSH配置](#1远程机SSH配置)
|
||||
- [WebIDE客户端安装](#2WebIDE客户端安装)
|
||||
- [WebIDE客户端主页面](#3WebIDE客户端主页面)
|
||||
- [WebIDE客户端设置页面](#4WebIDE客户端设置页面)
|
||||
- [远程资源管理](#5远程资源管理)
|
||||
- [提示信息管理](#6提示信息管理)
|
||||
- [项目管理、多语言开发、调试功能使用](#7项目管理、多语言开发、调试功能使用)
|
||||
- [远程开发环境卸载](#8远程开发环境卸载)
|
||||
- [插件安装、多语言开发、调试功能使用](#7插件安装多语言开发调试功能使用)
|
||||
- [卸载](#8卸载)
|
||||
|
||||
## Linux远程开发插件安装使用说明
|
||||
### 1、准备工作
|
||||
- 获取远程Linux主机的SSH用户和密码(或设置免秘登录)，查看远程主机的架构，是否属于x86_64、loongarch64、aarch64的其中一种，目前远程开发支持以上三种架构
|
||||
## 功能概述
|
||||
- 远程开发WebIDE版，本文简称WebIDE，与一般意义的Web IDE概念不同，并不在云端提供一套统一的Web服务，而是结合了浏览器访问和SSH认证，服务端随用部署的一套软件。用法和Remote SSH插件类似，但不需要安装桌面版IDE软件。为用户提供跨机器、跨平台远程编辑、远程编译、远程运行、远程调试等功能。
|
||||
- 用法举例
|
||||
* 跨机器、跨平台：在X86、银河麒麟桌面操作系统上安装客户端(kylin-ide-web-client)，远程开发飞腾或LoongArch机器上的应用
|
||||
* 跨系统：在Windows上安装客户端，远程开发银河麒麟操作系统上的软件（Windows客户端正在开发中）
|
||||
* 无界面系统：银河麒麟服务器操作系统上未安装图形界面的情况，在银河麒麟桌面系统或Windows上安装客户端，可以使用图形化的界面编辑、调试代码（Windows客户端正在开发中）
|
||||
- 整体结构如下图所示。
|
||||
|
||||
- 分为客户端(kylin-ide-web-client)和服务端(kylin-ide-server)
|
||||
* kylin-ide-web-client
|
||||
- 小巧的图形化的远程开发管理软件，不依赖桌面版Kylin-IDE或VSCode
|
||||
- 根据远程机器架构自动部署服务端，或引导用户手动部署服务端
|
||||
- 用户连接远程机器时，在开发机和远程机之间建立ssh隧道，进行ssh登录认证
|
||||
- 登录认证后，启动浏览器，使用浏览器访问服务端
|
||||
- 获取途径：目前仅支持从gitee仓库中下载，[地址](https://gitee.com/leven08/kylin-ide-web-client/releases/)
|
||||
* kylin-ide-server
|
||||
- 服务端是IDE基础平台的Web服务版本，与远程开发插件版共用一套服务端，改造自开源项目Code-OSS
|
||||
- 服务端通常由客户端自动部署，在某些无网络环境下，可在客户端引导下手动部署。[手动下载地址](https://gitee.com/mcy-kylin/kylin-ide-server/releases)
|
||||
- 支持的平台：见[支持的平台章节](./支持的平台.md)
|
||||
|
||||
## 安装使用说明
|
||||
### 1、远程机SSH配置
|
||||
- 获取远程主机的SSH用户和密码(或设置免秘登录)
|
||||
- 检查“远程机”的sshd服务是否正常，“/etc/ssh/sshd_config”中 “AllowTcpForwarding”为yes，如果“AllowTcpForwarding”为no，请修改配置，并重启sshd服务
|
||||
- 检查在客户机是否能够通过ssh连接到远程机
|
||||
>注：因为远程开发插件需要建立SSH连接，若用户IDE端使用的是麒麟操作系统，请确认'设置'->'网络保护'->'联网控制'开启了Kylin-IDE/KylinCode联网权限。
|
||||
### 2、远程客户端安装
|
||||
- 本地客户端机器需要安装远程开发客户端，可以从软件商店、软件源、gitee下载客户端软件包，目前仅支持gitee下载[远程开发客户端软件包gitee地址](https://gitee.com/leven08/kylin-ide-web-client)
|
||||
- 远程开发客户端支持自动下载并部署环境，无需手动下载
|
||||
### 2、安装
|
||||
- 开发机：本地开发机需要安装WebIDE客户端，计划可以从软件商店、软件源、gitee下载客户端软件包，目前仅支持gitee下载[远程开发WebIDE客户端软件包gitee地址](https://gitee.com/leven08/kylin-ide-web-client/releases/)
|
||||
- 远程开发服务端支持自动下载并部署环境，通常无需手动下载；在某些无网络环境下，可在客户端引导下手动部署。[手动下载地址](https://gitee.com/mcy-kylin/kylin-ide-server/releases)
|
||||
|
||||
### 3、客户端主页面
|
||||
- 安装完成后，启动程序，将显示客户端主页面；如下图所示，右上角包含“添加连接”、“刷新”按钮，中间区域用于显示添加的连接，窗口右下角用于显示客户端提示信息。
|
||||
### 3、WebIDE客户端主页面
|
||||
- 安装完成后，启动程序，将显示WebIDE客户端主页面；如下图所示，右上角包含“添加连接”、“刷新”按钮，中间区域用于显示添加的连接，窗口右下角用于显示客户端提示信息。
|
||||
|
||||
|
||||
### 4、客户端设置页面
|
||||
### 4、WebIDE客户端设置页面
|
||||
- 客户端设置页面如下图所示，用于设置日志级别、主题样式、关闭面板，以及主页、当前版本、版权信息等。
|
||||
- 日志级别：日志优先级从高到底分为ERROR、WARN、INFO、DEBUG四个等级，客户端日志信息随着等级降低而更多。当鼠标放在日志开关上时会高亮，选中后会变成蓝色。
|
||||
- 主题设置：提供多种主题样式，用户可以根据喜好选择不同样式。
|
||||
- 关闭面板：用于设置客户端退出按钮的状态，默认点击窗口的关闭按钮时，客户端会最小化到任务栏；如果选择“退出程序”，则在点击窗口关闭按钮时客户端会退出。
|
||||
|
||||
- 版本信息：显示当前客户端版本
|
||||
- 帮助文档连接：在右上角？为远程开发WebIDE使用手册链接，点击可打开链接。
|
||||
|
||||
|
||||
|
||||
|
|
@ -43,9 +62,9 @@
|
|||
- 添加基本信息：在添加页面中，基本信息包括远程机器的IP地址、用户名、软件包安装方式（在线安装、离线安装、软件源安装）、浏览器选择（默认浏览器、指定浏览器）、认证方式等。
|
||||
安装方式是指如何在远程机器上安装远程服务包，包括在线安装、软件源安装、离线安装。
|
||||
|
||||
1）在线安装：从Kylin-IDE官网下载远程服务包，并将软件包放在本地机器的~/.cache目录，然后进行远程服务部署。
|
||||
1）在线安装：自动从[gitee仓库](https://gitee.com/mcy-kylin/kylin-ide-server/releases)下载远程服务包，并将软件包放在本地机器的~/.cache目录，然后进行远程服务部署。
|
||||
|
||||
2）软件源安装：使用apt或yum命令从系统软件源下载远程服务包，并将软件包放在本地机器的~/.cache目录，然后进行远程服务部署。
|
||||
2）软件源安装(目前未支持)：使用apt或yum命令从系统软件源下载远程服务包，并将软件包放在本地机器的~/.cache目录，然后进行远程服务部署。
|
||||
|
||||
3）离线安装：在离线情况下，用户将远程服务包下载到本地机器后，指定存放目录，客户端从指定目录进行远程服务部署。
|
||||
在线安装和软件源安装会优先检查~/.cache目录下是否存在远程服务包，若有则使用该软件包，否则会进行下载。
|
||||
|
|
@ -58,13 +77,10 @@
|
|||
- 添加高级配置：
|
||||
|
||||
1）在高级配置中，用户可以设置与远程机器ssh连接所使用的端口号port，以及本地访问远程机器所使用的端口号transport（用于通过https://localhost:transport来访问远程开发环境）。
|
||||
2) 自动更新远程服务，默认打开时，会在打开连接时检查已部署的远程服务版本是否为最新版本，如果不是则自动更新为最新版本；如果关闭则对已经部署的服务端包不进行版本检查。
|
||||
|
||||
2）点击数据压缩复选框后，将打开数据压缩功能，ssh在传输数据时将对数据进行压缩。
|
||||
|
||||
3）点击x11转发复选框后，将辅助用户设置和使用X11功能。
|
||||
|
||||
4）其他参数表示允许用户自行输入ssh的其他参数。
|
||||
|
||||
|
||||
- 合法性检查：在切换高级配置页面或点击确认按钮进行连接创建时，会进行用户名、IP、浏览器路径等信息的合法性检查，如果为空或者格式错误将进行提示
|
||||
|
||||
|
||||
|
|
@ -95,7 +111,7 @@
|
|||
|
||||
- 当输入密码并点击“确认”后，客户端将创建与远程机器的ssh连接、完成环境检查、服务部署启动、打开浏览器显示远程开发环境等工作。
|
||||
|
||||
- 打开浏览器：当远程机器连接成功后会打开本地浏览器显示远程开发环境。因为去掉了浏览器的外壳，所以Kylin-IDE远程开发环境与本地开发环境在外观上并没有本质区别，安装插件后即可进行远程开发
|
||||
- 打开浏览器：当远程机器连接成功后会打开本地浏览器显示远程开发环境。对于支持app模式的浏览器(例如chrome、奇安信等)，采用app模式打开浏览器，所以打开的WebIDE远程开发环境隐藏了地址栏，并隐藏了浏览器传参中url具体细节，与本地开发环境外观上类似；针对不支持app模式的浏览器，需要在使用时导入证书或者接受不信任地址，具体可以参考[远程开发章节中-浏览器导入证书方法](./远程开发.md)。
|
||||
|
||||
|
||||
|
||||
|
|
@ -114,7 +130,7 @@
|
|||
- 提示信息关闭：当点击信息框右上角的关闭按钮时则关闭提示信息，系统会在一定时间后自动关闭信息。
|
||||
|
||||
|
||||
### 7、项目管理、多语言开发、调试功能使用
|
||||
### 7、插件安装、多语言开发、调试功能使用
|
||||
- 通过远程开发插件打开远程开发环境后，其使用方法和Kylin-IDE(KylinCode)编辑器类似。
|
||||
- 远程插件市场设置
|
||||
- 默认使用OpenVSX插件市场，如果更改插件市场，请在设置中进行修改：点击左下角的设置->在弹出的页面中搜索gallery关键字->在输入框中输入serviceUrl和itemUrl。
|
||||
|
|
@ -125,17 +141,14 @@
|
|||
- 远程开发环境插件的安装方法和Kylin-IDE(KylinCode)相同
|
||||
- 插件安装后，在“LOCALHOST:PORT-已安装”中显示远程开发环境已安装的插件
|
||||
|
||||
- 项目管理
|
||||
- 项目管理功能使用方法请参见[项目管理章节](%E9%A1%B9%E7%9B%AE%E7%AE%A1%E7%90%86)
|
||||
|
||||
- 多语言开发
|
||||
- 提供C、C++、Java、Python、Go、JavaScript语言的代码开发功能，包括代码编辑、编译、调试、运行等功能，具体使用条件和方法请参见[C-C++开发章节](./C-C%2B%2B%E5%BC%80%E5%8F%91.md)、[Java开发章节](./Java%E5%BC%80%E5%8F%91.md)、[Python开发章节](./Python%E5%BC%80%E5%8F%91.md)、[Go开发章节](./Go%E5%BC%80%E5%8F%91.md)、[JavaScript开发章节](./JavaScript%E5%BC%80%E5%8F%91.md)。
|
||||
|
||||
### 8、远程开发环境卸载
|
||||
### 8、卸载
|
||||
- 服务端卸载
|
||||
- 检查远程机“server-main”服务进程是否存在，如果存在请杀死该进程，或等进程自动退出
|
||||
- 删除远程机用户目录下~/.kylin-ide-server 目录
|
||||
|
||||
- 客户端卸载
|
||||
- 使用dpkg命令或者rpm命令进行卸载，同时删除用户目录下~/.kylin-ide-remote目录和~/.config/kylin-remote-ide目录
|
||||
|
||||
Loading…
Reference in New Issue