安装指南
Windows 桌面、源码构建、服务器/NAS 部署
系统要求
| 操作系统 | Windows 10/11, macOS 12+, Linux |
| 处理器 | x64 / ARM64 |
| 内存 | 4 GB+ |
| 磁盘空间 | 100 MB+ |
Windows 安装(推荐)
下载安装包,双击运行按向导完成安装。安装会写入 Program Files 并可选加入 PATH,需要管理员权限授权一次。
1
从官网下载 Windows 安装包(约 30MB)
2
双击运行安装程序,按向导完成安装(可选:将程序目录加入 PATH、安装本地 CA 到系统信任库)
3
启动 Ginkgo Backup,输入激活码完成首次激活
从源码构建
需要 Go 1.25+ 环境。适合 macOS/Linux 用户或想自定义构建的场景。
Shell
git clone https://github.com/ginkgo-backup/ginkgo.git
cd ginkgo
go build -tags oss -o ginkgo-server ./cmd/ginkgo-server
go build -tags oss -o ginkgo-cli ./cmd/ginkgo-cli开源构建使用 -tags oss,排除企业功能。Linux/macOS 想要 FUSE 挂载支持,用 CGO_ENABLED=0 构建。
Headless 模式(服务器 / NAS)
在没有图形界面的服务器或 NAS 上运行,通过 HTTP API 和 CLI 管理全部功能。
Shell
./ginkgo-server --tls-auto
# API: https://127.0.0.1:9275
# Token 首次启动自动生成,保存在 ~/.ginkgo-backup/config.json
# headless 模式自动开启 TLS首次启动会在 stdout 打印自动生成的 Token,并保存到 ~/.ginkgo-backup/config.json。监听 0.0.0.0 时建议设置 WebUI 密码(ginkgo-server --set-password YOUR_PASSWORD)。
命令行参数
启动 ginkgo-server 时可指定以下参数:
| 参数 | 默认值 | 说明 |
|---|---|---|
--port | 9275 | API 服务端口(环境变量 GINKGO_API_PORT) |
--addr | 0.0.0.0 | API 监听地址(环境变量 GINKGO_API_ADDR,默认监听所有接口) |
--open | true | 启动时自动打开浏览器 |
--debug | false | 调试模式(单进程,禁用 watchdog) |
--tls-cert | — | TLS 证书文件路径 |
--tls-key | — | TLS 私钥文件路径 |
--tls-auto | false | 自动生成本地 CA 和服务器证书(headless 模式自动开启) |
--tls-trust | false | 将本地 CA 安装到系统信任库后退出(需要管理员权限) |
--set-password | — | 设置 WebUI 访问密码后退出(监听 0.0.0.0 时推荐) |
--no-watchdog | false | 禁用看门狗自动重启 |
环境变量
环境变量会覆盖对应的命令行参数:
| 环境变量 | 说明 |
|---|---|
GINKGO_API_PORT | API 服务端口(覆盖 --port) |
GINKGO_API_ADDR | API 监听地址(覆盖 --addr,默认 0.0.0.0) |
GINKGO_TOKEN | 认证 Token(覆盖自动生成) |
GINKGO_TLS | 设为 1 启用 TLS(CLI 端,使用 --tls 等效) |
GINKGO_NO_WATCHDOG | 设为 1 禁用看门狗自动重启 |
验证安装
安装后用以下命令确认服务正常:
Shell
# 健康检查(无需认证)
curl http://127.0.0.1:9275/api/v1/health
# 列出备份源(需要 Token)
curl -H "Authorization: Bearer <TOKEN>" http://127.0.0.1:9275/api/v1/sources升级
1
停止正在运行的服务
2
用新版本替换旧的可执行文件
3
重新启动——数据库迁移会自动执行
Ginkgo 使用版本化迁移,升级是安全的,但不支持降级。