Twikoo 使用指南

从零开始,把评论功能接到自己的静态站点上。

← 返回评论主页

一、设置管理员密码

Twikoo 的评论后台是「自举」的:第一次进入时由你自己设定管理员密码,平台上没有默认账号。

  1. 回到评论主页,找到评论组件。
  2. 点评论框右上角的齿轮图标,弹出「Twikoo 评论管理」。
  3. 输入两次相同的密码,点「注册」,即成为管理员。
  4. 之后再用齿轮图标进入,输入该密码登录管理面板。
密码只保存在本应用的数据库里,忘记后需要重置。若不想让别人看到管理入口,可在 「配置管理 → 通用」里设置 HIDE_ADMIN_CRYPT(管理面板入口暗号), 设置后只有在「昵称」里输入该暗号,齿轮图标才会出现。

二、把评论接到静态站点

Twikoo 采用「后端 + 前端组件」的结构:本应用就是后端,前端是官方提供的 twikoo.min.js。在你的页面里加上这三段即可:

<div id="tcomment"></div>
<script src="本应用地址/twikoo.min.js"></script>
<script>
  twikoo.init({
    envId: "本应用地址/api/",
    el: "#tcomment",
    lang: "zh-CN"
  });
</script>

把 本应用地址 换成你在浏览器里打开本应用时看到的地址即可(主页上已经帮你拼好这段代码,直接复制更省事)。

常见问题

  • 评论不显示:先确认 envId 结尾带 /api/,并且该地址能在浏览器里直接打开。
  • 跨域报错:如果你的站点与本应用不是同一个域名,在「配置管理 → 通用」的 CORS_ALLOW_ORIGIN 里填上你站点的地址(多个用英文逗号分隔)。
  • 表情加载不出来:本应用已内置表情包,无需外网;若你在 EMOTION_CDN 里改过地址,改回默认即可。

三、公网站点要用这些评论,先把本应用发布到公网

Twikoo 是「后端 + 前端组件」的结构:后端就是本应用。访客打开你的静态站点时, 浏览器会直接从访客的浏览器请求本应用的 /api/,所以 本应用必须能被互联网访问到——只在局域网里、或只在懒猫客户端里能打开是不够的。

怎么做

  1. 给本应用配一条公网通道:用懒猫微服的公网访问 / 端口转发功能,或在你的 VPS 上做一层反向代理, 把公开域名指到本应用(至少覆盖 /api/、twikoo.min.js、twikoo.css、owo.json)。 必须是 HTTPS:静态站点如果是 https,浏览器会拦掉 http 的评论请求。
  2. 拿到公网地址后,回到评论主页,在「公网访问地址」输入框里填它, 生成的嵌入代码就会自动换成公网地址,复制粘贴即可。
  3. 若代码里还是形如 https://twikoo.<你的微服>.heiyu.space 的私网名字, 公网访客解析不到、评论必然加载失败 —— 请务必换成公网地址。
跨域:实测本应用默认允许跨域调用(响应会带上请求来源的 Access-Control-Allow-Origin)。若要收紧,在「配置管理 → 通用 → CORS 安全域名」里填你的站点地址 (多个用英文逗号分隔),之后只放行这些来源。

只在内网站点用?

那就不需要公网,直接使用当前打开的地址即可;此时公网访客访问不到评论,属于预期行为。

四、管理面板能做什么

页面用途
评论管理查看、搜索、置顶、隐藏、删除评论;支持按「全部 / 只看可见 / 只看隐藏」筛选。
配置管理评论显示项、排序方式、头像与表情源、CORS 安全域名、违禁词与屏蔽词等。
导入 / 导出把评论导出成 JSON 备份,或从其他 Twikoo 站点导入既有评论。
面板里右侧有一列操作按钮:搜索、刷新、齿轮(进入管理)、其他设置。保存配置后立即生效,无需重启应用。

五、数据与备份

  • 所有评论与配置都存放在本应用的持久化目录 /lzcapp/var 下,升级应用不会丢失。
  • 数据库是内置的文件型数据库,不需要你另外准备 MySQL / PostgreSQL。
  • 建议定期在「导入 / 导出」页导出一次评论 JSON 作为冷备份。