快速开始
选择 Cloudflare 或 Docker 部署 Calends;还没有自己的账本时,按本页完成部署和首次登录。
Calends 有两种运行方式,功能相同:部署到 Cloudflare Workers,或者用 Docker 跑在自己的机器上。也可以把下面的提示词交给能操作终端的 AI 代理,让它替你完成。
一键部署:点击 GitHub 仓库 README 里的 Deploy to Cloudflare 按钮,或打开
deploy.workers.cloudflare.com。
部署完成后,还需要在 Worker 的设置里添加一个名为 SETUP_TOKEN 的密钥(Secret),否则无法设置密码。
命令行部署:
-
克隆仓库并安装依赖:
终端窗口 git clone https://github.com/imetn/calends && cd calendsnpm ci -
登录 Cloudflare:
终端窗口 npx wrangler login -
设置初始化令牌。填一串足够长的随机字符串,首次设置密码时输入一次:
终端窗口 npx wrangler secret put SETUP_TOKEN -
部署。这一步会构建前端、自动创建 D1 数据库、部署 Worker 并执行数据库迁移:
终端窗口 npm run deploy -
打开
https://<你的 worker>.workers.dev,输入初始化令牌并设置密码。
更多细节(邮件提醒、定时任务、自定义域名)见 Cloudflare Workers + D1。
docker run -d --name calends -p 8787:8787 -v calends-data:/data xizozhe/calends:latestdocker logs calends # 首次启动会打印一次性的初始化令牌打开 http://localhost:8787,输入日志里的初始化令牌并设置密码。数据以 SQLite 文件保存在 calends-data 卷里。
镜像支持 linux/amd64 和 linux/arm64,可匿名拉取;GHCR 备选为 ghcr.io/imetn/calends:latest。生产部署建议固定版本,例如 xizozhe/calends:1.4.0。Compose 配置、升级、数据目录和定时任务见 Docker。
把下面这段话发给 Claude Code、Codex、Cursor 等能操作终端的 AI 代理:
帮我部署 Calends(https://github.com/imetn/calends),一个可自托管的订阅账本。1. 先问我部署到 Cloudflare Workers(免费)还是这台机器/服务器上的 Docker。2. Cloudflare:克隆仓库,执行 npm ci,确认 `npx wrangler whoami` 正常(不行就 `npx wrangler login`), 生成一个随机的 SETUP_TOKEN 并用 `npx wrangler secret put SETUP_TOKEN` 设置,然后 `npm run deploy`。 如果我要自定义域名,部署前在 wrangler.jsonc 的 routes 里以 custom_domain 加上。3. Docker:运行官方镜像 xizozhe/calends,给 /data 挂一个命名卷,开放 8787 端口, 再从容器日志里读出初始化令牌;顺便问我要不要用 Caddy 配 HTTPS。4. 最后把应用地址和初始化令牌告诉我,并提醒我绑定 Passkey,以及在「连接」页(/connect)接入我的 AI 助手。