fix: 更新文档链接和说明，调整评论管理界面样式
This commit is contained in:
anghunk
@@ -34,12 +34,16 @@ npm install
|
||||
```bash
|
||||
npx wrangler login
|
||||
```
|
||||
|
||||
* **创建数据库和数据库表**，如果遇到提示，请按回车继续
|
||||
|
||||
```bash
|
||||
npx wrangler d1 create CWD_DB
|
||||
npx wrangler d1 execute CWD_DB --remote --file=./schemas/comment.sql
|
||||
```
|
||||
|
||||
运行完成后可以确认一下 `wrangler.jsonc` 中是否有如下配置
|
||||
|
||||
```jsonc
|
||||
"d1_databases": [
|
||||
{
|
||||
@@ -49,13 +53,17 @@ npm install
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
如果`binding`字段不是`CWD_DB`，请修改为`CWD_DB`
|
||||
|
||||
* **创建 KV 存储**，如果遇到提示，按回车继续
|
||||
|
||||
```bash
|
||||
npx wrangler kv namespace create CWD_AUTH_KV
|
||||
```
|
||||
|
||||
运行完成后可以确认一下 `wrangler.jsonc` 中是否有如下配置
|
||||
|
||||
```jsonc
|
||||
"kv_namespaces": [
|
||||
{
|
||||
@@ -64,12 +72,14 @@ npm install
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
* **部署上线**
|
||||
|
||||
```bash
|
||||
npm run deploy
|
||||
```
|
||||
|
||||
没有异常报错后，可以进入Cloudflare Workers 面板查看是否部署成功，若显示存在一个名称为 `cwd-backend-worker` 的项目即推送成功。
|
||||
没有异常报错后，可以进入 Cloudflare Workers 面板查看是否部署成功，若显示存在一个名称为 `cwd-comments-api` 的项目即推送成功。
|
||||
|
||||
#### 3. 配置环境变量
|
||||
|
||||
@@ -79,30 +89,36 @@ npm install
|
||||
|
||||
#### 4. 检测部署情况
|
||||
|
||||
部署成功后回得到一个域名，即为后端的域名（格式一般为`https://cwd-backend-worker.xxx.workers.dev`。访问该域名，如果显示后端管理页面并可以正常登录则部署成功，将此域名填写到博客的配置文件中即可使用评论功能。
|
||||
部署成功后回得到一个域名，即为后端的域名（格式一般为`https://cwd-comments-api.xxx.workers.dev`。访问该域名，如果显示部署成功页面，说明 API 部署成功，可以到管理后台进行登录。
|
||||
|
||||
当然也可以使用自定义域名，注意不要使用三级域名，即`*.*.example.com`。
|
||||
当然也可以使用自定义域名。
|
||||
|
||||
## 环境变量
|
||||
|
||||
所需环境变量如下表所示，请参考源码中 `.dev.vars.example` 文件
|
||||
所需环境变量如下表所示。
|
||||
|
||||
| 变量名 | 描述 |
|
||||
| -------------------- | ------------------------------------------------------------------------------------ |
|
||||
| `CF_FROM_EMAIL` | 作为发件人显示的邮箱地址（需在 Cloudflare Email 路由中预先配置） |
|
||||
| `EMAIL_ADDRESS` | 管理员接收通知邮件的默认邮箱（可在后台设置中覆盖） |
|
||||
| `ADMIN_NAME` | 管理员登录名称，默认为 admin |
|
||||
| `ADMIN_PASSWORD` | 管理员登录密码，默认密码为 password |
|
||||
| 变量名 | 描述 |
|
||||
| ---------------- | ---------------------------------------------------------------- |
|
||||
| `ADMIN_NAME` | 管理员登录名称 |
|
||||
| `ADMIN_PASSWORD` | 管理员登录密码 |
|
||||
| `CF_FROM_EMAIL` | 作为发件人显示的邮箱地址（需在 Cloudflare Email 路由中预先配置） |
|
||||
| `EMAIL_ADDRESS` | 管理员接收通知邮件的默认邮箱（可在后台设置中覆盖） |
|
||||
|
||||
**注:** 需要在 Cloudflare 控制面板中为 Email 路由开启发送权限并配置发件人域和地址，并在 `wrangler.jsonc` 中为 Worker 添加 `send_email` 绑定，以便在代码中通过 `env.SEND_EMAIL.send()` 直接发信。
|
||||
**注：** 需要在 Cloudflare 控制面板中为 Email 路由开启发送权限并配置发件人域和地址，并在 `wrangler.jsonc` 中为 Worker 添加 `send_email` 绑定，以便在代码中通过 `env.SEND_EMAIL.send()` 直接发信。
|
||||
|
||||
## 发信设置
|
||||
|
||||
## 本地测试
|
||||
手动在 `wrangler.jsonc` 中添加 `send_email` 绑定，以便在代码中通过 `env.SEND_EMAIL.send()` 直接发信。
|
||||
|
||||
如果需要本地测试，环境变量可以使用 `.dev.vars` 文件来设置
|
||||
|
||||
```bash
|
||||
cp .dev.vars.example .dev.vars
|
||||
# 编辑 .dev.vars 文件
|
||||
npm run dev
|
||||
```jsonc
|
||||
{
|
||||
...
|
||||
"send_email": [
|
||||
{
|
||||
"name": "SEND_EMAIL",
|
||||
"destination_address": "hi@zishu.me"
|
||||
}
|
||||
],
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
@@ -16,8 +16,8 @@
|
||||
<script>
|
||||
const comments = new CWDComments({
|
||||
el: '#comments', // 容器 id
|
||||
apiBaseUrl: 'https://your-api.example.com', // 你部署的api地址
|
||||
postSlug: 'my-post', // 当前页面路径，可使用博客程序支持的 url 模板路径
|
||||
apiBaseUrl: 'https://your-api.example.com', // 你部署的 api 地址
|
||||
postSlug: 'https://example.com/my-post', // 当前页面路径，可使用博客程序支持的 url 模板路径，或者直接使用 window.location.origin
|
||||
});
|
||||
comments.mount();
|
||||
</script>
|
||||
|
||||
@@ -1,16 +1,21 @@
|
||||
# 快速开始
|
||||
> [!WARNING]
|
||||
> 目前仍处于 Beta 测试阶段，欢迎反馈测试结果。
|
||||
|
||||
## 简介
|
||||
# cwd-comments
|
||||
|
||||
CWD 评论系统是一个基于 Cloudflare Workers 的轻量级评论解决方案，使用 Hono 框架构建，数据存储使用 Cloudflare D1（SQLite）和 KV。
|
||||
Cloudflare Worker 版本基于 Cloudflare Workers + D1 + KV 实现，无需服务器即可部署运行的评论组件。
|
||||
|
||||
[文档地址](https://cwd-comments-docs.zishu.me)
|
||||
|
||||
## 特性
|
||||
|
||||
- ⚡️ **极速响应**：基于 Cloudflare 全球边缘网络
|
||||
- 🔒 **安全可靠**：内置管理员认证、CORS 保护
|
||||
- 📧 **邮件通知**：支持 Resend 邮件服务
|
||||
- 🎨 **易于集成**：提供完整的 REST API
|
||||
|
||||
**开发中：**
|
||||
- [ ]📧 **邮件通知**：基于 Cloudflare Workers 发送邮件
|
||||
|
||||
## 前置要求
|
||||
|
||||
- Node.js 16+
|
||||
@@ -22,13 +27,18 @@ CWD 评论系统是一个基于 Cloudflare Workers 的轻量级评论解决方
|
||||
```bash
|
||||
# 克隆项目
|
||||
git clone https://github.com/anghunk/cwd-comments
|
||||
cd cwd-comments
|
||||
|
||||
# 安装依赖
|
||||
# API 项目
|
||||
cd cwd-comments-api
|
||||
# 部署请查看文档
|
||||
|
||||
# 前端项目
|
||||
cd cwd-comments-web
|
||||
npm install
|
||||
|
||||
```
|
||||
|
||||
## 配置
|
||||
|
||||
- [后端配置](./backend-config.md)
|
||||
- [前端配置](./frontend-config.md)
|
||||
- [后端配置](https://cwd-comments-docs.zishu.me/guide/backend-config.html)
|
||||
- [前端配置](https://cwd-comments-docs.zishu.me/guide/frontend-config.html)
|
||||
|
||||
Reference in New Issue
Block a user