From 8a15bb8d9406602f34bd79c6d36d620e92cf7081 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20D=C3=B6rsch?= <656249+Flow86@users.noreply.github.com> Date: Fri, 16 Aug 2024 10:09:22 +0200 Subject: [PATCH] docs: add information on how to use a custom CA certificate and/or where to obtain it --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 81c5194..9b68f20 100644 --- a/README.md +++ b/README.md @@ -68,11 +68,24 @@ nats: You must put the configuration file into the `/config/config.yml` volume of the docker container. For all available configuration options, see [config.full-example.yml](./config/config.full-example.yml). -ℹ️ The container also used the `/config` volume to store the [multi-platform probe's GID][GID] and therefore cannot be set as read-only (`:ro`) unless you specify the GID as an environment variable. +ℹ️ If necessary you can put your custom [CA certificate][TLS] into `/config/certs` and specify it in the `/config/config.yml` as well: + +```yaml +access_key: YOUR_PROBE_ACCESS_KEY +nats: + url: tls://localhost:23561 + authentication: + user: USER + password: PASSWORD + server_ca: /config/certs/ca.crt +``` + +ℹ️ The container also used the `/config` volume to store the [multi-platform probe's GID][GID] and therefore cannot be set as read-only (`:ro`) unless you specify the [multi-platform probe's GID][GID] as an environment variable. You can also use the `/opt/paessler/share/scripts` volume for the scripts of the [Script v2][prtgmanual:scriptv2] sensor. [prtgmanual:scriptv2]: https://www.paessler.com/manuals/prtg/script_v2_sensor +[TLS]: https://kb.paessler.com/en/topic/91877-how-can-i-create-a-tls-certificate [GID]: https://www.paessler.com/manuals/prtg/prtg_administration_tool_on_remote_probe_systems#:~:text=GID ```sh