Hexo框架(十六):Valine评论系统配置邮件提醒功能
next 主题集成了很多评论系统,Disqus、友言、畅言、Valine(基于 Leancloud)、Gitment、Gitalk 等。不过 Disqus 是韩国的,虽说国内是能有的不过有时候还是会莫名其妙像被墙起来了一样,友言和畅言已经停止维护,Next 在 7.2 版本也把 Gitment 移除支持了,不过 Gitalk 和 Gitment 比较类似,都是基于 GitHub 的 Issue 实现的。Gitalk 评论虽然最符合程序员的喜好,毕竟基于 GitHub 的 Issue,可以自由改动、打 Tag 等,但是缺点就是必须登录 GitHub 账号,有时候有些小问题就显得麻烦了所以我最后选择了 valine,免登陆,而且免费!
不过我很早就配置了这个评论功能,配置起来也很简单,但是这里还是简单的说一下吧。
我现在的 next 主题版本已经更新到了 7.8.0
注册 Valine
注册 valine 及配置,你可以参考:Next 主题配置与美化 第三部分中的第 10 条。总体来说十分简单。
值得注意的是,如果你和我一样采用的是数据文件的方式,只需要把该文中的主题配置文件换成 next.yml 就好。你可以参考:博客主题持续更新的问题
当然我也更加推荐使用数据文件的方式来进行配置。
Valine 的一些样式修改
这里贴一下,我修改过的一些样式,让评论区看起来更加整洁。我所有的自定义样式都放置于hexo/source/_data/style.styl
文件中
1 | // 隐藏 valine 的 powered by |
记得要在 next.yml 或是主题配置文件中取消掉custom_file_path
的注释:
1 | custom_file_path: |
注意:隐藏 valine 的 powered by 样式已经发生了变化(2020.4.12),现在应该修正为:
1 | // 隐藏 valine 的 powered by |
配置邮件提醒功能
基础设置
- 在 设置》安全中心》服务开关中,关闭除了数据存储外的所有功能,并在下方 web 安全域名中添加好你的域名:
- 在
主题配置文件中
,我们需要关闭掉自带的邮件提醒服务:
1 | valine: |
顺便提一句,因为主题自带的 CDN 很慢,你可以在主题配置文件中使用第三方 CDN:
1 | vendors: |
配置 Valine Admin
Valine Admin 是 Valine 评论系统的扩展和增强,主要实现评论邮件通知、评论管理、垃圾评论过滤等功能。支持完全自定义的邮件通知模板。基于 Akismet API 实现准确的垃圾评论过滤。此外,使用云函数等技术解决了免费版云引擎休眠问题,支持云引擎自动唤醒,漏发邮件自动补发。兼容云淡风轻及 Deserts 维护的多版本 Valine。
云引擎”一键”部署
- 在Leancloud云引擎设置界面,填写代码库并保存:https://github.com/DesertsP/Valine-Admin.git
- 在设置页面,设置环境变量以及 Web 二级域名。
变量 | 示例 | 说明 |
---|---|---|
SITE_NAME | Deserts | [必填]博客名称 |
SITE_URL | https://blog.juanertu.com | [必填]首页地址 |
SMTP_SERVICE | [新版支持]邮件服务提供商,支持 QQ、163、126、Gmail 以及 更多 | |
SMTP_USER | xxxxxx@qq.com | [必填]SMTP 登录用户 |
SMTP_PASS | ccxxxxxxxxch | [必填]SMTP 登录密码(QQ 邮箱需要获取独立密码) |
SENDER_NAME | Deserts | [必填]发件人 |
SENDER_EMAIL | xxxxxx@qq.com | [必填]发件邮箱 |
ADMIN_URL | https://xxx.leanapp.cn/ | [建议]Web 主机二级域名,用于自动唤醒 |
BLOGGER_EMAIL | xxxxx@gmail.com | [可选]博主通知收件地址,默认使用 SENDER_EMAIL |
AKISMET_KEY | xxxxxxxxxxxx | [可选]Akismet Key 用于垃圾评论检测,设为 MANUAL_REVIEW 开启人工审核,留空不使用反垃圾 |
以上必填参数请务必正确设置。
二级域名用于评论后台管理,如https://XXX.leanapp.cn 。
- 切换到部署标签页,分支使用 master,点击部署即可
第一次部署需要花点时间。
评论管理。访问设置的二级域名
1
https://二级域名.leanapp.cn/sign-up
,注册管理员登录信息,如:
https://deserts.leanapp.cn/sign-up
注:使用原版 Valine 如果遇到注册页面不显示直接跳转至登录页的情况,请手动删除_User 表中的全部数据。
此后,可以通过https://二级域名.leanapp.cn/
管理评论。
- 定时任务设置
目前实现了两种云函数定时任务:
- (1)自动唤醒,定时访问 Web APP 二级域名防止云引擎休眠;.
- (2)每天定时检查 24 小时内漏发的邮件通知。
进入云引擎-定时任务中,创建定时器,创建两个定时任务。
选择self-wake
云函数,Cron 表达式为0 0/30 7-23 * * ?
,表示每天早 6 点到晚 23 点每隔 30 分钟访问云引擎,ADMIN_URL
环境变量务必设置正确:
选择resend-mails
云函数,Cron 表达式为0 0 8 * * ?
,表示每天早 8 点检查过去 24 小时内漏发的通知邮件并补发:
添加定时器后记得点击启动方可生效。
至此,Valine Admin 已经可以正常工作,更多以下是可选的进阶配置。
邮件通知模板
邮件通知模板在云引擎环境变量中设定,可自定义通知邮件标题及内容模板。
环境变量 | 示例 | 说明 |
---|---|---|
MAIL_SUBJECT | ${PARENT_NICK},您在${SITE_NAME}上的评论收到了回复 | [可选]@通知邮件主题(标题)模板 |
MAIL_TEMPLATE | 见下文 | [可选]@通知邮件内容模板 |
MAIL_SUBJECT_ADMIN | ${SITE_NAME}上有新评论了 | [可选]博主邮件通知主题模板 |
MAIL_TEMPLATE_ADMIN | 见下文 | [可选]博主邮件通知内容模板 |
邮件通知包含两种,分别是被@通知和博主通知,这两种模板都可以完全自定义。默认使用经典的蓝色风格模板(样式来源未知)。
默认被@通知邮件内容模板如下:
1 | <div |
效果如下图:
@通知模板中的可用变量如下(注,这是邮件模板变量,是指嵌入到 HTML 邮件模板中的变量,请勿与云引擎环境变量混淆):
模板变量 | 说明 |
---|---|
SITE_NAME | 博客名称 |
SITE_URL | 博客首页地址 |
POST_URL | 文章地址(完整路径) |
PARENT_NICK | 收件人昵称(被@者,父级评论人) |
PARENT_COMMENT | 父级评论内容 |
NICK | 新评论者昵称 |
COMMENT | 新评论内容 |
默认博主通知邮件内容模板如下:
1 | <div style="border-top:2px solid #12ADDB;box-shadow:0 1px 3px #AAAAAA;line-height:180%;padding:0 15px 12px;margin:50px auto;font-size:12px;"><h2 style="border-bottom:1px solid #DDD;font-size:14px;font-weight:normal;padding:13px 0 10px 8px;">您在<a style="text-decoration:none;color: #12ADDB;" href="${SITE_URL}" target="_blank">${SITE_NAME}</a>上的文章有了新的评论</h2><p><strong>${NICK}</strong>回复说:</p><div style="background-color: #f5f5f5;padding: 10px 15px;margin:18px 0;word-wrap:break-word;"> ${COMMENT}</div><p>您可以点击<a style="text-decoration:none; color:#12addb" href="${POST_URL}" target="_blank">查看回复的完整內容</a><br></p></div></div> |
博主通知邮件模板中的可用变量与@通知中的基本一致,**PARENT_NICK
和 PARENT_COMMENT
变量不再可用。**
这里还提供一个彩虹风格的@通知邮件模板代码:
1 | <div |
效果如图:
垃圾评论检测
Akismet (Automattic Kismet)是应用广泛的一个垃圾留言过滤系统,其作者是大名鼎鼎的 WordPress 创始人 Matt Mullenweg,Akismet 也是 WordPress 默认安装的插件,其使用非常广泛,设计目标便是帮助博客网站来过滤留言 Spam。有了 Akismet 之后,基本上不用担心垃圾留言的烦恼了。
启用 Akismet 后,当博客再收到留言会自动将其提交到 Akismet 并与 Akismet 上的黑名单进行比对,如果名列该黑名单中,则该条留言会被标记为垃圾评论且不会发布。
如果还没有 Akismet Key,你可以去 AKISMET FOR DEVELOPERS 免费申请一个;
当 AKISMET_KEY 设为 MANUAL_REVIEW 时,开启人工审核模式;
如果你不需要反垃圾评论,Akismet Key 环境变量可以忽略。
为了实现较为精准的垃圾评论识别,采集的判据除了评论内容、邮件地址和网站地址外,还包括评论者的 IP 地址、浏览器信息等,但仅在云引擎后台使用这些数据,确保隐私和安全。
如果使用了本站最新的 Valine 和 Valine Admin,并设置了 Akismet Key,可以有效地拦截垃圾评论。被标为垃圾的评论可以在管理页面取消标注。
环境变量 | 示例 | 说明 |
---|---|---|
AKISMET_KEY | xxxxxxxxxxxx | [可选]Akismet Key 用于垃圾评论检测 |
防止云引擎休眠
关于自动休眠的官方说法:点击查看
目前最新版的 Valine Admin 已经可以实现自唤醒,即在 LeanCloud 云引擎中定时请求 Web 应用地址防止休眠。对于夜间休眠期漏发的邮件通知,自动在次日早上补发。务必确保配置中设置了 ADMIN_URL 环境变量,并在第 5 步添加了两个云函数定时任务。
Troubleshooting
部署失败,请在评论中附图,或去 Github 发起 Issue
邮件发送失败,确保环境变量都没问题后,重启云引擎
博主通知模板中不要出现
PARENT*
相关参数(请勿混用模板)点击邮件中的链接跳转至相应评论,这一细节实现需要一点额外的代码:
1 | <script> |
- 自定义邮件服务器地址和端口信息,删除 SMTP_SERVICE 环境变量,新增以下变量:
变量 | 示例 | 说明 |
---|---|---|
SMTP_HOST | smtp.qq.com | [可选]SMTP_SERVICE 留空时,自定义 SMTP 服务器地址 |
SMTP_PORT | 465 | [可选]SMTP_SERVICE 留空时,自定义 SMTP 端口 |
SMTP_SECURE | true | [可选]SMTP_SERVICE 留空时填写 |
- 这是我的环境变量配置。
可能遇到的一些问题
部署失败
这种情况是 node 的问题,你需要把项目 fork 到自己的仓库,并且修改package.json
1 | "engines": { |
修改为:
1 | "engines": { |
然后把代码库改为你 fork 下来的仓库即可。
目前作者好像已经修复了这个问题。(2020.4.26)
邮件发送失败
可能是被判定为垃圾邮件被拒收了。我最开始使用的 126 邮箱,刚刚开始还可以,后面发送邮件全部被拒,查了一下,是因为被判定为垃圾邮件了,我就换成了 outlook 邮箱。具体的失败信息,可以查看 云引擎》应用日志 。在日志中可以查看失败的具体原因。