feat: add email notification for failed and success backup

2024-10-09 22:39:44 +02:00
parent 45826d19cd
commit 4a43a28888
13 changed files with 480 additions and 85 deletions
--- a/docs/how-tos/receive-notification.md
+++ b/docs/how-tos/receive-notification.md
@@ -0,0 +1,136 @@
+---
+title: Receive notifications
+layout: default
+parent: How Tos
+nav_order: 12
+---
+Send Email or Telegram notifications on success or failed backup.
+
+### Email
+To send out email notifications on failed backup runs, provide SMTP credentials, a sender and a recipient:
+
+```yaml
+services:
+  pg-bkup:
+    image: jkaninda/pg-bkup
+    container_name: pg-bkup
+    command: backup
+    volumes:
+      - ./backup:/backup
+    environment:
+      - DB_PORT=5432
+      - DB_HOST=postgres
+      - DB_NAME=database
+      - DB_USERNAME=username
+      - DB_PASSWORD=password
+      - MAIL_HOST=
+      - MAIL_PORT=587
+      - MAIL_USERNAME=
+      - MAIL_PASSWORD=!
+      - MAIL_FROM=
+      - MAIL_TO=me@example.com,team@example.com,manager@example.com
+      - MAIL_SKIP_TLS=false
+    networks:
+      - web
+networks:
+  web:
+```
+
+### Telegram
+
+```yaml
+services:
+  pg-bkup:
+    image: jkaninda/pg-bkup
+    container_name: pg-bkup
+    command: backup
+    volumes:
+      - ./backup:/backup
+    environment:
+      - DB_PORT=5432
+      - DB_HOST=postgres
+      - DB_NAME=database
+      - DB_USERNAME=username
+      - DB_PASSWORD=password
+      - TG_TOKEN=[BOT ID]:[BOT TOKEN]
+      - TG_CHAT_ID=
+    networks:
+      - web
+networks:
+  web:
+```
+
+### Customize notifications
+
+The title and body of the notifications can be tailored to your needs using Go templates.
+Template sources must be mounted inside the container in /config/templates:
+
+- email.template: Email notification template
+- telegram.template: Telegram notification template
+- error.template: Error notification template
+
+### Data
+
+Here is a list of all data passed to the template:
+- `Database` : Database name
+- `StartTime`: Backup start time process
+- `EndTime`: Backup start time process
+- `Storage`: Backup storage
+- `BackupLocation`: Backup location
+- `BackupSize`: Backup size
+
+>  email.template:
+
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>[✅  Database Backup Notification – {{.Database}}</title>
+</head>
+<body>
+<h2>Hi,</h2>
+<p>Backup of the {{.Database}} database has been successfully completed on {{.EndTime}}.</p>
+<h3>Backup Details:</h3>
+<ul>
+<li>Database Name: {{.Database}}</li>
+<li>Backup Start Time: {{.StartTime}}</li>
+<li>Backup End Time: {{.EndTime}}</li>
+<li>Backup Storage: {{.Storage}}</li>
+<li>Backup Location: {{.BackupLocation}}</li>
+<li>Backup Size: {{.BackupSize}} bytes</li>
+</ul>
+<p>Best regards,</p>
+</body>
+</html>
+```
+
+> telegram.template
+
+```html
+[✅  Database Backup Notification – {{.Database}}
+Hi,
+Backup of the {{.Database}} database has been successfully completed on {{.EndTime}}.
+
+Backup Details:
+- Database Name: {{.Database}}
+- Backup Start Time: {{.StartTime}}
+- Backup EndTime: {{.EndTime}}
+- Backup Storage: {{.Storage}}
+- Backup Location: {{.BackupLocation}}
+- Backup Size: {{.BackupSize}} bytes
+```
+
+> error.template
+
+
+```html
+🔴 Urgent: Database Backup Failure Notification
+
+An error occurred during database backup.
+Failure Details:
+
+Error Message: {{.Error}}
+Date: {{.EndTime}}
+```