mysql-bkup/docs/how-tos/receive-notification.md

---
title: Receive notifications
layout: default
parent: How Tos
nav_order: 12
---
Send Email or Telegram notifications on successfully or failed backup.

### Email
To send out email notifications on failed or successfully backup runs, provide SMTP credentials, a sender and a recipient:

```yaml
services:
  mysql-bkup:
    image: jkaninda/mysql-bkup
    container_name: mysql-bkup
    command: backup
    volumes:
      - ./backup:/backup
    environment:
      - DB_PORT=3306
      - DB_HOST=mysql
      - DB_NAME=database
      - DB_USERNAME=username
      - DB_PASSWORD=password
      - MAIL_HOST=
      - MAIL_PORT=587
      - MAIL_USERNAME=
      - MAIL_PASSWORD=!
      - MAIL_FROM=Backup Jobs <backup@example.com>
      ## Multiple recipients separated by a comma
      - MAIL_TO=me@example.com,team@example.com,manager@example.com
      - MAIL_SKIP_TLS=false
      ## Time format for notification 
      - TIME_FORMAT=2006-01-02 at 15:04:05
      ## Backup reference, in case you want to identify every backup instance
      - BACKUP_REFERENCE=database/Paris cluster
    networks:
      - web
networks:
  web:
```

### Telegram

```yaml
services:
  mysql-bkup:
    image: jkaninda/mysql-bkup
    container_name: mysql-bkup
    command: backup
    volumes:
      - ./backup:/backup
    environment:
      - DB_PORT=3306
      - DB_HOST=mysql
      - DB_NAME=database
      - DB_USERNAME=username
      - DB_PASSWORD=password
      - TG_TOKEN=[BOT ID]:[BOT TOKEN]
      - TG_CHAT_ID=
      ## Time format for notification 
      - TIME_FORMAT=2006-01-02 at 15:04:05
      ## Backup reference, in case you want to identify every backup instance
      - BACKUP_REFERENCE=database/Paris cluster
    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.tmpl: Email notification template
- telegram.tmpl: Telegram notification template
- email-error.tmpl: Error notification template
- telegram-error.tmpl: 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
- `BackupReference`: Backup reference(eg: database/cluster name or server name)

>  email.template:


```html
<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>
    <li>Backup Reference: {{.BackupReference}} </li>
</ul>
<p>Best regards,</p>
```

> 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
- Backup Reference: {{.BackupReference}}
```

> email-error.template

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>🔴 Urgent: Database Backup Failure Notification</title>
</head>
<body>
<h2>Hi,</h2>
<p>An error occurred during database backup.</p>
<h3>Failure Details:</h3>
<ul>
<li>Error Message: {{.Error}}</li>
<li>Date: {{.EndTime}}</li>
<li>Backup Reference: {{.BackupReference}} </li>
</ul>
</body>
</html>
```

> telegram-error.template


```html
🔴 Urgent: Database Backup Failure Notification

An error occurred during database backup.
Failure Details:

Error Message: {{.Error}}
Date: {{.EndTime}}
```
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
+								---
 								title: Receive notifications
 								layout: default
 								parent: How Tos
 								nav_order: 12
 								---
-												chore: fix infinity calling Fatal, add a backup reference

											
										
										
											2024-10-10 04:14:42 +02:00
+								Send Email or Telegram notifications on successfully or failed backup.
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
 								### Email
-												chore: fix infinity calling Fatal, add a backup reference

											
										
										
											2024-10-10 04:14:42 +02:00
+								To send out email notifications on failed or successfully backup runs, provide SMTP credentials, a sender and a recipient:
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
 								```yaml
 								services:
 								  mysql-bkup:
 								    image: jkaninda/mysql-bkup
 								    container_name: mysql-bkup
 								    command: backup
 								    volumes:
 								      - ./backup:/backup
 								    environment:
 								      - DB_PORT=3306
 								      - DB_HOST=mysql
 								      - DB_NAME=database
 								      - DB_USERNAME=username
 								      - DB_PASSWORD=password
 								      - MAIL_HOST=
 								      - MAIL_PORT=587
 								      - MAIL_USERNAME=
 								      - MAIL_PASSWORD=!
-												docs: update email notification example

											
										
										
											2024-10-12 10:47:14 +02:00
+								      - MAIL_FROM=Backup Jobs <backup@example.com>
 								      ## Multiple recipients separated by a comma
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
+								      - MAIL_TO=me@example.com,team@example.com,manager@example.com
 								      - MAIL_SKIP_TLS=false
-												chore: fix infinity calling Fatal, add a backup reference

											
										
										
											2024-10-10 04:14:42 +02:00
+								      ## Time format for notification
 								      - TIME_FORMAT=2006-01-02 at 15:04:05
