From e646f02e27dbe84ded769781650844c7cadb0bde Mon Sep 17 00:00:00 2001 From: Otto Winter Date: Wed, 5 Dec 2018 22:42:40 +0100 Subject: [PATCH] Update Hass.io READMe --- esphomeyaml-edge/README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/esphomeyaml-edge/README.md b/esphomeyaml-edge/README.md index 25c23ea4b2..3b7093efa1 100644 --- a/esphomeyaml-edge/README.md +++ b/esphomeyaml-edge/README.md @@ -64,19 +64,23 @@ Example add-on configuration: ### Option: `ssl` -Enables/Disables encrypted SSL (HTTPS) connections to the web server of this add-on. Set it to `true` to encrypt communications, `false` otherwise. Please note that if you set this to `true` you must also specify a `certfile` and `keyfile`. +Enables/Disables encrypted SSL (HTTPS) connections to the web server of this add-on. +Set it to `true` to encrypt communications, `false` otherwise. +Please note that if you set this to `true` you must also generate the key and certificate +files for encryption. For example using [Let's Encrypt](https://www.home-assistant.io/addons/lets_encrypt/) +or [Self-signed certificates](https://www.home-assistant.io/docs/ecosystem/certificates/tls_self_signed_certificate/). ### Option: `certfile` -The certificate file to use for SSL. +The certificate file to use for SSL. If this file doesn't exist, the add-on start will fail. -**Note**: _The file MUST be stored in `/ssl/`, which is the default for Hass.io_ +**Note**: The file MUST be stored in `/ssl/`, which is the default for Hass.io ### Option: `keyfile` -The private key file to use for SSL. +The private key file to use for SSL. If this file doesn't exist, the add-on start will fail. -**Note**: _The file MUST be stored in `/ssl/`, which is the default for Hass.io_ +**Note**: The file MUST be stored in `/ssl/`, which is the default for Hass.io ### Option: `leave_front_door_open`