English | 中文
Self-hosted server backup management
One binary, one command — manage every backup of every server.
Docs · Downloads · Docker Hub
 |
 |
 |
 |
| 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 | Master-Agent mode via HTTP long-polling — Agents run tasks locally, upload straight to storage, 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, Docker one-click, zero external dependencies |
# Docker (recommended)
docker run -d --name backupx -p 8340:8340 -v backupx-data:/app/data awuqing/backupx:latest
# Or prebuilt archive
curl -LO https://github.com/Awuqing/BackupX/releases/latest/download/backupx-linux-amd64.tar.gz
tar xzf backupx-*.tar.gz && cd backupx-* && sudo ./install.shFor 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.
Open http://your-server:8340, create the admin account, then follow the 5-minute Quick Start.
The full docs live at https://awuqing.github.io/BackupX/ — Getting Started, Deployment, 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
- Multi-Node Cluster — deploy the Agent on remote servers
- SAP HANA Support — hdbsql Runner and native Backint
- API Reference — REST endpoints
BackupX provides structured error handling to help you diagnose and resolve issues quickly.
| Environment | Log Path |
|---|---|
| Docker | docker logs <container> |
| Binary ( systemd ) | journalctl -u backupx |
| Binary ( manual ) | ./backupx logs or console output |
Backup task fails with "connection refused"
- Verify the storage backend credentials are correct and the endpoint is reachable
- Check firewall rules allow outbound connections to your storage provider
- For S3-compatible backends, ensure the region and endpoint URL are correctly configured
Agent node appears offline
- Confirm the Agent process is running on the remote node
- Verify network connectivity between the master and Agent (default port 8340)
- Check the Agent logs for authentication or certificate errors
Database backup hangs or times out
- Increase the
timeoutvalue in the backup task settings - For large databases, enable incremental or differential backup modes
- Ensure the database user has sufficient privileges (e.g.,
LOCK TABLES,SELECTfor MySQL)
Webhook or notification failures
- Verify the webhook URL is publicly accessible
- Check that the HMAC secret matches between BackupX and your receiver
- Ensure the target server accepts POST requests with JSON payload
Enable verbose logging for troubleshooting:
# Binary
./backupx --log-level debug
# Docker
docker run -d --name backupx -p 8340:8340 -e LOG_LEVEL=debug awuqing/backupx:latestIf you encounter an error not listed here:
- Check the troubleshooting guide in the docs
- Search existing issues for similar errors
- Open a new issue with the error message, log excerpts, and your configuration
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/distSee the development guide for more.
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.
PRs welcome!