添加远程开发客户端使用手册

user-guide/files/远程开发客户端.md

@@ -0,0 +1,140 @@
+# 远程开发客户端功能使用说明
+## 功能概述
+远程开发客户端作为一个小巧的图形化的远程开发管理软件，能够在未安装Kylin-IDE的系统中为用户提供远程开发功能。通过远程开发客户端可以完成远程开发连接管理、服务部署等功能，并使用系统浏览器访问远程开发环境。功能支持通过Linux或Windows操作系统客户端连接到远程机上进行代码开发功能，目前支持x86_64、loongarch64、aarch64三种架构。为用户提供远程编辑、远程编译、远程运行、远程调试等功能，具体使用方法如下：
+- [Linux远程开发插件安装使用说明](#linux远程开发插件安装使用说明)
+  - [准备工作](#1准备工作)
+  - [远程客户端安装](#2远程客户端安装)
+  - [客户端主页面](#3客户端主页面)
+  - [客户端设置页面](#4客户端设置页面)
+  - [远程资源管理](#5远程资源管理)
+  - [提示信息管理](#6提示信息管理)
+  - [项目管理、多语言开发、调试功能使用](#7项目管理、多语言开发、调试功能使用)
+  - [远程开发环境卸载](#8远程开发环境卸载)
+
+## Linux远程开发插件安装使用说明
+### 1、准备工作
+  - 获取远程Linux主机的SSH用户和密码(或设置免秘登录)，查看远程主机的架构，是否属于x86_64、loongarch64、aarch64的其中一种，目前远程开发支持以上三种架构
+  - 检查“远程机”的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)
+  - 远程开发客户端支持自动下载并部署环境，无需手动下载
+   
+### 3、客户端主页面
+  - 安装完成后，启动程序，将显示客户端主页面；如下图所示，右上角包含“添加连接”、“刷新”按钮，中间区域用于显示添加的连接，窗口右下角用于显示客户端提示信息。
+![图3-1](resources/kylin-remote-dev/client_mainpage.png "客户端主页面")
+
+### 4、客户端设置页面
+  - 客户端设置页面如下图所示，用于设置日志级别、主题样式、关闭面板，以及主页、当前版本、版权信息等。
+    - 日志级别：日志优先级从高到底分为ERROR、WARN、INFO、DEBUG四个等级，客户端日志信息随着等级降低而更多。当鼠标放在日志开关上时会高亮，选中后会变成蓝色。
+    - 主题设置：提供多种主题样式，用户可以根据喜好选择不同样式。
+    - 关闭面板：用于设置客户端退出按钮的状态，默认点击窗口的关闭按钮时，客户端会最小化到任务栏；如果选择“退出程序”，则在点击窗口关闭按钮时客户端会退出。
+
+    ![图4-1](resources/kylin-remote-dev/client_setpage.png "设置页面")
+    
+    
+### 5、远程资源管理
+
+- “远程资源管理器”提供了添加连接、连接配置信息修改、打开连接、删除连接、清理连接等功能：
+- 添加连接：
+  - 点击主页面右上角添加按钮，弹出添加连接页面
+  ![图5-1](resources/kylin-remote-dev/client_addconnect.png "连接添加")
+  - 添加基本信息：在添加页面中，基本信息包括远程机器的IP地址、用户名、软件包安装方式（在线安装、离线安装、软件源安装）、浏览器选择（默认浏览器、指定浏览器）、认证方式等。
+    安装方式是指如何在远程机器上安装远程服务包，包括在线安装、软件源安装、离线安装。
+    
+    1）在线安装：从Kylin-IDE官网下载远程服务包，并将软件包放在本地机器的~/.cache目录，然后进行远程服务部署。
+
+    2）软件源安装：使用apt或yum命令从系统软件源下载远程服务包，并将软件包放在本地机器的~/.cache目录，然后进行远程服务部署。
+
+    3）离线安装：在离线情况下，用户将远程服务包下载到本地机器后，指定存放目录，客户端从指定目录进行远程服务部署。
+    在线安装和软件源安装会优先检查~/.cache目录下是否存在远程服务包，若有则使用该软件包，否则会进行下载。
+
+    4）浏览器选择是指采用哪个浏览器打开远程开发环境，默认情况下使用系统默认浏览器，当用户指定了浏览器之后就优先使用该浏览器。
+    
+    5）认证方式是指在ssh连接到远程机器时采用的认证方式，默认选择密码认证，在连接时需要输入远程机器登录密码；如果选择秘钥认证，则在ssh连接时采用秘钥方式登录，默认秘钥存放路径为~/.ssh/id_rsa，用户可以指定具体的秘钥路径（如果秘钥设置了口令，则在连接时的密码输入框中需要输入秘钥口令，否则无法连接）。如果该文件不存在，则执行"ssh-keygen -t rsa"命令生成。 
+    ![图5-2](resources/kylin-remote-dev/client_addpage.png "基本信息页")
+
+  - 添加高级配置：
+    
+    1）在高级配置中，用户可以设置与远程机器ssh连接所使用的端口号port，以及本地访问远程机器所使用的端口号transport（用于通过https://localhost:transport来访问远程开发环境）。
+
+    2）点击数据压缩复选框后，将打开数据压缩功能，ssh在传输数据时将对数据进行压缩。
+
+    3）点击x11转发复选框后，将辅助用户设置和使用X11功能。
+
+    4）其他参数表示允许用户自行输入ssh的其他参数。
+    ![图5-3](resources/kylin-remote-dev/client_addpage2.png "高级信息页")
+  - 合法性检查：在切换高级配置页面或点击确认按钮进行连接创建时，会进行用户名、IP、浏览器路径等信息的合法性检查，如果为空或者格式错误将进行提示
+    ![图5-4](resources/kylin-remote-dev/client_addpagecheck.png "合法性检查")
+
+  - 点击确认后，会创建连接，并在主页面显示所创建的连接，包括用户名、IP地址，以及“打开连接”、“修改配置”、“删除连接”、“清理连接”等连接管理的快捷按钮
+    ![图5-5](resources/kylin-remote-dev/client_createsuccess.png "创建成功")
+
+- 修改配置    
+  - 将鼠标放在连接上，会在连接右侧显示四个快捷按钮，分别是打开连接、修改配置、删除连接、清理连接，点击第二个“修改配置”按钮将弹出修改页面
+  ![图5-6](resources/kylin-remote-dev/client_edit.png "修改配置")
+  - 修改页面中除用户名和IP地址不可修改外，其他基本信息均可修改
+  ![图5-7](resources/kylin-remote-dev/client_editpage.png "修改配置基础页")
+   ![图5-8](resources/kylin-remote-dev/client_editpage2.png "修改配置高级页")
+  
+  注意：如果远程连接已经建立，修改配置后，需要清理掉原连接并使用新的配置重新创建连接。
+
+- 删除连接：点击连接右侧的“删除连接”按钮将弹出删除连接确认框，当点击“确认”按钮后，连接将从主页面中删除
+  ![图5-9](resources/kylin-remote-dev/client_delete.png "删除连接")
+  ![图5-10](resources/kylin-remote-dev/client_deletenotify.png "删除连接提示")
+
+- 清理连接：点击连接右侧的“删除连接”按钮将弹出删除连接确认框，当点击“确认”按钮后，将弹出密码/秘钥口令输入框，在输入密码后，客户端将清理掉远程服务以及ssh相关连接，并将连接从主页面中删除。
+
+  ![图5-11](resources/kylin-remote-dev/client_clear.png "清理连接")
+  ![图5-12](resources/kylin-remote-dev/client_clearnotify.png "清理连接提示")
+
+- 打开连接
+  - 点击连接右侧“打开连接”按钮将弹出密码/秘钥口令输入框
+  ![图5-13](resources/kylin-remote-dev/client_openconnect.png "打开连接")
+  ![图5-14](resources/kylin-remote-dev/client_openconnectpwd.png "输入密码")
+  - 当输入密码并点击“确认”后，客户端将创建与远程机器的ssh连接、完成环境检查、服务部署启动、打开浏览器显示远程开发环境等工作。
+
+  - 打开浏览器：当远程机器连接成功后会打开本地浏览器显示远程开发环境。因为去掉了浏览器的外壳，所以Kylin-IDE远程开发环境与本地开发环境在外观上并没有本质区别，安装插件后即可进行远程开发
+
+    ![图5-15](resources/kylin-remote-dev/client_openbrowser.png "打开浏览器")
+
+
+### 6、提示信息管理
+ - 在使用过程中，会在窗口右下角以提示框的形式显示关键信息，并且点击底部的历史信息按钮，能够显示历史信息。本软件会定时清理过期的提示信息。
+ - 提示信息类型：本软件提供INFO、WARN、ERROR、SUCCESS、远程服务软件下载等类型提示窗
+ ![图6-1](resources/kylin-remote-dev/client_msg.png "提示信息样式")
+ ![图6-2](resources/kylin-remote-dev/client_msg2.png "提示信息样式2")
+
+ - 历史提示框：当点击历史信息按钮时，会弹出历史信息列表，显示所有的历史信息，无信息时显示"无新通知"，点击上方的折叠按钮后会隐藏信息
+  ![图6-3](resources/kylin-remote-dev/client_history.png "历史提示框")
+  ![图6-4](resources/kylin-remote-dev/client_history2.png "历史提示框")
+
+ - 提示信息关闭：当点击信息框右上角的关闭按钮时则关闭提示信息，系统会在一定时间后自动关闭信息。
+
+
+### 7、项目管理、多语言开发、调试功能使用
+  - 通过远程开发插件打开远程开发环境后，其使用方法和Kylin-IDE(KylinCode)编辑器类似。
+  - 远程插件市场设置
+    - 默认使用OpenVSX插件市场，如果更改插件市场，请在设置中进行修改：点击左下角的设置->在弹出的页面中搜索gallery关键字->在输入框中输入serviceUrl和itemUrl。
+      ![图5-1](resources/kylin-remote-dev/remote-extension.png "插件商店设置")
+  
+  - 插件安装
+    - 打开远程开发环境后，可通过窗口上方标题显示的ip来区分所连接的远程环境与本地环境。
+    - 远程开发环境插件的安装方法和Kylin-IDE(KylinCode)相同
+    - 插件安装后，在“LOCALHOST:PORT-已安装”中显示远程开发环境已安装的插件
+     ![图5-2](resources/kylin-remote-dev/remote-dev-install.gif "插件安装")
+  - 项目管理
+    - 项目管理功能使用方法请参见[项目管理章节](%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、远程开发环境卸载
+  - 服务端卸载
+    - 检查远程机“server-main”服务进程是否存在，如果存在请杀死该进程，或等进程自动退出
+    - 删除远程机用户目录下~/.kylin-ide-server 目录
+    
+  - 客户端卸载
+    - 使用dpkg命令或者rpm命令进行卸载，同时删除用户目录下~/.kylin-ide-remote目录和~/.config/kylin-remote-ide目录
+