服务端配置
你可以在服务端入口文件 index.js 中配置下列选项。
注意
如果你使用模板，请额外注意你需要自行保存这些配置，因为它们会在拉取官方最新模板时被覆盖。
建议将官方最新模板上传到自己的仓库，并进行修改。
基本配置
plugins
- 类型：
plugin[]
详情见 插件系统
secureDomains
- 类型:
string | RegExp | string[] | RegExp[]
安全域名配置。配置后非该域名来源的请求会返回 403 状态码。支持字符串、正则、数组类型，不配置表示允许所有域名来源。
例子
// index.js
const Waline = require('@waline/vercel');
module.exports = Waline({
secureDomains: 'waline.js.org',
});
提示
- 为了方便本地开发，
localhost和127.0.0.1会被默认添加到安全域名列表中。 - 当存在该配置时，环境变量
SECURE_DOMAINS不生效。 - 腾讯云开发需要同时在
环境 -> 安全配置 -> WEB 安全域名中配置安全域名
forbiddenWords
- 类型:
string[]
违禁词配置，包含违禁词的内容会直接标记为垃圾评论。
例子
//index.js
const Waline = require('@waline/vercel');
module.exports = Waline({
forbiddenWords: ['习近平', '毛泽东'],
});
disallowIPList
- 类型:
string[]
IP 黑名单配置，名单中的 IP 访问会直接返回 403 错误。
例子
// index.js
const Waline = require('@waline/vercel');
module.exports = Waline({
disallowIPList: ['8.8.8.8', '4.4.4.4'],
});
mailSubject
- 类型:
string
评论回复邮件标题自定义，等同于环境变量 MAIL_SUBJECT。
mailTemplate
- 类型:
string
评论回复邮件内容自定义，等同于环境变量 MAIL_TEMPLATE。
mailSubjectAdmin
- 类型:
string
新评论通知邮件标题自定义，等同于环境变量 MAIL_SUBJECT_ADMIN。
mailTemplateAdmin
- 类型:
string
新评论通知邮件内容自定义，等同于环境变量 MAIL_TEMPLATE_ADMIN。
QQTemplate
- 类型:
string
QQ 评论通知模板，等同于环境变量 QQ_TEMPLATE。
TGTemplate
- 类型:
string
Telegram 评论通知模板，等同于环境变量 TG_TEMPLATE。
SCTemplate
- 类型:
string
Server酱 评论通知模板，等同于环境变量 SC_TEMPLATE。
model
- 类型：
class
详情见 自定义数据库服务
encryptPassword
- 类型：
function
详情见 自定义用户系统
评论 Hooks
Waline 提供了一些自定义 Hook，方便用户根据自身业务需求对 Waline 服务端行为进行定制。
自定义 Hook 在服务端入口文件 index.js 中进行配置。
preSave(comment)
发布评论前执行的操作。传入评论数据，如果该方法返回内容，则接口会直接返回，不存储评论数据。
例子
// index.js
const Waline = require('@waline/vercel');
module.exports = Waline({
async preSave(comment) {
const isSpam = await Akismet.check(comment);
if (isSpam) {
return { errmsg: '这是垃圾邮件!' };
}
},
});
postSave(comment, pComment)
评论发布后执行的操作。
方法执行时会传入评论数据，如果是回复评论的话还会传入父级评论。
例子
// index.js
const Waline = require('@waline/vercel');
module.exports = Waline({
async postSave(comment, pComment) {
await mailto({
mail: pComment.mail,
text: `${comment.nick} 回复了你的评论!`,
});
},
});
preUpdate(comment)
评论内容在后台被更新前执行的操作。如果该方法返回内容，则接口会直接返回，不更新评论数据。
例子
// index.js
const Waline = require('@waline/vercel');
module.exports = Waline({
async preUpdate(comment) {
return '你无法更新评论数据';
},
});
afterUpdate(comment)
评论内容在后台被更新后执行的操作。方法执行时会传入评论数据。
例子
// index.js
const Waline = require('@waline/vercel');
module.exports = Waline({
async postUpdate(comment) {
console.log(`${comment.objectId} 评论已更新!`);
},
});
preDelete(commentId)
评论被删除前执行的操作，方法执行时会传入需要操作的评论 Id。如果该方法返回内容，则接口会直接返回，不更新评论数据。
例子
// index.js
const Waline = require('@waline/vercel');
module.exports = Waline({
async preDelete(commentId) {
return "Then you can't delete comment";
},
});
afterDelete(commentId)
评论被删除后执行的操作，方法执行时会传入需要操作的评论 Id。
例子
// index.js
const Waline = require('@waline/vercel');
module.exports = Waline({
async postDelete(commentId) {
console.log(`comment ${commentId} has been deleted!`);
},
});
avatarUrl(comment)
获取头像时执行的操作，方法执行时会传入需要操作的 comment 对象。
例子
这是一个实现自动替换使用 QQ 头像的示例函数
// index.js
const Waline = require('@waline/vercel');
module.exports = Waline({
async avatarUrl(comment) {
const reg = new RegExp('(\\d+)@qq\\.com$', 'i');
const mail = comment.mail;
if (reg.test(mail)) {
const q = mail.replace(/@qq\.com/i, '').toLowerCase();
return 'https://q1.qlogo.cn/headimg_dl?dst_uin=' + q + '&spec=4';
}
},
});
此方法或传入一个 comment 对象，你可以通过 comment.mail 获取邮箱。若返回值为 string 类型，则会直接调用返回值作为头像地址，否则正常生成 MD5。
