本文首发在语雀
自动同步更新至CC的部落格
本文仅作为官方文档的补充，若有错误，还望指正
Waline 评论系统部署日志
Waline - 一款从 Valine 衍生的带后端评论系统。可以将 Waline 等价成 With backend Valine.
特性 快速 真·安全 Markdown 语法支持 轻量易用 免费部署 多种部署部署方式和存储服务支持，每列选择一项多达 84 种（可以更多）部署方式任君选择 对于想免费使用的用户， Vercel + LeanCloud（国际版） 是不错的选择，不过Deta一个服务就能解决所有问题而且还快点，如果你主要面向对象为大陆用户，使用 CloudBase 部署也是个不错的选择，它在海外表现也没那么差，或者您仅使用 CloudBase 来做数据存储
Vercel + LeanCloud ，并且使用 Vercel 发送评论通知，您不必担心 LeanCloud 流控问题，并且之前使用过 Valine 或者部署过 Valine-Admin 项目的可以直接拿来用；对于评论转移，官方提供了迁移助手 供您使用，不用担心之前评论丢失的问题
Todo 微信通知
QQ 通知
Telegram 通知
Akismet
文章统计
多语言同步
自定义语言支持
登录支持
评论管理
评论删除
基于 IP 的发布评论频率限制
基于关键词的评论过滤限制
IP 黑名单
重复内容检测
CloudBase 腾讯云开发部署支持
社交登录
<font style="color:#333333;">GitHub</font> ， 未来会支持更多平台
Vercel + LeanCloud 部署 这部分请前往官方文档 查看，不过需要注意的是如果你的 GitHub 账号主邮箱是 QQ 邮箱的话建议更改为其他邮箱（毕竟他们认为QQ邮箱是垃圾邮箱）再去注册 Vercel（或者你可以选择给客服发一封邮件让他们帮忙解锁你的账号），环境变量配置部分官方文档也写了，这里不再赘述
如果您之前用过 Valine，那么关于 LeanCloud 部分你就不用做什么了，数据兼容，拿到那几个 key 即可
配置项 这个可直接参考官方文档按需进行配置即可，因为目前云开发因众所周知的原因不支持连接 Telegram 服务器，所以如果您要配置电报新评论通知，请使用 Vercel 进行配置，不过因为目前没有异步通知，加上反垃圾检测等功能，发布评论可能需要很长时间，这个我使用了 LeanCloud 来继续帮我发送通知（反正我也没什么评论，流控问题第二天补发评论也不是不可）
对于邮件通知部分，目前的设定是，对于新评论，如果博主配置了 QQ/微信/Telegram 通知中任意一种或多种，则邮件通知将会取消，而对于回复（子评论），博主和被回复者（如果填了邮箱的话）均可收到邮件通知
我目前使用的 Hexo Butterfly 主题已经从 3.5.0 beta3 版本起内置了 Waline 评论系统，如果您使用老版本主题请升级，或者根据您所用版本的 Valine 模板 pug 来照葫芦画瓢，根据官方配置进行对应修改，主题中 option 为可选配置，万一将来增加了某些配置，主题不必为此升级, bg 为主题配置项
这里注意一下 serverURL 以及环境变量里的 SITE_URL 网址最后的斜杠因为作者没做兼容，所以不要带上 / ，导致跳转不到对应评论界面
客户端脚本里可以通过 langMode.admin 这个配置自定义角标的文案,例如：
1 2 3 4 5 6 7 8 9 10 11 12 13 function waline ( const Waline = require ('@waline/client' ); new Waline ({ el : '#waline-comment' , serverURL : 'https://waline.vercel.app' , path : window .location .pathname , visitor : true , lang : location.pathname .startsWith ('/en/' ) ? 'en' : 'zh-CN' , langMode : { admin : location.pathname .startsWith ('/en/' ) ? 'Administrator' : '可爱的管理员' } }); }
对于同主题在主题配置里找到 waline 配置项相关内容
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 waline: serverURL: https://waline.ccknbc.ml avatar: monsterid bg: emojiCDN: https://cdn.jsdelivr.net/gh/GamerNoTitle/ValineCDN@master/ visitor: false option: pageSize: 10 requiredFields: mail placeholder: avatarCDN: https://sdn.geekzu.org/avatar/ langMode: admin: 博主兼管理员 nick: 昵称(选填) mail: 邮箱(必填) link: 网址(选填) sofa: 这里冷冷清清的，快来留下脚印吧！
还有就是可能有人会觉得默认邮件通知模板太单调，想和 Valine-Admin 一样切换模板，其实有这个配置的，只是目前的方法是写在环境变量中，而环境变量限制长度（大小），或者说是不适合这种方式配置，如果要改的话可以先查看 issues/106 相关内容，或者等以后优化再说；当然如果你的评论不是很多，并且之前配置过 Valine-Admin，那么你仍然可以使用 LeanCloud 来做异步发送通知，关闭默认的通知配置，或者使用 js 推送
关于邮件模板大家可查看官方文档 相关章节，或者使用附录提供的邮件通知模板 ，也提交了 PR
评论 Hooks ，可以根据官方的例子自己做一些配置，相比于其他，违禁词，屏蔽IP等配置可以说是人性化了，但万一配置不好一些正常评论可能也会被判定为垃圾内容，所以我推荐使用人工审核功能，不过这边不得不说另一个评论系统 Twikoo ，支持查看自己审核中的评论，评论置顶，点赞等，不过我想 Waline 将来也能实现，毕竟 Flag 立那了
图片上传 uploadImage 部分配置 理论上是可以适配任何图床，配置例子可查看 issues/123 ，当然内置了一个默认图床，开箱即用
表情配置和之前 Valine 是一样的，同主题还可使用 walien.json 的配置方式，具体可查看主题文档
CloudBase 云开发部署 一键部署 一键脚本部署可以查看官方文档 ，我删了之后就没成功过
截至文档最新更新日期，这个已被修复（不过tcb-starter那个链接还没改所以还是失败），不过我只能说作者非常不细心，毕竟能一天发十几个版本，详见 commit ，他还是把链接协议头多打了一个 h ,所以请点击这里 一键部署
嗯，后来修复了，期待接下来的开发
警告内容来自 Twikoo 官方文档 建议您直接查看 手动部署部分 ！！！
一键部署虽然方便，但是仅支持按量计费环境——也就是说，一键部署的环境，当免费资源用尽后，将会产生费用 。且按量计费环境无法切换为包年包月环境。免费额度数据库读操作数只有 500 次 / 天，无法支撑 Twikoo 的运行需求 。Twikoo 建议您手动部署 以节约成本。
对于新用户或者说没有创建过按量计费环境的用户会显示如下内容，记得勾选开启免费资源
为了日后升级的方便，不管您是否使用了 Vercel 部署，您都可以 fork 我的仓库 ，稍加配置即可完成自动部署更新
手动部署 首先前往腾讯云的活动区域
没错，这个环境不错吧
按照提示购买后稍等几分钟，在这个界面可查看您所购买的环境
有能力的其实可以看一下 Vercel 自动升级 和TCB自动升级 部分，间接实现一键部署，自动更新
点击云函数 ，新建云函数，函数内存选择 128M，名称随意，例如 Waline，其他默认,单击进入下一步
下图中的函数代码部分填入以下代码
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 module .exports .main = async (event, context) => { context.callbackWaitsForEmptyEventLoop = false ; const entry = (() => { const result = require ('./app.js' ); return result; })(); const serverless = require ('serverless-http' ); let app = entry; if (entry && entry.tcbGetApp && typeof entry.tcbGetApp === 'function' ) { app = await entry.tcbGetApp (); } return serverless (app, { binary : [ 'application/javascript' , 'application/json' , 'application/octet-stream' , 'application/xml' , 'font/eot' , 'font/opentype' , 'font/otf' , 'image/*' , 'video/*' , 'audio/*' , 'text/comma-separated-values' , 'text/css' , 'text/javascript' , 'text/plain' , 'text/text' , 'text/xml' , ], })(event, context); };
点击对应的云函数，进入在线编辑页面，按照模板仓库 里的文件，新建对应的文件，并复制粘贴对应的内容即可
注意点击保存并安装依赖 ，可能会没有反应一会儿，然后等待转圈圈部署完毕即可
当然还没有结束，我们需要点击 环境 --> HTTP 访问服务 （点击直达 )，如果你想绑定自定义域名可以照图中绑定，记得先申请一下证书，如果你想要 HTTPS（这个可能花的时间有点长）
点击新建，新建触发路径，点击保存即可，注意路径最后没有 / ，等待构建完成后你就可通过对应的链接访问 demo 页面了，这个链接就是上面提到的 serverURL ，例如我的 https://tcb.ccknbc.cc/waline
然后我们需要设置 WEB 安全域名 ，把你的域名放入白名单即可（本地测试的话端口也要对应上哦）
如何升级 Vercel 手动升级 找到 Vercel 帮你在创建的仓库，叫 waline 啦，编辑 package.json 中依赖版本号即可完成升级，版本号以 npm 为准，因为 GitHub 由于考虑到电报机器人自动推送消息过于频繁影响到群友，会延迟推送
自动升级 其实原理还是一样的，因为Vercel会监控仓库文件的变化来帮我们自动部署，那么我们要做的就是自动更改版本号，这里你可以用 Github Actions 实现，定时每隔半小时自动更新并push，但这样似乎有点浪费资源，所以不怎么推荐，而我们这个仓库通常都是公开的（私有也没关系）
首先你需要安装一个应用Renovate ,选择免费版计划即可，他会帮我们监控所用依赖的版本更新变化，并为提交一个 PR ，我们要做的只是合并 PR 而已，但手动合并之前也讲过，多少有点不方便，自动合并我们知道有打标签自动合并，GitHub Actions 工具人自动合并，这些大家搜以下关键词就好，但这个应用它本身实际上支持自动合并，查看官方文档 发现在 renovate.json 中配置即可，示例代码如下，其中代理人是为了通知更新的作用，与PR同理，但也可删除此段配置，同样的PR也可关闭通知静默自动更新。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { "extends" : [ "config:base" ] , "assignees" : [ "CCKNBC" ] , "separateMinorPatch" : true , "packageRules" : [ { "updateTypes" : [ "minor" , "patch" ] , "automerge" : true , "automergeType" : "branch" } ] }
我目前还是用的默认的提交PR自动合并的方式，如果你是公开仓库，还可以使用Mergify ，安装完成后他能它免费帮我们自动合并公开仓库的PR，我们设定一个条件，比如 PR 提交作者为 renovate，就自动帮我们点击合并，并删除多余分支，当然这些都需要配置，这里具体会在另一篇文档中讲到
如果你想懒的话可以先删除你现有的名为 Waine 的仓库，再 fork 我的仓库 ，然后去你的 Vercel 解绑之前的仓库，再绑定你fork的仓库，最后点一下重新部署即可
但是如果你没用tcb 就把 .github/workflows/Update Waline TCB.yml 里的文件删掉，因为涉及到自动部署更新云开发，还有环境变量问题，如果没设定会导致报错
CloudBase 一键部署 就是点击我的应用 找到 Waline 点击部署即可
手动部署 手动升级 就是去仓库 复制粘贴修改过的文件的事情了，如果没有文件改动就点击 保存并安装依赖 即可（知道在哪了吧）
自动升级 原理在上面讲了，结合 Vercel 自动升级 部分查看，这部分其实可以作为上面的手动部署，或者自动部署？
你可以 fork 我的仓库 进行更改，和上面提到的原理差不多，只是用到了 Actions（如果你之前没接触过这些，建议使用 Vercel 部署或者上面的一键部署，也比较方便），在合并PR后帮我们自动升级部署到云开发，解释一下几个密钥，您需要在 仓库的 settings/secrets/actions 中配置，组织的话可以把常用到的密钥添加为组织密钥
，比如 ID KEY 等
变量名 变量解释 SECRETID API 访问密钥 ID，可点击这里 新建/查看 SECRETKEY API 访问密钥 KEY，可 点击这里 新建/查看 TCBFUNNAME（没什么好加密的，就叫 waline 算了） 你想要新建/已有函数的名称，比如 Waline TCBENVID 环境ID，可点击这里 或这里 查看，地址栏后也会显示，反正就是很多地方都在上面点一下就能看到
附录 邮件通知模板 1 2 3 4 mailSubject : '{{parent.nick}}，您在 {{site.name}} 上发表的评论,收到了来自 {{self.nick}} 的回复' ,mailSubjectAdmin : '{{site.name}} 上收到了来自 {{self.nick}} 的留言' ,mailTemplate : '<head><base target="_blank"/><style id="scrollbar"type="text/css">::-webkit-scrollbar{width:0!important}pre{white-space:pre-wrap!important;word-wrap:break-word!important;*white-space:normal!important}pre{white-space:pre-wrap!important;word-wrap:break-word!important;*white-space:normal!important}#letter img{max-width:300px}</style><style id="from-wrapstyle"type="text/css">#form-wrap{overflow:hidden;height:447px;position:relative;top:0px;transition:all 1s ease-in-out.3s;z-index:0}</style><style id="from-wraphoverstyle"type="text/css">#form-wrap:hover{height:1300px;top:-200px}</style></head><body><div style="width: 530px;margin: 20px auto 0;height: 1000px;"><div id="form-wrap"><img src="https://cdn.jsdelivr.net/gh/Akilarlxh/Valine-Admin@v1.0/source/img/before.png"alt="before"style="position: absolute;bottom: 126px;left: 0px;background-repeat: no-repeat;width: 530px;height: 317px;z-index:-100"><div style="position: relative;overflow: visible;height: 1500px;width: 500px;margin: 0px auto;transition: all 1s ease-in-out .3s;padding-top:200px;"<form><div style="background: white;width: 95%;max-width: 800px;margin: auto auto;border-radius: 5px;border: 1px solid;overflow: hidden;-webkit-box-shadow: 0px 0px 20px 0px rgba(0, 0, 0, 0.12);box-shadow: 0px 0px 20px 0px rgba(0, 0, 0, 0.18);"><img style="width:100%;overflow: hidden;"src="https://area.sinaapp.com/bingImg"/><div style="padding: 5px 20px;"><br><div><h3 style="text-decoration: none; color: #8fbc8f;">{{parent.nick}}，见信安：</h3></div><br><div id="letter"style="overflow:auto;height:300px;width:100%;display:block;word-break: break-all;word-wrap: break-word;"><p style="display: inline-block;">您在<a style="text-decoration: none;color: #8fbc8f"target="_blank"href="{{site.postUrl}} display: inline-block;">{{site.name}}</a>上发表的评论:</p><div style="border-bottom: #ddd 1px solid;border-left: #ddd 1px solid;padding-bottom: 20px;background-color: #eee;margin: 15px 0px;padding-left: 20px;padding-right: 20px;border-top: #ddd 1px solid;border-right: #ddd 1px solid;padding-top: 20px;font-family: "Arial", "Microsoft YaHei" , "黑体" , "宋体" , sans-serif;">{{parent.comment | safe}}</div><p>收到了来自{{self.nick}}的回复：</p><div style="border-bottom: #ddd 1px solid;border-left: #ddd 1px solid;padding-bottom: 20px;background-color: #eee;margin: 15px 0px;padding-left: 20px;padding-right: 20px;border-top: #ddd 1px solid;border-right: #ddd 1px solid;padding-top: 20px;font-family: "Arial", "Microsoft YaHei" , "黑体" , "宋体" , sans-serif;">{{self.comment | safe}}</div></div><br><div style="text-align: center;margin-top: 40px;"><img src="https://ae01.alicdn.com/kf/U0968ee80fd5c4f05a02bdda9709b041eE.png"alt="hr"style="width:100%; margin:5px auto 5px auto; display: block;"/><a style="text-transform: uppercase;text-decoration: none;font-size: 14px;border: 2px solid #ace0f9;color: #FFFFFF;padding: 10px;display: inline-block;margin: 10px auto 0;background-color: #8fbc8f;"target="_blank"href="{{site.postUrl}}">{{site.name}}｜请您签收~</a></div><p style="font-size: 12px;text-align: center;color: #999;">自动书记人偶竭诚为您服务！<br>©2020 - 2021 <a style="text-decoration:none; color:#8fbc8f"href="{{site.url}}">{{site.name}}</a></p></div></div></form></div><img src="https://cdn.jsdelivr.net/gh/Akilarlxh/Valine-Admin@v1.0/source/img/after.png"alt="after"style=" position: absolute;bottom: -2px;left: 0;background-repeat: no-repeat;width: 530px;height: 259px;z-index:100"></div></div></body>' ,mailTemplateAdmin : '<head><base target="_blank"/><style id="scrollbar"type="text/css">::-webkit-scrollbar{width:0!important}pre{white-space:pre-wrap!important;word-wrap:break-word!important;*white-space:normal!important}#letter img{max-width:300px}</style><style id="from-wrapstyle"type="text/css">#form-wrap{overflow:hidden;height:447px;position:relative;top:0px;transition:all 1s ease-in-out.3s;z-index:0}</style><style id="from-wraphoverstyle"type="text/css">#form-wrap:hover{height:1300px;top:-200px}</style></head><body><div style="width: 530px;margin: 20px auto 0;height: 1000px;"><div id="form-wrap"><img src="https://cdn.jsdelivr.net/gh/Akilarlxh/Valine-Admin@v1.0/source/img/before.png"alt="before"style="position: absolute;bottom: 126px;left: 0px;background-repeat: no-repeat;width: 530px;height: 317px;z-index:-100"><div style="position: relative;overflow: visible;height: 1500px;width: 500px;margin: 0px auto;transition: all 1s ease-in-out .3s;padding-top:200px;"><form><div style="background: white;width: 95%;max-width: 800px;margin: auto auto;border-radius: 5px;border: 1px solid;overflow: hidden;-webkit-box-shadow: 0px 0px 20px 0px rgba(0, 0, 0, 0.12);box-shadow: 0px 0px 20px 0px rgba(0, 0, 0, 0.18);"><img style="width:100%;overflow: hidden;"src="https://area.sinaapp.com/bingImg"/><div style="padding: 5px 20px;"><br><div><h3 style="text-decoration: none; color: #8fbc8f;">来自{{self.nick}}的留言:</h3></div><br><br><div id="letter"style="overflow:auto;height:300px;width:100%;display:block;word-break: break-all;word-wrap: break-word;"><div style="border-bottom: #ddd 1px solid;border-left: #ddd 1px solid;padding-bottom: 20px;background-color: #eee;margin: 15px 0px;padding-left: 20px;padding-right: 20px;border-top: #ddd 1px solid;border-right: #ddd 1px solid;padding-top: 20px;font-family: "Arial", "Microsoft YaHei" , "黑体" , "宋体" , sans-serif;">{{self.comment | safe}}</div></div><div style="text-align: center;margin-top: 40px;"><img src="https://ae01.alicdn.com/kf/U0968ee80fd5c4f05a02bdda9709b041eE.png"alt="hr"style="width:100%; margin:5px auto 5px auto; display: block;"/><a style="text-transform: uppercase;text-decoration: none;font-size: 14px;border: 2px solid #ace0f9;color: #FFFFFF;padding: 10px;display: inline-block;margin: 10px auto 0;background-color: #8fbc8f;"target="_blank"href="{{site.postUrl}}">{{site.name}}｜请您过目~</a></div><p style="font-size: 12px;text-align: center;color: #999;">©2020 - 2021 <a style="text-decoration:none; color:#8fbc8f"href="{{site.url}}">{{site.name}}</a></p></div></div></form></div><img src="https://cdn.jsdelivr.net/gh/Akilarlxh/Valine-Admin@v1.0/source/img/after.png"alt="after"style=" position: absolute;bottom: -2px;left: 0;background-repeat: no-repeat;width: 530px;height: 259px;z-index:100"></div></div></body>'
下载 邮件通知模板下载 （包含 Waline/Valine/Twikoo），您可以下载后根据官方文档提及的变量自行修改index.js相关内容，以上代码仅作参考，对于本文未涉及到的其他内容，请自行查看官方文档，如有错误，欢迎指正，谢谢！
本博客所有文章除特别声明外，均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来源 CC的部落格 ！
三合一
爱发电
为准，因为 GitHub 由于考虑到电报机器人自动推送消息过于频繁影响到群友，会延迟推送
