kingmo888/rustdesk-api-server

rustdesk-api-server

一个Python实现的Rustdesk API接口，支持WebUI管理，基于Django框架开发，兼容多平台和多种Docker架构。

!版本 !Python !Django !平台 !Docker

版本区别说明

请使用自定义key，因不填写key或使用服务端自动生成的key而引起的链接超时或建立链接时间过长的问题，不在本项目解决范围内。

rustdesk官方在其新版服务端中已强制要求key（rustdesk-server版本号≥1.1.10）

• rustdesk版本≤1.2.3：服务端需配合使用rustdesk-server≤1.1.10，可根据需要选择是否配置服务端key参数。

• rustdesk版本>1.2.3：服务端需配合使用rustdesk-server≥1.1.11

  • 使用rustdesk-server自动生成的key时，可能出现链接缓慢甚至超时。
  • 解决办法：配置rustdesk-server时传入k参数自定义key值，客户端同步配置相同key即可秒连。

  rustdesk-server的docker-compose配置参考：

  !https://github.com/kingmo888/rustdesk-api-server/raw/master/images/compose_demo.png

key用于防止他人获知中继服务器IP后滥用中继服务。若不配置key，需做好中继IP保密工作。服务端配置密钥（随机生成或自定义）后，未配置对应key的控制客户端无法控制其他机器（被控机器可不填key）。

验证自定义key是否生效，可查看rustdesk server中hbbs的日志：

!https://github.com/kingmo888/rustdesk-api-server/raw/master/images/key_activate.png

功能特点

界面展示

!https://github.com/kingmo888/rustdesk-api-server/raw/master/images/front_main.png

核心功能

• 用户管理：支持前台网页自主注册和登录

  • 注册页与登录页： !https://github.com/kingmo888/rustdesk-api-server/raw/master/images/front_reg.png !https://github.com/kingmo888/rustdesk-api-server/raw/master/images/front_login.png

• 设备管理：支持前台展示设备信息，分管理员版和用户版

• 自定义别名：支持为设备设置备注名称

• 后台管理：提供管理员后台操作界面

• 彩色标签：支持为设备添加彩色标签分类 !https://github.com/kingmo888/rustdesk-api-server/raw/master/images/rust_books.png

• 在线统计：支持设备在线状态统计

• 密码保存：支持保存设备访问密码

• 心跳保活：利用心跳接口自动管理token并保活

• 设备分享：支持将设备分享给其他用户 !https://github.com/kingmo888/rustdesk-api-server/raw/master/images/share.png

• Web控制端：集成Web控制功能（目前仅支持非SSL模式） !https://github.com/kingmo888/rustdesk-api-server/raw/master/images/webui.png

后台主页： !https://github.com/kingmo888/rustdesk-api-server/raw/master/images/admin_main.png

安装方法

方法1：开箱即用（Windows）

仅支持Windows系统，前往release下载后无需安装环境，直接运行启动.bat即可。

!https://github.com/kingmo888/rustdesk-api-server/raw/master//images/windows_run.png

方法2：代码运行

bash
# 克隆代码到本地
git clone https://github.com/kingmo888/rustdesk-api-server.git
# 进入目录
cd rustdesk-api-server
# 安装依赖
pip install -r requirements.txt
# 启动服务（端口可自定义，建议保留21114为默认端口）
python manage.py runserver 0.0.0.0:21114

访问方式：http://本机IP:端口

注意：CentOS系统中，Django4可能因系统sqlite3版本过低报错，需修改依赖文件： 路径：xxxx/Lib/site-packages/django/db/backends/sqlite3/base.py（根据实际安装路径调整） 修改内容：

python
# from sqlite3 import dbapi2 as Database   # 注释此行
from pysqlite3 import dbapi2 as Database # 启用pysqlite3

方法3：Docker运行

Docker方法1：自行构建

bash
git clone https://github.com/kingmo888/rustdesk-api-server.git
cd rustdesk-api-server
docker compose --compatibility up --build -d

Docker方法2：预构建镜像运行

docker run命令：

bash
docker run -d \
  --name rustdesk-api-server \
  -p 21114:21114 \
  -e CSRF_TRUSTED_ORIGINS=http://yourdomain.com:21114 \ # 防跨域信任来源，可选
  -e ID_SERVER=yourdomain.com \ # Web控制端使用的ID服务器
  -v /yourpath/db:/rustdesk-api-server/db \ # 宿主机数据库挂载目录，需替换/yourpath/db
  -v /etc/timezone:/etc/timezone:ro \
  -v /etc/localtime:/etc/localtime:ro \
  --network bridge \
  --restart unless-stopped \
  ghcr.io/kingmo888/rustdesk-api-server:latest

docker-compose配置：

yaml
version: "3.8"
services:
  rustdesk-api-server:
    container_name: rustdesk-api-server
    image: ghcr.io/kingmo888/rustdesk-api-server:latest
    environment:
      - CSRF_TRUSTED_ORIGINS=http://yourdomain.com:21114 # 防跨域信任来源，可选
      - ID_SERVER=yourdomain.com # Web控制端使用的ID服务器
    volumes:
      - /yourpath/db:/rustdesk-api-server/db # 宿主机数据库挂载目录，需替换/yourpath/db
      - /etc/timezone:/etc/timezone:ro
      - /etc/localtime:/etc/localtime:ro
    network_mode: bridge
    ports:
      - "21114:21114"
    restart: unless-stopped

环境变量配置

使用常见问题

管理员设置

数据库中首个注册的账户自动获得超级管理员权限，后续注册账户为普通用户。

设备信息获取

客户端需在非绿色版模式下安装为服务，才能定时发送设备信息到API接口。

连接速度慢

新版本Key模式可能导致链接速度慢，可在服务端启动时不使用-k参数，客户端也不配置key。

Web控制端配置

• 设置ID_SERVER环境变量，或修改rustdesk_server_api/settings.py中的ID_SERVER配置项，填写ID服务器/中继服务器IP或域名。

Web控制端一直转圈

• 检查ID服务器配置是否正确
• Web控制端仅支持非SSL模式，若访问地址为https://domain.com/webui，需改为http://domain.com/webui

CSRF验证失败

多出现于docker配置+nginx反代+SSL组合，需正确设置CSRF_TRUSTED_ORIGINS（SSL环境用https开头，非SSL用http）。

Mysql版本要求

Django4.x需要Mysql8.0，若使用Mysql5.8需将Django版本降至3.2。

开发计划

• 设备分享功能（v1.3+）：支持将设备分享给其他已注册用户
• Web客户端集成（v1.4+）：集成Web控制端功能
• 设备状态过滤（1.4.7）：支持过滤过期（不在线）设备
• 页面优化（1.4.6）：首屏拆分与分页功能
• 信息导出（1.4.6）：支持导出设备信息为xlsx文件
• 注册控制（1.4.7）：通过配置项控制是否允许新用户注册
• 数据库支持（1.4.8）：支持Mysql及sqlite3迁移Mysql
• [-] 用户密码修改：待实现
• [-] 前端改造：计划V2版本实现前后端分离及自适应页面

相关工具

• https://github.com/abdullah-erturk/RustDesk-ID-Changer
• https://github.com/rustdesk/rustdesk
• https://github.com/rustdesk/rustdesk-server

项目趋势

![Stargazers over time]([***]

联络方式

!https://github.com/kingmo888/rustdesk-api-server/raw/master/images/wechat.png