mirror of
https://github.com/Awuqing/BackupX.git
synced 2026-05-13 09:00:15 +08:00
bc3d03de7e
- 新建 docs-site/ Docusaurus 项目，支持 en + zh-Hans 双语 - 从 README 迁移内容为独立文档页面： - Getting Started（安装、快速开始） - Deployment（Docker、裸机、Nginx、配置参考） - Features（备份类型、存储后端、SAP HANA、多节点集群、通知） - Reference（API、CLI） - Development（开发、贡献） - 自定义 BackupX 主题色、logo、落地页组件 - 新增 .github/workflows/docs.yml，Actions 自动构建并发布到 GitHub Pages - README.md 切换为英文，中文版挪到 README.zh-CN.md，两者均精简为导航型 - 配置站点 URL：https://awuqing.github.io/BackupX/
60 lines
2.2 KiB
Markdown
60 lines
2.2 KiB
Markdown
---
|
|
sidebar_position: 2
|
|
title: Quick Start
|
|
description: Set up BackupX, add a storage target, create your first backup task.
|
|
---
|
|
|
|
# Quick Start
|
|
|
|
After [installation](./installation), get a first backup running in five minutes.
|
|
|
|
## 1. Open the console
|
|
|
|
Browse to `http://your-server:8340`. The first time, you'll be guided through creating an admin account.
|
|
|
|
## 2. Add a storage target
|
|
|
|
Navigate to **Storage Targets → Add**. Pick a type and fill the required fields:
|
|
|
|
| Type | Fields |
|
|
|------|--------|
|
|
| Alibaba OSS | Region + AccessKey ID/Secret + Bucket |
|
|
| Tencent COS | Region + SecretId/SecretKey + Bucket (format `name-appid`) |
|
|
| Qiniu Kodo | Region + AccessKey/SecretKey + Bucket |
|
|
| S3-compatible | Endpoint + AccessKey + Bucket |
|
|
| Google Drive | Client ID/Secret → click "Authorize" for OAuth flow |
|
|
| WebDAV | URL + username/password |
|
|
| FTP | Host + port + username/password |
|
|
| Local disk | Target directory |
|
|
| SFTP / Azure / Dropbox / OneDrive | Type-specific required fields; advanced options collapsed |
|
|
|
|
:::tip
|
|
For mainland China cloud vendors you only fill Region and AccessKey — BackupX assembles the endpoint automatically. Rclone-style providers separate required fields from advanced ones, with advanced collapsed by default.
|
|
:::
|
|
|
|
Click **Test Connection** to verify.
|
|
|
|
## 3. Create a backup task
|
|
|
|
Go to **Backup Tasks → New**. Three steps:
|
|
|
|
1. **Basic info** — name, type, cron expression (leave empty for manual-only)
|
|
2. **Source** — paths for file backup (multi-source supported), or connection info for databases
|
|
3. **Storage & policy** — pick target(s), compression, retention days, encryption on/off
|
|
|
|
Save, then click **Run Now** to trigger a test. Live logs stream on the **Backup Records** page.
|
|
|
|
:::note
|
|
Deleting a task also removes remote backup files to prevent orphans, but records are kept for audit.
|
|
:::
|
|
|
|
## 4. Configure notifications (optional)
|
|
|
|
**Notifications** page supports email, webhook, and Telegram. Configure per-channel rules for success/failure events.
|
|
|
|
## Next up
|
|
|
|
- Explore [backup types](/docs/features/backup-types) and [storage backends](/docs/features/storage-backends)
|
|
- Running SAP HANA? See [SAP HANA Support](/docs/features/sap-hana)
|
|
- Managing many servers? See [Multi-Node Cluster](/docs/features/multi-node)
|