Merge pull request #13 from PaesslerAG/adjust-readme-for-builtin-nats

docs: refer to built-in NATS server and manual

.github/workflows/dockerhub-description.yml

@@ -1,30 +0,0 @@
-# https://github.com/peter-evans/dockerhub-description
-
-name: Update Docker Hub Description
-
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - README.md
-      - .github/workflows/dockerhub-description.yml
-
-env:
-  IMAGE_NAME: paessler/multi-platform-probe
-
-jobs:
-  update-description:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the repository
-        uses: actions/checkout@v4
-
-      - name: Docker Hub Description
-        uses: peter-evans/dockerhub-description@v4
-        with:
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PUSH_TOKEN }}
-          repository: ${{ env.IMAGE_NAME }}
-          short-description: ${{ github.event.repository.description }}
-          enable-url-completion: true

README.md

@@ -17,38 +17,27 @@ We recommend that you always update to the latest version of PRTG via the Auto-U
 Requires a [NATS server](#install-and-configure-a-nats-server) connection configured in PRTG.
 
  [prtg-96]: https://www.paessler.com/prtg/history/stable#24.2.96.1315
- [manual]: https://paessler.canto.global/direct/document/qvou34dmut1uh0gg6mqee3ip2k/K-e9xGiEiT58XzlH3s_Nf-B3lVk/original?content-type=application%2Fpdf&name=Multi-Platform+Probe+Manual.pdf
+ [manual]: https://manuals.paessler.com/multiplatformprobemanual.pdf
 
 ## How to use the multi-platform probe container
 
 The set up to use this container is a three-part process:
 
-1. [Install and configure a NATS server](#install-and-configure-a-nats-server)
+1. [Configure the NATS server](#configure-the-nats-server)
 2. [Configure PRTG](#configure-prtg)
 3. [Install and use the container](#container-usage)
 
 ℹ️ If you already have a NATS server configured in PRTG, skip to [step 3](#container-usage).
 
-### Install and configure a NATS server
+### Configure the NATS server
 
-Paessler GmbH provides the **NATS Server for Paessler PRTG** Windows installer that does the following:
-
-* Installs the NATS server executable.
-* Configures the NATS server.
-* Installs and starts the NATS server service in the background.
-
-For the installer and step-by-step instructions on how to set up a NATS server on Windows, see section **Step 1: Install a NATS server** in the [Multi-Platform Probe for PRTG (PDF)][manual] manual.
+Paessler PRTG ships with a NATS server. For the step-by-step instructions on how configure the NATS server for the Multi-Platform Probe, see section **2.1: Configure NATS server connection** in the [Multi-Platform Probe for PRTG][manual] manual.
 
 ℹ️ If you want to deploy your NATS server on a non-Windows system, see the NATS documentation on their website.
 
 ### Configure PRTG
 
-Once you set up your NATS server, you must configure PRTG to accept connections to the NATS server.
-This is done from the PRTG web interface via **Setup** | **Cores & Probes** | **[Multi-Platform Probe Connection Settings][prtg-manual:cores]**.
-
-For step-by-step instructions on how to configure PRTG, see section **Step 2: Configure connection in PRTG** in the [Multi-Platform Probe for PRTG (PDF)][manual] manual.
-
- [prtg-manual:cores]: https://www.paessler.com/manuals/prtg/core_and_probes#multi_platform_probe_connection
+For step-by-step instructions on how to configure PRTG, see section **2.3: Configure PRTG connection** in the [Multi-Platform Probe for PRTG][manual] manual.
 
 ### Container usage
 
@@ -91,8 +80,8 @@ You can also use the `/opt/paessler/share/scripts` volume for the scripts of the
 ```sh
 docker run -it \
   --network bridge \
-  -v ./scripts:/opt/paessler/share/scripts:ro \
-  -v ./config:/config \
+  -v $(pwd)/scripts:/opt/paessler/share/scripts:ro \
+  -v $(pwd)/config:/config \
   --cap-add NET_ADMIN \
   --cap-add NET_RAW \
   paessler/multi-platform-probe:latest

run-prtgmpprobe.sh

@@ -13,12 +13,12 @@ _passthrough=0
 for _arg in "$@"
 do
     case "$_arg" in
-        --help|example-config)
+        -h|--help|example-config|-V|--version)
             _passthrough=1
         ;;
     esac
 done
-if [ $_passthrough -neq 0 ] ; then
+if [ $_passthrough -ne 0 ] ; then
     exec gosu paessler_mpprobe:paessler_mpprobe \
         ${PRTGMPPROBE__BINARY} \
         "$@"
@@ -51,7 +51,7 @@ if [ ! -f "${PRTGMPPROBE__CONFIG_FILE}" ] ; then
 fi
 
 # Get/Generate a probe id from PRTGMPPROBE__ID_FILE or from PRTGMPPROBE__ID if not set in PRTGMPPROBE__CONFIG_FILE
-if [ ! grep -q "^id:" "${PRTGMPPROBE__CONFIG_FILE}" ] ; then
+if ! grep -q "^id:" "${PRTGMPPROBE__CONFIG_FILE}" ; then
     if [ -z "${PRTGMPPROBE__ID-}" ] ; then
         if [ ! -f "${PRTGMPPROBE__ID_FILE}" ] ; then
             cat /proc/sys/kernel/random/uuid > ${PRTGMPPROBE__ID_FILE} || (