jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-26 10:46:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enhance QNap configuration value documentation with more hints (#16726)

Browse Source 
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 <frenck@frenck.nl>

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Benjamin Schmid 2021-02-24 14:35:49 +01:00 committed by GitHub
parent 01d3a2b7a2
commit 7935c5d620
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
source/_integrations/qnap.markdown
View File

@ -35,7 +35,7 @@ sensor:
{% configuration %} {% configuration %}
host: 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 required: true
type: string type: string
port: port:
@ -44,12 +44,12 @@ port:
default: 8080 default: 8080
type: integer type: integer
ssl: 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 required: false
default: false default: false
type: boolean type: boolean
verify_ssl: 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 required: false
default: true default: true
type: boolean type: boolean
@ -59,7 +59,7 @@ timeout:
default: 10 default: 10
type: integer type: integer
username: 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 required: true
type: string type: string
password: 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). description: Displays the used space of the volume as a percentage (creates a new entry for each volume).
{% endconfiguration %} {% 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 ### QNAP device support