Skip to content

CheckMK

mailcow provides the ability to check for updates using its own update script.

If you want to check for mailcow updates using checkmk, you can create an executable file in the local directory of the checkmk agent (typically /usr/lib/check_mk_agent/local/) with the name mailcow_update and the following content: 

#!/bin/bash
cd /opt/mailcow-dockerized/ && ./update.sh --check-tags >/dev/null
status=$?
if [ $status -eq 3 ]; then
  echo "0 \"mailcow_update\" mailcow_update=0;1;;0;1 No newer tags available."
elif [ $status -eq 0 ]; then
  echo "1 \"mailcow_update\" mailcow_update=1;1;;0;1 New tag is available.\nThe changes can be found here: https://github.com/mailcow/mailcow-dockerized/releases/latest"
else
  echo "3 \"mailcow_update\" - Unknown output from update script ..."
fi
exit

To check for every updated code, just create the executable with the following content: 

#!/bin/bash
cd /opt/mailcow-dockerized/ && ./update.sh -c >/dev/null
status=$?
if [ $status -eq 3 ]; then
  echo "0 \"mailcow_update\" mailcow_update=0;1;;0;1 No updates available."
elif [ $status -eq 0 ]; then
  echo "1 \"mailcow_update\" mailcow_update=1;1;;0;1 Updated code is available.\nThe changes can be found here: https://github.com/mailcow/mailcow-dockerized/commits/master"
else
  echo "3 \"mailcow_update\" - Unknown output from update script ..."
fi
exit

If the mailcow installation directory is not /opt/, adjust this in the 2nd line.

After that re-inventory the services for your mailcow host in checmk and a new check named mailcow_update should be selectable.

This will run the mailcow_update everytime checkmk agent is checked, you can cache the result by placing the script in a subfolder named the number of seconds you wish to cache it. \ /usr/lib/check_mk_agent/local/3600/ will cache the response for an 3600 seconds (1 hour).

Screenshots

No updates available

If there are no updates / newer tag available, OK is displayed.

No update available

New updates available

If updates / newer tags are available, WARN is displayed.

Updates available

If CRIT is desired instead, replace the 7th line with the following:

echo "2 \"mailcow_update\" mailcow_update=1;1;;0;1 Updated code is available.\nThe changes can be found here: https://github.com/mailcow/mailcow-dockerized/commits/master"

Detailed check output

Long check output

  • This provides a link to mailcow's GitHub commits, if updates are available.
  • Metrics are also displayed ( not only when updates are available):
  • 0 = No updates available
  • 1 = New updates available