Valine-Admin: A JavaScript repository from Qj9901

Valine Admin 是 Valine 评论系统的扩展和增强，主要实现评论邮件通知、评论管理、垃圾评论过滤等功能。支持完全自定义的邮件通知模板。基于Akismet API实现准确的垃圾评论过滤。此外，使用云函数等技术解决了免费版云引擎休眠问题，支持云引擎自动唤醒，漏发邮件自动补发。兼容云淡风轻及Deserts维护的多版本Valine。

NOTE: 该项目基于LeanCloud云引擎示例代码实现，您可以自由地复制和修改。包含了一些 trick 实现资源的最大化利用，但请勿滥用免费资源。引用本说明文档及Deserts博客上的相关文章务必注明来源。

评论在线演示及相关功能测试

安装教程请以博客最新版为准。

快速部署

在Leancloud云引擎设置界面，填写代码库并保存：https://github.com/panjunwen/Valine-Admin.git

在设置页面，设置环境变量以及 Web 二级域名。

变量	示例	说明
SITE_NAME	Deserts	[必填]博客名称
SITE_URL	https://panjunwen.com	[必填]首页地址
SMTP_SERVICE	QQ	[新版支持]邮件服务提供商，支持 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
TEMPLATE_NAME	rainbow	[可选]通知邮件的模板（default和rainbow）

以上必填参数请务必正确设置。

二级域名用于评论后台管理，如https://deserts.leanapp.cn 。

切换到部署标签页，分支使用master，点击部署即可

第一次部署需要花点时间。

评论管理。访问设置的二级域名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 已经可以正常工作，更多以下是可选的进阶配置。

邮件通知模板

游客 A 评论，站长收到邮件 :

(分别为 default 与 rainbow 主题)

游客被 @ 收到的邮件 :

分别为默认主题和 rainbow 彩虹主题

垃圾评论检测

Akismet (Automattic Kismet)是应用广泛的一个垃圾留言过滤系统，其作者是大名鼎鼎的WordPress 创始人 Matt Mullenweg，Akismet也是WordPress默认安装的插件，其使用非常广泛，设计目标便是帮助博客网站来过滤留言Spam。有了Akismet之后，基本上不用担心垃圾留言的烦恼了。启用Akismet后，当博客再收到留言会自动将其提交到Akismet并与Akismet上的黑名单进行比对，如果名列该黑名单中，则该条留言会被标记为垃圾评论且不会发布。

如果你用过 WordPress 你应该有 Akismet Key；如果还没有，你可以去 AKISMET FOR DEVELOPERS 免费申请一个；如果你不需要反垃圾评论，Akismet Key 环境变量可以忽略。

为了实现较为精准的垃圾评论识别，采集的判据除了评论内容、邮件地址和网站地址外，还包括评论者的IP地址、浏览器信息等，但仅在云引擎后台使用这些数据，确保隐私和安全。

如果使用了本站最新的Valine和Valine Admin，并设置了Akismet Key，可以有效地拦截垃圾评论。被标为垃圾的评论可以在管理页面取消标注。

环境变量	示例	说明
AKISMET_KEY	xxxxxxxxxxxx	[可选]Akismet Key 用于垃圾评论检测

防止云引擎休眠

关于自动休眠的官方说法：点击查看

目前最新版的 Valine Admin 已经可以实现自唤醒，即在 LeanCloud 云引擎中定时请求 Web 应用地址防止休眠。对于夜间休眠期漏发的邮件通知，自动在次日早上补发。务必确保配置中设置了ADMIN_URL环境变量，并在第5步添加了两个云函数定时任务。

Troubleshooting

部署失败，请在评论中附图，或去Github发起Issue
邮件发送失败，确保环境变量都没问题后，重启云引擎
博主通知模板中不要出现PARENT*相关参数（请勿混用模板）
点击邮件中的链接跳转至相应评论，这一细节实现需要一点额外的代码：

<script>
    if(window.location.hash){
        var checkExist = setInterval(function() {
           if ($(window.location.hash).length) {
              $('html, body').animate({scrollTop: $(window.location.hash).offset().top-90}, 1000);
              clearInterval(checkExist);
           }
        }, 100);
    }
</script>

自定义邮件服务器地址和端口信息，删除SMTP_SERVICE环境变量，新增以下变量：

变量	示例	说明
SMTP_HOST	smtp.qq.com	[可选]SMTP_SERVICE留空时，自定义SMTP服务器地址
SMTP_PORT	465	[可选]SMTP_SERVICE留空时，自定义SMTP端口
SMTP_SECURE	true	[可选]SMTP_SERVICE留空时填写

开发者文档

以下内容仅用于 LeanEngine 开发，普通用户无需理会

首先确认本机已经安装 Node.js 运行环境和 LeanCloud 命令行工具，然后执行下列指令：

$ git clone https://github.com/panjunwen/ValineAdmin.git
$ cd ValineAdmin

安装依赖：

npm install

登录并关联应用：

lean login
lean switch

启动项目：

lean up

之后你就可以在 localhost:3000 访问到你的应用了。

部署到预备环境（若无预备环境则直接部署到生产环境）：

lean deploy

License

MIT License

Qj9901/Valine-Admin