docs(zh): add hook docs

This commit is contained in:
krau
2025-06-20 21:46:00 +08:00
parent c82c2462bf
commit 2979628cf7
2 changed files with 24 additions and 1 deletions

View File

@@ -131,6 +131,27 @@ storages = []
blacklist = true
```
### 事件触发
事件触发提供了在 Bot 处理任务时根据任务状态执行自定义操作的能力, 目前仅支持任意命令执行. 使用 `[hook.exec]` 配置.
目前具有以下几种事件类型:
- `task_before_start`: 任务即将开始前
- `task_success`: 任务成功完成后
- `task_fail`: 任务失败后
- `task_cancel`: 任务被取消后
提供的配置值需要为完整的命令行命令, Bot 会在事件发生时执行该命令. 示例:
```toml
[hook.exec]
task_before_start = "echo '任务即将开始'"
task_success = "bash /path/to/success_script.sh"
task_fail = "curl -X POST https://example.com/api/notify -d '任务失败'"
task_cancel = "bash /path/to/cancel_script.sh"
```
### 杂项
```toml

View File

@@ -5,11 +5,13 @@ weight: 10
# 使用帮助
这里介绍 Save Any Bot 的一些功能和使用方法, 如果你没有在这里找到你需要的内容, 另请参阅 [配置说明](../deployment/configuration) 或前往 Github [Discussions](https://github.com/krau/SaveAny-Bot/discussions) 提问.
## 转存文件
Bot 接受两种消息: 文件和链接.
支持以下链接:
对于链接, 目前支持以下类型的链接:
1. Telegram 消息链接, 例如: `https://t.me/acherkrau/1097`. **即使频道禁止了转发和保存, Bot 依然可以下载其文件.**
2. Telegra.ph 的文章链接, Bot 将下载其中的所有图片