mirror of https://github.com/Awuqing/BackupX.git synced 2026-06-08 03:09:34 +08:00

Files

Wu Qing 61709dd4c9 fix(cluster): support external master URL

- add server.external_url / BACKUPX_SERVER_EXTERNAL_URL for Agent install URL generation
- pass the configured external Master URL into install script and compose rendering
- document cluster deployment requirements for Docker, bare-metal, and multi-node setups

Fixes #55

2026-05-09 07:41:51 +08:00

2.1 KiB

Raw Blame History

sidebar_position, title, description

sidebar_position	title	description
1	Docker 部署	生产级 Docker 部署方案，含 compose 配置、宿主目录挂载、环境变量覆盖。

Docker 部署

BackupX 官方 Docker 镜像 awuqing/backupx 支持多架构（linux/amd64 + linux/arm64）。

Compose 文件

services:
  backupx:
    image: awuqing/backupx:latest
    container_name: backupx
    restart: unless-stopped
    ports:
      - "8340:8340"
    volumes:
      - backupx-data:/app/data
      # 挂载需要备份的宿主机目录：
      - /var/www:/mnt/www:ro
      - /etc/nginx:/mnt/nginx-conf:ro
    environment:
      - TZ=Asia/Shanghai
      # 远程 Agent 需要通过公网或可路由地址连接 Master 时必须配置：
      # - BACKUPX_SERVER_EXTERNAL_URL=https://backup.example.com
      - BACKUPX_LOG_LEVEL=info
      - BACKUPX_BACKUP_MAX_CONCURRENT=2

volumes:
  backupx-data:

启动：

docker compose up -d

备份宿主机目录

想备份宿主机上的文件，需要将对应路径挂载进容器。在 Web UI 创建文件类型任务时，把源路径指向挂载后的容器内路径（如 /mnt/www）。

多节点集群

如果要在其他机器部署 Agent，请在 Master 容器上设置 BACKUPX_SERVER_EXTERNAL_URL，值为所有 Agent 都能访问到的 URL：

environment:
  - BACKUPX_SERVER_EXTERNAL_URL=https://backup.example.com

Agent 跨不可信网络访问时建议使用 HTTPS。控制台生成的一键安装脚本和 docker-compose 片段会把这个值写成 BACKUPX_AGENT_MASTER。

环境变量

所有配置项都可以通过 BACKUPX_ 前缀环境变量覆盖：

environment:
  - TZ=Asia/Shanghai
  - BACKUPX_SERVER_PORT=8340
  - BACKUPX_LOG_LEVEL=debug
  - BACKUPX_BACKUP_MAX_CONCURRENT=4
  - BACKUPX_BACKUP_TEMP_DIR=/tmp/backupx

完整列表见配置参考。

升级

在 UI 系统设置 → 检查更新 页面查看是否有新版，然后在宿主机上：

docker compose pull && docker compose up -d

无需手工迁移：BackupX 启动时自动迁移 SQLite schema。

2.1 KiB Raw Blame History Unescape Escape