快速开始

这个指南会启动一个本地 SubBoost 实例。它包含应用服务、PostgreSQL 数据库和定时刷新侧车。

准备条件

• 已安装 Docker，并支持 Docker Compose。
• 服务器或本机有一个可持久化的磁盘目录。
• 准备好几个随机密钥，用于数据库、加密、登录会话和定时任务。

获取代码

如果你使用公开包或公开仓库，进入项目里的 local 目录：

Set-Location local
Copy-Item local.env.example .env

然后编辑 .env。

配置环境变量

最少需要设置这些值：

POSTGRES_DB=subboost
POSTGRES_USER=subboost
POSTGRES_PASSWORD=<choose-a-database-password>
DATABASE_URL=postgresql://subboost:<choose-a-database-password>@db:5432/subboost?schema=public
ENCRYPTION_KEY=<generate-a-random-key>
JWT_SECRET=<generate-a-random-key>
CRON_SECRET=<generate-a-random-key>
APP_URL=http://localhost:3000
SUBBOOST_PORT=3000

这些值不要公开。数据库备份要和 ENCRYPTION_KEY 一起保管，否则恢复后无法解密已保存的订阅内容。

启动

在 local 目录运行：

docker compose up -d

打开：

http://localhost:3000

第一次进入会看到管理员初始化页面。创建管理员后，就可以开始添加订阅。

验证是否正常

打开健康检查：

http://localhost:3000/api/health/live
http://localhost:3000/api/health/ready

如果两个接口都正常，再进入页面创建一个订阅，复制生成的 YAML 链接到客户端测试。

下一步

• 了解每个环境变量：读 配置说明。
• 准备长期运行：读 备份与恢复。
• 了解日常操作：读 订阅管理。