mirror of
https://github.com/Awuqing/BackupX.git
synced 2026-06-14 06:09:39 +08:00
3a4c2edd9b
重构： - 首页 Hero 重设计：双列布局（标题+CTA+指标 / macOS 风代码窗口） - 引入渐变文字、pulse 徽章、悬停带动画的主按钮 - 功能卡片加 SVG 图标、悬停提升效果、部分卡片变成可点击链接 - 新增 HomepageShowcase 截图轮播区：Tab 切换四个核心页面（仪表盘/任务/存储/多节点） - 全站换 Arco 蓝 (#165dff) 作为主色，紫色 (#8f4bff) 作为辅助 - 导航栏加毛玻璃效果、表格加圆角与边框、菜单项圆角化 - 深色模式配色整体收敛 内容修正： - API 参考补全遗漏的端点：auth logout/profile、records batch-delete、 storage-targets star/usage/google-drive、notifications test、dashboard timeline、settings - 把 API 表格改为"方法/端点/说明"三列，加响应结构说明 - 中英文 API 文档同步更新 i18n： - code.json 补充 Hero、Features、Showcase 全部新翻译键 - 校对：16 个中英文档 frontmatter 完全对齐，无漏译 构建：双语 build 通过、产物 3.3MB
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 | 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 |
| Deployment | Single binary + embedded SQLite, Docker one-click, zero external dependencies |
Quick Start
# 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.sh
Open http://your-server:8340, create the admin account, then follow the 5-minute Quick Start.
Documentation
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
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.