English | 中文
BackupX
Self-hosted server backup management
One binary, one command — manage every backup of every server.
Docs · Downloads · Docker Hub
 |
 |
 |
 |
Highlights
| Capability | Details |
|---|---|
| Backup Types | Files/directories (multi-source), MySQL, PostgreSQL, SQLite, SAP HANA (full / incremental / differential / log + parallel channels + retry) |
| SAP HANA Backint Agent | Built-in Backint protocol — HANA's native interface routes data directly to any BackupX storage backend |
| 70+ Storage Backends | Alibaba OSS, Tencent COS, Qiniu, S3, Google Drive, WebDAV, FTP + SFTP, Azure Blob, Dropbox, OneDrive and dozens more via rclone |
| Scheduling | Cron + visual editor + auto-retention (by days/count + empty-directory cleanup) |
| Multi-Node Cluster | Outbound-only Master-Agent polling with proxy, private-CA, and SSH-bastion support; Agents run tasks locally with no reverse connectivity required |
| Security | JWT + bcrypt + AES-256-GCM encrypted config + optional backup encryption + full audit log |
| Notifications | Email / Webhook / Telegram on success or failure |
| Observability | Prometheus /metrics endpoint + /health + /ready probes + SLA breach gauge |
| Audit Webhook | HMAC-SHA256 signed forwarding to SIEM / WORM storage for compliance (SOC2 / GDPR) |
| Flow Control | Per-node bandwidth cap + per-node concurrency limit — tune big/small nodes independently |
| Deployment | Single binary + embedded SQLite; no external control-plane database (database backup tools are required on the execution host) |
Quick Start
Docker Compose (recommended):
git clone --depth 1 https://github.com/Awuqing/BackupX.git
cd BackupX
docker compose up -d
Prebuilt archive:
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
Build and install on bare metal:
git clone https://github.com/Awuqing/BackupX.git
cd BackupX
make build
sudo ./deploy/install.sh
For ARM64 hosts, use backupx-linux-arm64.tar.gz. The archive contains backupx, web/, config.example.yaml, and install.sh; run install.sh from the extracted directory.
The Compose quick start defaults to latest for evaluation. Pin BACKUPX_IMAGE to a release tag or digest and review the security and recovery guides before production.
Open http://your-server:8340, choose English or Chinese on the setup screen, create the first administrator account, then follow the 5-minute Quick Start.
Documentation
The full docs live at https://awuqing.github.io/BackupX/ — Getting Started, Deployment, Operations, SAP HANA, Multi-Node Cluster, API reference, and more. Switch to Chinese via the language dropdown in the top-right nav.
Quick links:
- Quick Start — first backup in five minutes
- Installation — Docker / bare metal / source
- Upgrade & Recovery — snapshots, upgrades, rollback, and disaster recovery
- Security Hardening — production exposure, roles, and secrets
- Monitoring & Alerts — probes, metrics, and initial alerts
- Troubleshooting — Master, proxy, Agent, and task diagnostics
- Multi-Node Cluster — deploy the Agent on remote servers
- SAP HANA Support — hdbsql Runner and native Backint
- API Reference — REST endpoints
Development
git clone https://github.com/Awuqing/BackupX.git && cd BackupX
make dev-server # Terminal 1 — backend (:8340)
make dev-web # Terminal 2 — frontend (Vite HMR)
make test # run all tests
make build # produce server/bin/backupx + web/dist
See the development guide for more.
Contributing
Issues and pull requests welcome. Please read the contributing guide before opening a PR — commit messages and PRs on this project are written in Chinese.