English | 中文

BackupX

Self-hosted server backup management
One binary, one command — manage every backup of every server.

Stars Release CI Docs Go React SQLite License

Docs · Downloads · Docker Hub

---
BackupX dashboard with 30-day backup trends, storage distribution, and task health
Dashboard — 30-day success and failure trends, storage distribution, task volume, and cluster health.		 BackupX task list with schedules, targets, retention, tags, RPO, and verification status
Backup tasks — schedules, multi-target policies, retention, tags, RPO goals, and recurring verification.
BackupX storage targets with connection health, capacity usage, and redundancy roles
Storage targets — connection health, live capacity, favourites, and redundancy roles at a glance.		 BackupX backup history with success and failure states, checksums, destinations, and retention locks
Backup records — success and failure states, checksums, destinations, execution logs, and retention locks.
## 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): ```bash git clone --depth 1 https://github.com/Awuqing/BackupX.git cd BackupX docker compose up -d ``` Prebuilt archive: ```bash 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: ```bash 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](https://awuqing.github.io/BackupX/docs/getting-started/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](https://awuqing.github.io/BackupX/docs/getting-started/quick-start) — first backup in five minutes - [Installation](https://awuqing.github.io/BackupX/docs/getting-started/installation) — Docker / bare metal / source - [Upgrade & Recovery](https://awuqing.github.io/BackupX/docs/operations/upgrade-recovery) — snapshots, upgrades, rollback, and disaster recovery - [Security Hardening](https://awuqing.github.io/BackupX/docs/operations/security) — production exposure, roles, and secrets - [Monitoring & Alerts](https://awuqing.github.io/BackupX/docs/operations/monitoring) — probes, metrics, and initial alerts - [Troubleshooting](https://awuqing.github.io/BackupX/docs/operations/troubleshooting) — Master, proxy, Agent, and task diagnostics - [Multi-Node Cluster](https://awuqing.github.io/BackupX/docs/features/multi-node) — deploy the Agent on remote servers - [SAP HANA Support](https://awuqing.github.io/BackupX/docs/features/sap-hana) — hdbsql Runner and native Backint - [API Reference](https://awuqing.github.io/BackupX/docs/reference/api) — REST endpoints ## Development ```bash 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](https://awuqing.github.io/BackupX/docs/development/setup) for more. ## Contributing Issues and pull requests welcome. Please read the [contributing guide](https://awuqing.github.io/BackupX/docs/development/contributing) before opening a PR — commit messages and PRs on this project are written in Chinese. ## Star History Star History Chart ## License [Apache License 2.0](LICENSE)