mirror of https://github.com/Awuqing/BackupX.git synced 2026-05-12 02:20:36 +08:00

Files

Wu Qing bc3d03de7e 文档: 新增 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-04-17 13:19:41 +08:00

1.8 KiB

Raw Blame History

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-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:

Creates a system user backupx
Copies the binary to /opt/backupx/
Generates a default config.yaml with safe JWT/encryption secrets
Installs backupx.service (systemd), enabled at boot
(Optional) installs an Nginx site file — see Nginx Reverse Proxy

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
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:

sudo systemctl status backupx
sudo journalctl -u backupx -f    # live logs
sudo systemctl restart backupx

Password reset

If the admin password is lost:

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

Docker equivalent:

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

1.8 KiB Raw Blame History