Skip to content

一键部署

适合新手用户。这个路径从公开镜像构建应用。

准备

  • 一台 Linux 服务器。
  • 服务器能访问 GitHub Release 和 GHCR 镜像。
  • 服务器已有 curl
  • 建议在个人局域网内部署,未TLS加密时部署在公网风险较高。

运行安装脚本

在服务器终端运行:

bash
curl -fsSL https://github.com/SubBoost/subboost/releases/latest/download/install.sh | bash

脚本会做这些事:

  • 检查 Docker 和 Docker Compose。
  • 缺少 Docker 时提示是否安装。
  • 创建安装目录,默认是 /opt/subboost
  • 生成 .env 里的数据库密码和密钥。
  • 下载 Compose 文件和镜像。
  • 安装 subboost 管理命令。
  • 启动应用。

按提示填写

安装时会询问访问地址和端口。

输入访问地址时,直接回车脚本会自动填入服务器 ip。

输入端口时,直接回车脚本会自动选择一个可用端口。

安装结束后会显示最终访问地址:

text
http(s)://<访问地址>:<端口>

创建管理员

打开安装结束时显示的访问地址。

第一次进入页面时,按提示创建管理员账号。这个账号用于管理订阅、模板和设置。

检查状态

安装完成后运行:

bash
subboost status

再做一次完整检查:

bash
subboost doctor

如果页面打不开,先看日志:

bash
subboost logs

日志会持续显示。看完后按 Ctrl+C 退出。

做第一次备份

创建管理员后,先备份一次:

bash
subboost backup

备份会保存数据库和 .env。不要只保存数据库;没有 .env 里的 ENCRYPTION_KEY,已保存的订阅内容无法解密。

常用命令

命令用途
subboost status查看运行状态和访问地址。
subboost doctor检查 Docker、配置和健康接口。
subboost logs查看运行日志,按 Ctrl+C 退出。
subboost backup备份数据库和 .env
subboost update更新到最新发布资产。
subboost restart重启服务。

下一步

SubBoost 面向在线使用、部署和维护。