mirror of
https://github.com/crazy-max/diun.git
synced 2026-01-04 20:15:01 +01:00
db2bce3bb3
* Fix build workflow * Docs website with mkdocs (#99) * Fix docs workflow * Move mkdocs Docker file * Ignore docs in build workflow * Update workflows * Update links * Move upgrade notes to documentation Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
36 lines
1018 B
Markdown
36 lines
1018 B
Markdown
# Telegram notifications
|
|
|
|
Notifications can be sent via Telegram using a [Telegram Bot](https://core.telegram.org/bots).
|
|
|
|
Follow the [instructions](https://core.telegram.org/bots#6-botfather) to set up a bot and get it's token.
|
|
|
|
Message the [GetID bot](https://t.me/getidsbot) to find your chat ID.
|
|
Multiple chat IDs can be provided in order to deliver notifications to multiple recipients.
|
|
|
|
## Configuration
|
|
|
|
!!! example "File"
|
|
```yaml
|
|
notif:
|
|
telegram:
|
|
token: aabbccdd:11223344
|
|
chatIDs:
|
|
- 123456789
|
|
- 987654321
|
|
```
|
|
|
|
!!! abstract "Environment variables"
|
|
* `DIUN_NOTIF_TELEGRAM_TOKEN`
|
|
* `DIUN_NOTIF_TELEGRAM_CHATIDS` (comma separated)
|
|
|
|
| Name | Default | Description |
|
|
|--------------------|---------------|---------------|
|
|
| `token`[^1] | | Telegram bot token |
|
|
| `chatIDs`[^1] | | List of chat IDs to send notifications to |
|
|
|
|
## Sample
|
|
|
|
|
|
|
|
[^1]: Value required
|