diff --git a/README.md b/README.md index ab497cc916237f710ba869d88c79d487b54d09b4..137a2552f04bb495e45e1636d28158e0e1cf644b 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ To use this plugin with the RAW edition of CMK you need to copy the plugin files Don't forget to make the Linux script executable (`chmod a+x curl.sh`). -*Note*: the executables and cert are optional. If you don't want to use them, the plugin tryes to use the system provided crul (see: [curl shipped by Microsoft](https://curl.se/windows/microsoft.html)). +*Note*: the executables and cert bundle are optional. If you don't want to use them, the plugin tryes to use the system provided crul (see: [curl shipped by Microsoft](https://curl.se/windows/microsoft.html)). </details> @@ -99,9 +99,9 @@ The bakrey will dynamicly create some additional files in the check_mk agent con | File | Created by bakery option | | ---- | ---- | -| curl_item_#.search | Strings to expect in response | -| curl_item_#.header | Strings to expect in header | -| curl_item_#.pem | Configure certificate verification -> Certificate to verify against | +| curl_item_#.search_response | Strings to expect in response | +| curl_item_#.search_header | Strings to expect in header | +| curl_item_#.ca_cert | Configure certificate verification -> Certificate to verify against | </details> @@ -111,7 +111,7 @@ The bakrey will dynamicly create some additional files in the check_mk agent con #### Configuration file If you are not using the CheckMK agent bakery, than you need to create the config file for the plugin your self. -On each line you have the four fields _service_name_, _url_, _curl_options_, _curl_item__#. Thes fields are sepereated by `|`. There are no comments or empty lines allowed. In addition to the _curl_options_ from _curl.cfg_ the plugin uses the hard coded options `-q -w %{json} -s`. If no expected strings are configured, the option `-o NUL` will be added on Windows and `-o /dev/null` on Linux. +On each line you have the four fields _service_name_, _url_, _curl_options_, _curl_item__#. Thes fields are sepereated by `|`. There are no comments or empty lines allowed. In addition to the _curl_options_ from _curl.cfg_ the plugin uses the hard coded options `-q -w %{json} -s -verbose --stderr $TEMP_DIR\curl_session`. If no expected strings are configured, the option `-o NUL` will be added on Windows and `-o /dev/null` on Linux. <details><summary>Sample curl.cfg file</summary> @@ -155,12 +155,12 @@ thl-cmk.hopto.org|"https://thl-cmk.hopto.org"|-o /dev/null --user-agent "your us | --ntlm | Configure user authentication -> Authentication method -> NTLM authentication | | --ntlm-wb | Configure user authentication -> Authentication method -> NTLM authentication with winbind | | --proxy | Configure proxy server -> Use Proxy -> HTTP | -| --proxy-anyauth | Configure proxy server -> Use Proxy -> Any authentication | -| --proxy-basic | Configure proxy server -> Use Proxy -> Basic authentication | -| --proxy-digest |Configure proxy server -> Use Proxy -> Digest authentication | -| --proxy-negotiate | Configure proxy server -> Use Proxy -> HTTP Negotiate (SPNEGO) authentication | -| --proxy-ntlm | Configure proxy server -> Use Proxy -> NTLM authentication | -| --proxy-user | Configure proxy server -> Use Proxy -> Proxy username | +| --proxy-anyauth | Configure proxy server -> Use Proxy -> Proxy authentication -> Authentication method -> Any authentication | +| --proxy-basic | Configure proxy server -> Use Proxy -> Proxy authentication -> Authentication method -> Basic authentication | +| --proxy-digest |Configure proxy server -> Use Proxy -> Proxy authentication -> Authentication method -> Digest authentication | +| --proxy-negotiate | Configure proxy server -> Use Proxy -> Proxy authentication -> Authentication method -> HTTP Negotiate (SPNEGO) authentication | +| --proxy-ntlm | Configure proxy server -> Use Proxy -> Proxy authentication -> Authentication method -> NTLM authentication | +| --proxy-user | Configure proxy server -> Use Proxy -> Proxy authentication -> Proxy username | | --referer | Set referer | | --socks4 | Configure proxy server -> Use Proxy -> SOCKS4 | | --socks4a |Configure proxy server -> Use Proxy -> SOCKS4a |