mirror of https://github.com/Awuqing/BackupX.git synced 2026-08-12 16:03:59 +08:00

Files

Wu Qing bdd16dafa8 docs: 完善部署与运维文档 (#107 )

新增中英文升级恢复、安全加固、监控告警与故障排查手册，校正安装部署、CLI 与 API 参考，并修复安全密钥环境变量注入及其回归测试。

2026-08-09 13:51:38 +08:00

3.5 KiB

Raw Blame History

sidebar_position, title, description

sidebar_position	title	description
2	Bare-metal Deployment	Hardened systemd deployment from the prebuilt release tarball or source, with opt-in Nginx.

Bare-metal Deployment

From prebuilt release

# Download the matching tarball
curl -LO https://github.com/Awuqing/BackupX/releases/latest/download/backupx-linux-amd64.tar.gz
curl -LO https://github.com/Awuqing/BackupX/releases/latest/download/backupx-linux-amd64.tar.gz.sha256
sha256sum -c backupx-linux-amd64.tar.gz.sha256

# Extract and install
tar xzf backupx-linux-amd64.tar.gz && cd backupx-*-linux-amd64
sudo ./install.sh

The installer performs these steps automatically:

Creates a system user backupx
Copies the binary to /opt/backupx/bin/backupx and the web console to /opt/backupx/web
Installs the default configuration at /etc/backupx/config.yaml
Installs backupx.service (systemd), enabled at boot
Leaves Nginx unchanged unless INSTALL_NGINX=1 is explicitly requested
Verifies the first-setup API before reporting success

The executable and web assets are owned by root; only /opt/backupx/data is writable by the backupx service account. /etc/backupx/config.yaml is installed as root:backupx with mode 0640.

The bundled Nginx template is a starting point and may conflict with an existing default server. Review its hostname and TLS policy first, then opt in:

sudo INSTALL_NGINX=1 ./install.sh

For multi-node clusters, edit /etc/backupx/config.yaml after installation and set the Master URL that remote Agents can reach:

server:
  external_url: "https://backup.example.com"

Restart BackupX after changing it:

sudo systemctl restart backupx

From source

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:

[Unit]
Description=BackupX API Service
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
User=backupx
Group=backupx
WorkingDirectory=/opt/backupx
ExecStart=/opt/backupx/bin/backupx -config /etc/backupx/config.yaml
Restart=on-failure
RestartSec=5
NoNewPrivileges=true
UMask=0027
LimitNOFILE=65535

[Install]
WantedBy=multi-user.target

Typical operations:

sudo systemctl status backupx
sudo journalctl -u backupx -f    # live logs
sudo systemctl restart backupx
curl -fsS http://127.0.0.1:8340/api/auth/setup/status

Open http://your-server:8340, switch to English if desired, and create the first administrator on the System setup screen. For a custom listen port, run the installer with a matching HEALTH_URL.

For production, expose BackupX through HTTPS or restrict port 8340 at the firewall. The installer does not make firewall changes.

Before replacing a release, snapshot /etc/backupx, /opt/backupx/data, the installed binary, and web assets while the service is stopped. Follow the versioned procedure in Upgrade and Recovery; running an older binary against a database already migrated by a newer release is not a safe rollback.

Password reset

If the admin password is lost:

/opt/backupx/bin/backupx reset-password \
  --username admin \
  --password 'newpass123' \
  --config /etc/backupx/config.yaml

Docker equivalent:

docker exec -it backupx /app/bin/backupx reset-password --username admin --password 'newpass123'

3.5 KiB Raw Blame History