mirror of
https://github.com/Awuqing/BackupX.git
synced 2026-05-06 20:02:41 +08:00
bc3d03de7e
- 新建 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/
2.0 KiB
2.0 KiB
sidebar_position, title, description
| sidebar_position | title | description |
|---|---|---|
| 2 | CLI 参考 | backupx 子命令 — server / agent / backint / reset-password。 |
CLI 参考
backupx 二进制内置多个子命令。无子命令时默认启动主服务进程。
backupx（默认：服务进程）
backupx --config /opt/backupx/config.yaml
backupx --version
| 参数 | 说明 |
|---|---|
--config <path> |
配置文件路径（默认 ./config.yaml） |
--version |
打印版本后退出 |
backupx agent
以 Agent 模式运行，连接到 Master。详见 多节点集群。
backupx agent --master http://master:8340 --token <token>
| 参数 | 说明 |
|---|---|
--master <url> |
Master URL |
--token <token> |
Agent 认证令牌 |
--config <path> |
YAML 配置文件（优先级高于环境变量） |
--temp-dir <path> |
本地临时目录（默认 /tmp/backupx-agent） |
--insecure-tls |
跳过 TLS 校验（仅测试用） |
环境变量：BACKUPX_AGENT_MASTER、BACKUPX_AGENT_TOKEN、BACKUPX_AGENT_HEARTBEAT、BACKUPX_AGENT_POLL、BACKUPX_AGENT_TEMP_DIR、BACKUPX_AGENT_INSECURE_TLS。
backupx backint
SAP HANA Backint 协议代理，详见 SAP HANA 支持。
backupx backint -f <function> -i <input> -o <output> -p <params>
| 参数 | 说明 |
|---|---|
-f <fn> |
backup / restore / inquire / delete |
-i <path> |
输入文件 |
-o <path> |
输出文件 |
-p <path> |
参数文件 |
-u / -c / -l / -v |
接收但忽略（兼容 SAP 约定） |
backupx reset-password
直接在 SQLite 中重置管理员密码，无需重启服务。
backupx reset-password --username admin --password 'newpass123' [--config /path/to/config.yaml]
| 参数 | 说明 |
|---|---|
--username |
目标用户名（默认 admin） |
--password |
新密码（最少 8 字符，必填） |
--config |
配置文件路径（用于定位数据库文件） |