docs: 更新文档内容和导航配置

- 在导航栏添加管理后台链接
- 更新数据迁移文档中的路径描述和域名前缀说明
- 完善安全设置文档,添加管理员密钥验证细节和风控机制
- 新增邮件通知配置文档,包含SMTP设置和模板变量
- 重构管理后台文档,移除重复内容并添加多站点管理说明
- 修正环境变量表格的格式问题
This commit is contained in:
anghunk
2026-01-22 14:58:45 +08:00
parent cb2b15c5f6
commit 849f0837eb
5 changed files with 70 additions and 65 deletions

View File

@@ -2,6 +2,10 @@
管理后台用于审核评论、删除评论和管理评论设置。
## 域名筛选(多站点管理)
管理后台顶部导航栏提供了全局域名下拉选择器,用于在多域名站点之间切换数据视图。
## 设置
### 头像服务前缀
@@ -18,13 +22,7 @@
开启是否显示博主标签,配置博主邮箱和标签文字,即可在评论中显示博主标签;关闭为不显示。
### 管理员评论密钥
设置管理员评论密钥后,博主在前台发布评论时需要输入此密钥进行身份验证,评论将被直接通过,不受"先审核再显示"设置的影响。
**注意**
- 同一 IP 连续验证失败 3 次后,该 IP 将被锁定 30 分钟
- 失败次数记录有效期为 1 小时
### 评论置顶
@@ -35,53 +33,6 @@
置顶后的评论会在前台评论列表中优先显示。
### 邮件通知配置
在设置页面可以配置邮件通知功能,包括:
#### 全局开关
控制是否启用邮件通知功能。
#### SMTP 配置
| 字段 | 说明 | 示例 |
| ------- | -------------------------------- | ----------------- |
| 主机 | SMTP 服务器地址 | `smtp.qq.com` |
| 端口 | SMTP 服务器端口 | `465` |
| 用户名 | 发件邮箱 | `noreply@qq.com` |
| 密码 | 邮箱密码或授权码 | `your_password` |
| 安全连接 | 是否使用 SSL/TLS | `true` |
#### 邮件模板
支持自定义 HTML 邮件模板,包含以下变量:
**回复评论模板变量**
| 变量名 | 说明 |
| ----------------- | ------------ |
| `${toEmail}` | 收件人邮箱 |
| `${toName}` | 收件人昵称 |
| `${postTitle}` | 文章标题 |
| `${parentComment}` | 被回复的评论内容 |
| `${replyAuthor}` | 回复者昵称 |
| `${replyContent}` | 回复内容 |
| `${postUrl}` | 文章链接 |
**新评论通知模板变量**
| 变量名 | 说明 |
| ----------------- | ------------ |
| `${postTitle}` | 文章标题 |
| `${postUrl}` | 文章链接 |
| `${commentAuthor}` | 评论者昵称 |
| `${commentContent}` | 评论内容 |
#### 测试邮件
配置完成后,可以使用"测试邮件"功能发送一封测试邮件到指定邮箱,验证配置是否正确。
## 使用官方管理后台
使用官方提供的管理后台最新版本https://cwd.zishu.me
@@ -92,7 +43,7 @@
支持单条评论的修改,包括状态、内容等。
> [!WARNING]
> [!WARNING]
> 如若批量修改评论信息,请前往 Cloudflare D1 SQL 控制台执行 SQL 语句。
>
> 高危操作,请保证你熟悉 SQL 语句,避免对评论数据造成不可逆的损失。建议使用前先导出评论数据备份。
@@ -137,11 +88,11 @@ cp .env.example .env
每个环境文件中可配置以下变量:
| 变量名 | 说明 | 示例 |
| --------------------- | ----------------------------------------------- | ----------------------------------- |
| 变量名 | 说明 | 示例 |
| --------------------- | ----------------------------------------------- | -------------------------- |
| `VITE_API_BASE_URL` | 后端 API 地址Cloudflare Worker 域名或自定义) | `https://cwd-api.test.com` |
| `VITE_ADMIN_NAME` | 登录页默认管理员账号占位值 | `admin@example.com` |
| `VITE_ADMIN_PASSWORD` | 登录页默认密码占位值 | `123456` |
| `VITE_ADMIN_NAME` | 登录页默认管理员账号占位值 | `admin@example.com` |
| `VITE_ADMIN_PASSWORD` | 登录页默认密码占位值 | `123456` |
说明: