From 35836864a2104e2ef07372be466f1aae0bec7c69 Mon Sep 17 00:00:00 2001 From: anghunk Date: Wed, 21 Jan 2026 10:17:47 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=E5=AE=89=E5=85=A8?= =?UTF-8?q?=E8=AE=BE=E7=BD=AE=E6=96=87=E6=A1=A3=E5=B9=B6=E6=9B=B4=E6=96=B0?= =?UTF-8?q?README=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 添加安全设置功能文档，详细说明各项安全配置选项。同时更新README中的项目状态描述和功能简介，使其更准确反映当前项目阶段和特点。 --- README.md | 6 ++++-- docs/.vitepress/configs/sidebar.js | 1 + docs/function/admin-panel.md | 12 ------------ docs/function/data-migration.md | 7 ++++++- docs/function/email-reminder.md | 8 ++++++-- docs/function/security-settings.md | 21 +++++++++++++++++++++ docs/guide/getting-started.md | 8 ++++++-- docs/index.md | 19 ++++++++++++++----- 8 files changed, 58 insertions(+), 24 deletions(-) create mode 100644 docs/function/security-settings.md diff --git a/README.md b/README.md index 82f3d4c..e0016d1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ > [!WARNING] -> 目前仍处于 Beta 测试阶段，欢迎反馈测试结果。 +> ~~目前仍处于 Beta 测试阶段，欢迎反馈测试结果。~~ +> +> 目前处于内测阶段，欢迎参与测试。 # cwd-comments -Cloudflare Worker 版本基于 Cloudflare Workers + D1 + KV 实现，无需服务器即可部署运行的评论组件。 +基于 Cloudflare Workers 与全球边缘网络的免服务器、极速安全、即插即用评论系统。 [文档地址](https://cwd-comments-docs.zishu.me) diff --git a/docs/.vitepress/configs/sidebar.js b/docs/.vitepress/configs/sidebar.js index f1377fa..fdb0e1a 100644 --- a/docs/.vitepress/configs/sidebar.js +++ b/docs/.vitepress/configs/sidebar.js @@ -13,6 +13,7 @@ export default [ items: [ { text: '后台设置', link: '/function/admin-panel' }, { text: '通知邮箱', link: '/function/email-reminder' }, + { text: '安全设置', link: '/function/security-settings' }, { text: '数据迁移', link: '/function/data-migration' }, ], }, diff --git a/docs/function/admin-panel.md b/docs/function/admin-panel.md index 885c100..0ebc0fb 100644 --- a/docs/function/admin-panel.md +++ b/docs/function/admin-panel.md @@ -18,18 +18,6 @@ 开启是否显示博主标签，配置博主邮箱和标签文字，即可在评论中显示博主标签；关闭为不显示。 -### 允许调用的域名 - -多个域名用逗号分隔，留空则不限制。设置后仅匹配域名可调用前台评论组件。 - -### 管理员评论密钥 - -设置后前台使用管理员邮箱评论需输入此密钥。如果没有经过验证，无法使用管理员邮箱进行评论，进一步避免邮箱被滥用。 - -### 新评论是否审核后再显示 - -开启后新评论默认状态为待审核，需管理员审核后才会显示在评论列表中。关闭为直接显示。 - ## 使用官方管理后台 使用官方提供的管理后台（最新版本）https://cwd-comments.zishu.me。 diff --git a/docs/function/data-migration.md b/docs/function/data-migration.md index 8168238..e40372f 100644 --- a/docs/function/data-migration.md +++ b/docs/function/data-migration.md @@ -1,9 +1,14 @@ # 数据迁移 -目前支持从 Twikoo, Artalk 评论系统迁移数据。 +目前支持迁移数据的评论框架有以下，请保证导出的格式为 json 格式。 + +- **Twikoo** +- **Artalk**（如果是 .artalk 后缀，导出到本地后修改后缀为 .json 即可） 其他评论框架逐步支持，欢迎提交反馈，可以将你想要迁移进来的框架以及相关结构提交到评论区，我会尽快添加支持。 +--- + **使用方法：** `后台管理 > 数据导入`，选择你要导入框架类型，然后选择本地文件进行导入。 diff --git a/docs/function/email-reminder.md b/docs/function/email-reminder.md index 1ed3a84..4380852 100644 --- a/docs/function/email-reminder.md +++ b/docs/function/email-reminder.md @@ -1,8 +1,12 @@ # 通知邮箱 -目前接入了 QQ 邮箱提醒，后续会添加其他邮箱服务。 +目前支持进行通知的邮箱有： -### QQ 邮箱 +- QQ 邮箱 + +后续会添加其他邮箱服务，可以提交反馈。 + +## QQ 邮箱 1. 登录 QQ 邮箱，进入 `设置 > 账户` 2. 开启 `POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV 服务`，并获取授权码 diff --git a/docs/function/security-settings.md b/docs/function/security-settings.md new file mode 100644 index 0000000..3fca936 --- /dev/null +++ b/docs/function/security-settings.md @@ -0,0 +1,21 @@ +# 安全设置 + +### 管理员评论密钥 + +设置后前台使用管理员邮箱评论需输入此密钥。如果没有经过验证，无法使用管理员邮箱进行评论，进一步避免邮箱被滥用。 + +### 允许调用的域名 + +多个域名用逗号分隔，留空则不限制。设置后仅匹配域名可调用前台评论组件。 + +### 新评论是否审核后再显示 + +开启后新评论默认状态为待审核，需管理员审核后才会显示在评论列表中。关闭为直接显示。 + +### IP 黑名单 + +多个 IP 用逗号或换行分隔，留空则不限制，设置后匹配到的 IP 提交评论将被拒绝。 + +### 邮箱黑名单 + +多个邮箱用逗号或换行分隔，留空则不限制，设置后匹配到的邮箱提交评论将被拒绝。 diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 66e4fa6..7d3f56c 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -1,9 +1,13 @@ > [!WARNING] -> 目前仍处于 Beta 测试阶段，欢迎反馈测试结果。 +> ~~目前仍处于 Beta 测试阶段，欢迎反馈测试结果。~~ +> +> 目前处于内测阶段，欢迎参与测试。 # CWD 评论系统 -Cloudflare Worker 版本基于 Cloudflare Workers + D1 + KV 实现，无需服务器即可部署运行的评论组件。 + + +基于 Cloudflare Workers 与全球边缘网络的免服务器、极速安全、即插即用评论系统。 [文档地址](https://cwd-comments-docs.zishu.me) diff --git a/docs/index.md b/docs/index.md index 21130c1..227d786 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,7 +3,7 @@ layout: home hero: name: 'CWD 评论系统' - tagline: 轻量级、高性能的评论解决方案
基于 Cloudflare Workers + D1 + KV 构建 + tagline: 基于 Cloudflare Workers 与全球边缘网络的免服务器、极速安全、即插即用评论系统。 image: src: https://github.com/anghunk/cwd-comments/blob/main/icon.png?raw=true alt: 文档封面 @@ -18,15 +18,24 @@ hero: features: - icon: ⚡️ title: 极速响应 - details: 基于 Cloudflare 全球边缘网络，毫秒级响应速度 + details: 基于 Cloudflare 全球边缘网络，毫秒级响应、自动扩缩容 + - icon: 💬 + title: 完整评论能力 + details: 支持嵌套回复、分页加载、Markdown 与访客信息收集 + - icon: 🔔 + title: 邮件通知 + details: 评论与回复邮件提醒，支持多种邮箱服务商 - icon: 🔒 title: 安全可靠 - details: 内置管理员认证、CORS 保护、SQL 注入防护 + details: 管理员后台、登录鉴权、CORS 与 SQL 注入防护 - icon: 🎨 title: 易于集成 - details: 提供完整的 REST API，支持任意前端框架 + details: 一行脚本嵌入，提供完整 REST API，适配任意前端框架 + - icon: 🛠 + title: 轻松运维 + details: 一键部署到 Cloudflare Workers + D1 + KV，零服务器成本 ---