修改远程开发说明书

user-guide/files/支持的平台.md

@@ -6,7 +6,7 @@
         - 客户端（插件，开发机）：安装在桌面版Kylin-IDE中时，支持的平台见上文；安装在VSCode中时，支持X86、Windows10、Windows11系统
         - 服务端（远程机）：支持X86、ARM（飞腾）、LoongArch、银河麒麟桌面和服务器操作系统，可根据需要支持更多的平台
     * 远程开发WebIDE版
-        - 客户端（开发机）：目前已支持X86、银河麒麟桌面操作系统。计划支持X86、ARM（飞腾）、LoongArch、银河麒麟桌面和服务器操作系统；X86、Windows10和Windows11操作系统。可根据需要支持更多的平台；注意，操作系统需安装浏览器
+        - 客户端（开发机）：目前已支持X86、ARM（飞腾）、LoongArch、银河麒麟桌面操作系统以及X86、Windows10和Windows11操作系统。可根据需要支持更多的平台；注意，操作系统需安装浏览器
         - 服务端（远程机）：与插件版共用一套服务端，支持的平台见上文
     * 建议内存：>= 8G
     * 建议剩余存储空间：>= 5G     

user-guide/files/远程开发.md

@@ -16,9 +16,9 @@
 - 远程开发插件版，提供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上安装VSCodium，然后安装Kylin Remote Development插件，远程开发银河麒麟操作系统上的软件
   * 无界面系统：银河麒麟服务器操作系统上未安装图形界面的情况，在银河麒麟桌面系统或Windows上安装Kylin-IDE或VSCodium，然后安装Kylin Remote Development插件，可以使用图形化的界面编辑、调试代码
-- 整体结构如下图所示。
+- 整体结构如下图所示。  
  ![图0-1](resources/kylin-remote-dev/remote-ext.png "架构")
 - 分为远程开发插件(Kylin Remote Development)和服务端(kylin-ide-server)
   * Kylin Remote Development

user-guide/files/远程开发WebIDE版.md

@@ -15,9 +15,9 @@
 - 远程开发WebIDE版，本文简称WebIDE，与一般意义的Web IDE概念不同，并不在云端提供一套统一的Web服务，而是结合了浏览器访问和SSH认证，服务端随用部署的一套软件。用法和Remote SSH插件类似，但不需要安装桌面版IDE软件。为用户提供跨机器、跨平台远程编辑、远程编译、远程运行、远程调试等功能
 - 用法举例
   * 跨机器、跨平台：在X86、银河麒麟桌面操作系统上安装客户端(kylin-ide-web-client)，远程开发飞腾或LoongArch机器上的应用
-  * 跨系统：在Windows上安装客户端，远程开发银河麒麟操作系统上的软件（Windows客户端正在开发中）
-  * 无界面系统：银河麒麟服务器操作系统上未安装图形界面的情况，在银河麒麟桌面系统或Windows上安装客户端，可以使用图形化的界面编辑、调试代码（Windows客户端正在开发中）
-- 整体结构如下图所示。
+  * 跨系统：在Windows上安装客户端，远程开发银河麒麟操作系统上的软件
+  * 无界面系统：银河麒麟服务器操作系统上未安装图形界面的情况，在银河麒麟桌面系统或Windows上安装客户端，可以使用图形化的界面编辑、调试代码
+- 整体结构如下图所示。  
  ![图0-1](resources/kylin-remote-dev/webide.png "webide架构")
 - 分为客户端(kylin-ide-web-client)和服务端(kylin-ide-server)
   * kylin-ide-web-client
@@ -49,16 +49,14 @@
     - 日志级别：日志优先级从高到底分为ERROR、WARN、INFO、DEBUG四个等级，客户端日志信息随着等级降低而更多。当鼠标放在日志开关上时会高亮，选中后会变成蓝色。
     - 主题设置：提供多种主题样式，用户可以根据喜好选择不同样式。
     - 关闭面板：用于设置客户端退出按钮的状态，默认点击窗口的关闭按钮时，客户端会最小化到任务栏；如果选择“退出程序”，则在点击窗口关闭按钮时客户端会退出。
