RustDesk API

English Doc

本项目使用 Go 实现了 RustDesk 的 API，并包含了 Web Admin 和 Web 客户端。

搭配[lejianwen/rustdesk-server]使用更佳。

[lejianwen/rustdesk-server]fork自RustDesk Server官方仓库

1. 解决了使用API链接超时问题
2. 可以强制登录后才能发起链接
3. 支持客户端websocket

特性

• PC端API
  • 个人版API
  • 登录
  • 地址簿
  • 群组
  • 授权登录
    • 支持github, google 和 OIDC 登录，
    • 支持web后台授权登录
    • 支持LDAP(AD和OpenLDAP已测试), 如果API Server配置了LDAP
  • i18n
• Web Admin
  • 用户管理
  • 设备管理
  • 地址簿管理
  • 标签管理
  • 群组管理
  • Oauth 管理
  • 配置LDAP, 配置文件或者环境变量
  • 登录日志
  • 链接日志
  • 文件传输日志
  • 快速使用web client
  • i18n
  • 通过 web client 分享给游客
  • server控制(一些官方的简单的指令 WIKI (https://github.com/lejianwen/rustdesk-api/wiki/Rustdesk-Command))
• Web Client
  • 自动获取API server
  • 自动获取ID服务器和KEY
  • 自动获取地址簿
  • 游客通过临时分享链接直接远程到设备
• CLI
  • 重置管理员密码

功能

API 服务

基本实现了PC端基础的接口。支持Personal版本接口，可以通过配置文件rustdesk.personal或环境变量RUSTDESK_API_RUSTDESK_PERSONAL来控制是否启用

  登录


    

 
  地址簿
  群组


    
    

Web Admin:

• 使用前后端分离，提供用户友好的管理界面，主要用来管理和展示。前端代码在rustdesk-api-web (https://github.com/lejianwen/rustdesk-api-web)

• 后台访问地址是http://[:port]/_admin/

• 初次安装管理员为用户名为admin，密码将在控制台打印，可以通过命令行更改密码

  !img.png

1. 管理员界面 !web_admin

2. 普通用户界面 !web_user

3. 每个用户可以多个地址簿，也可以将地址簿共享给其他用户

4. 分组可以自定义，方便管理，暂时支持两种类型: 共享组 和 普通组

5. 可以直接打开webclient，方便使用；也可以分享给游客，游客可以直接通过webclient远程到设备

6. Oauth,支持了Github, Google 以及 OIDC, 需要创建一个OAuth App，然后配置到后台

   • 对于Google 和 Github, Issuer 和 Scopes不需要填写.
   • 对于OIDC, Issuer是必须的。Scopes是可选的，默认为 openid,profile,email. 确保可以获取 sub,email 和preferred_username
   • github oauth app在Settings->Developer settings->OAuth Apps->New OAuth App 中创建,地址 https://github.com/settings/developers (https://github.com/settings/developers)
   • Authorization callback URL填写http:///api/oidc/callback ，比如http://127.0.0.1:21114/api/oidc/callback

7. 登录日志

8. 链接日志

9. 文件传输日志

10. server控制