CF-SubBoost部署记录

准备工作

  1. 注册 Cloudflare 账号(免费即可)。

  2. 安装 Node.js ≥ 22.13.0(建议 24.x LTS)。

  3. 克隆仓库并安装依赖:

    git clone https://github.com/Amamiya23/subboost.git
    cd subboost
    npm ci

步骤 1:配置 Wrangler 登录

cd local
npx wrangler login

浏览器会弹出 Cloudflare 授权页,点击 Allow 完成登录。

步骤 2:创建 D1 数据库

# 创建数据库(只需执行一次)
npx wrangler d1 create subboost-db

命令会输出类似:

✅ Successfully created DB 'subboost-db'
[[d1_databases]]
database_id = "45cb5ac4-5e0f-4656-ac08-b18a8801cf89"

把 database_id 填入 local/wrangler.jsonc 的 d1_databases[0].database_id 字段。已存在的占位 ID 需要替换为你自己的。

步骤 3:应用数据库 Migration(建表)

# 应用到生产 D1
npm run db:migrate:d1:remote

或先在本地 D1 测试:

npm run db:migrate:d1:local

步骤 4:设置 Secrets

本服务需要 4 个环境变量:

Secret 用途
ENCRYPTION_KEY 加密订阅 URL、节点、配置等敏感字段
JWT_SECRET 签名管理员会话 token
CRON_SECRET 保护定时刷新 API
APP_URL 应用外部访问 URL(用于生成订阅链接,例如 https://subboost-local.<your-subdomain>.workers.dev)

全新部署(一键生成)

仓库提供了一个辅助脚本,自动生成 3 个强随机密钥并上传到 Cloudflare:

cd local
./scripts/setup-secrets.sh

脚本会提示你输入 Workers URL(其余密钥自动生成),最后打印所有值——请保存到密码管理器,未来重新部署或迁移数据时需要复用。

如果此处bash闪退了,就在文件夹用bash执行下列命令,会把subboost-secrets-backup.txt放在用户目录。

./scripts/setup-secrets.sh | tee "$HOME/subboost-secrets-backup.txt"

手动设置(可选)

如不使用脚本,可逐个交互式设置:

npx wrangler secret put ENCRYPTION_KEY
npx wrangler secret put JWT_SECRET
npx wrangler secret put CRON_SECRET
npx wrangler secret put APP_URL

生成强随机密钥:openssl rand -base64 32

步骤 5:构建并部署

npm run deploy:worker

部署成功后,输出类似:

Deployed subboost-local triggers
  https://subboost-local.<your-subdomain>.workers.dev
  schedule: */5 * * * *
  schedule: 0 3 * * * *

步骤 6:设置管理员账号

  1. 浏览器访问你的 Workers URL。
  2. 首次访问会跳转到设置页面,输入管理员用户名和密码。
  3. 设置完成后用该账号登录即可使用。

常用命令速查

cd local

# 一键生成并设置所有 secrets(全新部署)
./scripts/setup-secrets.sh

# 本地开发预览(需先 build:worker)
npm run preview:worker

# 重新构建并部署
npm run deploy:worker

# 仅构建 Worker bundle(不部署)
npm run build:worker

# 查看 D1 数据
npx wrangler d1 execute subboost-db --remote --command='SELECT * FROM LocalAdmin;'

# 应用新的 migration 到远程 D1
npm run db:migrate:d1:remote

# 查看 Worker 实时日志
npx wrangler tail

# 更新某个 secret
npx wrangler secret put ENCRYPTION_KEY

本地开发

# 从仓库根目录
npm ci
npm run dev     # Next.js 开发模式(http://127.0.0.1:3001)

常用检查:

npm run lint
npm run test:unit
npm run local:typecheck

以后找回项目

假设你把整个 D:\subboost 文件夹删除了,以后想更新版本,只需要重新执行:

cd /d git clone https://github.com/Amamiya23/subboost.git cd subboost npm ci cd local npx wrangler login

然后查询以前创建的 D1 数据库:

npx wrangler d1 list

找到:

subboost-db

复制对应的 database_id,填入新下载项目中的:

local/wrangler.jsonc

确认 Worker 名称仍是 subboost-local、数据库绑定为原来的 DB 后,便可以重新部署:

npm run deploy:worker

注意:这里不需要重新创建 D1,不需要重新初始化管理员,也不要再次运行 setup-secrets.sh。

因为原来的 Worker 密钥还保存在 Cloudflare 中,已有数据库也无需重建。