-    - 版本信息：显示当前客户端版本
-    - 帮助文档连接：在右上角？为远程开发WebIDE使用手册链接，点击可打开链接。
+    - 版本信息：显示当前客户端版本  
     ![图4-1](resources/kylin-remote-dev/client_setpage.png "设置页面")
     
-    
 ### 5、远程资源管理
 
 - “远程资源管理器”提供了添加连接、连接配置信息修改、打开连接、删除连接、清理连接等功能：
-- 添加连接：
-  - 点击主页面右上角添加按钮，弹出添加连接页面
+- 添加连接：  
+  - 点击主页面右上角添加按钮，弹出添加连接页面  
   ![图5-1](resources/kylin-remote-dev/client_addconnect.png "连接添加")
   - 添加基本信息：在添加页面中，基本信息包括远程机器的IP地址、用户名、软件包安装方式（在线安装、离线安装、软件源安装）、浏览器选择（默认浏览器、指定浏览器）、认证方式等。
     安装方式是指如何在远程机器上安装远程服务包，包括在线安装、软件源安装、离线安装。
@@ -79,8 +77,9 @@
     
     1）在高级配置中，用户可以设置与远程机器ssh连接所使用的端口号port，以及本地访问远程机器所使用的端口号transport（用于通过https://localhost:transport来访问远程开发环境）。  
     2) 自动更新远程服务，默认打开时，会在打开连接时检查已部署的远程服务版本是否为最新版本，如果不是则自动更新为最新版本；如果关闭则对已经部署的服务端包不进行版本检查。  
