文档: 新增 Docusaurus 官网与双语文档，README 切换为英文默认 (#39)

- 新建 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/
2026-05-17 22:47:36 +08:00 · 2026-04-17 13:19:41 +08:00
parent 757b0fa5ed
commit bc3d03de7e
55 changed files with 22429 additions and 901 deletions
--- a/docs-site/docs/deployment/bare-metal.md
+++ b/docs-site/docs/deployment/bare-metal.md
@@ -0,0 +1,86 @@
+---
+sidebar_position: 2
+title: Bare-metal Deployment
+description: systemd + Nginx deployment from the prebuilt release tarball or source.
+---
+
+# Bare-metal Deployment
+
+## From prebuilt release
+
+```bash
+# Download the matching tarball
+curl -LO https://github.com/Awuqing/BackupX/releases/latest/download/backupx-v1.6.0-linux-amd64.tar.gz
+
+# Extract and install
+tar xzf backupx-v*-linux-amd64.tar.gz && cd backupx-*
+sudo ./install.sh
+```
+
+The installer performs these steps automatically:
+
+1. Creates a system user `backupx`
+2. Copies the binary to `/opt/backupx/`
+3. Generates a default `config.yaml` with safe JWT/encryption secrets
+4. Installs `backupx.service` (systemd), enabled at boot
+5. (Optional) installs an Nginx site file — see [Nginx Reverse Proxy](./nginx)
+
+## From source
+
+```bash
+git clone https://github.com/Awuqing/BackupX.git && cd BackupX
+make build
+sudo ./deploy/install.sh
+```
+
+`make build` compiles:
+
+- `server/bin/backupx` (Go backend, no CGO)
+- `web/dist/` (React frontend, `npm run build`)
+
+## systemd
+
+The installed unit:
+
+```ini title="/etc/systemd/system/backupx.service"
+[Unit]
+Description=BackupX backup management service
+After=network.target
+
+[Service]
+Type=simple
+User=backupx
+WorkingDirectory=/opt/backupx
+ExecStart=/opt/backupx/backupx --config /opt/backupx/config.yaml
+Restart=on-failure
+RestartSec=5s
+LimitNOFILE=65536
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Typical operations:
+
+```bash
+sudo systemctl status backupx
+sudo journalctl -u backupx -f    # live logs
+sudo systemctl restart backupx
+```
+
+## Password reset
+
+If the admin password is lost:
+
+```bash
+/opt/backupx/backupx reset-password \
+  --username admin \
+  --password 'newpass123' \
+  --config /opt/backupx/config.yaml
+```
+
+Docker equivalent:
+
+```bash
+docker exec -it backupx /app/bin/backupx reset-password --username admin --password 'newpass123'
+```
--- a/docs-site/docs/deployment/configuration.md
+++ b/docs-site/docs/deployment/configuration.md
@@ -0,0 +1,52 @@
+---
+sidebar_position: 4
+title: Configuration Reference
+description: All server.yaml configuration keys with defaults and matching environment variables.
+---
+
+# Configuration Reference
+
+BackupX loads `./config.yaml` from the working directory by default. You can override the path with `--config`. Every key can also be set via a `BACKUPX_` prefixed environment variable.
+
+## Full config reference
+
+```yaml title="config.yaml"
+server:
+  host: "0.0.0.0"             # BACKUPX_SERVER_HOST
+  port: 8340                  # BACKUPX_SERVER_PORT
+  mode: "release"             # release | debug
+
+database:
+  path: "./data/backupx.db"   # BACKUPX_DATABASE_PATH — embedded SQLite
+
+security:
+  jwt_secret: ""              # BACKUPX_SECURITY_JWT_SECRET — auto-generated if empty
+  jwt_expires_in: "24h"
+  encryption_key: ""          # AES-256-GCM key for storage config encryption
+
+backup:
+  temp_dir: "/tmp/backupx"    # BACKUPX_BACKUP_TEMP_DIR
+  max_concurrent: 2           # BACKUPX_BACKUP_MAX_CONCURRENT
+  retries: 3                  # Per-upload rclone low-level retries
+  bandwidth_limit: ""         # e.g. "10M" to cap transfers at 10 MB/s
+
+log:
+  level: "info"               # debug | info | warn | error
+  file: "./data/backupx.log"
+```
+
+## Secret generation
+
+If `jwt_secret` or `encryption_key` is empty on first start, BackupX generates a random value and persists it to the `system_configs` table. Keep a backup of `data/backupx.db` — losing it invalidates all existing encrypted storage configurations.
+
+## Environment variables
+
+The environment wins when both file and env are set. All dot-paths become underscores and uppercase:
+
+| Config key | Env variable |
+|------------|--------------|
+| `server.port` | `BACKUPX_SERVER_PORT` |
+| `log.level` | `BACKUPX_LOG_LEVEL` |
+| `backup.max_concurrent` | `BACKUPX_BACKUP_MAX_CONCURRENT` |
+| `backup.temp_dir` | `BACKUPX_BACKUP_TEMP_DIR` |
+| `backup.bandwidth_limit` | `BACKUPX_BACKUP_BANDWIDTH_LIMIT` |
--- a/docs-site/docs/deployment/docker.md
+++ b/docs-site/docs/deployment/docker.md
@@ -0,0 +1,68 @@
+---
+sidebar_position: 1
+title: Docker Deployment
+description: Production-style Docker deployment with docker compose, mounted source directories, and environment overrides.
+---
+
+# Docker Deployment
+
+BackupX's official Docker image [`awuqing/backupx`](https://hub.docker.com/r/awuqing/backupx) supports multi-architecture (linux/amd64 + linux/arm64).
+
+## Compose file
+
+```yaml title="docker-compose.yml"
+services:
+  backupx:
+    image: awuqing/backupx:latest
+    container_name: backupx
+    restart: unless-stopped
+    ports:
+      - "8340:8340"
+    volumes:
+      - backupx-data:/app/data
+      # Mount host directories you want to back up:
+      - /var/www:/mnt/www:ro
+      - /etc/nginx:/mnt/nginx-conf:ro
+    environment:
+      - TZ=Asia/Shanghai
+      - BACKUPX_LOG_LEVEL=info
+      - BACKUPX_BACKUP_MAX_CONCURRENT=2
+
+volumes:
+  backupx-data:
+```
+
+Start with:
+
+```bash
+docker compose up -d
+```
+
+## Host-directory backup
+
+To back up files from the host, mount them into the container. When creating a file-type task in the web UI, point the source path at the mount location (e.g. `/mnt/www`). Make sure the directory is visible inside the container.
+
+## Environment variables
+
+All configuration keys can be overridden with the `BACKUPX_` prefix:
+
+```yaml
+environment:
+  - TZ=Asia/Shanghai
+  - BACKUPX_SERVER_PORT=8340
+  - BACKUPX_LOG_LEVEL=debug
+  - BACKUPX_BACKUP_MAX_CONCURRENT=4
+  - BACKUPX_BACKUP_TEMP_DIR=/tmp/backupx
+```
+
+See the [Configuration](./configuration) page for the full list.
+
+## Upgrades
+
+Check **System Settings → Check Updates** in the UI to see if a new version is available, then on the host:
+
+```bash
+docker compose pull && docker compose up -d
+```
+
+No migrations needed — BackupX auto-migrates the SQLite schema on startup.
--- a/docs-site/docs/deployment/nginx.md
+++ b/docs-site/docs/deployment/nginx.md
@@ -0,0 +1,53 @@
+---
+sidebar_position: 3
+title: Nginx Reverse Proxy
+description: Expose BackupX behind Nginx with HTTPS and SSE-friendly buffering disabled.
+---
+
+# Nginx Reverse Proxy
+
+A minimal production-ready Nginx site for BackupX:
+
+```nginx title="/etc/nginx/sites-available/backupx"
+server {
+    listen 80;
+    server_name backup.example.com;
+
+    # Static UI (served from /opt/backupx/web)
+    location / {
+        root /opt/backupx/web;
+        try_files $uri $uri/ /index.html;
+    }
+
+    # API reverse proxy
+    location /api/ {
+        proxy_pass http://127.0.0.1:8340;
+        proxy_http_version 1.1;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+
+        # Large uploads (restore flow)
+        client_max_body_size 0;
+
+        # Live log stream uses SSE — buffering must be off
+        proxy_buffering off;
+        proxy_read_timeout 3600s;
+        proxy_send_timeout 3600s;
+    }
+}
+```
+
+## HTTPS with certbot
+
+```bash
+sudo apt install certbot python3-certbot-nginx
+sudo certbot --nginx -d backup.example.com
+```
+
+Certbot rewrites the config to listen on 443 with auto-renewal.
+
+:::caution Agent needs a stable URL
+If Master is behind HTTPS, remote Agent deployments must use the public HTTPS URL for `--master`. Self-signed certs require `--insecure-tls` (testing only).
+:::