# rustdesk-api-web

**Repository Path**: yanjingtu/rustdesk-api-web

## Basic Information

- **Project Name**: rustdesk-api-web
- **Description**: No description available
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-11
- **Last Updated**: 2026-08-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RustDesk API Web

基于 Vue3 + Element Plus 的后台管理页面，适用于私有化部署 [RustDesk API](https://github.com/lejianwen/rustdesk-api)（[lejianwen/rustdesk-api](https://github.com/lejianwen/rustdesk-api)）时使用，用于完善原版管理后台不足、补充私有化场景下需要的运维与管理功能。

<a href="https://github.com/vuejs/vue-next">
    <img src="https://img.shields.io/badge/vue-^3.2.16-brightgreen.svg" alt="vue3">
  </a>
  <a href="https://github.com/element-plus/element-plus">
    <img src="https://img.shields.io/badge/element--plus-^2.8.2-brightgreen.svg" alt="element-plus">
  </a>
  <a href="https://github.com/lejianwen/Gwen-admin/blob/master/LICENSE">
    <img src="https://img.shields.io/github/license/mashape/apistatus.svg" alt="license">
  </a>

# 功能列表

## 账户与认证
- **登录 / 注册**：用户账号登录与自助注册（可配置是否开放注册）。
- **OAuth 登录与绑定**：支持第三方 OAuth 登录，以及将 OAuth 账号与本地账号绑定/解绑。

## 个人中心（My）
- **用户信息**：查看与修改个人资料、修改密码。
- **我的设备**：管理自己名下的客户端设备（别名、标签等）。
- **我的地址簿**：个人地址簿分类与联系人管理。
- **我的标签**：个人设备标签管理。
- **分享记录**：查看设备/地址簿的分享记录。
- **登录日志**：查看本人的登录历史。

## 概览首页（Dashboard）
- 登录后默认进入的概览页，对所有登录用户可见。
- 以卡片形式展示关键指标：用户总数、设备总数、在线设备数、连接日志数、文件传输数、标签数、地址簿数、分享记录数、用户组数、设备组数、登录日志数。
- 卡片可点击跳转到对应管理页；并提供常用模块的快捷入口。
- 数据来源于各列表接口的 `total` 统计（在线设备通过 `time_ago=-60` 取近 60 秒在线数），单个统计请求失败不影响其他卡片展示。

## 系统管理（管理员）
- **用户管理**：用户的增删改查、启用/禁用、分配用户组。
- **用户组管理**：用户分组（用于权限/资源划分）。
- **设备分组管理**：对客户端设备进行分组管理。
- **设备管理（Peer）**：查看与管理所有客户端设备。
- **地址簿管理**：系统级地址簿分类与地址簿管理。
- **标签管理**：系统级标签管理。
- **用户令牌（Token）**：管理系统内用户的访问令牌，支持签发与吊销。
- **OAuth 管理**：配置第三方 OAuth 应用（client id/secret 等）。
- **登录日志**：全量用户登录日志审计。

## 审计日志
- **连接审计日志**：记录客户端连接/控制行为。
- **文件传输审计日志**：记录文件传输行为，便于合规审计。

## 服务器命令（RustDesk 控制）
- 向 ID Server / Relay Server 下发管理命令，包括：
  - 强制中继（always use relay）
  - 强制登录（must login）
  - 用量统计（usage）
  - 黑名单 / 阻止列表（blocklist / blacklist）
  - 自定义命令的保存、发送与执行。

# 建议补充的常用功能

下面是在私有化部署场景下常被需要、目前尚未在页面中实现的功能，可作为后续迭代方向：

- **角色与细粒度权限（RBAC）**：在「用户组」之上引入角色，对菜单/接口做权限控制，区分管理员、普通用户、只读审计员等。
- **系统配置中心**：在后台直接配置 ID Server / Relay Server 地址、许可证、默认强制中继等全局参数，避免改配置文件。
- **设备配额 / 限制**：按用户或用户组限制可绑定设备数量、并发连接数等。
- **设备批量操作**：批量重启、批量下线、批量打标签、批量 Wake-on-LAN / 关机、远程执行命令。
- **设备在线状态与心跳监控**：实时在线/离线状态、最后在线时间、异常离线告警。
- **操作审计日志**：除连接/文件外，记录后台管理员的配置操作（谁在何时改了什么）。
- **双因素认证（2FA）**：登录时 TOTP / 短信 / 邮箱验证码，提升账号安全。
- **找回密码 / 邮件通知**：注册验证、密码重置、异常登录提醒等邮件/消息能力。
- **公告 / 系统通知**：向所有用户或指定用户组推送公告。
- **数据导出**：用户、设备、审计日志等列表支持 CSV / Excel 导出。
- **自定义客户端配置下发**：把自建中继、策略等配置直接推送给客户端，简化部署。
- **暗黑模式 / 主题切换**：界面主题个性化。
- **Web 客户端直达**：在浏览器内直接发起远程控制会话（WebRTC）。

# 安装步骤

```shell
git clone https://github.com/lejianwen/rustdesk-api-web
cd rustdesk-api-web   
npm install

// 本地开发
npm run dev

// 打包
npm run build

```

# 说明
- 本项目为前端后台，需配合后端 [RustDesk API](https://github.com/lejianwen/rustdesk-api) 一起使用。
- 服务器命令相关功能详见 [RustDesk Command WIKI](https://github.com/lejianwen/rustdesk-api/wiki/Rustdesk-Command)。