diff --git a/README.md b/README.md index 8ae4af02f75f90a52848f34977cdcb24a0726dd0..a8f5fc94b5484cf9935c22663ad66496a05ada6a 100644 --- a/README.md +++ b/README.md @@ -12,24 +12,25 @@ This plugin is based on the work of Allan GooD: allan[dot]cassaro[at]gmail[dot]c ### Download * [Download latest mkp file][PACKAGE] - ---- + +**Note**: before you update to a newer version, always check the [CHANGELOG](CHANGELOG). There might be incompatible changes. + +--- ### Installation You can install the package by uploading it to your CheckMK site and as site user run ``` -mkp install squid.mkp -mkp enable squid VERSION +mkp install PACKAGENAME-VERSION.mkp ``` - -In the Enterprise/Free/Cloud edition of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_) - -If you are not using the Agent Bakery, you need to copy the `squid` agent plugin from `~/local/share/check_mk/agents/plugins/squid` of your CheckMK site to the check_mk agent path of your Squid server. This is usually `/usr/lib/check_mk_agent/plugins/` (Don't forget to make it executable). - -**Note**: The agent plugin requieres the **squidclient** package to be installed in addition to the _**Squid Web Proxy**_. +or beginning with CMK2.2.x +``` +mkp add PACKAGENAME-VERSION.mkp +mkp enable PACKAGENAME VERSION +``` +In the non RAW editions of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_) --- -### Want to Contribute? +### Want to contribute? Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing") @@ -112,4 +113,4 @@ The plugin creates the service **_Squid_** the items _**Client**_, _**Server**_, Sample output - +