mirror of https://github.com/Awuqing/BackupX.git synced 2026-08-16 01:44:07 +08:00

Files

Wu Qing 00151e466c feat: 解决 CDC 去重、集中备份与首次初始化问题 (#105 )

实现 CDC 内容寻址仓库、远程 Agent 中央中转备份与首次初始化体验，并补充安全校验、测试及双语文档。

Closes #94
Closes #101
Closes #104

2026-08-07 23:01:29 +08:00

2.6 KiB

Raw Blame History

sidebar_position, title, description

sidebar_position	title	description
1	Installation	Install BackupX via Docker, prebuilt archive, or from source.

Installation

BackupX ships as a single static binary. Three ways to install, pick the one that matches your environment.

Docker (recommended)

No cloning required.

docker run -d --name backupx \
  -p 8340:8340 \
  -v backupx-data:/app/data \
  awuqing/backupx:latest

Or use docker compose:

services:
  backupx:
    image: awuqing/backupx:latest
    container_name: backupx
    restart: unless-stopped
    ports:
      - "8340:8340"
    volumes:
      - backupx-data:/app/data
      # Mount host directories to back up (as needed):
      # - /var/www:/mnt/www:ro
      # - /etc/nginx:/mnt/nginx-conf:ro
    environment:
      - TZ=Asia/Shanghai

volumes:
  backupx-data:

Images: awuqing/backupx — supports linux/amd64 and linux/arm64.

Prebuilt archive (bare metal)

Download from the Releases page and run the installer:

tar xzf backupx-v*-linux-amd64.tar.gz && cd backupx-*
sudo ./install.sh        # creates system user, installs to /opt/backupx, sets up systemd + nginx

The installer:

Creates a backupx system user
Installs the binary to /opt/backupx/bin/backupx and the web console to /opt/backupx/web
Creates /etc/backupx/config.yaml with safe defaults
Installs and enables the backupx.service systemd unit
(Optional) Configures an Nginx reverse proxy
Waits for /api/auth/setup/status; if startup fails, prints systemd diagnostics and exits non-zero

From source

Requires Go ≥ 1.25 and Node.js ≥ 20.

git clone https://github.com/Awuqing/BackupX.git && cd BackupX
make build
sudo ./deploy/install.sh

After make build, the binary is at server/bin/backupx and the built web UI is at web/dist/. The installer consumes those exact paths, so no Docker runtime is required. If an existing configuration uses a non-default port, set HEALTH_URL for the readiness check, for example sudo HEALTH_URL=http://127.0.0.1:9000/api/auth/setup/status ./deploy/install.sh.

Verify the install

/opt/backupx/bin/backupx --version
curl -fsS http://127.0.0.1:8340/api/auth/setup/status

Then open http://your-server:8340. Choose English or 中文 in the upper-right corner. A fresh database shows System setup, where you create the first administrator username and password. If that form does not appear, retry the status request above before attempting to sign in.

2.6 KiB Raw Blame History