cmk-bonobo/Mailcow-CheckMK
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

MKP 1.2.0, added version check

Browse Source
This commit is contained in:
mellis
2024-01-26 15:05:03 +01:00
parent 276e67d473
commit 3ae427459a
9 changed files with 165 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -8,13 +8,6 @@ Email domains with quota usage, number of mailboxes, number of aliases
Mailboxes with quota usage, number of messages, last logins via IMAP/POP3/SMTP
You have to create an API Key for the MKP to work. Login to your Mailcow instance and go to
System|Configuration
Take a note of the section API, expand it and activate "Activate API" in the section "Read-Only Access"
Don't forget to insert the IP of your CheckMK instance into the textbox "Allow API access from these IPs/CIDR networks".
## Caveats:
Tested only with dockerized versions of Mailcow
@@ -23,6 +16,19 @@ Tested with Mailcow version 2022-07a and higher
Please feel free to add other working environments via review/email.
## Upgrade from older MKPs (before 1.2.0):
If you upgrade from a already installed version before 1.2.0, you have to re-create your rules for the "Mailcow Server Information" (reason: massive parameter changes).
## Steps to accomplish this without problems:
1. Take a screenshot of your settings in the above mentioned ruleset
2. Assure that you have access to the API keys you used within the current rules
3. Delete all rules for "Mailcow Server Information"
4. Install and enable the new MKP
5. Re-create your rules with the previously saved information from steps 1 and 2
6. Apply your changes
## General installation instructions:
1. Upload and enable the MKP
@@ -38,8 +44,21 @@ Please feel free to add other working environments via review/email.
11. Execute a service discovery on your Mailcow host(s) and accept the newly detected services
12. Feel free to adjust the various parameters for thresholds within the available parameter sections (Setup, "Service monitoring rules" after searching for "Mailcow")
## How to create the API Key:
1. Login to your Mailcow instance with an administrative user
2. Got to "System|Configuration"
3. Take a note of the Section "API" and expand it
4. Within the section "Read-Only Access":
4.1 Activate the checkbox "Activate API"
4.2 Take care that the IP your CheckMK server ist listed in the input field "Allow API access from these IPs/CIDR network notations"
5. Save your changes and transfer the show API key to your CheckMK instance
## Version history:
2024/01/26 1.2.0 Added password store option for the API key, added version check
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)