schlabbi/docker-notify

Docker-Notify

Docker-Notify能够在Docker镜像更新时向您发送邮件或调用webhook通知。如果您想在Synology上设置docker-notify，可参考这里的指南。

变量定义

• $CONFIG_DIR：定义存储配置文件的目录

配置步骤

1. 将 config.json.example 文件复制到 $CONFIG_DIR/config.json
2. 填写 config.json 文件：
   • 参考src/schema.json中的自描述schema
   • 若省略标签（如：user/repoName），将收到所有更新通知（如 nightly builds）
   • 若为官方仓库，可省略用户部分，直接使用repoName:tag作为镜像名称
3. 构建docker-notify的Docker容器
4. 在docker-compose文件中设置变量 $CONFIG_DIR
5. 使用 docker-compose up -d 运行容器
6. 修改配置后需再次执行 docker-compose up

使用场景示例

假设您的服务器运行两个docker化服务：web服务器和自定义nextcloud镜像，初始docker-compose.yml如下：

yaml
version: '3'
services:
  webserver:
    image: apache2
    restart: always
  nextcloud:
    image: customUser/nextcloud:latest
    restart: always

您希望收到apache2更新通知，并在nextcloud需重建时触发CI流水线，修改后的docker-compose.yml：

yaml
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

对应的config.json示例：

javascript
{
    "notifyServices":[
        {
            "image": "nextcloud:fpm",
            "actions": [
                {
                    "type": "mailHook",
                    "instance": "generalMail",
                    "recipient": "***"
                },
                {
                    "type": "webHook",
                    "instance": "gitlabHook"
                }
            ]
        },
        {
            "image": "httpd",
            "actions": [
                {
                    "type": "mailHook",
                    "instance": "generalMail",
                    "recipient": "***"
                }
            ]
        }
    ],
    "smtpServer": {
        "generalMail": {
            "host": "mail.example.org",
            "port": 25,
            "username": "***",
            "password": "PASSWORD",
            "sendername": "Docker-Notify",
            "senderadress": "***"
        }
    },
    "webHooks":{
        "gitlabHook": {
            "reqUrl": "[***]",
            "httpMethod": "POST",
            // 可选，默认值为null
            "httpBody": {
                "foo": [1, 2, 3]
            }
        }
    }
}