Docker-Notify
Docker-Notify can send you a mail or call a webhook when a Docker image gets updated.
If you are trying to set docker-notify up on a Synology, here is a guide for that.
Variable Definitions
$CONFIG_DIR
defines the directory where the config is stored
Setup
- Copy the
config.json.example
file to$CONFIG_DIR/config.json
- Fill out the
config.json
file:- Read the self describing schema in src/schema.json
- If the tag is left out (example: user/repoName), you will receive a mail about any updates made (e.g. nightly builds)
- If the repository is an official repository, you can leave out the user and just add repoName:tag as image.
- Build the Docker container for
docker-notify
. - Set the variable
$CONFIG_DIR
in the docker-compose file. - Run the container with
docker-compose up -d
- If you edit settings in the config, you need to execute
docker-compose up
again.
Example
Consider the following scenario:
You have a server with 2 software services.
One is a dockerized webserver and the other one is a dockerized nextcloud image with some customizations, so your docker-compose.yml
is looking like this:
version: '3'
services:
webserver:
image: apache2
restart: always
nextcloud:
image: customUser/nextcloud:latest
restart: always
Now you want to be notified if you may update your apache2-server and you want to be notified if you must call your ci-pipeline to rebuild your custom nextcloud-docker-image.
So, now your docker-compose.yml
file is looking like this:
version: '3'
services:
webserver:
image: apache2
restart: always
nextcloud:
image: customUser/nextcloud:latest
restart: always
docker-notify:
image: schlabbi/docker-notify
restart: always
volumes:
- /home/someUser/notify/cache:/usr/src/app/cache
- /home/someUser/notify/config.json:/usr/src/app/config.json
The config.json
looks like the following:
{
"notifyServices":[
{
"image": "nextcloud:fpm",
"actions": [
{
"type": "mailHook",
"instance": "generalMail",
"recipient": "info@example.org"
},
{
"type": "webHook",
"instance": "gitlabHook"
}
]
},
{
"image": "httpd",
"actions": [
{
"type": "mailHook",
"instance": "generalMail",
"recipient": "info@example.org"
}
]
}
],
"smtpServer": {
"generalMail": {
"host": "mail.example.org",
"port": 25,
"username": "docker-notify@example.org",
"password": "PASSWORD",
"sendername": "Docker-Notify",
"senderadress": "docker-notify@example.org"
}
},
"webHooks":{
"gitlabHook": {
"reqUrl": "https://ci.example.org",
"httpMethod": "POST",
// This one is optional and will default to null.
"httpBody": {
"foo": [1, 2, 3]
}
}
}
}