diff --git a/README.md b/README.md index b7145a2..2ec3c3a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ # Mailcow-CheckMK -CheckMK Special Agent for Mailcow \ No newline at end of file +##CheckMK Special Agent for Mailcow + +Monitors various aspects of a Mailcow instance: +Email domains with quota usage, number of mailboxes, number of aliases +Mailboxes with quota usage, number of messages, last logins via IMAP/POP3/SMTP + +##Caveats: +Tested only with dockerized versions of Mailcow +Tested with Mailcow version 2022-07a and higher + +Please feel free to add other working environments via review. + +##Version history: + +2023/09/22: 1.1.4 Bugfix for the last bugfix :-) +2023/09/22: 1.1.3 Bugfix for usage calculation if quota is not set (mailboxes) +2023/09/10: 1.1.2 Checks for Solr status added +2023/08/27: 1.0.0 Section "mailcow_mailboxes" completed +2023/08/26: 0.2.2 Section "mailcow_domains" completed +2023/08/21: 0.1.0 Section "mailcow_info" completed +2023/08/20: 0.0.1 Special agent completed + +##Examples how the services look like: + +Services Overview: +![Services Overview](images/Mailcow-Services-Overview.png) + +Service Details: + +![Service Detail Info](images/Mailcow-Info-Details.png) + +![Service Detail Domain](images/Mailcow-Domains-Details.png) + +![Service Detail User](images/Mailcow-Users-Details.png) diff --git a/images/Mailcow-Domains-Details.png b/images/Mailcow-Domains-Details.png new file mode 100644 index 0000000..2bca206 Binary files /dev/null and b/images/Mailcow-Domains-Details.png differ diff --git a/images/Mailcow-Info-Details.png b/images/Mailcow-Info-Details.png new file mode 100644 index 0000000..f585ac9 Binary files /dev/null and b/images/Mailcow-Info-Details.png differ diff --git a/images/Mailcow-Services-Overview.png b/images/Mailcow-Services-Overview.png new file mode 100644 index 0000000..5105ebf Binary files /dev/null and b/images/Mailcow-Services-Overview.png differ diff --git a/images/Mailcow-Users-Details.png b/images/Mailcow-Users-Details.png new file mode 100644 index 0000000..5e01528 Binary files /dev/null and b/images/Mailcow-Users-Details.png differ