Files
BackupX/docs-site/docs/deployment/bare-metal.md
T
Awuqing f8deafcb00 feat(auth): 完善英文初始化与裸机安装
在登录和首个管理员创建前提供中英文切换,并在初始化状态不可达时展示可重试错误,避免误入登录页。

对齐源码构建产物与安装脚本路径,增加 systemd/API 就绪检查、失败诊断及中英文裸机文档。

Closes #104
2026-08-07 05:55:56 +08:00

2.5 KiB

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

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

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

The installer performs these steps automatically:

  1. Creates a system user backupx
  2. Copies the binary to /opt/backupx/bin/backupx and the web console to /opt/backupx/web
  3. Installs the default configuration at /etc/backupx/config.yaml
  4. Installs backupx.service (systemd), enabled at boot
  5. (Optional) installs an Nginx site file — see Nginx Reverse Proxy
  6. Verifies the first-setup API before reporting success

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 backup management service
After=network.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
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.

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'