远程开发手册添加目录

This commit is contained in:
lijinwen 2023-07-19 14:33:38 +08:00
parent e5753cb9b5
commit 81f2c00bcb
1 changed files with 27 additions and 13 deletions

View File

@ -1,10 +1,24 @@
# Linux远程开发插件安装使用说明$\hookrightarrow$[Windows远程开发使用说明](#windows远程开发使用说明)
## 1、准备工作
# 远程开发功能使用说明
## 功能概述
远程开发功能支持通过linux或windows客户端连接到远程机上进行代码开发功能目前支持x86_64、loongarch64、aarch64三种架构。为用户提供远程编辑、远程编译、远程运行、远程调试等功能linux和windows客户端上使用方法有所不同具体使用方法如下
- [Linux远程开发插件安装使用说明](#linux远程开发插件安装使用说明)
- [准备工作](#1准备工作)
- [插件安装](#2插件安装)
- [远程资源管理](#3远程资源管理)
- [连接管理](#4连接管理)
- [项目管理、多语言开发、调试功能使用](#5项目管理多语言开发调试功能使用)
- [远程开发环境卸载](#6远程开发环境卸载)
- [例子](#7例子)
- [浏览器导入证书方法](#8浏览器导入证书方法)
- [Windows远程开发使用说明](#windows远程开发使用说明)
- [环境部署](#1环境部署)
- [脚本执行](#2脚本执行)
## Linux远程开发插件安装使用说明
### 1、准备工作
- 获取远程Linux主机的SSH用户和密码查看远程主机的架构是否属于x86_64、loongarch64、aarch64的其中一种目前远程开发支持以上三种架构
- 检查“远程机”的sshd服务是否正常“/etc/ssh/sshd_config”中 “AllowTcpForwarding”和“PermitTunnel”为yes如果“AllowTcpForwarding”和“PermitTunnel”为no请修改配置并重启sshd服务
- 检查在客户机是否能够通过ssh连接到远程机
## 2、插件安装
### 2、插件安装
- 从插件商店搜索`Kylin remote development`远程开发插件并安装
![图2-1](resources/kylin-remote-dev/remote-dev-install-from-open.png "通过插件商店安装插件")
@ -17,7 +31,7 @@
如: 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客户机端并非远程主机端)。
## 3、远程资源管理
### 3、远程资源管理
- 在“远程资源管理器”中提供了查看设置、新建连接、刷新等功能:
- 查看设置:提供配置文件查看功能,点击后将在编辑区打开配置文件。
@ -27,7 +41,7 @@
![图3-1](resources/kylin-remote-dev/remote-addconnect.gif "连接添加")
## 4、连接管理
### 4、连接管理
- 新窗口打开:
- 点击连接右边的“新窗口打开”图标
- 在弹出输入框中,输入远程开发环境密码,将在新的窗口中打开远程开发环境(该密码为此连接在新建连接时输入的用户名对应的密码,用户名和密码是远程服务端真实存在的用户和登录密码)
@ -47,7 +61,7 @@
- 重命名连接名默认显示ip地址点击“重命名”可以对当前连接进行命名方便用户记忆。
## 5、项目管理、多语言开发、调试功能使用
### 5、项目管理、多语言开发、调试功能使用
- 通过远程开发插件打开远程开发环境后其使用方法和Kylin-IDE编辑器类似。
- 插件安装
- 打开远程开发环境后可通过窗口上方标题显示的ip来区分所连接的远程环境与本地环境。
@ -61,7 +75,7 @@
- 多语言开发
- 提供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 目录
@ -72,7 +86,7 @@
- 注意:卸载操作旨在彻底清除环境中远程开发相关数据,可以用于版本升级或重装等操作,无需在每次使用完后进行卸载操作
## 7、例子
### 7、例子
- 假设A主机的用户“user1”想远程到B主机“test”用户进行远程开发则A主机即为客户端B主机即为服务端
- 使用远程开发的准备工作:
- 登录A主机的“user”用户启动Kylin-IDE并安装将远程插件
@ -89,7 +103,7 @@
- 客户端卸载
- 卸载Kylin-IDE中的远程开发插件并删除A主机用户“user1”目录下的.kylin-ide-remote目录
## 8、浏览器导入证书方法
### 8、浏览器导入证书方法
- 证书导入原因
- 通过浏览器方式打开远程开发环境时WebView有时无法加载
@ -168,8 +182,8 @@
![8-17](resources/kylin-remote-dev/3603.png "Chrome导入证书")
# Windows远程开发使用说明
## 1、环境部署
## Windows远程开发使用说明
### 1、环境部署
- 获取远程Linux主机的SSH用户和密码查看远程主机的架构是否属于x86_64、loongarch64、aarch64的其中一种目前远程开发支持以上三种架构
- 检查“远程机”的sshd服务是否正常“/etc/ssh/sshd_config”中 “AllowTcpForwarding”和“PermitTunnel”为yes如果“AllowTcpForwarding”和“PermitTunnel”为no请修改配置并重启sshd服务
- 检查在客户机是否能够通过ssh连接到远程机
@ -182,7 +196,7 @@
- 为kylin-ide-server-build.sh脚本设置`可执行权限`。
- 将kylin-remote-start.exe脚本放在windows客户端目录下
## 2、脚本执行
### 2、脚本执行
- kylin-remote-start.bat脚本执行
- 将脚本放在windows客户端上后通过cmd启动windows命令终端进入脚本所在目录执行该脚本,格式如下: