Files
Auto_Bangumi/docs/config/notifier.md
Estrella Pan f1dd439fbe feat(notification): Bark 支持铃声、分组、中断级别、图标与点击地址;插件权限新增「运行外部命令」
- Bark 渠道新增可选字段 sound、group、level、icon,并复用 url 作为点击打开的地址;
  只发送已设置的项,旧配置的请求体不变;配置了 icon 时优先于海报地址(#792)
- 测试接口 /notification/test-config 透传新字段;通知设置表单加上对应输入框
  与 level 下拉框,并更新三语言的通知配置文档
- 插件权限标签新增 subprocess(运行外部命令),仅用于展示
2026-10-21 09:09:43 +02:00

64 lines
2.8 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 通知设置
## WebUI 配置
![notification](/image/config/notifier.png){width=700}{class=ab-shadow-card}
![notification provider](/image/config/notifier-provider.png){width=700}{class=ab-shadow-card}
通知设置支持多个通知服务。启用总开关后,可以添加、编辑、启用/禁用、删除和测试单个 provider。修改通知设置后,需要点击底部 **保存并重启**。
当前支持的通知服务:
- Telegram
- Discord
- Bark
- Server Chan / Server 酱³
- WeCom / 企业微信
- Gotify
- Pushover
- Webhook
不同 provider 需要的字段不同:
- Telegram:`Bot Token`、`Chat ID`
- Discord:Webhook URL
- WeCom:Webhook URL、Key
- Bark:Device Key,可选 Server URL、铃声、分组、中断级别、图标地址、点击打开的地址
- Server Chan:SendKey
- Gotify:Server URL、App Token
- Pushover:User Key、API Token
- Webhook:Webhook URL、消息模板
Webhook 模板可以使用 `{{title}}`、`{{season}}`、`{{episode}}`、`{{poster_url}}` 等占位符。非 Webhook provider 会把模板渲染为普通文本。
已启用的插件也可以提供通知渠道,它们以「插件提供」标注出现在类型列表中。设置页不显示插件渠道的专用字段;需要时请在 `config.json` 中该 provider 对象里填写,AB 原样保存并传给插件。
## `config.json` 配置选项
配置节:`notification`
| 参数 | 说明 | 类型 | WebUI 选项 | 默认值 |
| --- | --- | --- | --- | --- |
| `enable` | 启用通知系统 | 布尔值 | 启用 | `false` |
| `providers` | 通知服务列表 | 数组 | 通知服务列表 | `[]` |
| `base_url` | 生成通知海报绝对地址时使用的公开 URL | 字符串 | 暂无 WebUI 项 | `""` |
`providers` 中的单个对象通常包含:
| 参数 | 说明 |
| --- | --- |
| `type` | provider 类型:`telegram`、`discord`、`bark`、`server-chan`、`wecom`、`gotify`、`pushover`、`webhook`,或插件提供的渠道 id |
| `enabled` | 是否启用该 provider |
| `token` | Telegram(Bot Token)、Server Chan(SendKey)、WeCom(Key)、Gotify(App Token)使用 |
| `chat_id` | Telegram 使用 |
| `webhook_url` | Discord、WeCom 使用 |
| `url` | Webhook 使用;Bark 中为点击通知后打开的地址(可选) |
| `server_url` | Bark(可选)、Gotify 使用 |
| `device_key` | Bark 使用 |
| `sound` / `group` / `level` / `icon` | Bark 可选:铃声、分组、中断级别(`active`、`timeSensitive`、`passive`、`critical`)、图标地址。留空则不发送;`icon` 留空时单集通知用海报地址 |
| `user_key` / `api_token` | Pushover 使用 |
| `template` | 自定义通知模板 |
升级到 4.0 后第一次启动时,Bark 的旧字段 `token` 迁移到 `device_key`,WeCom 的旧字段 `chat_id` 迁移到 `webhook_url`。