From 7935c5d62038eca0c09bc19d8652103ed4d58de6 Mon Sep 17 00:00:00 2001 From: Benjamin Schmid Date: Wed, 24 Feb 2021 14:35:49 +0100 Subject: [PATCH] Enhance QNap configuration value documentation with more hints (#16726) Add a few more hints to avoid the configuration pitfalls I stepped into. I was already writing bug reports until I realized my configuration errors. Co-authored-by: Franck Nijhof Co-authored-by: Franck Nijhof --- source/_integrations/qnap.markdown | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/_integrations/qnap.markdown b/source/_integrations/qnap.markdown index 91a4d7ba479..bc0662975c1 100644 --- a/source/_integrations/qnap.markdown +++ b/source/_integrations/qnap.markdown @@ -35,7 +35,7 @@ sensor: {% configuration %} host: - description: The IP address of the QNAP NAS to monitor. + description: The IP address of the QNAP NAS to monitor, i.e., `192.168.8.12`. required: true type: string port: @@ -44,12 +44,12 @@ port: default: 8080 type: integer ssl: - description: Whether to connect via `https`. + description: Whether to connect via `https`. You might need to configure `port` (i.e., `443`) and `verify_ssl` (i.e., `false`) accordingly. required: false default: false type: boolean verify_ssl: - description: Whether SSL certificates should be validated. + description: Whether SSL certificates should be validated. Set to `false` if you use the default, self-signed QNap certificate. required: false default: true type: boolean @@ -59,7 +59,7 @@ timeout: default: 10 type: integer username: - description: An user to connect to the QNAP NAS. + description: An administration user to connect to the QNAP NAS. This user must be a member of the _administration_ group. required: true type: string password: @@ -118,9 +118,9 @@ monitored_conditions: description: Displays the used space of the volume as a percentage (creates a new entry for each volume). {% endconfiguration %} -### Self-signed certificates +### SSL and Self-signed certificates -If your QNAP device uses self-signed certificates, set the `verify_ssl` option to `false`. +If your QNAP device uses self-signed certificates, set the `verify_ssl` option to `false`. If you configured your device to accept SSL-only connections, please also check that you set `port` accordingly, or you might get an `SSL: WRONG_VERSION_NUMBER` error. ### QNAP device support