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-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add on docs (#5456)

Browse Source 
* Update sentence

* Move warning up

* Minor changes

* Update warning

* Update

* Update

* Update warning
This commit is contained in:
Fabian Affolter 2018-05-30 13:12:02 +02:00 committed by GitHub
parent 45091aa564
commit f96a49ba26
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 26 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
source/_addons/configurator.markdown
View File

@ -11,11 +11,9 @@ featured: true
og_image: /images/hassio/screenshots/addon-hass-configurator.png
---
As long as a fully featured configuration GUI for Home Assistant is still under development, you can use this add-on to add a browser-based file-editor to your Hass.IO installation. By default it will listen on port `3218` of the host Hass.IO is running on.
You can use this add-on to add a browser-based file editor to your Hass.io installation. By default it will listen on port `3218` of the host Hass.io is running on.
More information and a standalone version for regular Home Assistant installations can be found in the [GitHub repository][code].
[code]: https://github.com/danielperna84/hass-configurator
More information and a standalone version for regular Home Assistant installations can be found in the [GitHub repository](https://github.com/danielperna84/hass-configurator).
<p class='img'>
<img src='/images/hassio/screenshots/addon-hass-configurator.png'>
@ -24,12 +22,12 @@ Screenshot of the HASS Configurator.
### {% linkable_title Feature list %}
- Web-Based editor to modify your files with syntax highlighting.
- Web-based editor to modify your files with syntax highlighting.
- Upload and download files.
- Stage and commit changes in Git repositories, create and switch between branches, push to remotes.
- Lists of available triggers, events, entities, conditions, and services. The selected element gets inserted into the editor at the last cursor position.
- Restart Home Assistant directly with the click of a button. Reloading groups, automations, etc. can be done as well. An API-password is required.
- SSL support.
- Lists of available triggers, events, entities, conditions and services. The selected element gets inserted into the editor at the last cursor position.
- Restart Home Assistant directly with the click of a button. Reloading groups, automations, etc. can be done as well. An API password is required.
- SSL/TLS support.
- Optional authentication and IP filtering for added security.
- Direct links to Home Assistant documentation and icons.
- Execute shell commands within the add-on container.
@ -55,7 +53,7 @@ Screenshot of the HASS Configurator.
- **username** (*Optional*): Set a username to access your configuration is protected.
- **password** (*Required*): Set a password for access.
- **ssl** (*Optional*): Enable or Disable SSL for the editor.
- **ssl** (*Optional*): Enable or Disable SSL/TLS for the editor.
- **allowed_networks** (*Optional*): Limit access to the configurator by adding allowed IP addresses/networks to the list.
- **banned_ips** (*Optional*): List of statically banned IP addresses.
- **banlimit** (*Optional*): Ban access from IPs after `banlimit` failed login attempts. The default value `0` disables this feature. Restart the add-on to clear the list of banned IP addresses.
@ -63,7 +61,11 @@ Screenshot of the HASS Configurator.
- **dirsfirst** (*Optional*): List directories before files in the file browser.
- **sesame** (*Optional*): Secret token to dynamically allow access from the IP the request originates from. Open your bookmark https://hassio.yourdomain.com:8123/somesecretnobodycanguess while `allowed_networks` is set to `[]` and boom! Open Sesame! You can use the _Network status_ menu to revoke IP addresses for which access has been granted.
### {% linkable_title Embedding into Home-Assistant %}
<p class='note warning'>
Be careful when setting up port forwarding to the configurator while embedding into Home Assistant. If you don't restrict access by requiring authentication and/or blocking based on client IP addresses, your configuration will be exposed to the internet!
</p>
### {% linkable_title Embedding into Home Assistant %}
Using the Home Assistant component [panel_iframe](/components/panel_iframe/) it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration from within the Home Assistant frontend.
@ -77,6 +79,3 @@ panel_iframe:
url: http://hassio.local:3218
```
<p class='note warning'>
Be careful when setting up port forwarding to the configurator while embedding into Home Assistant. If you don't restrict access by requiring authentication and/or blocking based on client IP addresses, your configuration will be exposed to the internet!
</p>

2
source/_addons/mariadb.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
---
Set up a [mariadb](https://mariadb.org/) SQL server. It supports multiple databases, users, and permission settings. If you want to only connect from inside Home Assistant use `core-mariadb` as the host address.
Set up a [mariadb](https://mariadb.org/) SQL server. It supports multiple databases, users and permission settings. If you want to only connect from inside Home Assistant use `core-mariadb` as the host address.
```json
{

4
source/_addons/mosquitto.markdown
View File

@ -29,7 +29,7 @@ Set up [Mosquitto](https://mosquitto.org/) as MQTT broker.
}
```
<p class='note'>
<p class='warning note'>
Make sure you use logins and disable anonymous access if you want to secure the system.
</p>
@ -74,5 +74,5 @@ protocol mqtt
4. Restart MQTT
<p class='note warning'>
It's recommened that you only open your firewall to the SSL/TLS port (8883) and only use the insecure port (1883) for local devices.
It's recommened that you only open your firewall to the SSL/TLS port (8883) and only use the insecure port (1883) for local devices. Also, disable `anonymous:` and set `logins:`.
</p>

2
source/_addons/nginx_proxy.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
---
Setup an SSL proxy with NGINX and redirect port 80 to 443. Make sure you have generated a certificate before you start this add-on.
Sets up an SSL proxy with NGINX and redirect port 80 to 443. Make sure you have generated a certificate before you start this add-on.
In the `http` section of the `configuration.yaml` file remove `ssl_certificate` and `ssl_key` and don't enter the port in the `base_url` to avoid an HTTP 502 error.

4
source/_addons/samba.markdown
View File

@ -39,3 +39,7 @@ Configuration variables:
- **username** (*Optional*): Username for logging in if guest login is not used.
- **password** (*Optional*): Password for `username`. An empty password is not supported.
- **interface** (*Optional*): Interface that will start the share. Normally this is `eth0` for ethernet wired connection and `wlan0` for wireless connection.
<p class='note warning'>
Be careful when setting up port forwarding to the remote access. If you don't restrict access by requiring authentication and guest access is enabled, your configuration could be exposed to the internet!
</p>

10
source/_addons/ssh.markdown
View File

@ -22,7 +22,7 @@ This add-on will not enable you to install packages or do anything as root. This
To use this add-on, you must have a private/public key to log in. To generate them, follow the [instructions for Windows][win] and [these for other platforms][other]. It is possible to set a password for login since version 2.0 but for high security use private/public keys. You can not run both variants at the same time.
To start this add-on for the first time, you either need to include an ssh key (enclosed in quotation marks, on a single line without line breaks) or set a password in the options section.
To start this add-on for the first time, you either need to include a key (enclosed in quotation marks, on a single line without line breaks) or set a password in the options section.
```json
{
@ -33,14 +33,14 @@ To start this add-on for the first time, you either need to include an ssh key (
}
```
The username for login over ssh is `root`. The complete login command is `ssh root@hassio.local`.
The username for login over SSH is `root`. The complete login command is `ssh root@hassio.local`.
After logging in, you will find yourself in this add-ons container. The Home Assistant configuration directory is mounted on the path `/config`.
Configuration variables:
- **authorized_keys** (*Optional*): Your public keys for the authorized key file. Every element will be a line inside that file.
- **password** (*Optional*): Set a password for login. We do not recommend this variant.
- **password** (*Optional*): Set a password for login. We do **NOT** recommend this variant.
<div class='videoWrapper'>
@ -50,4 +50,6 @@ Configuration variables:
[win]: https://www.digitalocean.com/community/tutorials/how-to-create-ssh-keys-with-putty-to-connect-to-a-vps
[other]: https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/
<p class='note'>This add-on is not compatible if Hass.io was installed via the generic Linux installer.</p>
<p class='note'>
This add-on is not compatible if Hass.io was installed via the generic Linux installer.
</p>