-												docs: correct grammar in  receive-notification.md

											
										
										
											2024-10-10 04:28:02 +02:00
+								      ## Backup reference, in case you want to identify every backup instance
-												chore: fix infinity calling Fatal, add a backup reference

											
										
										
											2024-10-10 04:14:42 +02:00
+								      - BACKUP_REFERENCE=database/Paris cluster
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
+								    networks:
 								      - web
 								networks:
 								  web:
 								```
 								### Telegram
 								```yaml
 								services:
 								  mysql-bkup:
 								    image: jkaninda/mysql-bkup
 								    container_name: mysql-bkup
 								    command: backup
 								    volumes:
 								      - ./backup:/backup
 								    environment:
 								      - DB_PORT=3306
 								      - DB_HOST=mysql
 								      - DB_NAME=database
 								      - DB_USERNAME=username
 								      - DB_PASSWORD=password
 								      - TG_TOKEN=[BOT ID]:[BOT TOKEN]
 								      - TG_CHAT_ID=
-												chore: fix infinity calling Fatal, add a backup reference

											
										
										
											2024-10-10 04:14:42 +02:00
+								      ## Time format for notification
 								      - TIME_FORMAT=2006-01-02 at 15:04:05
-												docs: correct grammar in  receive-notification.md

											
										
										
											2024-10-10 04:28:02 +02:00
+								      ## Backup reference, in case you want to identify every backup instance
-												chore: fix infinity calling Fatal, add a backup reference

											
										
										
											2024-10-10 04:14:42 +02:00
+								      - BACKUP_REFERENCE=database/Paris cluster
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
+								    networks:
 								      - web
 								networks:
 								  web:
 								```
 								### Customize notifications
-												chore: fix infinity calling Fatal, add a backup reference

											
										
										
											2024-10-10 04:14:42 +02:00
+								The title and body of the notifications can be tailored to your needs using Go templates.
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
+								Template sources must be mounted inside the container in /config/templates:
-												docs: update notification template

											
										
										
											2024-10-22 17:22:45 +02:00
+								- email.tmpl: Email notification template
 								- telegram.tmpl: Telegram notification template
 								- email-error.tmpl: Error notification template
 								- telegram-error.tmpl: Error notification template
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
-												docs: update send notification

											
										
										
											2024-10-09 22:38:07 +02:00
+								### 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
-												chore: fix infinity calling Fatal, add a backup reference

											
										
										
											2024-10-10 04:14:42 +02:00
+								- `BackupReference`: Backup reference(eg: database/cluster name or server name)
-												docs: update send notification

											
										
										
											2024-10-09 22:38:07 +02:00
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
+								>  email.template:
 								```html
 								<h2>Hi,</h2>
 								<p>Backup of the {{.Database}} database has been successfully completed on {{.EndTime}}.</p>
 								<h3>Backup Details:</h3>
 								<ul>
-												chore: fix infinity calling Fatal, add a backup reference

											
										
										
											2024-10-10 04:14:42 +02:00
+								    <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>
 								    <li>Backup Reference: {{.BackupReference}} </li>
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
+								</ul>
 								<p>Best regards,</p>
 								```
 								> telegram.template
 								```html
-												chore: fix infinity calling Fatal, add a backup reference

											
										
										
											2024-10-10 04:14:42 +02:00
+								✅  Database Backup Notification – {{.Database}}
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
+								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
-												chore: fix infinity calling Fatal, add a backup reference

											
										
										
											2024-10-10 04:14:42 +02:00
+								- Backup Reference: {{.BackupReference}}
 								```
 								> email-error.template
 								```html
 								<!DOCTYPE html>
 								<html lang="en">
 								<head>
 								    <meta charset="UTF-8">
 								    <title>🔴 Urgent: Database Backup Failure Notification</title>
 								</head>
 								<body>
 								<h2>Hi,</h2>
 								<p>An error occurred during database backup.</p>
 								<h3>Failure Details:</h3>
 								<ul>
 								<li>Error Message: {{.Error}}</li>
 								<li>Date: {{.EndTime}}</li>
 								<li>Backup Reference: {{.BackupReference}} </li>
 								</ul>
 								</body>
 								</html>
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
+								```
-												chore: fix infinity calling Fatal, add a backup reference

											
										
										
											2024-10-10 04:14:42 +02:00
+								> telegram-error.template
-												feat: add email notification for failed and success backup

											
										
										
											2024-10-09 22:31:52 +02:00
 								```html
 								🔴 Urgent: Database Backup Failure Notification
 								An error occurred during database backup.
 								Failure Details:
 								Error Message: {{.Error}}
 								Date: {{.EndTime}}
 								```