petersem/monocker

Monocker

监控Docker容器状态变化并发送警报的工具

!https://github.com/petersem/monocker/blob/master/doco/title.png?raw=true

核心功能与特性

• 监控所有容器的状态变化
• 可指定包含或排除特定容器进行监控
• 可选仅在容器状态变为（暂停、退出、运行中（不健康）或停止）时发送警报
• 内置Docker健康检查

支持集成的消息平台

• ---

• Pushbullet
• Pushover

• ---

• Ntfy
• Slack
• Gotify
• Matrix
• Apprise

未来规划

• 支持更多消息平台

安装部署

ya
services:
  monocker:
    container_name: monocker
    image: petersem/monocker
    environment:
      #DOCKER_HOST: tcp://docker-socket-proxy:2375
      SERVER_LABEL: '你的服务器名称'
      SERVER_AVATAR: 'https://content.invisioncic.com/u329766/monthly_2024_05/monocker.png.ba5ffdb390b627097d2a53645cf87350.png'
      MESSAGE_PLATFORM: 'gotify@server@app_token'
      ONLY_OFFLINE_STATES: 'false'
      EXCLUDE_EXITED: 'false'      
      PERIOD: 30
      DISABLE_STARTUP_MSG: 'false'
      #CUSTOM_NTFY_SERVER: 'https://custom.ntfy.com' 
      #NTFY_USER: 'user' 
      #NTFY_PASS: 'password' 
      SHA: 'false'
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
    restart: unless-stopped

环境变量配置

• 可以是UNIX套接字（unix://）、Windows命名管道（npipe://）或TCP连接（tcp://）。如果是管道或套接字，需将连接作为卷挂载。如果连接经过代理，确保允许对/containers端点的GET请求。
• 默认情况下，此值未设置，连接将使用/var/run/docker.sock。

• 'pushbullet@你的_api_key@你的_device_id'
• 'pushover@你的_user_key@你的_app_api_token'
• '@webhook_url'（ Webhook URL）
• 'ntfy@topic_title'（Ntfy主题名称）
• 'slack@bot_user_oauth_token@你的_chat_id'（Slack机器人用户OAuth令牌@聊天ID）
• 'gotify@服务器_url@app_token'（Gotify服务器URL@app令牌）
• '***@你的_bot_id@你的_chat_id'（***机器人ID@聊天ID）
• 'apprise@apprise_url@config_id@tag'（Apprise URL@配置ID@标签） （仅支持一个标签，当前不支持server_avatar）
• 'matrix@[***] （对于Matrix，用户ID需“不带”前导@符号。值依次为服务器、用户ID、访问令牌、房间ID）

高级Ntfy设置

如果自行托管Ntfy服务器或需要身份验证才能连接，请使用以下设置。

项	是否必填	描述
CUSTOM_NTFY_SERVER	False	自行托管的Ntfy服务器URL（否则将使用[***]
NTFY_USER	False	登录用户名（在ntfy.sh或自有服务器上。如果自有服务器开放，则可选）
NTFY_PASS	False	登录密码（在ntfy.sh或自有服务器上）

此功能允许你通过yaml中的标签指定“监控”或“排除”特定容器。

• 如果设为false，则监控所有容器，但排除带有以下标签的容器：

ya
   labels:
     monocker.enable: 'false'

• 如果设为true，则“仅”监控带有以下标签的容器：

ya
   labels:
     monocker.enable: 'true'

• 如果你想监控所有容器，将LABEL_ENABLE: 'false'或直接省略，并无需为其他容器添加标签。

消息平台配置指南

• ***：查看https://github.com/petersem/monocker/raw/master/doco/***_chatid_botid.mkv%E5%B9%B6%E4%BD%BF%E7%94%A8%E6%AD%A4%E9%93%BE%E6%8E%A5%E8%8E%B7%E5%8F%96ID%E5%80%BC%EF%BC%9Ahttps://api.***.org/bot%7Bbot-id%7D/getUpdates
• Pushbullet：在浏览器中打开Pushbullet，从URL获取device IDhttps://raw.githubusercontent.com/petersem/monocker/master/doco/pbdeviceid.PNG
• Pushover：在浏览器中登录Pushover，查看user key（用户密钥）和app token（应用令牌）详情
• ：参考文档创建Webhook并获取URL
• Slack：查看文档获取ID值
• Ntfy：在[***]
• Apprise：请查看官方文档https://github.com/caronc/apprise
• Matrix：查看以下图片获取https://github.com/petersem/monocker/blob/master/doco/matrix-user-id.png?raw=true%E3%80%81https://github.com/petersem/monocker/blob/master/doco/matrix-room-id.png?raw=true%E5%92%8Chttps://github.com/petersem/monocker/blob/master/doco/matrix-access-token.png?raw=true

感谢

如果你喜欢我的工作，可以*以表感谢！*****

主要支持渠道：*** 代码链接：https://github.com/petersem/monocker

本应用使用语义化版本控制。详情见此处。