-    ![图5-3](resources/kylin-remote-dev/client_addpage2.png "高级信息页")
-    
+    ![图5-3](resources/kylin-remote-dev/client_addpage2.png "高级信息页")  
+    3) X11转发功能：在远程服务上进行图形化开发时，如果需要将图形程序显示在本地，则需要打开该功能，具体请参考[开启X11转发](#9开启x11转发)
+
   - 合法性检查：在切换高级配置页面或点击确认按钮进行连接创建时，会进行用户名、IP、浏览器路径等信息的合法性检查，如果为空或者格式错误将进行提示
     ![图5-4](resources/kylin-remote-dev/client_addpagecheck.png "合法性检查")
 
@@ -88,9 +87,9 @@
     ![图5-5](resources/kylin-remote-dev/client_createsuccess.png "创建成功")
 
 - 修改配置    
-  - 将鼠标放在连接上，会在连接右侧显示四个快捷按钮，分别是打开连接、修改配置、删除连接、清理连接，点击第二个“修改配置”按钮将弹出修改页面
+  - 将鼠标放在连接上，会在连接右侧显示四个快捷按钮，分别是打开连接、修改配置、删除连接、清理连接，点击第二个“修改配置”按钮将弹出修改页面  
   ![图5-6](resources/kylin-remote-dev/client_edit.png "修改配置")
-  - 修改页面中除用户名和IP地址不可修改外，其他基本信息均可修改
+  - 修改页面中除用户名和IP地址不可修改外，其他基本信息均可修改  
   ![图5-7](resources/kylin-remote-dev/client_editpage.png "修改配置基础页")
    ![图5-8](resources/kylin-remote-dev/client_editpage2.png "修改配置高级页")
   
@@ -153,49 +152,63 @@
 
 
 ### 9、开启X11转发
-远程开发WebIDE版支持在Linux平台开启X11转发，进而支持GUI程序相关开发。X11转发功能开启需要服务端与客户端同时配置X11转发功能，如下：
-* 远程机sshd服务开启X11转发
-```shell
-#修改 X11Forwarding 配置项为 yes
-sudo vi /etc/ssh/sshd_config
-#重启sshd服务
-sudo systemctl restart ssh/sshd
-```
-* 客户端开启ssh转发
-    * 方法一：在客户端连接配置页中打开X11转发开关
-
-        ![9-1](resources/kylin-remote-dev/openx11.png "x11开关")
-    
-        - 在打开x11开关时，会弹窗提示是否断开当前正在使用的连接，点击“断开”后会将已打开的连接关闭，重新打开连接时才能生效。
-
-        ![9-2](resources/kylin-remote-dev/x11prompt.png "x11提示")
-
-        ![9-3](resources/kylin-remote-dev/x11prompt2.png "x11提示")
-
-        - 打开x11开关后，点击“修改远程连接”页面的确认按钮，提交修改。再次点击“打开连接”，此时x11功能即可生效。
-
-        ![图5-8](resources/kylin-remote-dev/client_editpage2.png "修改配置高级页")
-
-        - 如果点击“取消”，则不会修改x11开关状态。
-
-        - 在添加连接页面打开x11开关时，因为新增连接并没有打开连接，只提示服务端sshd配置方法。
-        
-        ![9-3](resources/kylin-remote-dev/addpage_x11open.png "x11提示")
-
-        - 当前用户的本地127.0.0.1连接无需设置x11功能
-
-
-    * 方法二：修改ssh配置文件
-
+  - linux平台  
+    远程开发WebIDE版支持在Linux平台开启X11转发，进而支持GUI程序相关开发。X11转发功能开启需要服务端与客户端同时配置X11转发功能，如下：
+    * 远程机sshd服务开启X11转发
     ```shell
-    #客户端ssh配置文件位于~/.ssh/config 如下：
-    Host 192.168.1.101
-      HostName 192.168.1.101
-      User test
-      ForwardX11 yes
-      ForwardX11Trusted yes
-
-    #添加ForwardX11 yes及ForwardX11Trusted yes
-    #若无对应IP Host项直接添加对应Host即可，其他ssh相关配置也可在此配置文件直接添加。
+    #修改 X11Forwarding 配置项为 yes
+    sudo vi /etc/ssh/sshd_config
+    #重启sshd服务
+    sudo systemctl restart ssh/sshd
     ```
-  
+  * 客户端开启ssh转发
+      * 方法一：在客户端连接配置页中打开X11转发开关
+
+          ![9-1](resources/kylin-remote-dev/openx11.png "x11开关")
+      
+          - 在打开x11开关时，会弹窗提示是否断开当前正在使用的连接，点击“断开”后会将已打开的连接关闭，重新打开连接时才能生效。
+
+          ![9-2](resources/kylin-remote-dev/x11prompt.png "x11提示")
+
+          ![9-3](resources/kylin-remote-dev/x11prompt2.png "x11提示")
+
+          - 打开x11开关后，点击“修改远程连接”页面的确认按钮，提交修改。再次点击“打开连接”，此时x11功能即可生效。
+
+          ![图5-8](resources/kylin-remote-dev/client_editpage2.png "修改配置高级页")
+
+          - 如果点击“取消”，则不会修改x11开关状态。
+
+          - 在添加连接页面打开x11开关时，因为新增连接并没有打开连接，只提示服务端sshd配置方法。
+          
+          ![9-3](resources/kylin-remote-dev/addpage_x11open.png "x11提示")
+
+          - 当前用户的本地127.0.0.1连接无需设置x11功能
+
+
+      * 方法二：修改ssh配置文件
+
+      ```shell
+      #客户端ssh配置文件位于~/.ssh/config 如下：
+      Host 192.168.1.101
+        HostName 192.168.1.101
+        User test
+        ForwardX11 yes
+        ForwardX11Trusted yes
+
+      #添加ForwardX11 yes及ForwardX11Trusted yes
+      #若无对应IP Host项直接添加对应Host即可，其他ssh相关配置也可在此配置文件直接添加。
+      ```
+  - windows平台  
+    windows系统作为客户端使用X11功能时，需要在windows中安装Xming软件，具体如下：  
+    - 点击修改页或添加页中“安装Xming”按钮，弹出Xming安装引导页面，根据引导完成安装
+    - 设置Xming.exe程序的安装路径，并点击确认（若不设置，在打开连接时无法启动Xming服务） 
+   
+      ![9-4](resources/kylin-remote-dev/windowsx11.png "x11提示")
+    -  远程机sshd服务开启X11转发
+      ```shell
+      #修改 X11Forwarding 配置项为 yes
+      sudo vi /etc/ssh/sshd_config
+      #重启sshd服务
+      sudo systemctl restart ssh/sshd
+      ```
+      注意：在使用过程中，在windows中会根据display变量信息启动一个或多个Xming服务 ![9-4](resources/kylin-remote-dev/xming.png "x11提示")，请在使用完成后手动关闭。