Merge branch 'current' into next
This commit is contained in:
Fabian Affolter
commit
c8ec8391f4
190 changed files with 787 additions and 379 deletions
80
source/_addons/configurator.markdown
Normal file
80
source/_addons/configurator.markdown
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
---
|
||||
layout: page
|
||||
title: "HASS Configurator"
|
||||
description: "Browser-based configuration file editor for Home Assistant."
|
||||
date: 2017-09-25 14:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
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.
|
||||
|
||||
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
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/hassio/screenshots/addon-hass-configurator.png'>
|
||||
Screenshot of the HASS Configurator.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Feature list %}
|
||||
|
||||
- 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. Selected element gets inserted into the editor at the last cursor position.
|
||||
- Restart Home Assitant directly with the click of a button. Reloading groups, automations etc. can be done as well. An API-password is required.
|
||||
- SSL 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.
|
||||
- Editor settings are saved in your browser.
|
||||
|
||||
### {% linkable_title Add-on Configuration %}
|
||||
|
||||
```json
|
||||
{
|
||||
"homeassistant_api": "http://homeassistant:8123/api",
|
||||
"homeassistant_password": "",
|
||||
"username": "admin",
|
||||
"password": "secret",
|
||||
"certfile": "fullchain.pem",
|
||||
"keyfile": "privkey.pem",
|
||||
"ssl": false,
|
||||
"allowed_networks": ["192.168.0.0/16"],
|
||||
"banned_ips": ["8.8.8.8"],
|
||||
"ignore_pattern": ["__pycache__"]
|
||||
}
|
||||
```
|
||||
|
||||
- **homeassistant_api** (*Optional*): The configurator fetches some data from your running Home Assistant instance. If the API is not available through the default URL, modify this variable to fix this.
|
||||
- **homeassistant_password** (*Optional*): If you plan on using API functions, you have to set your API password. Calling services of Home Assistant is prohibited without authentication.
|
||||
- **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.
|
||||
- **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.
|
||||
- **ignore_pattern** (*Optional*): Files and folders to ignore in the UI.
|
||||
|
||||
### {% linkable_title Embedding into Home-Assistant %}
|
||||
|
||||
Using the Home Assistant component [panel_iframe](https://home-assistant.io/components/panel_iframe/) it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration within the Home Assistant frontend.
|
||||
|
||||
An example configuration would look like this:
|
||||
|
||||
```yaml
|
||||
panel_iframe:
|
||||
configurator:
|
||||
title: Configurator
|
||||
icon: mdi:wrench
|
||||
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>
|
||||
|
|
@ -10,12 +10,15 @@ footer: true
|
|||
featured: true
|
||||
---
|
||||
|
||||
[Duck DNS](https://duckdns.org/) is a free dynamic DNS service. Using this service you can have a custom domainname under duckdns.org point at your home computer.
|
||||
[Duck DNS](https://duckdns.org/) is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. This add-on includes support for Let's Encrypt and will automatically create and renew your certificates.
|
||||
|
||||
```json
|
||||
{
|
||||
"lets_encrypt": {
|
||||
"accept_terms": true
|
||||
},
|
||||
"token": "sdfj-2131023-dslfjsd-12321",
|
||||
"domains": ["my-first-account.duckdns.org", "my-second-account.duckdns.org"]
|
||||
"domains": ["my-domain.duckdns.org"]
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -24,3 +27,16 @@ Configuration variables:
|
|||
- **token** (*Required*): Your Duck DNS API key.
|
||||
- **domains** (*Required*): A list of domains to update DNS.
|
||||
- **seconds** (*Optional*): Seconds between updates to Duck DNS.
|
||||
- **lets_encrypt.accept_terms** (*Optional*): If you accept the [Let's Encrypt Subscriber Agreement][le], it will generate & update Let's Enrypt certificates for your DuckDNS domain.
|
||||
|
||||
[le]: https://letsencrypt.org/repository/
|
||||
|
||||
## {% linkable_title Home Assistant configuration %}
|
||||
|
||||
Use the following configuration in Home Assistant to use the generated certificate:
|
||||
|
||||
```yaml
|
||||
http:
|
||||
ssl_certificate: /ssl/fullchain.pem
|
||||
ssl_key: /ssl/privkey.pem
|
||||
```
|
||||
|
|
|
|||
28
source/_addons/git_pull.markdown
Normal file
28
source/_addons/git_pull.markdown
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
layout: page
|
||||
title: "GIT pull"
|
||||
description: "Load and update configuration files for Home Assistant from a GIT repository."
|
||||
date: 2017-09-25 14:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Load and update configuration files for Home Assistant from a GIT repository.
|
||||
|
||||
```json
|
||||
{
|
||||
"repository": null,
|
||||
"auto_restart": false,
|
||||
"repeat": {
|
||||
"active": false,
|
||||
"interval": 300
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- **repository** (*Required*): GIT url to your repository.
|
||||
- **auto_restart** (*Optional*): Make a restart of Home-Assistant if the config have change and is valid.
|
||||
- **repeat/active** (*Optional*): Pull periodic for GIT updates.
|
||||
- **repeat/interval** (*Optional*): Pull all x seconds and look for changes.
|
||||
|
|
@ -56,7 +56,7 @@ Configuration example that uses the USB microphone and use the built-in headset
|
|||
{
|
||||
"mic": "1,0",
|
||||
"speaker": "0,0",
|
||||
"client_secrets": "google_assistant.json",
|
||||
"client_secrets": "google_assistant.json"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ Set up [Mosquitto](https://mosquitto.org/) as MQTT broker.
|
|||
],
|
||||
"customize": {
|
||||
"active": false,
|
||||
"folder": "mosquitto",
|
||||
"folder": "mosquitto"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue