评论通知 | Waline

Omnivore

Read on Omnivore

Read Original

date_saved: 2024-03-24 23:40:19

date_published: 2024-02-02 11:12:10

Full Content:

迁移’ d=‘M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z’/%3E%3C/svg%3E)

• Waline 客户端 V3 迁移指南
• Waline 客户端 V2 迁移指南
• 从 Valine 迁移
• 数据迁移助手

参考’ d=‘M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z’/%3E%3C/svg%3E)

• API

• 客户端

  • 客户端 API
  • 组件属性
  • 客户端文件
  • CSS 变量

• 服务端

  • API
  • 服务端配置
  • 服务端环境变量
  • 插件系统

高级’ d=‘M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z’/%3E%3C/svg%3E)

• 介绍
• 设计目标
• 生态系统
• FAQ
• 贡献指南
• 隐私协议

’ d=‘M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z’/%3E%3C/svg%3E)

• 简体中文
• English

当网站有用户发布评论或者用户回复评论时，Waline 支持对博主和回复评论作者进行通知。

• 博主通知支持多种方式，包括 QQ、微信、邮件等。
• 当访客的评论收到回复时，我们会对访客进行邮件通知。

邮件通知

邮件通知需要配置以下环境变量:

• SMTP_SERVICE: SMTP 邮件发送服务提供商。
  提示
  你可以在 这里 查看所有支持的运营商。
  如果你的运营商不受支持，你必须填写 SMTP_HOST 和 SMTP_PORT。
  • SMTP_HOST: SMTP 服务器地址，一般可以在邮箱的设置中找到。
  • SMTP_PORT: SMTP 服务器端口，一般可以在邮箱的设置中找到。
• SMTP_USER: SMTP 邮件发送服务的用户名，一般为登录邮箱。
• SMTP_PASS: SMTP 邮件发送服务的密码，一般为邮箱登录密码，部分邮箱(例如 163)是单独的 SMTP 密码。
• SMTP_SECURE: 是否使用 SSL 连接 SMTP。
• SITE_NAME: 网站名称，用于在消息中显示。
• SITE_URL: 网站地址，用于在消息中显示。
• AUTHOR_EMAIL: 博主邮箱，用来接收新评论通知。如果是博主发布的评论则不进行提醒通知。

以下是选填的环境变量:

• SENDER_NAME: 自定义发送邮件的发件人
• SENDER_EMAIL: 自定义发送邮件的发件地址
• MAIL_SUBJECT: 自定义评论回复邮件标题
• MAIL_TEMPLATE: 自定义评论回复邮件内容
• MAIL_SUBJECT_ADMIN: 自定义新评论通知邮件标题
• MAIL_TEMPLATE_ADMIN: 自定义新评论通知邮件内容

微信通知

微信通知使用了 Server 酱 提供的服务，需要在环境变量中配置在 Server 酱中申请的 SC_KEY。

• SC_KEY: Server 酱提供的 Token，必填。
• AUTHOR_EMAIL: 博主邮箱，用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
• SITE_NAME: 网站名称，用于在消息中显示。
• SITE_URL: 网站地址，用于在消息中显示。
• SC_TEMPLATE: Server酱 使用的通知模板，变量与具体格式可参见下文的通知模板。未配置则使用默认模板。

企业微信应用通知

由于 Server 酱 提供的推送服务对发送消息数量有限制，如果消息数量较多时，建议使用企业微信应用通知。

要使用企业微信应用通知，需要配置环境变量 QYWX_AM 。

第一个值是企业 id，第二个值是应用 secret，第三个值@all(或者成员 id)，第四个值是 AgentID，第五个值是图片 id，中间以逗号隔开。最终格式例：

ww479cadfqfe8c151f,MPKN9gX97w4e4b4h4u7u4i4i4i4iO6mN_dDedBFzqC5c,@all,1000002,2S8H-JWEdsadFDSFSDDijbrtkldfhjslafhs5zEU1GyUkU
 

参考文档 1 | 参考文档 2

• QYWX_AM: 用于发送企业应用消息的变量，必填。
• AUTHOR_EMAIL: 博主邮箱，用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
• SITE_NAME: 网站名称，用于在消息中显示。
• SITE_URL: 网站地址，用于在消息中显示。
• WX_TEMPLATE: QYWX_AM 使用的通知模板，变量与具体格式可参见下文 QQ 的通知模板。未配置则使用默认模板。

QQ 通知

QQ 通知使用了 Qmsg 酱 提供的服务，需要在环境变量中配置在 Qmsg 酱中申请的 QMSG_KEY。

• QMSG_KEY: Qmsg 酱提供的 KEY，必填。
• QMSG_Host: Qmsg 酱提供的私有化 HOST，选填。默认为 https://qmsg.zendee.cn。
• QQ_ID: 接收消息的 QQ 号 (不支持 QQ 群)，可以添加多个，以半角逗号分割，如: 1244453393,2952937634 (必须均在您的 Qmsg 酱 QQ 号列表中)。
• AUTHOR_EMAIL: 博主邮箱，用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
• SITE_NAME: 网站名称，用于在消息中显示。
• SITE_URL: 网站地址，用于在消息中显示。
• QQ_TEMPLATE: QQ 使用的通知模板，变量与具体格式可参见下文的通知模板。未配置则使用默认模板。

Telegram 通知

Telegram 通知通过 Telegram bot 机器人实现，需要配置以下几个环境变量:

• ==TG_BOT_TOKEN==: Telegram 机器人用于访问 HTTP API 的 token，通过 ==@BotFather 创建机器人获取，必填。==
• ==TG_CHAT_ID==: 接收消息对象的 ==chat_id==，可以是单一用户、频道、群组，通过 ==@userinfobot 获取，必填。==
• ==AUTHOR_EMAIL==: 博主邮箱，用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
• ==SITE_NAME==: 网站名称，用于在消息中显示。
• ==SITE_URL==: 网站地址，用于在消息中显示。
• ==TG_TEMPLATE==: Telegram 使用的通知模板，变量与具体格式可参见下文的通知模板。未配置则使用默认模板。

PushPlus 通知

pushplus 集成了微信、企业微信、钉钉、短信、邮件等渠道的信息推送平台。需要配置以下几个环境变量，具体的参数格式见 pushplus 文档：

• PUSH_PLUS_KEY： 用户令牌，即 token，必填。
• PUSH_PLUS_TOPIC：群组编码，不填仅发送给自己；channel 为 webhook 时无效
• PUSH_PLUS_TEMPLATE：发送模板
• PUSH_PLUS_CHANNEL：发送渠道
• PUSH_PLUS_WEBHOOK：webhook 编码，仅在 channel 使用 webhook 渠道和 CP 渠道时需要填写
• PUSH_PLUS_CALLBACKURL：发送结果回调地址
• AUTHOR_EMAIL: 博主邮箱，用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
• SITE_NAME: 网站名称，用于在消息中显示。
• SITE_URL: 网站地址，用于在消息中显示。

Discord 通知

Discord 通知通过 Discord Webhook 实现，需要配置以下几个环境变量：

• DISCORD_WEBHOOK：Discord Webhook 地址，如何创建 Discord Webhook？
• DISCORD_TEMPLATE：发送模板
• AUTHOR_EMAIL: 博主邮箱，用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
• SITE_NAME: 网站名称，用于在消息中显示。
• SITE_URL: 网站地址，用于在消息中显示。

飞书通知

飞书群聊机器人支持通过 Webhook 发送消息，需配置以下几个环境变量。

• LARK_WEBHOOK: 飞书群聊机器人 使用指南
• LARK_SECRET: 请参考上面的飞书文档，该密钥用于请求签名以避免接口被滥用（可选）
• LARK_TEMPLATE: 消息模板
• SITE_NAME: 网站名称，用于在消息中显示。
• SITE_URL: 网站地址，用于在消息中显示。

通知模板

Waline 支持为每个平台分别配置您自定义的通知模板，从而实现更强大的自定义能力与多语言兼容性。

支持的变量

模板通过 self 、 parent 和 site 对象传递参数，其中分别包含以下变量:

• self: 该条评论本身
  | 变量 | 备注 |
  | --------------- | ------ |
  | nick | 评论者名 |
  | mail | 评论者邮箱 |
  | link | 评论者网址 |
  | url | 文章地址 |
  | comment | 评论内容 |
  | browser | 浏览器 |
  | os | 操作系统 |
  | addr | 归属地 |
  | avatar | 头像地址 |
  | commentLink* | 评论中的链接 |
  *: commentLink 仅在 Telegram 通知中提供，会自动封装成 Markdown 的格式
• parent: 该条评论的回复对象(父评论)
  | 变量 | 备注 |
  | ------- | ----- |
  | nick | 评论者名 |
  | mail | 评论者邮箱 |
  | link | 评论者网址 |
  | browser | 浏览器 |
  | os | 操作系统 |
  | addr | 归属地 |
  | avatar | 头像地址 |
  | comment | 评论内容 |
• site: 网站配置
  | 变量 | 备注 |
  | ------- | ------ |
  | name | 站点名 |
  | url | 站点网址 |
  | postUrl | 评论完整地址 |

默认模板

此处附上默认的模板，方便您参考:

• QQ_TEMPLATE:

💬 {{site.name|safe}} 有新评论啦  
{{self.nick}} 评论道:  
{{self.comment}}  
邮箱: {{self.mail}}  
状态: {{self.status}}  
仅供评论预览，查看完整內容:  
{{site.postUrl}}  

• TG_TEMPLATE:

💬 _[{{site.name}}]({{site.url}}) 有新评论啦_  
_{{self.nick}}_ 回复说:  

{{self.comment-}}

{{-self.commentLink}}  
_邮箱_: `{{self.mail}}`  
_审核_: {{self.status}}  
仅供评论预览，点击 [查看完整內容]({{site.postUrl}})  

• SC_TEMPLATE:

{{site.name|safe}} 有新评论啦  
【评论者昵称】：{{self.nick}}  
【评论者邮箱】：{{self.mail}}  
【内容】：{{self.comment}}  
【地址】：{{site.postUrl}}  

附加说明

1. Vercel 的环境变量大小限制为 4KB ，所以如果您的模板很长，请使用代码配置，参见 issue#106 ；
2. 变量具体信息在开发过程中可能会发生变化，此处的变量说明仅供参考，具体的内容请以具体的代码示例为准。

’ d=‘M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z’/%3E%3C/svg%3E)上一页安全性下一页’ d=‘M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z’/%3E%3C/svg%3E)自定义样式

Highlights

Telegram 通知通过 Telegram bot 机器人实现，需要配置以下几个环境变量:

• TG_BOT_TOKEN: Telegram 机器人用于访问 HTTP API 的 token，通过 @BotFather 创建机器人获取，必填。
• TG_CHAT_ID: 接收消息对象的 chat_id，可以是单一用户、频道、群组，通过 @userinfobot 获取，必填。
• AUTHOR_EMAIL: 博主邮箱，用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
• SITE_NAME: 网站名称，用于在消息中显示。
• SITE_URL: 网站地址，用于在消息中显示。
• TG_TEMPLATE: Telegram 使用的通知模板，变量与具体格式可参见下文的通知模板。未配置则使用默认模板。 ⤴️