Skip to content

Commit 6a77311

Browse files
authored
Merge pull request #795 from jumpserver/pr@v4.0@perf_optimize_clients
perf: 优化客户端文档
2 parents 19a8443 + 99e8e2f commit 6a77311

10 files changed

Lines changed: 130 additions & 86 deletions
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Check Client Release
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: '0 21 * * *'
6+
jobs:
7+
check:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v4
11+
with:
12+
ref: v4.0
13+
14+
- name: Get Client Version
15+
run: |
16+
version=$(curl -s https://api.github.com/repos/jumpserver/client/releases/latest | jq -r .tag_name | sed 's/^v//')
17+
echo "Current Client Version: ${version}"
18+
if [ -z "${version}" ]; then
19+
exit 1
20+
fi
21+
echo "version=${version}" >> $GITHUB_ENV
22+
grep -q "client_tag: ${version}" mkdocs.yml || echo "update=true" >> $GITHUB_ENV
23+
24+
- name: Update Client Version
25+
if: env.update == 'true'
26+
run: |
27+
sed -i "s@client_tag: .*@client_tag: ${{ env.version }}@" mkdocs.yml
28+
git config --global user.name 'github-actions[bot]'
29+
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
30+
git add .
31+
git commit -m "Update Client Version to ${{ env.version }}"
32+
git push origin HEAD
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# 资产连接
2+
3+
!!! info "注: RDP 客户端连接、数据库客户端连接为 JumpServer 企业版功能。"
4+
5+
## Linux 资产连接
6+
7+
!!! tip ""
8+
- 客户端支持 SSH、SFTP、VNC 协议连接目标 Linux 资产,连接后可执行命令,上传下载文件。
9+
10+
!!! tip ""
11+
- 在 Linux 资产列表中,点击目标资产名称右侧的 **连接** ,弹出连接窗口。
12+
- 在连接窗口中,选择协议,选择需要使用的账号,点击 **确认** 按钮,即可连接资产。
13+
14+
![image](../../img/clientV4_03.png)
15+
16+
## Windows 资产连接
17+
18+
!!! tip ""
19+
- 客户端支持 RDP、VNC、SSH、SFTP 协议连接目标 Windows 资产,连接后可执行命令,上传下载文件。
20+
- 在 Windows 资产列表中,点击目标资产名称右侧的 **连接** ,弹出连接窗口。
21+
- 在连接窗口中,选择协议,选择需要使用的账号,点击 **确认** 按钮,即可连接资产。
22+
23+
## 数据库资产连接
24+
25+
### 本地客户端配置
26+
27+
!!! tip ""
28+
- 在使用客户端方式连接数据库之前,需要先配置本地客户端调用路径。
29+
- 点击右上角的设置按钮,进入设置页面。
30+
- 点击 **数据库** ,会展开支持连接的数据库列表,这里以 **MySQL** 为例。
31+
- 选中 **MySQL** 后,右侧会出现可连接的应用列表并提供下载方式,点击 **下载应用** 并安装。
32+
- 安装完成后,点击 **Select path** 配置其安装路径后,即可使用该应用进行数据库的连接。
33+
34+
![image](../../img/clientV4_04.png)
35+
36+
### 连接资产
37+
38+
!!! tip ""
39+
- 在 **数据库** 资产列表中,点击目标资产名称右侧的 **连接** ,即可自动调用客户端连接资产。
40+
41+
## 设备资产连接
42+
43+
!!! tip ""
44+
- 客户端支持 SSH 协议连接目标设备资产,设备资产默认包含 General、Cisco、Huawei、H3C。
45+
- 在 **设备** 资产列表中,点击目标资产名称右侧的 **连接** ,弹出连接窗口。
46+
- 在连接窗口中,选择协议,选择需要使用的账号,点击 **确认** 按钮,即可连接资产。
47+
48+
## 收藏资产连接
49+
50+
!!! tip ""
51+
- 在各类型资产的连接页面,可右键点击目标资产,然后点击 **收藏** ,即可将目标资产添加到收藏列表中。
52+
53+
![image](../../img/clientV4_05.png)
Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
11
# 客户端下载与安装
2+
23
## 简介
34

45
!!! tip ""
5-
本次 v4.10.13 LTS 版本推出的全新客户端,采用 Rust 生态的 Tauri 框架 重构,替代了此前的 Electron 框架,带来两大核心突破:
6-
7-
- 极致轻量化:安装包体积从 Electron 版本的约 150MB 缩减至仅 13MB,降低一个数量级,分发与安装效率显著提升;
8-
9-
- 体验原生化:优化界面布局与交互逻辑,完美适配 macOS 与 Windows 系统 UI 风格,操作流畅度及系统融合感大幅增强。
6+
JumpServer 客户端是一款跨平台的桌面应用程序,支持 Windows、macOS 和 Linux 系统。用户可以使用客户端本地连接和管理 JumpServer 纳管的远程资产(Windows、Linux、数据库以及网络设备)。
107

11-
## 下载
12-
### Windows
13-
- [Windows](https://github.com/jumpserver/client/releases/download/v4.0.0/JumpServerClient_4.0.0_x64-setup.exe)
8+
!!! warning "注:新版客户端(>=v4.0.0)仅支持 JumpServer 版本 **v4.10.13 及以上**,请确保服务端版本满足要求。"
9+
1410

15-
### MAC
16-
- [MAC](https://github.com/jumpserver/client/releases/download/v4.0.0/JumpServerClient_4.0.0_aarch64.dmg)
11+
## 客户端下载
1712

18-
### Linux (如 Ubuntu)
19-
- [Linux](https://github.com/jumpserver/client/releases/download/v4.0.0/JumpServerClient_4.0.0_amd64.deb)
13+
各平台安装包
2014

21-
其他系统请自行进入JumpServer 官方 GitHub 仓库下载对应版本
22-
仓库访问地址
23-
- [https://github.com/jumpserver/client/releases](https://github.com/jumpserver/client/releases)
15+
| 操作系统 | 架构 | 下载链接 |
16+
|---------|------|---------|
17+
| Windows | x64 | [JumpServerClient_{{ jumpserver.client_tag }}_x64-setup.exe](https://github.com/jumpserver/client/releases/download/v{{ jumpserver.client_tag }}/JumpServerClient_{{ jumpserver.client_tag }}_x64-setup.exe) |
18+
| macOS | Apple Silicon (M1/M2) | [JumpServerClient_{{ jumpserver.client_tag }}_aarch64.dmg](https://github.com/jumpserver/client/releases/download/v{{ jumpserver.client_tag }}/JumpServerClient_{{ jumpserver.client_tag }}_aarch64.dmg) |
19+
| macOS | Intel (x64) | [JumpServerClient_{{ jumpserver.client_tag }}_x64.dmg](https://github.com/jumpserver/client/releases/download/v{{ jumpserver.client_tag }}/JumpServerClient_{{ jumpserver.client_tag }}_x64.dmg) |
20+
| Linux | amd64 (Ubuntu/Debian) | [JumpServerClient_{{ jumpserver.client_tag }}_amd64.deb](https://github.com/jumpserver/client/releases/download/v{{ jumpserver.client_tag }}/JumpServerClient_{{ jumpserver.client_tag }}_amd64.deb) |
2421

25-
!!! warning "注意"
26-
新版客户端仅支持 Jumpserver 版本 v4.10.13 及以上版本,请确保 Jumpserver 版本在 v4.10.13 及以上。
22+
> 用户可以访问 '<JumpServer 服务端地址>/core/download/' 页面下载对应平台的客户端安装包,企业版服务端支持内网环境下载。
2723
28-
![image](../../img/clientV4_01.png)
24+
## 客户端界面预览
2925

30-
![image](../../img/clientV4_02.png)
26+
![客户端登录界面](../../img/clientV4_01.png)
Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,66 @@
11
# 连接设置
2-
点击客户端右上角的设置按钮,可以打开连接设置页面
2+
3+
!!! tip ""
4+
- 点击客户端右上角的设置按钮,可以打开连接设置页面。
35

46
## 通用
57

6-
- 该页面可以调整客户端的 **语言****字符集****字符终端设置****分辨率**
8+
!!! tip ""
9+
- 该页面可以调整客户端的 **语言****字符集****字符终端设置****分辨率**
710

811
![image](../../img/clientV4_10.png)
912

1013
## 外观
1114

12-
- 该页面可调整客户端的 **外观颜色****主色****字体**
15+
!!! tip ""
16+
- 该页面可调整客户端的 **外观颜色****主色****字体**
1317

1418
![image](../../img/clientV4_11.png)
1519

1620
## 应用配置
21+
1722
### 命令行终端
1823

1924
**SSH**
2025

21-
该页面可以调整通过 SSH 协议连接资产的本地应用配置
26+
!!! tip ""
27+
- 该页面可以调整通过 SSH 协议连接资产的本地应用配置。
2228

2329
![image](../../img/clientV4_06.png)
2430

2531
**Telnet**
2632

27-
该页面可以调整通过 Telnet 协议测试端口连接的本地应用配置,具体页面与 SSH 类似
33+
!!! tip ""
34+
- 该页面可以调整通过 Telnet 协议测试端口连接的本地应用配置,具体页面与 SSH 类似。
2835

2936
### 文件传输
37+
3038
**SFTP**
31-
该页面可以调整通过 SFTP 协议传输文件的本地应用配置
39+
40+
!!! tip ""
41+
- 该页面可以调整通过 SFTP 协议传输文件的本地应用配置。
3242

3343
![image](../../img/clientV4_07.png)
3444

3545
### 远程桌面
46+
3647
**RDP**
3748

38-
该页面可以调整通过 RDP 协议连接资产的本地应用配置
49+
!!! tip ""
50+
- 该页面可以调整通过 RDP 协议连接资产的本地应用配置。
51+
- Windows 用户默认为本地 MSTSC 应用,Mac 用户默认为 Microsoft Remote Desktop 应用,需要在系统定义 rdp 文件的打开方式。Linux 用户需要自行安装配置 Remmina 或者 XFreeRDP。
3952

4053
![image](../../img/clientV4_08.png)
4154

4255
**VNC**
4356

44-
该页面可以调整通过 VNC 协议连接资产的本地应用配置, 具体页面与 RDP 类似
57+
!!! tip ""
58+
- 该页面可以调整通过 VNC 协议连接资产的本地应用配置,具体页面与 RDP 类似。
4559

4660
### 数据库
4761

48-
该页面可以调整连接数据库资产的本地应用配置, 支持 MySQL, MariaDB, MongoDB, Redis, PostgreSQL, Oracle, SQL Server数据库
62+
!!! tip ""
63+
- 该页面可以调整连接数据库资产的本地应用配置,支持 MySQL、MariaDB、MongoDB、Redis、PostgreSQL、Oracle、SQL Server 数据库。
4964

5065
![image](../../img/clientV4_09.png)
5166

docs/manual/client/database_asset_connection.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/manual/client/device_asset_connection.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/manual/client/favorite_asset_connection.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/manual/client/linux_asset_connection.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/manual/client/windows_asset_connection.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

mkdocs.yml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -178,15 +178,12 @@ nav:
178178
- 文件传输: manual/admin/workbench/my_assets/file_transfer.md
179179
- 文件管理: manual/admin/workbench/my_assets/file_explorer.md
180180
- 工单: manual/user/ticket.md
181+
- 客户端使用:
182+
- 客户端下载与安装: manual/client/client_installation.md
183+
- 资产连接: manual/client/asset_connection.md
184+
- 连接设置: manual/client/connection_settings.md
185+
181186

182-
- 客户端手册:
183-
- 客户端下载与安装: manual/client/client_installation.md
184-
- Linux 资产连接: manual/client/linux_asset_connection.md
185-
- Windows 资产连接: manual/client/windows_asset_connection.md
186-
- 数据库资产连接: manual/client/database_asset_connection.md
187-
- 设备资产连接: manual/client/device_asset_connection.md
188-
- 收藏资产连接: manual/client/favorite_asset_connection.md
189-
- 连接设置: manual/client/connection_settings.md
190187

191188
- 常见问题:
192189
- 产品 FAQ: faq/faq.md
@@ -245,6 +242,7 @@ markdown_extensions:
245242
extra:
246243
jumpserver:
247244
tag: v4.10.14
245+
client_tag: 4.1.1
248246
search:
249247
separator: '[\s\-\.]+'
250248
language: 'zh'

0 commit comments

Comments
 (0)