DraARL 文档站

这是 DraARL Server 的文档入口，包含：

• 架构设计与数据字典
• 使用与说明文档（按功能拆分）
• DraARLv1 协议文档
• API 对接文档（按模块拆分）

推荐阅读顺序

新部署或运维人员

1. 先读 架构设计 了解系统整体架构
2. 再读 部署与配置 进行部署
3. 参考 运维与排障 解决常见问题

平台管理员

1. 阅读 管理员后台 了解管理功能
2. 参考 数据字典 了解数据库结构
3. 阅读 运维与排障 处理运维问题

普通用户

1. 阅读 账号、登录与权限 了解账号系统
2. 阅读 用户控制台 了解个人功能
3. 阅读 设备与群组 管理设备和群组
4. 阅读 在线收发与通信记录 使用实时通信

设备或客户端开发者

1. 阅读 设备接入与 API 快速对接 了解接入方式
2. 查阅 DraARLv1 协议文档 了解协议细节
3. 参考 WebSocket协议详解 了解浏览器接入
4. 查阅 API 文档 了解接口细节
5. 参考 错误码与状态码 处理错误情况

固件开发者

1. 阅读 固件与OTA升级 了解固件管理
2. 查阅 DraARLv1 协议文档 了解协议细节
3. 参考 APRS与位置服务 了解位置上报

文档目录

架构与设计

文档	说明
架构设计	系统整体架构、模块划分、数据流
数据字典	完整数据库表结构、字段定义、索引信息
协议文档	DraARLv1 协议规范、报文格式、认证流程

使用与说明文档

文档	说明
总览	文档总览和系统定位
部署与配置	环境要求、配置文件、部署方式
账号、登录与权限	注册、登录、Token、SSO
用户控制台	仪表盘、个人中心、设备密码
设备与群组	设备绑定、配置同步、群组管理
在线收发与通信记录	WebSocket通信、通信录制、通联日志
管理员后台	用户管理、设备管理、站点配置
设备接入与API快速对接	设备接入指南、API示例
运维与排障	常见问题、检查清单、运维建议
固件与OTA升级	固件管理、OTA流程、版本规范
APRS与位置服务	APRS配置、位置上报、地图展示

API 文档

文档	说明
总览	API 文档总览
约定与鉴权	通用约定、认证方式、限流策略
认证与SSO	登录、注册、Token刷新、SSO
用户与资料	用户信息、密码管理、头像上传
设备与配置	设备绑定、配置同步、固件管理
群组与互联	群组CRUD、虚拟互联组
无线电与实时通信	WebSocket、在线收发
通联记录与日志	通信记录、通联日志、电台预设
资源上传与站点配置	文件上传、操作证、站点配置
运维与管理接口	审批、中继台、操作日志、缓存
完整路由索引	所有API路径汇总表
WebSocket协议详解	WebSocket认证、消息格式、语音通信
错误码与状态码	HTTP状态码、业务错误码、协议状态码

本地预览

pip install -r docs/requirements.txt
mkdocs serve -f docs/mkdocs.yml

启动后访问：http://127.0.0.1:8000

构建静态站点

mkdocs build -f docs/mkdocs.yml

构建输出目录：site/

自动发布

• GitHub Actions 工作流：.github/workflows/docs-pages.yml
• 触发条件：Release 工作流成功完成后自动触发
• 结果：自动构建并发布到 EdgeOne Pages（production 环境）

需要在 GitHub 仓库配置：

• Secrets:
• EDGEONE_API_TOKEN
• Variables:
• EDGEONE_PAGES_PROJECT（EdgeOne Pages 项目名，若不存在会自动创建）

快速链接

场景	入口文档
快速部署	部署与配置
了解协议	协议文档
设备接入	设备接入与API快速对接
API对接	API总览
问题排查	运维与排障
数据库设计	数据字典
系统架构	架构设计