Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hydrotho/telegram_qbittorrent_notifier
A simple CLI tool for qBittorrent that sends a notification to Telegram chat via bot on torrent finished. 一个简单的用于 qBittorrent 的命令行工具，当种子下载完成时，通过 Telegram 机器人向聊天发送通知。
https://github.com/hydrotho/telegram_qbittorrent_notifier
ffmpeg qbittorrent telegram
Last synced: 26 days ago
JSON representation
A simple CLI tool for qBittorrent that sends a notification to Telegram chat via bot on torrent finished. 一个简单的用于 qBittorrent 的命令行工具，当种子下载完成时，通过 Telegram 机器人向聊天发送通知。
- Host: GitHub
- URL: https://github.com/hydrotho/telegram_qbittorrent_notifier
- Owner: hydrotho
- License: mit
- Created: 2023-11-13T08:45:16.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-02-26T14:10:26.000Z (9 months ago)
- Last Synced: 2024-09-30T18:43:21.360Z (about 1 month ago)
- Topics: ffmpeg, qbittorrent, telegram
- Language: Go
- Homepage:
- Size: 21.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telegram_qBittorrent_Notifier
A simple CLI tool for qBittorrent that sends a notification to Telegram chat via bot on torrent finished.
## Quick Start
### Installation
Download prebuilt statically-linked binaries from [Releases](https://github.com/hydrotho/Telegram_qBittorrent_Notifier/releases/latest) for Linux, Windows and macOS.
### Configuration
Please refer to the [config example](config.example.yaml).
### Integrate with qBittorrent
In the qBittorrent Web UI:
1. Navigate to `Options` and select the `Downloads` tab.
2. At the bottom, locate `Run external program on torrent finished`.
### Handling Empty Category or Tags
When using `%L` (Category) or `%G` (Tags), follow these formats to avoid errors:
```sh
❯ Telegram_qBittorrent_Notifier send -n "%N" -l "6д9%L"
❯ Telegram_qBittorrent_Notifier send -n "%N" -g "6д9%G"
❯ Telegram_qBittorrent_Notifier send -n "%N" -l "6д9%L" -g "6д9%G"
```
These formats use "6д9" as a prefix to ensure that the CLI does not encounter parsing errors from empty values in `%L` or `%G`.
You can customize this magic word in the configuration file or by using the `--magic-word` option.
### Thumbnail
Enhance your notifications with the thumbnail feature for a more visually engaging experience.
When a valid video file is specified via `--thumbnail-source` option, the tool uses FFmpeg to automatically generate a thumbnail, adding a visual element to your Telegram notifications.
```sh
❯ Telegram_qBittorrent_Notifier send --thumbnail-source "%F" -n "%N"
```
Please ensure FFmpeg is installed and can be executed directly from the command line. The tool performs an automatic check for FFmpeg. In case FFmpeg is not detected or cannot be executed, the thumbnail generation will not take place.
## Support
If you encounter any issues or have any suggestions, please [open an issue](https://github.com/hydrotho/Telegram_qBittorrent_Notifier/issues).
## License
This project is licensed under the MIT License, see the [LICENSE](LICENSE) file for details.