monocker

Overview

Monitors Docker (MONitors dOCKER) containers and alerts on 'state' change. Pick one of the following 'message platforms': - pushbullet@your_api_key@your_device_id - pushover@your_user_key@your_app_api_token - discord@webhook_url - ntfy@topic_title - slack@bot_user_oauth_token@your_chat_id - gotify@server_url@app_token - telegram@your_bot_id@your_chat_id - matrix@https://matrix.org@user:matrix.org@access-token@room-id:matrix.org - apprise@apprise_url@config_id@tag (For Matrix, add the userid 'without' the leading @ sign. Values are server, userid, access-token, room-id) (For Apprise, only one tag is supported, and server_avatar is not currently supported)

Runtime arguments

Network: bridge
Shell: sh
Privileged: false

Template configuration

DockerPathro

Allows Monocker to access the list of running containers on Unraid. (Do not change or remove this!)

Target: /var/run/docker.sock
Value: /var/run/docker.sock

Server labelVariable

[Optional] Allows you to add a server-specific label to alert messages. Handy if you have multiple servers running Docker.

Target: SERVER_LABEL
Value: Unraid

Server AvatarVariable

Optional avatar image URL to add to messages. Handy if you are running Monocker on different machines (ONLY supported by discord, slack & ntfy)

Target: SERVER_AVATAR
Default: https://content.invisioncic.com/u329766/monthly_2024_05/monocker.png.ba5ffdb390b627097d2a53645cf87350.png
Value: https://content.invisioncic.com/u329766/monthly_2024_05/monocker.png.ba5ffdb390b627097d2a53645cf87350.png

Docker socket addressVariable

[Optional] - Set this value to a docker socket URL, if you want to connect to docker this way. Leave it blank or omit it otherwise. e.g tcp://n.n.n.n:2375

Target: DOCKER_HOST

Message platformVariable

The details for connecting to a specific message platform.

Target: MESSAGE_PLATFORM

Label EnableVariable

[Optional] Includes or excludes specified containers that have the

Target: LABEL_ENABLE
Default: false
Value: false

Only offline statesVariable

[Optional] Only monitor container state changing to being offline. (Paused, Exited, Running (unhealth), or Dead). Default is false.

Target: ONLY_OFFLINE_STATES
Default: false
Value: false

Exclude exitedVariable

[Optional] Regardless of any other settings, you can choose to ignore or include container states moving to 'Exited'. (This will optionally show or ignore manual stops or containers).

Target: EXCLUDE_EXITED
Default: false
Value: false

PeriodVariable

[Optional] - Set the poll period in seconds. Defaults to 30 seconds (10s minimum).

Target: PERIOD
Default: 30
Value: 30

Disable startup messagesVariable

[Optional] Suppress startup messages being sent when Monocker starts up

Target: DISABLE_STARTUP_MSG
Default: false
Value: false

SHAVariable

[optional] - adds SHA ID for all container alerts. 'true' or 'false' (default)

Default: false
Value: false

Custom NTFY serverVariable

Use this if you self-host a NTFY server. e.g. https://ntfy.yourdomain.com

Target: CUSTOM_NTFY_SERVER

NTFY useridVariable

If you need to authenticate to the official NTFY site or a self-hosted site

Target: NTFY_USER

Password for NTFY authenticationVariable

Password for NTFY authentication

Target: NTFY_PASS

Links

Template Support Docker Hub Project

Details

Repository

petersem/monocker

Registry

https://hub.docker.com/r/petersem/monocker

Last Updated2024-11-05

First Seen2024-05-13

Run Monocker on Unraid.

Monocker is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.

Explore Unraid OS