mirror of
https://github.com/Awuqing/BackupX.git
synced 2026-05-12 02:20:36 +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/
70 lines
2.1 KiB
Markdown
70 lines
2.1 KiB
Markdown
---
|
|
sidebar_position: 2
|
|
title: CLI Reference
|
|
description: backupx subcommands — server, agent, backint, reset-password.
|
|
---
|
|
|
|
# CLI Reference
|
|
|
|
The `backupx` binary ships several subcommands. Running `backupx` with no subcommand starts the main server process.
|
|
|
|
## `backupx` (default: server)
|
|
|
|
```bash
|
|
backupx --config /opt/backupx/config.yaml
|
|
backupx --version
|
|
```
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--config <path>` | Path to config YAML (default: `./config.yaml`) |
|
|
| `--version` | Print version and exit |
|
|
|
|
## `backupx agent`
|
|
|
|
Run in Agent mode, connecting to a Master. See [Multi-Node Cluster](../features/multi-node).
|
|
|
|
```bash
|
|
backupx agent --master http://master:8340 --token <token>
|
|
```
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--master <url>` | Master URL |
|
|
| `--token <token>` | Agent auth token |
|
|
| `--config <path>` | YAML config (takes precedence over env) |
|
|
| `--temp-dir <path>` | Local temp directory (default `/tmp/backupx-agent`) |
|
|
| `--insecure-tls` | Skip TLS verification (testing only) |
|
|
|
|
Environment variables: `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 protocol agent. See [SAP HANA Support](../features/sap-hana).
|
|
|
|
```bash
|
|
backupx backint -f <function> -i <input> -o <output> -p <params>
|
|
```
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `-f <fn>` | `backup` / `restore` / `inquire` / `delete` |
|
|
| `-i <path>` | Input file |
|
|
| `-o <path>` | Output file |
|
|
| `-p <path>` | Parameter file |
|
|
| `-u / -c / -l / -v` | Accepted and ignored for SAP compatibility |
|
|
|
|
## `backupx reset-password`
|
|
|
|
Reset an admin password directly in the SQLite database. No server restart needed.
|
|
|
|
```bash
|
|
backupx reset-password --username admin --password 'newpass123' [--config /path/to/config.yaml]
|
|
```
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--username` | Target username (default: `admin`) |
|
|
| `--password` | New password (min 8 chars, required) |
|
|
| `--config` | Config path (used to locate the database file) |
|