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

docs: refer to built-in NATS server and manual
2026-03-27 18:52:13 +00:00 · 2026-03-26 12:03:11 +01:00 · 2026-03-26 11:47:07 +01:00 · 2025-05-27 09:00:40 +02:00 · 2025-05-26 11:43:02 +02:00
2 changed files with 5 additions and 16 deletions
--- a/README.md
+++ b/README.md
@@ -23,32 +23,21 @@ Requires a [NATS server](#install-and-configure-a-nats-server) connection config

 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][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][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

--- a/run-prtgmpprobe.sh
+++ b/run-prtgmpprobe.sh
@@ -13,7 +13,7 @@ _passthrough=0
 for _arg in "$@"
 do
    case "$_arg" in
-        --help|example-config)
+        -h|--help|example-config|-V|--version)
            _passthrough=1
        ;;
    esac
Author	SHA1	Message	Date
Benjamin Kästner	bc23fd3745	Merge pull request #13 from PaesslerAG/adjust-readme-for-builtin-nats docs: refer to built-in NATS server and manual	2026-03-26 12:03:11 +01:00
Benjamin Kästner	0f42b1cdb9	docs: refer to built-in NATS server and manual PRTG ships with a NATS server, which can be set up via the provided PRTG Administration Tool. As we do not want to duplicate documentation in the README, we now only refer to the manual.	2026-03-26 11:47:07 +01:00
Flow86	baa179a41c	Merge pull request #8 from PaesslerAG/Flow86-patch-1 fix: allow more parameters to be passed through	2025-05-27 09:00:40 +02:00
Flow86	91a2187ec1	fix: allow more parameters to be passed through allow short form of --help (-h) and also --version (-V) to be directly used	2025-05-26 11:43:02 +02:00