Skip to content

配置说明

本地部署通过 .env 配置。建议先从 local/local.env.example 复制,再逐项修改。

必填配置

变量作用
POSTGRES_DBPostgreSQL 数据库名。
POSTGRES_USERPostgreSQL 用户名。
POSTGRES_PASSWORDPostgreSQL 密码。
DATABASE_URL应用连接数据库使用的完整连接串。
ENCRYPTION_KEY加密订阅源、节点和配置。
JWT_SECRET签发本地登录会话。
CRON_SECRET定时任务调用本地接口时使用的 bearer secret。
APP_URL用户访问应用的浏览器地址。
SUBBOOST_PORTDocker Compose 暴露到宿主机的端口。

密钥建议

  • POSTGRES_PASSWORDENCRYPTION_KEYJWT_SECRETCRON_SECRET 都使用随机值。
  • 不要把真实 .env 上传到 Git 仓库。
  • 备份数据库时同时备份 .env,尤其是 ENCRYPTION_KEY

端口和访问地址

本机试用可以使用:

text
APP_URL=http://localhost:3000
SUBBOOST_PORT=3000

如果部署到服务器并绑定域名,APP_URL 应设置为实际访问地址,例如:

text
APP_URL=https://subboost.example.com
SUBBOOST_PORT=3000

如果前面还有 Nginx、Caddy 或 Cloudflare,请确保反向代理转发到 SUBBOOST_PORT 对应的本机端口。

修改配置后

修改 .env 后重启容器:

powershell
docker compose up -d

然后检查:

text
/api/health/live
/api/health/ready

SubBoost 文档面向部署、使用和维护。