diff --git a/docs/.vitepress/configs/nav.js b/docs/.vitepress/configs/nav.js index f4e6c57..5b306c3 100644 --- a/docs/.vitepress/configs/nav.js +++ b/docs/.vitepress/configs/nav.js @@ -2,4 +2,5 @@ export default [ { text: '首页', link: '/' }, { text: '快速开始', link: '/guide/backend-config' }, { text: 'API 文档', link: '/api/overview' }, + { text: '管理后台', link: 'https://cwd.zishu.me' }, ]; diff --git a/docs/function/admin-panel.md b/docs/function/admin-panel.md index aba8103..6217958 100644 --- a/docs/function/admin-panel.md +++ b/docs/function/admin-panel.md @@ -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` | 说明： diff --git a/docs/function/data-migration.md b/docs/function/data-migration.md index e40372f..33493f2 100644 --- a/docs/function/data-migration.md +++ b/docs/function/data-migration.md @@ -11,6 +11,6 @@ **使用方法：** -`后台管理 > 数据导入`，选择你要导入框架类型，然后选择本地文件进行导入。 +`后台管理 > 数据迁移 > 数据导入`，选择你要导入的框架类型，然后选择本地文件进行导入。 -迁移程序会自动判断是否包含前缀（因部分框架默认不输出前缀），然后可以自定义前缀。 +迁移程序会自动判断是否包含域名前缀（因部分框架默认不输出域名前缀），然后可以自定义前缀。 diff --git a/docs/function/email-reminder.md b/docs/function/email-reminder.md index 4380852..99b5ee3 100644 --- a/docs/function/email-reminder.md +++ b/docs/function/email-reminder.md @@ -11,3 +11,51 @@ 1. 登录 QQ 邮箱，进入 `设置 > 账户` 2. 开启 `POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV 服务`，并获取授权码 3. 在管理后台设置中配置 QQ 邮箱账号和授权码 + + +## 邮件通知配置 + +在设置页面可以配置邮件通知功能，包括： + +### 全局开关 + +控制是否启用邮件通知功能。 + +### 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}` | 评论内容 | + +### 测试邮件 + +配置完成后，可以使用"测试邮件"功能发送一封测试邮件到指定邮箱，验证配置是否正确。 \ No newline at end of file diff --git a/docs/function/security-settings.md b/docs/function/security-settings.md index 3fca936..a174aa5 100644 --- a/docs/function/security-settings.md +++ b/docs/function/security-settings.md @@ -2,20 +2,25 @@ ### 管理员评论密钥 -设置后前台使用管理员邮箱评论需输入此密钥。如果没有经过验证，无法使用管理员邮箱进行评论，进一步避免邮箱被滥用。 +设置管理员评论密钥后，博主在前台使用管理员邮箱发表评论时，需要先输入正确的密钥进行身份验证。验证通过的评论将直接视为已审核，通过「先审核再显示」的限制；未通过验证时，无法使用管理员邮箱发表评论，从而降低管理员邮箱被他人冒用或滥用的风险。 + +**注意**： + +- 同一 IP 连续验证失败 3 次后，将触发风控并锁定该 IP 30 分钟，在此期间无法继续尝试管理员密钥验证； +- 失败次数的统计有效期为 1 小时，超过 1 小时未再尝试会自动清零。 ### 允许调用的域名 -多个域名用逗号分隔，留空则不限制。设置后仅匹配域名可调用前台评论组件。 +多个域名用逗号或换行分隔，留空表示不做限制。配置后，仅当当前访问页面的域名在列表中（或为列表中域名的子域名）时，前台评论组件才会正常加载；否则组件会提示“当前域名未获得调用授权”。 ### 新评论是否审核后再显示 -开启后新评论默认状态为待审核，需管理员审核后才会显示在评论列表中。关闭为直接显示。 +开启后，普通用户提交的新评论默认状态为“待审核”，需在后台审核通过后才会显示在评论列表和前台页面中；关闭时，新评论将在通过基础校验后直接公开展示。通过管理员密钥验证的评论不受此开关限制。 ### IP 黑名单 -多个 IP 用逗号或换行分隔，留空则不限制，设置后匹配到的 IP 提交评论将被拒绝。 +支持多个 IP，用逗号或换行分隔，留空表示不限制。匹配到的 IP 在提交评论时会被直接拒绝，并提示“当前 IP 已被限制评论”，适合用于临时封禁恶意刷评或攻击来源。 ### 邮箱黑名单 -多个邮箱用逗号或换行分隔，留空则不限制，设置后匹配到的邮箱提交评论将被拒绝。 +支持多个邮箱，用逗号或换行分隔，留空表示不限制。匹配到的邮箱在提交评论时会被直接拒绝，并提示“当前邮箱已被限制评论”，适合用于屏蔽垃圾邮箱或可疑机器人账号。