mirror of
https://github.com/Awuqing/BackupX.git
synced 2026-08-28 11:37:04 +08:00
Wu Qing
61709dd4c9
- 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
67 lines
2.6 KiB
Markdown
67 lines
2.6 KiB
Markdown
---
|
||
sidebar_position: 4
|
||
title: 配置参考
|
||
description: server.yaml 所有配置项及对应的环境变量。
|
||
---
|
||
|
||
# 配置参考
|
||
|
||
BackupX 默认从工作目录加载 `./config.yaml`，可通过 `--config` 指定其他路径。所有配置项都可通过 `BACKUPX_` 前缀环境变量覆盖。
|
||
|
||
## 完整配置
|
||
|
||
```yaml title="config.yaml"
|
||
server:
|
||
host: "0.0.0.0" # BACKUPX_SERVER_HOST
|
||
port: 8340 # BACKUPX_SERVER_PORT
|
||
mode: "release" # release | debug
|
||
external_url: "" # BACKUPX_SERVER_EXTERNAL_URL — Agent 安装脚本使用的 Master 对外 URL
|
||
|
||
database:
|
||
path: "./data/backupx.db" # BACKUPX_DATABASE_PATH — 内嵌 SQLite
|
||
|
||
security:
|
||
jwt_secret: "" # BACKUPX_SECURITY_JWT_SECRET — 留空自动生成
|
||
jwt_expire: "24h" # BACKUPX_SECURITY_JWT_EXPIRE
|
||
encryption_key: "" # 用于加密存储配置的 AES-256-GCM 密钥
|
||
|
||
backup:
|
||
temp_dir: "/tmp/backupx" # BACKUPX_BACKUP_TEMP_DIR
|
||
max_concurrent: 2 # BACKUPX_BACKUP_MAX_CONCURRENT
|
||
retries: 3 # 单次上传的 rclone 底层重试次数
|
||
bandwidth_limit: "" # 例如 "10M" 表示限速 10 MB/s
|
||
|
||
log:
|
||
level: "info" # debug | info | warn | error
|
||
file: "./data/backupx.log"
|
||
```
|
||
|
||
## 密钥生成
|
||
|
||
如果首次启动时 `jwt_secret` 或 `encryption_key` 为空，BackupX 会自动生成随机值并写入 `system_configs` 表。请妥善备份 `data/backupx.db`，一旦丢失将导致所有已加密的存储配置失效。
|
||
|
||
## 环境变量
|
||
|
||
文件和环境变量同时存在时，环境变量优先。配置路径转换规则：小写字母下划线 → 大写字母下划线：
|
||
|
||
| 配置项 | 环境变量 |
|
||
|--------|----------|
|
||
| `server.port` | `BACKUPX_SERVER_PORT` |
|
||
| `server.external_url` | `BACKUPX_SERVER_EXTERNAL_URL` |
|
||
| `security.jwt_expire` | `BACKUPX_SECURITY_JWT_EXPIRE` |
|
||
| `log.level` | `BACKUPX_LOG_LEVEL` |
|
||
| `backup.max_concurrent` | `BACKUPX_BACKUP_MAX_CONCURRENT` |
|
||
| `backup.temp_dir` | `BACKUPX_BACKUP_TEMP_DIR` |
|
||
| `backup.bandwidth_limit` | `BACKUPX_BACKUP_BANDWIDTH_LIMIT` |
|
||
|
||
## Master 对外 URL
|
||
|
||
当 BackupX 部署在 Docker、Nginx、负载均衡或多层反向代理后面，且后端收到的内部 Host 不是远程 Agent 可访问地址时，请配置 `server.external_url`：
|
||
|
||
```yaml
|
||
server:
|
||
external_url: "https://backup.example.com"
|
||
```
|
||
|
||
BackupX 会用这个地址渲染一键 Agent 安装脚本和 docker-compose 片段。该地址必须能被所有 Agent 主机访问。只有在 `X-Forwarded-Proto` / `X-Forwarded-Host` 可靠且正好指向 Agent 可访问地址时，才建议留空。
|