RustDesk API服务器从零搭建完整指南：远程协助工具后端部署与配置详解

核心功能概览

RustDesk API服务器是远程协助工具RustDesk的后端支撑系统，提供用户账号管理、设备地址簿维护、远程连接授权等核心功能。通过RESTful API接口，支持账号创建、密码修改、设备列表管理等操作，兼容MySQL和SQLite3数据库，满足不同规模部署需求。作为远程协助工具后端，该API服务器实现了设备身份验证、连接权限控制和操作审计等关键能力，为RustDesk客户端提供稳定的数据服务支持。

技术选型解析

核心技术栈

• Go语言：选择Go语言开发确保了高并发处理能力和跨平台兼容性，适合作为API服务的底层语言
• Beego框架：采用成熟的MVC架构设计，提供完整的Web开发组件，加速API接口开发
• JWT认证：实现无状态的用户身份验证，提升API调用的安全性和可扩展性
• 多数据库支持：同时兼容MySQL和SQLite3，满足从个人使用到企业部署的不同场景需求

选型优势

Go语言的并发模型特别适合处理大量客户端API请求，Beego框架提供的路由管理和ORM工具大幅降低开发复杂度，JWT认证机制则确保了API通信的安全性。多数据库支持使部署更加灵活，开发者可根据实际需求选择合适的存储方案。

环境部署指南

1. 环境准备

• Go 1.16+开发环境
• GCC编译器
• MySQL或SQLite3数据库
• Git版本控制工具

2. 获取项目代码

git clone https://gitcode.com/gh_mirrors/rus/rustdesk-api-server.git
cd rustdesk-api-server

3. 安装依赖包

go mod download

4. 配置数据库连接

创建并编辑配置文件：conf/app.conf

appname = rustdesk-api-server
HTTPAddr = 0.0.0.0
httpport = 21114
runmode = dev
sessionon = true

[dev]
log_level=7
log_path=logs/app.log

5. 启动服务

go run main.go

✅ 验证：服务启动后自动创建数据表结构，默认监听21114端口

6. 客户端配置

在RustDesk客户端中设置API服务器地址：

• API服务器地址：输入部署服务器的IP或域名
• 端口：21114（Android客户端必须使用此端口）
• 无需添加"http://"前缀

实用操作手册

账号管理

创建用户账号

curl -X POST "http://127.0.0.1:21114/api/reg?username=test&password=test&auth_key=123456"

修改用户密码

curl -X POST "http://127.0.0.1:21114/api/set-pwd?username=test&password=newpassword&auth_key=123456"

地址簿操作

登录后获取当前账号下所有主机列表：

curl -X GET "http://127.0.0.1:21114/api/address-book" -H "Authorization: Bearer {your_token}"

架构设计详解

项目目录结构

rustdesk-api-server/
├── app/           # 应用核心代码
│   ├── controllers/ # 请求处理层：[app/controllers/user.go](https://gitcode.com/gh_mirrors/rus/rustdesk-api-server/blob/4b114c2fa717c5e6787962d15719d1755887f221/app/controllers/user.go?utm_source=gitcode_repo_files)
│   ├── models/     # 数据模型层：[app/models/user.go](https://gitcode.com/gh_mirrors/rus/rustdesk-api-server/blob/4b114c2fa717c5e6787962d15719d1755887f221/app/models/user.go?utm_source=gitcode_repo_files)
│   ├── services/   # 业务逻辑层：[app/services/login.go](https://gitcode.com/gh_mirrors/rus/rustdesk-api-server/blob/4b114c2fa717c5e6787962d15719d1755887f221/app/services/login.go?utm_source=gitcode_repo_files)
│   └── dto/        # 数据传输对象
├── boot/          # 启动配置：数据库连接、服务初始化
├── conf/          # 配置文件：[conf/app.conf](https://gitcode.com/gh_mirrors/rus/rustdesk-api-server/blob/4b114c2fa717c5e6787962d15719d1755887f221/conf/app.conf?utm_source=gitcode_repo_files)
├── global/        # 全局变量和配置定义
├── routers/       # 路由配置：[routers/router.go](https://gitcode.com/gh_mirrors/rus/rustdesk-api-server/blob/4b114c2fa717c5e6787962d15719d1755887f221/routers/router.go?utm_source=gitcode_repo_files)
├── utils/         # 工具函数：JWT、日志、加密等
└── main.go        # 程序入口

核心模块交互流程

1. 客户端请求经路由层routers/router.go分发
2. 控制器层处理请求并调用相应服务
3. 服务层实现业务逻辑，通过模型层操作数据库
4. 工具函数提供通用功能支持，如JWT生成与验证

问题解决方案

5分钟快速部署问题排查

服务启动失败

• 检查数据库连接配置是否正确
• 确认21114端口未被占用：netstat -tuln | grep 21114
• 验证Go环境版本：go version

客户端连接问题

• 确保API服务器地址格式正确，无需添加"http://"
• 检查防火墙设置，确保21114端口开放
• 验证服务端日志，查看请求处理情况：logs/app.log

数据持久化问题

• 地址簿保存异常：检查username字段是否为"----"（系统保留值，不会保存）
• 数据库文件权限：确保应用对数据库文件有读写权限
• 定期备份数据库文件，防止数据丢失

最佳实践建议

• 生产环境使用Nginx反向代理提高安全性
• 定期更新依赖包，修复潜在安全漏洞
• 配置适当的日志级别和轮转策略，便于问题排查
• 对敏感操作实施审计日志，增强系统可追溯性