Skip to content

Commit f55a9b4

Browse files
arsabooballoob
authored andcommitted
Updated Hass.io documents (home-assistant#2559)
1 parent 15bf573 commit f55a9b4

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

source/_addons/lets_encrypt.markdown

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sharing: true
99
footer: true
1010
---
1111

12-
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.
12+
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.
1313

1414
```json
1515
{
@@ -18,7 +18,7 @@ Setup and manage a [let's encrypt](https://letsencrypt.org/) certificate. The fi
1818
}
1919
```
2020

21-
Option variables:
21+
Configuration variables:
2222

23-
- **email** (*Required*): default empty. Your email for register on let's encrypt with your domains.
24-
- **domains** (*Required*): default empty list. A list of domains for create/renew the certificate.
23+
- **email** (*Required*): Your email address for registration on Let's Encrypt.
24+
- **domains** (*Required*): A list of domains to create/renew the certificate.

source/_addons/mosquitto.markdown

+6-6
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sharing: true
99
footer: true
1010
---
1111

12-
Setup a [mosquitto](https://mosquitto.org/) mqtt broker.
12+
Set up a [mosquitto](https://mosquitto.org/) MQTT broker.
1313

1414
```json
1515
{
@@ -22,9 +22,9 @@ Setup a [mosquitto](https://mosquitto.org/) mqtt broker.
2222
}
2323
```
2424

25-
Option variables:
25+
Configuration variables:
2626

27-
- **plain** (*Optional*): default true. Listen broaker on port 1883 without SSL/TLS.
28-
- **ssl** (*Optional*): default false. Listen broker on port 8883 with SSL/TLS. Need to have certificates.
29-
- **anonymous** (*Optional*): default true. Allow anonymous connection. If *logins* is set, anonymous user can only read data.
30-
- **logins** (*Optional*): default empty. A list of user that will be create with *username* and *password*.
27+
- **plain** (*Optional*): Listen to broker on port 1883 without SSL/TLS. Defaults to `true`.
28+
- **ssl** (*Optional*): Listen to broker on port 8883 with SSL/TLS. This requires certificates. Defaults to `false`.
29+
- **anonymous** (*Optional*): Allow anonymous connection. If *logins* is set, anonymous user can only read data. Defaults to `true`.
30+
- **logins** (*Optional*): A list of user that will be created with *username* and *password*.

source/_addons/samba.markdown

+8-8
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sharing: true
99
footer: true
1010
---
1111

12-
Setup a [samba](https://samba.org/) server. Allow to access severals hass.io folders with windows network shares.
12+
This allows you to set up a [Samba](https://samba.org/) server to access hass.io folders using Windows network shares.
1313

1414
```json
1515
{
@@ -23,12 +23,12 @@ Setup a [samba](https://samba.org/) server. Allow to access severals hass.io fol
2323
}
2424
```
2525

26-
Option variables:
26+
Configuration variables:
2727

2828
- **workgroup** (*Optional*): default `WORKGROUP`. Set network workgroup.
29-
- **guest** (*Optional*): default true. Allow login without a username or password.
30-
- **map_config** (*Optional*): default true. Expose homeassistant config folder.
31-
- **map_addons** (*Optional*): default true. Expose local custom addons folder.
32-
- **map_ssl** (*Optional*): default false. Expose ssl folder. Be carfuly with that option!
33-
- **username** (*Optional*): default empty. The username for login if guest login is not active.
34-
- **password** (*Optional*): default empty. Set the password for `username`. A empty password will be not supported.
29+
- **guest** (*Optional*): Allow login without a username or password. Defaults to `true`.
30+
- **map_config** (*Optional*): Expose Home Assistant configuration folder. Defaults to `true`.
31+
- **map_addons** (*Optional*): Expose local custom addons folder. Defaults to `true`.
32+
- **map_ssl** (*Optional*): Expose SSL folder. Be careful with this option! Defaults to `false`.
33+
- **username** (*Optional*): The username for logging in if guest login is not used.
34+
- **password** (*Optional*): Password for `username`. An empty password is not supported.

source/_addons/ssh.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sharing: true
99
footer: true
1010
---
1111

12-
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.
12+
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.
1313

1414
```json
1515
{
@@ -19,6 +19,6 @@ Setup a [ssh](https://openssh.org/) server. Allow to access severals hass.io fol
1919
}
2020
```
2121

22-
Option variables:
22+
Configuration variables:
2323

24-
- **authorized_keys** (*Required*): default empty. Your public-keys for authorized keyfile. Every element will be a line inside that file.
24+
- **authorized_keys** (*Required*): Your public-keys for authorized keyfile. Every element will be a line inside that file.

0 commit comments

Comments
 (0)