From f55a9b425680b519bc5c46fc60b9258d072d3820 Mon Sep 17 00:00:00 2001 From: Alok Saboo Date: Wed, 3 May 2017 22:31:13 -0400 Subject: [PATCH] Updated Hass.io documents (#2559) --- source/_addons/lets_encrypt.markdown | 8 ++++---- source/_addons/mosquitto.markdown | 12 ++++++------ source/_addons/samba.markdown | 16 ++++++++-------- source/_addons/ssh.markdown | 6 +++--- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/source/_addons/lets_encrypt.markdown b/source/_addons/lets_encrypt.markdown index 6f3bb6a0d25..b2b3177c250 100644 --- a/source/_addons/lets_encrypt.markdown +++ b/source/_addons/lets_encrypt.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -Setup and manage a [let's encrypt](https://letsencrypt.org/) certificate. The first run will create the certificate and every other run will renew it if they will expire in 30 days. All other run make nothing. +Setup and manage a [Let's Encrypt](https://letsencrypt.org/) certificate. This will create a certificate on the first run and renew it if the certificate is expiring in the next 30 days. ```json { @@ -18,7 +18,7 @@ Setup and manage a [let's encrypt](https://letsencrypt.org/) certificate. The fi } ``` -Option variables: +Configuration variables: -- **email** (*Required*): default empty. Your email for register on let's encrypt with your domains. -- **domains** (*Required*): default empty list. A list of domains for create/renew the certificate. +- **email** (*Required*): Your email address for registration on Let's Encrypt. +- **domains** (*Required*): A list of domains to create/renew the certificate. diff --git a/source/_addons/mosquitto.markdown b/source/_addons/mosquitto.markdown index 0b100db2a40..ef37e5fd0c4 100644 --- a/source/_addons/mosquitto.markdown +++ b/source/_addons/mosquitto.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -Setup a [mosquitto](https://mosquitto.org/) mqtt broker. +Set up a [mosquitto](https://mosquitto.org/) MQTT broker. ```json { @@ -22,9 +22,9 @@ Setup a [mosquitto](https://mosquitto.org/) mqtt broker. } ``` -Option variables: +Configuration variables: -- **plain** (*Optional*): default true. Listen broaker on port 1883 without SSL/TLS. -- **ssl** (*Optional*): default false. Listen broker on port 8883 with SSL/TLS. Need to have certificates. -- **anonymous** (*Optional*): default true. Allow anonymous connection. If *logins* is set, anonymous user can only read data. -- **logins** (*Optional*): default empty. A list of user that will be create with *username* and *password*. +- **plain** (*Optional*): Listen to broker on port 1883 without SSL/TLS. Defaults to `true`. +- **ssl** (*Optional*): Listen to broker on port 8883 with SSL/TLS. This requires certificates. Defaults to `false`. +- **anonymous** (*Optional*): Allow anonymous connection. If *logins* is set, anonymous user can only read data. Defaults to `true`. +- **logins** (*Optional*): A list of user that will be created with *username* and *password*. diff --git a/source/_addons/samba.markdown b/source/_addons/samba.markdown index 09578a853b8..baba4d50372 100644 --- a/source/_addons/samba.markdown +++ b/source/_addons/samba.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -Setup a [samba](https://samba.org/) server. Allow to access severals hass.io folders with windows network shares. +This allows you to set up a [Samba](https://samba.org/) server to access hass.io folders using Windows network shares. ```json { @@ -23,12 +23,12 @@ Setup a [samba](https://samba.org/) server. Allow to access severals hass.io fol } ``` -Option variables: +Configuration variables: - **workgroup** (*Optional*): default `WORKGROUP`. Set network workgroup. -- **guest** (*Optional*): default true. Allow login without a username or password. -- **map_config** (*Optional*): default true. Expose homeassistant config folder. -- **map_addons** (*Optional*): default true. Expose local custom addons folder. -- **map_ssl** (*Optional*): default false. Expose ssl folder. Be carfuly with that option! -- **username** (*Optional*): default empty. The username for login if guest login is not active. -- **password** (*Optional*): default empty. Set the password for `username`. A empty password will be not supported. +- **guest** (*Optional*): Allow login without a username or password. Defaults to `true`. +- **map_config** (*Optional*): Expose Home Assistant configuration folder. Defaults to `true`. +- **map_addons** (*Optional*): Expose local custom addons folder. Defaults to `true`. +- **map_ssl** (*Optional*): Expose SSL folder. Be careful with this option! Defaults to `false`. +- **username** (*Optional*): The username for logging in if guest login is not used. +- **password** (*Optional*): Password for `username`. An empty password is not supported. diff --git a/source/_addons/ssh.markdown b/source/_addons/ssh.markdown index 82b6bc9e422..6223abed42e 100644 --- a/source/_addons/ssh.markdown +++ b/source/_addons/ssh.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -Setup a [ssh](https://openssh.org/) server. Allow to access severals hass.io folders with ssh client. It allow also to do some tunneling for access from outside. It should by used only on a ResinOS platform, generic linux would have here own ssh server. +Setting up a [SSH](https://openssh.org/) server allows access to hass.io folders with SSH client. It also allows tunneling for access from an external network. Please note that you only need to do this on a ResinOS platform as most Linux flavors have their own SSH server. ```json { @@ -19,6 +19,6 @@ Setup a [ssh](https://openssh.org/) server. Allow to access severals hass.io fol } ``` -Option variables: +Configuration variables: -- **authorized_keys** (*Required*): default empty. Your public-keys for authorized keyfile. Every element will be a line inside that file. +- **authorized_keys** (*Required*): Your public-keys for authorized keyfile. Every element will be a line inside that file.