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

docs: refer to built-in NATS server and manual

.github/workflows/docker-build.yml

@@ -1,85 +0,0 @@
-# See https://docs.github.com/en/actions/publishing-packages/publishing-docker-images
-
-name: Build and push # to docker registries
-
-on:
-  workflow_dispatch:
-  push:
-    branches:
-      - "main"
-    tags:
-      - "*"
-  release:
-    types: [published]
-
-env:
-  IMAGE_NAME: prtgprobe/multi-platform-probe
-
-jobs:
-  docker_build:
-    name: Build and push
-    runs-on: ubuntu-latest
-    permissions:
-      packages: write
-      contents: read
-      attestations: write
-      id-token: write
-    strategy:
-      fail-fast: false
-      matrix:
-        variant:
-          - name: systemec_piraeus
-            registry: "piraeus.systemec.nl"
-    steps:
-      - name: Set image for Docker
-        id: set-image
-        run: |
-          if [ "${{ matrix.variant.name }}" == "systemec_piraeus" ]; then
-            echo "IMAGE_TO_USE=${IMAGE_NAME}" >> $GITHUB_ENV
-          else
-            echo "Failing to resolve."
-            exit 1
-          fi
-
-      - name: Check out the repository
-        uses: actions/checkout@v5
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-        with:
-          platforms: |
-            - linux/amd64
-            - linux/arm64
-            - linux/arm/v7
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Log in to Systemec Piraeus
-        if: matrix.variant.name == 'systemec_piraeus'
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PUSH_TOKEN }}
-          registry: ${{ matrix.variant.registry }}
-
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@v5
-        with:
-          images: ${{ matrix.variant.registry }}/${{ env.IMAGE_TO_USE }}
-          tags: |
-            type=ref,event=branch
-            type=ref,event=tag
-            type=sha,format=short,prefix=
-
-      - name: Build and push Docker image
-        id: push
-        uses: docker/build-push-action@v6
-        with:
-          context: .
-          file: ./Dockerfile
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-          platforms: linux/amd64,linux/arm64,linux/arm/v7

.github/workflows/dockerhub.yml

@@ -3,8 +3,8 @@
 name: Push to Docker Hub
 
 on:
-#  release:
-#    types: [published]
+  release:
+    types: [published]
 
 env:
   IMAGE_NAME: paessler/multi-platform-probe

.github/workflows/github.yml

@@ -3,9 +3,9 @@
 name: Push to GitHub
 
 on:
-#  push:
-#    branches: ["main"]
-#    tags: ["*"]
+  push:
+    branches: ["main"]
+    tags: ["*"]
 
 env:
   REGISTRY: ghcr.io

Dockerfile

@@ -1,11 +1,10 @@
-FROM debian:13-slim
+FROM debian:11-slim
 
 LABEL org.opencontainers.image.authors="info@paessler.com"
 LABEL org.opencontainers.image.vendor="Paessler GmbH"
 LABEL org.opencontainers.image.licenses="MIT"
 
 ARG DEBIAN_FRONTEND=noninteractive
-ARG DEBIAN_FB_RELEASE=bookworm
 
 # enforce image to be up to date
 RUN \
@@ -22,7 +21,7 @@ RUN \
 # - libcap2-bin     (for setcap command)
 #
 RUN \
-    apt-get update && apt-get full-upgrade \
+    apt-get update \
     && apt-get -y install --no-install-recommends --no-install-suggests \
         ca-certificates \
         python3-minimal \
@@ -30,15 +29,13 @@ RUN \
         libcap2-bin \
     && apt-get clean
 
-# Add Paessler's official package repository with current release specifications.
-# If the current release is not present on Paessler's servers fallback to defined fallback release.
+# add paessler's official package repository
 RUN \
-    apt-get -qq update \
+    apt-get update \
     && apt-get -y install --no-install-recommends --no-install-suggests \
         curl \
-    && curl --fail https://packages.paessler.com/keys/paessler.asc > /usr/share/keyrings/paessler-archive-keyring.asc \
-    && curl --fail https://packages.paessler.com/docs/apt-sources/$(. /etc/os-release && $VERSION_CODENAME).sources \
-    || curl --fail https://packages.paessler.com/docs/apt-sources/${DEBIAN_FB_RELEASE}.sources > /etc/apt/sources.list.d/paessler.sources \
+    && curl --fail --silent https://packages.paessler.com/keys/paessler.asc > /usr/share/keyrings/paessler-archive-keyring.asc \
+    && curl --fail --silent https://packages.paessler.com/docs/apt-sources/$(. /etc/os-release && echo $VERSION_CODENAME).sources > /etc/apt/sources.list.d/paessler.sources \
     && apt-get -y remove --purge curl \
     && apt-get clean
 
@@ -47,11 +44,10 @@ RUN \
     apt-get update \
     && apt-get -y install --no-install-recommends --no-install-suggests \
         prtgmpprobe \
-    && apt-get autoremove -y \
     && apt-get clean
 
 # add entrypoint script
-COPY --chown=root:root --chmod=0555 run-prtgmpprobe.sh /entrypoint.sh
+COPY --chown=root:root --chmod=0555 run-prtgmpprobe.sh /run-prtgmpprobe.sh
 
 # specify volumes:
 # - /config : configuration directory for the prtgmpprobe, put your config.yml here.
@@ -61,5 +57,5 @@ VOLUME [ "/config", "/opt/paessler/share/scripts" ]
 # set WORKDIR to a sane default
 WORKDIR /
 
-ENTRYPOINT [ "/entrypoint.sh" ]
-CMD [ "service-run" ]
+ENTRYPOINT [ "/run-prtgmpprobe.sh" ]
+CMD [ "service-run" ]

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