archive/crazy-max_diun
0
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2025-01-12 11:38:11 +00:00
Code Issues Projects Releases Wiki Activity
crazy-max_diun/docs/notif/telegram.md

3.1 KiB
Raw Permalink Blame History

Telegram notifications

Notifications can be sent via Telegram using a Telegram Bot.

Follow the instructions to set up a bot and get it's token.

Message the GetID bot 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" - "567891234:25" - "891256734:25;12" templateBody: | Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.

Name Default Description
token Telegram bot token
tokenFile Use content of secret file as Telegram bot token if token not defined
chatIDs List of chat IDs to send notifications to
chatIDsFile Use content of secret file as chat IDs if chatIDs not defined
templateBody1 See below Notification template for message body

!!! abstract "Environment variables" * DIUN_NOTIF_TELEGRAM_TOKEN * DIUN_NOTIF_TELEGRAM_TOKENFILE * DIUN_NOTIF_TELEGRAM_CHATIDS (comma separated) * DIUN_NOTIF_TELEGRAM_CHATIDSFILE * DIUN_NOTIF_TELEGRAM_TEMPLATEBODY

!!! example "chat IDs secret file" Chat IDs secret file must be a valid JSON array like: ["123456789","987654321","567891234:25","891256734:25;12"]

chatIDs format

Chat IDs can be provided in the following formats:

  • 123456789: Send to chat ID 123456789
  • 567891234:25: Send to chat ID 567891234 with target message topic 25
  • 891256734:25;12: Send to chat ID 891256734 with target message topics 25 and 12

Each chat ID can be a simple integer or a string with additional topics. This allows you to specify not only the chat ID but also the specific topics within the chat to which the message should be sent.

Default templateBody

Docker tag {{ if .Entry.Image.HubLink }}[{{ .Entry.Image }}]({{ .Entry.Image.HubLink }}){{ else }}{{ .Entry.Image }}{{ end }} which you subscribed to through {{ .Entry.Provider }} provider has been {{ if (eq .Entry.Status "new") }}newly added{{ else }}updated{{ end }} on {{ escapeMarkdown .Meta.Hostname }}.

!!! note escapeMarkdown is a special function to deal with a markdown strict parsing issue on Telegram server.

Sample

  1. Value required ↩︎