diff --git a/.github/workflows/check-client-version.yml b/.github/workflows/check-client-version.yml new file mode 100644 index 00000000..89129709 --- /dev/null +++ b/.github/workflows/check-client-version.yml @@ -0,0 +1,32 @@ +name: Check Client Release +on: + workflow_dispatch: + schedule: + - cron: '0 21 * * *' +jobs: + check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + ref: v4.0 + + - name: Get Client Version + run: | + version=$(curl -s https://api.github.com/repos/jumpserver/client/releases/latest | jq -r .tag_name | sed 's/^v//') + echo "Current Client Version: ${version}" + if [ -z "${version}" ]; then + exit 1 + fi + echo "version=${version}" >> $GITHUB_ENV + grep -q "client_tag: ${version}" mkdocs.yml || echo "update=true" >> $GITHUB_ENV + + - name: Update Client Version + if: env.update == 'true' + run: | + sed -i "s@client_tag: .*@client_tag: ${{ env.version }}@" mkdocs.yml + git config --global user.name 'github-actions[bot]' + git config --global user.email 'github-actions[bot]@users.noreply.github.com' + git add . + git commit -m "Update Client Version to ${{ env.version }}" + git push origin HEAD diff --git a/docs/manual/client/asset_connection.md b/docs/manual/client/asset_connection.md new file mode 100644 index 00000000..fac56925 --- /dev/null +++ b/docs/manual/client/asset_connection.md @@ -0,0 +1,53 @@ +# 资产连接 + +!!! info "注: RDP 客户端连接、数据库客户端连接为 JumpServer 企业版功能。" + +## Linux 资产连接 + +!!! tip "" + - 客户端支持 SSH、SFTP、VNC 协议连接目标 Linux 资产，连接后可执行命令，上传下载文件。 + +!!! tip "" + - 在 Linux 资产列表中，点击目标资产名称右侧的 **连接** ，弹出连接窗口。 + - 在连接窗口中，选择协议，选择需要使用的账号，点击 **确认** 按钮，即可连接资产。 + +![image](../../img/clientV4_03.png) + +## Windows 资产连接 + +!!! tip "" + - 客户端支持 RDP、VNC、SSH、SFTP 协议连接目标 Windows 资产，连接后可执行命令，上传下载文件。 + - 在 Windows 资产列表中，点击目标资产名称右侧的 **连接** ，弹出连接窗口。 + - 在连接窗口中，选择协议，选择需要使用的账号，点击 **确认** 按钮，即可连接资产。 + +## 数据库资产连接 + +### 本地客户端配置 + +!!! tip "" + - 在使用客户端方式连接数据库之前，需要先配置本地客户端调用路径。 + - 点击右上角的设置按钮，进入设置页面。 + - 点击 **数据库** ，会展开支持连接的数据库列表，这里以 **MySQL** 为例。 + - 选中 **MySQL** 后，右侧会出现可连接的应用列表并提供下载方式，点击 **下载应用** 并安装。 + - 安装完成后，点击 **Select path** 配置其安装路径后，即可使用该应用进行数据库的连接。 + +![image](../../img/clientV4_04.png) + +### 连接资产 + +!!! tip "" + - 在 **数据库** 资产列表中，点击目标资产名称右侧的 **连接** ，即可自动调用客户端连接资产。 + +## 设备资产连接 + +!!! tip "" + - 客户端支持 SSH 协议连接目标设备资产，设备资产默认包含 General、Cisco、Huawei、H3C。 + - 在 **设备** 资产列表中，点击目标资产名称右侧的 **连接** ，弹出连接窗口。 + - 在连接窗口中，选择协议，选择需要使用的账号，点击 **确认** 按钮，即可连接资产。 + +## 收藏资产连接 + +!!! tip "" + - 在各类型资产的连接页面，可右键点击目标资产，然后点击 **收藏** ，即可将目标资产添加到收藏列表中。 + +![image](../../img/clientV4_05.png) diff --git a/docs/manual/client/client_installation.md b/docs/manual/client/client_installation.md index 99a42976..ccfa540e 100644 --- a/docs/manual/client/client_installation.md +++ b/docs/manual/client/client_installation.md @@ -1,30 +1,26 @@ # 客户端下载与安装 + ## 简介 !!! tip "" - 本次 v4.10.13 LTS 版本推出的全新客户端，采用 Rust 生态的 Tauri 框架 重构，替代了此前的 Electron 框架，带来两大核心突破： - - - 极致轻量化：安装包体积从 Electron 版本的约 150MB 缩减至仅 13MB，降低一个数量级，分发与安装效率显著提升； - - - 体验原生化：优化界面布局与交互逻辑，完美适配 macOS 与 Windows 系统 UI 风格，操作流畅度及系统融合感大幅增强。 + JumpServer 客户端是一款跨平台的桌面应用程序，支持 Windows、macOS 和 Linux 系统。用户可以使用客户端本地连接和管理 JumpServer 纳管的远程资产（Windows、Linux、数据库以及网络设备）。 -## 下载 -### Windows -- [Windows](https://github.com/jumpserver/client/releases/download/v4.0.0/JumpServerClient_4.0.0_x64-setup.exe) +!!! warning "注：新版客户端（>=v4.0.0）仅支持 JumpServer 版本 **v4.10.13 及以上**，请确保服务端版本满足要求。" + -### MAC -- [MAC](https://github.com/jumpserver/client/releases/download/v4.0.0/JumpServerClient_4.0.0_aarch64.dmg) +## 客户端下载 -### Linux (如 Ubuntu) -- [Linux](https://github.com/jumpserver/client/releases/download/v4.0.0/JumpServerClient_4.0.0_amd64.deb) +各平台安装包 -其他系统请自行进入JumpServer 官方 GitHub 仓库下载对应版本 -仓库访问地址 -- [https://github.com/jumpserver/client/releases](https://github.com/jumpserver/client/releases) +| 操作系统 | 架构 | 下载链接 | +|---------|------|---------| +| 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) | +| 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) | +| 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) | +| 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) | -!!! warning "注意" - 新版客户端仅支持 Jumpserver 版本 v4.10.13 及以上版本，请确保 Jumpserver 版本在 v4.10.13 及以上。 +> 用户可以访问 '/core/download/' 页面下载对应平台的客户端安装包，企业版服务端支持内网环境下载。 -![image](../../img/clientV4_01.png) +## 客户端界面预览 -![image](../../img/clientV4_02.png) \ No newline at end of file +![客户端登录界面](../../img/clientV4_01.png) \ No newline at end of file diff --git a/docs/manual/client/connection_settings.md b/docs/manual/client/connection_settings.md index b7e62fbd..2f72ebfc 100644 --- a/docs/manual/client/connection_settings.md +++ b/docs/manual/client/connection_settings.md @@ -1,51 +1,66 @@ # 连接设置 -点击客户端右上角的设置按钮，可以打开连接设置页面 + +!!! tip "" + - 点击客户端右上角的设置按钮，可以打开连接设置页面。 ## 通用 -- 该页面可以调整客户端的 **语言** ， **字符集** ， **字符终端设置** ， **分辨率** +!!! tip "" + - 该页面可以调整客户端的 **语言**、**字符集**、**字符终端设置**、**分辨率**。 ![image](../../img/clientV4_10.png) ## 外观 -- 该页面可调整客户端的 **外观颜色** ， **主色** ， **字体** +!!! tip "" + - 该页面可调整客户端的 **外观颜色**、**主色**、**字体**。 ![image](../../img/clientV4_11.png) ## 应用配置 + ### 命令行终端 **SSH** -该页面可以调整通过 SSH 协议连接资产的本地应用配置 +!!! tip "" + - 该页面可以调整通过 SSH 协议连接资产的本地应用配置。 ![image](../../img/clientV4_06.png) **Telnet** -该页面可以调整通过 Telnet 协议测试端口连接的本地应用配置，具体页面与 SSH 类似 +!!! tip "" + - 该页面可以调整通过 Telnet 协议测试端口连接的本地应用配置，具体页面与 SSH 类似。 ### 文件传输 + **SFTP** -该页面可以调整通过 SFTP 协议传输文件的本地应用配置 + +!!! tip "" + - 该页面可以调整通过 SFTP 协议传输文件的本地应用配置。 ![image](../../img/clientV4_07.png) ### 远程桌面 + **RDP** -该页面可以调整通过 RDP 协议连接资产的本地应用配置 +!!! tip "" + - 该页面可以调整通过 RDP 协议连接资产的本地应用配置。 + - Windows 用户默认为本地 MSTSC 应用，Mac 用户默认为 Microsoft Remote Desktop 应用，需要在系统定义 rdp 文件的打开方式。Linux 用户需要自行安装配置 Remmina 或者 XFreeRDP。 ![image](../../img/clientV4_08.png) **VNC** -该页面可以调整通过 VNC 协议连接资产的本地应用配置, 具体页面与 RDP 类似 +!!! tip "" + - 该页面可以调整通过 VNC 协议连接资产的本地应用配置，具体页面与 RDP 类似。 ### 数据库 -该页面可以调整连接数据库资产的本地应用配置， 支持 MySQL, MariaDB, MongoDB, Redis, PostgreSQL, Oracle, SQL Server数据库 +!!! tip "" + - 该页面可以调整连接数据库资产的本地应用配置，支持 MySQL、MariaDB、MongoDB、Redis、PostgreSQL、Oracle、SQL Server 数据库。 ![image](../../img/clientV4_09.png) diff --git a/docs/manual/client/database_asset_connection.md b/docs/manual/client/database_asset_connection.md deleted file mode 100644 index f16cb86d..00000000 --- a/docs/manual/client/database_asset_connection.md +++ /dev/null @@ -1,15 +0,0 @@ -# 数据库资产连接 - -## 本地客户端配置 -在使用客户端方式连接数据库之前，需要先配置本地客户端调用路径，配置方式如下： - -1. 点击右上角的设置按钮，进入设置页面 -2. 点击 **数据库** ， 会展开支持连接的数据库列表，这里我们以 **MySQL** 为例 -3. 选中 **MySQL** 后， 右侧会出现可连接的应用列表并提供下载方式， 点击 **下载应用** 并安装 -4. 安装完成后，点击 **Select path** 配置其安装路径后， 即可使用该应用进行数据库的连接 - -![image](../../img/clientV4_04.png) - -## 连接资产 - -- 在 **数据库** 资产列表中，点击目标资产名称右侧的 **连接** ，即可自动调用客户端连接资产。 diff --git a/docs/manual/client/device_asset_connection.md b/docs/manual/client/device_asset_connection.md deleted file mode 100644 index dc967406..00000000 --- a/docs/manual/client/device_asset_connection.md +++ /dev/null @@ -1,8 +0,0 @@ -# 设备资产连接 - -客户端支持 ssh 协议连接目标设备资产，设备资产默认包含 General、Cisco、Huawei、H3C - -## 连接资产 - -1. 在 **设备** 资产列表中，点击目标资产名称右侧的 **连接** ，弹出连接窗口 -2. 在连接窗口中，选择协议，选择需要使用的账号，点击 **确认** 按钮，即可连接资产 \ No newline at end of file diff --git a/docs/manual/client/favorite_asset_connection.md b/docs/manual/client/favorite_asset_connection.md deleted file mode 100644 index 4491d641..00000000 --- a/docs/manual/client/favorite_asset_connection.md +++ /dev/null @@ -1,6 +0,0 @@ -# 收藏资产连接 - -该页面可以查看用户所收藏的资产列表。 -- 在各类型资产的连接页面， 可右键点击目标资产， 然后点击 **收藏**， 即可将目标资产添加到收藏列表中。 - -![image](../../img/clientV4_05.png) \ No newline at end of file diff --git a/docs/manual/client/linux_asset_connection.md b/docs/manual/client/linux_asset_connection.md deleted file mode 100644 index 1534eb9b..00000000 --- a/docs/manual/client/linux_asset_connection.md +++ /dev/null @@ -1,12 +0,0 @@ -# Linux 资产连接 - -客户端支持 ssh, sftp, vnc 协议连接目标 Linux 资产，连接后可执行命令，上传下载文件。 - -## 连接资产 - -1. 在 Linux 资产列表中，点击目标资产名称右侧的 **连接** ，弹出连接窗口。 -2. 在连接窗口中，选择协议，选择需要使用的账号，点击 **确认** 按钮，即可连接资产。 - -资产连接成功效果图如下: - -![image](../../img/clientV4_03.png) \ No newline at end of file diff --git a/docs/manual/client/windows_asset_connection.md b/docs/manual/client/windows_asset_connection.md deleted file mode 100644 index 57ceef01..00000000 --- a/docs/manual/client/windows_asset_connection.md +++ /dev/null @@ -1,9 +0,0 @@ -# Windows 资产连接 - -客户端支持 rdp, vnc, ssh, sftp 协议连接目标 Windows 资产，连接后可执行命令，上传下载文件。 - -## 连接资产 - -1. 在 Windows 资产列表中，点击目标资产名称右侧的 **连接** ，弹出连接窗口。 -2. 在连接窗口中，选择协议，选择需要使用的账号，点击 **确认** 按钮，即可连接资产。 - diff --git a/mkdocs.yml b/mkdocs.yml index 5d5e2ad0..e4f9d227 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -178,15 +178,12 @@ nav: - 文件传输: manual/admin/workbench/my_assets/file_transfer.md - 文件管理: manual/admin/workbench/my_assets/file_explorer.md - 工单: manual/user/ticket.md + - 客户端使用: + - 客户端下载与安装: manual/client/client_installation.md + - 资产连接: manual/client/asset_connection.md + - 连接设置: manual/client/connection_settings.md + - - 客户端手册: - - 客户端下载与安装: manual/client/client_installation.md - - Linux 资产连接: manual/client/linux_asset_connection.md - - Windows 资产连接: manual/client/windows_asset_connection.md - - 数据库资产连接: manual/client/database_asset_connection.md - - 设备资产连接: manual/client/device_asset_connection.md - - 收藏资产连接: manual/client/favorite_asset_connection.md - - 连接设置: manual/client/connection_settings.md - 常见问题: - 产品 FAQ: faq/faq.md @@ -245,6 +242,7 @@ markdown_extensions: extra: jumpserver: tag: v4.10.14 + client_tag: 4.1.1 search: separator: '[\s\-\.]+' language: 'zh'