BackupX/README.zh-CN.md

English | 中文

BackupX

自托管服务器备份管理平台
一个二进制，一条命令，管好你所有服务器的备份。

文档 · 下载 · Docker Hub

---

功能亮点

能力	说明
备份类型	文件/目录（多源路径）、MySQL、PostgreSQL、SQLite、SAP HANA（完整/增量/差异/日志备份 + 并行通道 + 失败重试）
SAP HANA Backint 代理	内置 SAP HANA Backint 协议代理，HANA 原生备份接口可直接把数据路由到 BackupX 支持的任意存储后端
70+ 存储后端	内置阿里云 OSS / 腾讯云 COS / 七牛云 / S3 / Google Drive / WebDAV / FTP + 通过 rclone 集成 SFTP、Azure Blob、Dropbox、OneDrive 等 70+ 后端
自动调度	Cron 定时 + 可视化编辑器 + 自动保留策略（按天数/份数清理，自动回收空目录）
多节点集群	Master-Agent 模式，基于 Agent 主动出站的 HTTP 轮询跨服务器管理备份，支持代理、私有 CA 与 SSH 堡垒机，无需反向连通性
安全	JWT + bcrypt + AES-256-GCM 加密配置 + 可选备份文件加密 + 完整审计日志
通知	邮件 / Webhook / Telegram，备份成功或失败时自动推送
可观测性	Prometheus /metrics 端点 + /health + /ready 探针 + SLA 违约监控
审计外输	HMAC-SHA256 签名 Webhook，对接 SIEM / WORM 存储满足 SOC2 / GDPR 合规
流控	节点级带宽限速 + 节点级并发控制，大小节点分别配置，避免小内存 Agent 被挤爆
部署	单二进制 + 内嵌 SQLite，无需外部控制面数据库（数据库备份工具需安装在任务执行主机）

快速开始

Docker Compose（推荐）：

git clone --depth 1 https://github.com/Awuqing/BackupX.git
cd BackupX
docker compose up -d

预编译包：

curl -LO https://github.com/Awuqing/BackupX/releases/latest/download/backupx-linux-amd64.tar.gz
curl -LO https://github.com/Awuqing/BackupX/releases/latest/download/backupx-linux-amd64.tar.gz.sha256
sha256sum -c backupx-linux-amd64.tar.gz.sha256
tar xzf backupx-linux-amd64.tar.gz
cd backupx-*-linux-amd64
sudo ./install.sh

从源码构建并裸机安装：

git clone https://github.com/Awuqing/BackupX.git
cd BackupX
make build
sudo ./deploy/install.sh

ARM64 主机请下载 backupx-linux-arm64.tar.gz。预编译包内包含 backupx、web/、config.example.yaml 和 install.sh，请在解压后的目录内执行 install.sh。

Compose 快速开始为便于体验默认使用 latest。生产环境应把 BACKUPX_IMAGE 固定到 Release 标签或摘要，并先阅读安全与恢复指南。

打开 http://your-server:8340，在初始化页选择中文或 English 并创建首个管理员账户，按 5 分钟快速开始 完成首次备份。

文档

完整文档见 https://awuqing.github.io/BackupX/zh-Hans/ — 快速开始、部署、运维、SAP HANA、多节点集群、API 参考等。

快捷链接：

• 快速开始 — 五分钟跑通第一个备份
• 安装 — Docker / 裸机 / 源码
• 升级与恢复 — 快照、升级、回滚与灾难恢复
• 安全加固 — 生产暴露、角色与密钥
• 监控与告警 — 探针、指标与初始告警
• 故障排查 — Master、代理、Agent 与任务诊断
• 多节点集群 — 远程服务器部署 Agent
• SAP HANA 支持 — hdbsql Runner 与原生 Backint
• API 参考 — REST 端点

开发

git clone https://github.com/Awuqing/BackupX.git && cd BackupX
make dev-server          # 终端 1：后端（:8340）
make dev-web             # 终端 2：前端（Vite HMR）
make test                # 运行全部测试
make build               # 产出 server/bin/backupx + web/dist

更多细节见 开发指南。

贡献

欢迎提交 Issue 与 Pull Request。提交 PR 前请先阅读 贡献指南 — 本项目的 commit message 和 PR 正文均使用中文。

License

Apache License 2.0