后端配置
部署条件
- 拥有一个 Cloudflare 账号(使用邮箱即可注册,官网地址)
- 拥有一个 Node.js 运行环境,版本 >= 22(本地部署需要)
- 拥有一个域名并托管在 Cloudflare 上(这个不是必须项,但可以提高国内访问速度,也更方便)
后端项目目录为 /cwd-api,基于 Cloudflare Workers + D1 + KV 实现。
自部署
以下部署指令均在该目录下执行,不在根目录下
cd cwd-api本地部署
1. 下载代码,安装依赖
可以直接克隆仓库代码
npm install2. 配置 Cloudflare Workers
对于 D1 和 KV 配置,有两种方法,第一种是直接使用命令行配置,第二种是使用网页面板创建后填写配置文件,这里推荐使用第一种方法。如果想要使用之前 Cloudflare 上面已经创建的数据库,可以选择自行配置 wrangler.jsonc 文件。
下面介绍第一种方法。
登录到 Cloudflare
bashnpx wrangler login创建数据库和数据库表,如果遇到提示,请按回车继续
bashnpx wrangler d1 create CWD_DB npx wrangler d1 execute CWD_DB --remote --file=./schemas/comment.sql运行完成后可以确认一下
wrangler.jsonc中是否有如下配置jsonc"d1_databases": [ { "binding": "CWD_DB", "database_name": "CWD_DB", "database_id": "xxxxxx" // D1 数据库 ID } ]如果
binding字段不是CWD_DB,请修改为CWD_DB。创建 KV 存储,如果遇到提示,按回车继续
bashnpx wrangler kv namespace create CWD_AUTH_KV运行完成后可以确认一下
wrangler.jsonc中是否有如下配置jsonc"kv_namespaces": [ { "binding": "CWD_AUTH_KV", "id": "xxxxxxx" // KV 存储 ID } ]部署上线
bashnpm run deploy
没有异常报错后,可以进入 Cloudflare Workers 面板查看是否部署成功,若显示存在一个名称为 cwd-api 的项目即推送成功。
3. 配置环境变量
- 登录 Worker 面板,点击项目右侧的 Settings (设置) 选项卡,选择
查看设置 - 点击变量和机密右侧的添加按钮,给项目添加环境变量,环境变量 参考
- 部署生效:点击底部的 Save and deploy (保存并部署)。
4. 检测部署情况
部署成功后回得到一个域名,即为后端的域名(格式一般为https://cwd-api.xxx.workers.dev。访问该域名,如果显示部署成功页面,说明 API 部署成功,可以到管理后台进行登录,当然也可以使用自定义域名。
可以直接访问域名,确认是否部署成功。如果成功,则会显示
CWD 评论部署成功,当前版本...环境变量与绑定
后端通过 Cloudflare Worker 的绑定和环境变量控制行为,类型定义见 cwd-api/src/bindings.ts.
所需环境变量如下表所示。
| 名称 | 类型 | 描述 |
|---|---|---|
ADMIN_NAME | string | 管理员登录名称 |
ADMIN_PASSWORD | string | 管理员登录密码 |
在 Cloudflare 控制台中配置方式:
- 打开 Worker 项目 ->
Settings->Variables - 在
Environment Variables中添加ADMIN_NAME、ADMIN_PASSWORD等变量 - 在
D1 Databases中绑定CWD_DB(默认已配置好) - 在
KV Namespaces中绑定CWD_AUTH_KV(默认已配置好)