文档中心
详细的使用指南和API文档
快速开始
1. 注册账户
访问我们的注册页面，填写用户名、邮箱地址和密码即可完成注册。免费用户享有10GB存储空间和最多3台服务器。
2. 添加服务器
登录后，进入服务器管理页面，点击"添加服务器"按钮。填写服务器名称、IP地址、SSH端口和SSH用户名等信息。系统将自动生成SSH密钥对。
3. 安装客户端
在目标服务器上安装我们的客户端程序，使用生成的注册密钥进行注册。客户端将自动连接到我们的系统并保持心跳连接。
4. 创建备份
进入备份管理页面，选择要备份的服务器，配置备份参数（备份方法、备份范围等），点击"立即备份"即可开始备份任务。
5. 查看备份
备份完成后，您可以在备份文件列表中查看所有备份文件。点击备份文件可以浏览其中的内容，搜索文件或下载单个文件。
服务器管理
添加服务器
在服务器管理页面，点击"添加服务器"按钮。填写以下信息：
- 服务器名称：用于标识服务器的名称
- IP地址：服务器的IP地址或域名
- SSH端口：SSH服务端口，默认为22
- SSH用户名：SSH登录用户名
- 架构：服务器架构（AMD64或ARM64）
编辑服务器
点击服务器列表中的"编辑"按钮，可以修改服务器信息。注意：修改SSH连接信息后，需要重新注册客户端。
删除服务器
点击服务器列表中的"删除"按钮，可以删除服务器及其所有备份文件。此操作不可恢复，请谨慎操作。
SSH密钥管理
系统会自动为每台服务器生成SSH密钥对。您可以点击"轮换密钥"来生成新的密钥对。所有SSH私钥都经过AES加密存储，确保安全性。
备份操作
Tar打包备份
Tar打包备份将整个服务器或指定目录打包成一个tar文件。优点是备份文件完整，便于管理和传输。缺点是备份速度较慢，占用存储空间较大。
Rsync增量备份
Rsync增量备份只备份发生变化的部分，大大减少备份时间和存储空间。优点是备份速度快，节省存储空间。缺点是需要rsync支持，首次备份时间较长。
全量备份
全量备份备份整个服务器的所有文件。适用于需要完整备份的场景。
目录备份
目录备份只备份指定的目录。适用于只需要备份部分数据的场景。
备份进度
备份过程中，您可以实时查看备份进度。备份完成后，系统会自动建立文件索引，方便后续浏览和搜索。
还原操作
还原前检查
在执行还原操作前，系统会自动进行以下检查：
- 权限检查：确保有足够的权限执行还原操作
- 完整性检查：验证备份文件的完整性
- 磁盘空间检查：确保目标服务器有足够的磁盘空间
- 冲突检测：检测可能存在的文件冲突
还原回滚
还原前，系统会自动创建快照。如果还原失败或需要撤销，可以使用快照进行回滚。
还原完整性校验
还原完成后，系统会自动进行完整性校验，确保还原的数据与备份文件一致。
定时任务
创建定时任务
在定时任务页面，点击"创建定时任务"按钮。填写以下信息：
- 任务名称：用于标识定时任务的名称
- 备份服务器：要备份的服务器
- 备份方法：tar打包或rsync增量
- 备份范围：全量备份或目录备份
- Cron表达式：设置备份计划
- 保留天数：备份文件的保留天数
Cron表达式
Cron表达式用于设置定时任务的执行时间。格式为：分 时 日 月 周
- 每天凌晨2点备份：0 2 * * *
- 每周日凌晨3点备份：0 3 * * 0
- 每月1号凌晨4点备份：0 4 1 * *
- 每6小时备份一次：0 */6 * * *
保留策略
系统会自动清理超过保留天数的备份文件，释放存储空间。
文件浏览
浏览备份文件
点击备份文件可以浏览其中的内容。系统会以目录树的形式展示文件结构，支持懒加载和虚拟滚动，提高浏览效率。
文件搜索
支持按文件名、文件内容或正则表达式搜索文件。搜索结果会显示匹配的文件及其路径。
文件预览
支持文本文件和图片文件的在线预览。点击文件即可查看其内容。
文件下载
支持单个文件下载和批量文件下载。下载的文件会以压缩包的形式提供。
API文档
认证
所有API请求都需要在请求头中包含JWT令牌：
Authorization: Bearer <your-jwt-token>用户认证
POST /api/auth/login
Content-Type: application/json
{
"username": "admin",
"password": "Admin@123456"
}获取服务器列表
GET /api/servers
Authorization: Bearer <your-jwt-token>创建备份任务
POST /api/backups
Authorization: Bearer <your-jwt-token>
Content-Type: application/json
{
"server_id": 1,
"backup_method": "tar",
"backup_scope": "full"
}获取备份文件列表
GET /api/backups/files?server_id=1
Authorization: Bearer <your-jwt-token>安全指南
账户安全
- 使用强密码，包含大小写字母、数字和特殊字符
- 定期更换密码
- 不要与他人共享账户信息
- 启用两步验证（如支持）
服务器安全
- 使用SSH密钥认证，禁用密码登录
- 限制SSH访问的IP地址
- 定期更新系统和软件
- 配置防火墙规则
数据安全
- 定期验证备份数据的完整性
- 测试还原流程，确保备份可用
- 设置合理的保留策略
- 加密敏感数据
故障排除
无法连接服务器
请检查：
- 服务器IP地址和SSH端口是否正确
- 服务器是否在线
- 防火墙是否允许SSH连接
- SSH服务是否正常运行
备份失败
请检查：
- 服务器是否有足够的磁盘空间
- 是否有足够的权限执行备份操作
- 存储配额是否已满
- 网络连接是否稳定
还原失败
请检查：
- 备份文件是否完整
- 目标服务器是否有足够的磁盘空间
- 是否有足够的权限执行还原操作
- 是否存在文件冲突
客户端无法注册
请检查：
- 注册密钥是否正确
- 服务器架构是否匹配
- 网络连接是否正常
- 客户端版本是否兼容