
Twikoo · 简洁安全免费的静态网站评论系统|腾讯云 CloudBase/Vercel/Docker 多端部署与使用全指南
项目仓库: https://github.com/twikoojs/twikoo
开源协议:MIT · 定位:简洁、安全、免费的静态网站评论系统 · 服务端:腾讯云 CloudBase / Vercel / Netlify / Hugging Face / Railway / Cloudflare Workers / AWS Lambda / EdgeOne / Docker / 私有服务器 · 官方文档:twikoo.js.org
1 项目简介
Twikoo 是一个简洁、安全、免费的静态网站评论系统。它支持腾讯云 CloudBase、Vercel、Netlify、Hugging Face、Railway、Cloudflare Workers、AWS Lambda、EdgeOne Makers 等平台,也可使用私有服务器作为评论后台;提供 Vercel 一键部署与 Docker 私有部署。
1.1 核心信息一览
| 项目项 | 内容 |
|---|---|
| 项目名称 | Twikoo |
| 仓库地址 | github.com/twikoojs/twikoo |
| 项目定位 | 简洁、安全、免费的静态网站评论系统 |
| 开源协议 | MIT |
| 服务端 | CloudBase / Vercel / Netlify / Railway / Cloudflare Workers / Docker / 私有服务器 |
| 官方文档 | twikoo.js.org |
| 开发栈 | pnpm monorepo(Node 26) |
1.2 适用场景
- 静态博客 / Hexo / Hugo 等站点接入评论,且希望免费或 Docker 自托管。
- 国内用户偏好腾讯云 CloudBase 一键部署。
1.3 能力边界(官方口径)
- 隐私安全:通过云函数控制敏感字段(邮箱、IP、环境配置)不泄露。
- 反垃圾:Akismet、腾讯云内容安全、人工审核模式、防 XSS、IP 频率限制。
- 本仓库为 pnpm monorepo,二次开发用
pnpm demo起本地演示(http://localhost:9820/demo.html)。
2 功能特性
- 简单:免费搭建、简单部署,各平台有图文教程。
- 易用:回复 / 点赞 / 点踩、深浅色主题、QQ 号自动补全昵称头像、粘贴图片、表情、Ctrl+Enter 快捷回复、草稿实时保存、Katex 公式、代码高亮。
- 安全:隐私字段保护、Akismet、腾讯云内容安全、人工审核、防 XSS、IP 频率限制。
- 即时通知:邮件提醒(访客和博主)、微信(Server 酱)、QQ(Qmsg 酱 / go-cqhttp)、钉钉 / 企业微信 / 飞书 / Telegram / Discord / Bark / PushDeer / WxPusher。
- 个性:自定义背景图、博主标识、通知模板、placeholder、表情列表、必填项、代码高亮主题。
- 便捷管理:内嵌管理面板(密码登录)、隐藏管理入口、从 Valine/Artalk/Disqus 导入评论。
- 多图床:云开发图床、去不图床、S.EE、兰空图床、PicList、EasyImage、Chevereto、S3 兼容存储(Cloudflare R2 / MinIO)。
3 官方界面预览
开头封面为 Twikoo 官方 Logo。README 附评论列表、评论管理、推送通知三张官方截图。
4 官方跳转链接汇总
| 类别 | 链接 | 说明 |
|---|---|---|
| 官方文档 | https://twikoo.js.org | 快速上手与部署教程 |
| 仓库主页 | https://github.com/twikoojs/twikoo | 源码 |
| 快速上手 | twikoo.js.org/quick-start | 接入教程 |
| npm | npmjs.com/package/twikoo | 客户端包 |
5 前置要求与服务器配置
5.1 软件前提
- 任选:腾讯云 CloudBase 账号、Vercel / Netlify 等 Serverless,或一台可跑 Docker 的私有服务器。
- 静态博客页面引入 Twikoo 客户端 JS。
5.2 硬件建议
- Serverless 方式无需自备服务器;Docker 自托管用普通 VPS。
5.3 端口与资源
- 服务端一个 HTTP 端口;客户端以 JS 嵌入页面。
6 方式一:CloudBase / Vercel 一键部署(推荐)
按官方快速上手在腾讯云 CloudBase 或 Vercel 一键部署评论后端,再在博客页面引入客户端并指定环境 ID。
7 方式二:Docker 私有部署
按官方文档用 Docker 私有部署评论后台;本地二次开发:
pnpm install
pnpm demo # 一键启动本地演示 http://localhost:9820/demo.html
pnpm build # 编译 packages/client/dist/twikoo.all.min.js8 配置项说明
- 环境变量配置:通知渠道(邮件、Server 酱、Qmsg 酱、pushoo 各渠道)、Akismet、腾讯云内容安全、管理密码。
- 客户端:指定环境 ID、主题、图床、表情等。
9 常用运维命令
- 自托管容器启停与日志;升级按官方文档。
10 常见故障排查
- 查官方文档 FAQ;加入官方讨论群。
11 风险与合规说明
- 许可证:MIT。
- 本文整理自官方 README,命令以官方文档最新说明为准;不包含 star 数等动态数据。