mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-24 01:37:23 +00:00
Merge remote-tracking branch 'origin/current' into next
This commit is contained in:
Paulus Schoutsen
commit
6e3e7cf60e
@ -139,8 +139,8 @@ social:
|
||||
# Home Assistant release details
|
||||
current_major_version: 0
|
||||
current_minor_version: 91
|
||||
current_patch_version: 2
|
||||
date_released: 2019-04-08
|
||||
current_patch_version: 4
|
||||
date_released: 2019-04-16
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
|
||||
@ -11,7 +11,7 @@ featured: true
|
||||
og_image: /images/hassio/screenshots/addon-hass-configurator.png
|
||||
---
|
||||
|
||||
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 be available over Ingress only.
|
||||
|
||||
More information and a standalone version for regular Home Assistant installations can be found in the [GitHub repository](https://github.com/danielperna84/hass-configurator).
|
||||
|
||||
@ -27,8 +27,6 @@ Screenshot of the HASS Configurator.
|
||||
- Stage, stash and commit changes in Git repositories, create and switch between branches, push to remotes, view diffs.
|
||||
- Lists with available entities, triggers, events, conditions and services.
|
||||
- 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.
|
||||
- Editor settings are saved in your browser.
|
||||
@ -38,68 +36,12 @@ Screenshot of the HASS Configurator.
|
||||
|
||||
```json
|
||||
{
|
||||
"username": "admin",
|
||||
"password": "secret",
|
||||
"ssl": false,
|
||||
"certfile": "fullchain.pem",
|
||||
"keyfile": "privkey.pem",
|
||||
"verify_hostname": false,
|
||||
"allowed_networks": [
|
||||
"192.168.0.0/16",
|
||||
"172.30.0.0/16"
|
||||
],
|
||||
"banned_ips": [
|
||||
"8.8.8.8"
|
||||
],
|
||||
"banlimit": 0,
|
||||
"ignore_pattern": [
|
||||
"__pycache__"
|
||||
],
|
||||
"dirsfirst": false,
|
||||
"enforce_basepath": false,
|
||||
"notify_service": "persistent_notification.create"
|
||||
"enforce_basepath": false
|
||||
}
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: Set a username so that access your configuration is protected.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Set a password for access.
|
||||
required: true
|
||||
type: string
|
||||
ssl:
|
||||
description: Enable or Disable SSL/TLS for the editor.
|
||||
required: true
|
||||
type: boolean
|
||||
default: false
|
||||
certfile:
|
||||
description: Set the path the your SSL certificate if the ssl-option is set to `true`.
|
||||
required: true
|
||||
type: string
|
||||
keyfile:
|
||||
description: Set the path the your SSL private key if the ssl-option is set to `true`.
|
||||
required: true
|
||||
type: string
|
||||
allowed_networks:
|
||||
description: Limit access to the configurator by adding allowed IP addresses/networks to the list.
|
||||
required: true
|
||||
type: string
|
||||
banned_ips:
|
||||
description: List of statically banned IP addresses.
|
||||
required: true
|
||||
type: string
|
||||
banlimit:
|
||||
description: Ban access from IPs after `banlimit` failed login attempts, setting the value to 0 disables this feature. Restart the add-on to clear the list of banned IP addresses.
|
||||
required: true
|
||||
type: integer
|
||||
default: 0
|
||||
ignore_pattern:
|
||||
description: Regex of files and folders to ignore in the UI.
|
||||
required: true
|
||||
type: string
|
||||
dirsfirst:
|
||||
description: List directories before files in the file browser.
|
||||
required: true
|
||||
@ -110,40 +52,8 @@ enforce_basepath:
|
||||
required: true
|
||||
type: boolean
|
||||
default: false
|
||||
notify_service:
|
||||
description: Specify a custom notify-service to be used to push notifications.
|
||||
required: true
|
||||
type: string
|
||||
loglevel:
|
||||
description: The log level the configurator should run with. Valid values are `debug`, `info`, `warning`, `error`, `critical`.
|
||||
required: false
|
||||
type: string
|
||||
default: info
|
||||
sesame:
|
||||
description: Secret token to dynamically allow access from the IP the request originates from. Open your bookmark https://hassio.yourdomain.com:3218/somesecretnobodycanguess while `allowed_networks` is set to `[]` and your IP will get whitelisted. You can use the Network status menu to revoke IP addresses for which access has been granted. Regular authentication is still required.
|
||||
required: false
|
||||
type: string
|
||||
sesame_totp_secret:
|
||||
description: Like the `sesame` option, but instead as Base32 encoded secret string must be provided. This string then can be added to a TOTP App like Google Authenticator. This way you get a 6-digit `sesame` that changes every 30 seconds.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
<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.
|
||||
|
||||
An example configuration would look like this:
|
||||
|
||||
```yaml
|
||||
panel_iframe:
|
||||
configurator:
|
||||
title: Configurator
|
||||
icon: mdi:wrench
|
||||
url: http://hassio.local:3218
|
||||
```
|
||||
### {% linkable_title Old port based Access %}
|
||||
|
||||
You can set a network Port and the Add-on listens on that Port with Home Assistant user credential. That is as a backup if you are not able to connect to Home Assistant anymore. Today, you can restart Home Assistant with broken config, but maybe some times usefully.
|
||||
|
||||
@ -13,7 +13,7 @@ ha_category:
|
||||
ha_release: "0.91"
|
||||
---
|
||||
|
||||
The `aws` integration provides a single place to interact [Amazon Web Services](https://aws.amazon.com/). Current it provide a notification platform can send a message to [AWS SQS](https://aws.amazon.com/sqs/), [AWS SNS](https://aws.amazon.com/sns/), or invoke [AWS Lambda](https://aws.amazon.com/lambda/) functions.
|
||||
The `aws` integration provides a single place to interact with [Amazon Web Services](https://aws.amazon.com/). Currently it provides a notification platform that can send a message to [AWS SQS](https://aws.amazon.com/sqs/), [AWS SNS](https://aws.amazon.com/sns/), or invoke [AWS Lambda](https://aws.amazon.com/lambda/) functions.
|
||||
|
||||
## {% linkable_title Setup %}
|
||||
|
||||
|
||||
@ -12,4 +12,14 @@ ha_category: Other
|
||||
ha_release: 0.88
|
||||
---
|
||||
|
||||
This component is a meta-component and configures a default set of components for Home Assistant to load. The components that will be loaded can be found [here](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/default_config/__init__.py).
|
||||
This component is a meta-component and configures a default set of components for Home Assistant to load. The components that will be loaded can be found [here](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/default_config/manifest.json).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
default_config:
|
||||
```
|
||||
|
||||
|
||||
@ -35,7 +35,9 @@ There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [FRITZ!Box 6490 Cable](https://en.avm.de/products/fritzbox/fritzbox-6490-cable/)
|
||||
- [FRITZ!Box 7590](https://en.avm.de/products/fritzbox/fritzbox-7590/)
|
||||
- [FRITZ!Box 7430](https://en.avm.de/products/fritzbox/fritzbox-7430/)
|
||||
- [FRITZ!DECT 200](https://en.avm.de/products/fritzdect/fritzdect-200/)
|
||||
- [FRITZ!DECT 301](https://en.avm.de/products/fritzdect/fritzdect-301/)
|
||||
- [Eurotronic Comet DECT](https://eurotronic.org/produkte/elektronische-heizkoerperthermostate/sparmatic-comet/)
|
||||
|
||||
## {% linkable_title Setup %}
|
||||
|
||||
@ -114,7 +114,7 @@ automation:
|
||||
|
||||
### {% linkable_title Manual Theme Selection %}
|
||||
|
||||
When themes are enabled in the `configuration.yaml` file, a new option will show up in the user profile menu (before 0.77 it was in the Configuration panel under **General** called "Set a theme"). You can then choose any installed theme from the dropdown list and it will be applied immediately.
|
||||
When themes are enabled in the `configuration.yaml` file, a new option will show up in the user profile menu (accessed by clicking your user account initials at the top of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/frontend/user-theme.png' />
|
||||
@ -139,7 +139,7 @@ Those will be loaded via `<link rel='import' href='{{ extra_url }}' async>` on a
|
||||
|
||||
### {% linkable_title Manual Language Selection %}
|
||||
|
||||
The browser language is automatically detected. To use a different language, go to the user profile menu (before 0.77 it was found in **General** in the Configuration panel) and select one. It will be applied immediately.
|
||||
The browser language is automatically detected. To use a different language, go to the user profile menu (accessed by clicking your user account initials at the top of the sidebar) and select one. It will be applied immediately.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/frontend/user-language.png' />
|
||||
|
||||
@ -14,9 +14,9 @@ ha_iot_class: Local Polling
|
||||
---
|
||||
|
||||
|
||||
The [KNX](http://www.knx.org) integration for Home Assistant allows you to connect to a KNX/IP devices.
|
||||
The [KNX](https://www.knx.org) integration for Home Assistant allows you to connect to a KNX/IP devices.
|
||||
|
||||
The component requires a local KNX/IP interface like the [Weinzierl 730](http://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/knx-ip-interface-730-en). Through this, it will send and receive commands to and from other devices to the KNX bus.
|
||||
The component requires a local KNX/IP interface like the [Weinzierl 730](https://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/produktarchiv-en/knx-ip-interface-730-en). Through this, it will send and receive commands to and from other devices to the KNX bus.
|
||||
|
||||
<p class='note warning'>
|
||||
Please note, the `knx` platform does not support Windows and needs at least python version 3.5.
|
||||
|
||||
@ -25,7 +25,7 @@ The `luftdaten` component will query the open data API of [luftdaten.info](http:
|
||||
- To get the ID of a particle sensor you need to select it on the [Feinstaub map](http://deutschland.maps.luftdaten.info/) and find it in the sidebar (Column "Sensor ID").
|
||||
- To get the ID of a temperature/humidity sensor you need to find it on the map hosted on [Madavi](https://www.madavi.de/sensor/feinstaub-map-dht/).
|
||||
|
||||
## {% linkable_title COnfiguration via the frontend %}
|
||||
## {% linkable_title Configuration via the frontend %}
|
||||
|
||||
Menu: **Configuration** -> **Integrations**
|
||||
|
||||
|
||||
@ -131,10 +131,6 @@ Call the service `recorder.purge` to start a purge task which deletes events and
|
||||
| `keep_days` | yes | The number of history days to keep in recorder database (defaults to the component `purge_keep_days` configuration)
|
||||
| `repack` | yes | Rewrite the entire database, possibly saving some disk space. Only supported for SQLite and requires at least as much disk space free as the database currently uses.
|
||||
|
||||
<p class='note'>
|
||||
Purging does not necessarily remove all entries before a given date. For example, to be able to recover after startup, the last known state for each entry is never purged. This is true even if the entry is already removed from your configuration.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Custom database engines %}
|
||||
|
||||
| Database engine | `db_url` |
|
||||
|
||||
@ -21,16 +21,15 @@ The `rejseplanen` sensor will provide you with travel details for Danish public
|
||||
|
||||
The `stop_id` can be obtained through the following steps:
|
||||
|
||||
- Go to [http://rejseplanen.dk](http://rejseplanen.dk)
|
||||
- Make a search and fill in the location you want to find stop ID for in the from's (a) section.
|
||||
- Fill in either a random or the destination into the (b) section of the form.
|
||||
- Press on "detaljer" and find the name of the stop you are looking for.
|
||||
- Example search:
|
||||
- Jernaldervej 1, Søften, 8382 Hinnerup
|
||||
- Odense St. (detaljer)
|
||||
- Now insert the stop name in the end of this URL: http://xmlopen.rejseplanen.dk/bin/rest.exe/location?format=json&input=STOP_NAME
|
||||
If you know the exact name of the stop you can search the stop_id with the following url [http://xmlopen.rejseplanen.dk/bin/rest.exe/location?format=json&input=STOP_NAME](http://xmlopen.rejseplanen.dk/bin/rest.exe/location?format=json&input=STOP_NAME) and put in the name of the stop instead of "STOP_NAME" in the end of the url.
|
||||
|
||||
If you don't know the name of the stop follow this guide:
|
||||
- Go to [https://www.openstreetmap.org](https://www.openstreetmap.org)
|
||||
- Make a search and fill in the location you want to find for.
|
||||
- The url will look like this [https://www.openstreetmap.org/#map=18/56.15756/10.20674](https://www.openstreetmap.org/#map=18/56.15756/10.20674)
|
||||
- Now insert the coordinates for the location in the url, in this example it will be: [http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&](http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&)
|
||||
- You will now see the 30 stops closest to your location.
|
||||
|
||||
For "Engdalsvej/Århusvej" you would have to use: http://xmlopen.rejseplanen.dk/bin/rest.exe/location?format=json&input=Engdalsvej/%C3%85rhusvej
|
||||
You will se a output like this:
|
||||
|
||||
```text
|
||||
@ -75,7 +74,7 @@ departure_type:
|
||||
|
||||
## {% linkable_title Direction %}
|
||||
|
||||
If you use the direction filter it's important to put correct destination or else the sensor will not work at all.
|
||||
If you use the `direction` filter it's important to put correct destination or else the sensor will not work at all.
|
||||
The direction has to be the destination(s) for the transport type(s) for the departure stop destination, and NOT the stop where you want to get off. Check [http://rejseplanen.dk](http://rejseplanen.dk), make a search and use the destinations from there in your configuration. Make sure you use the exact name as the destination(s).
|
||||
|
||||
A working example on how to use this sensor with direction:
|
||||
@ -124,6 +123,7 @@ The sensor can filter the timetables by one or more routes, directions and types
|
||||
|--------------|-------------|
|
||||
| BUS | Normal bus |
|
||||
| EXB | Express bus |
|
||||
| LET | Letbanen |
|
||||
| M | Metro |
|
||||
| S | S-train |
|
||||
| REG | Regional train |
|
||||
|
||||
@ -57,6 +57,7 @@ A cloud queue cannot be restarted. This includes queues started from within Spot
|
||||
### {% linkable_title Service `media_player.sonos_join` %}
|
||||
|
||||
Group players together under a single coordinator. This will make a new group or join to an existing group.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `master` | no | A single `entity_id` that will become/stay the coordinator speaker.
|
||||
@ -65,6 +66,7 @@ Group players together under a single coordinator. This will make a new group or
|
||||
### {% linkable_title Service `media_player.sonos_unjoin` %}
|
||||
|
||||
Remove one or more speakers from their group of speakers. If no `entity_id` is provided, all speakers are unjoined.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | String or list of `entity_id`s to separate from their coordinator speaker.
|
||||
|
||||
@ -15,7 +15,7 @@ ha_iot_class: Local Push
|
||||
ha_qa_scale: internal
|
||||
---
|
||||
|
||||
The `stream` component provides a way to proxy live streams through Home Assistant. The component currently only supports proxying H.264 source streams to the HLS format.
|
||||
The `stream` component provides a way to proxy live streams through Home Assistant. The component currently only supports proxying H.264 source streams to the HLS format and requires at least FFmpeg >= 3.2.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
|
||||
@ -19,6 +19,7 @@ The `synology` camera platform allows you to watch the live streams of your [Syn
|
||||
|
||||
<p class='note'>
|
||||
Synology has disabled the livestreaming API and the component is currently broken if you are using Surveillance Station version 8.2.3-5828.
|
||||
There is an unsupported preview fix available. (8.2.3-5829) - Instructions can be found [here](https://www.vcloudinfo.com/2019/04/how-to-manually-upgrade-your-synology-surveillance-system-firmware.html) for updating manually.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
@ -43,6 +43,16 @@ fire_event:
|
||||
|
||||
To manually clear the system log, call this service.
|
||||
|
||||
### {% linkable_title Service `write` %}
|
||||
|
||||
Write a log entry
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------- |
|
||||
| `message` | no | Message to log |
|
||||
| `level` | yes | Log level: debug, info, warning, error, critical. Defaults to 'error'. |
|
||||
| `logger` | yes | Logger name under which to log the message. Defaults to 'system_log.external'. |
|
||||
|
||||
## {% linkable_title Events %}
|
||||
|
||||
Errors and warnings are posted as the event `system_log_event`, so it is possible to write automations that trigger whenever a warning or error occurs. The following information is included in each event:
|
||||
@ -114,3 +124,24 @@ automation:
|
||||
message: '{{ trigger.event.data.message }}'
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### {% linkable_title Writing to log %}
|
||||
|
||||
This automation will create a new log entry when the door is opened:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
automation:
|
||||
- alias: Log door opened
|
||||
trigger:
|
||||
platform: state
|
||||
entity_id: binary_sensor.door
|
||||
from: 'off'
|
||||
to: 'on'
|
||||
action:
|
||||
service: system_log.write
|
||||
message: 'Door opened!'
|
||||
level: info
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
|
||||
@ -375,7 +375,7 @@ Software Required:
|
||||
```bash
|
||||
java -jar abe.jar unpack backup.ab backup.tar
|
||||
```
|
||||
After that, you kann open the file with WinRaR or what ever you like.
|
||||
After that, you will be able to open the file with WinRaR or what ever you like.
|
||||
6. Go to \apps\com.xiaomi.smarthome\db
|
||||
7. Open miio2.db with SQLite Browser
|
||||
8. You can find your device tokens in "devicerecord" table
|
||||
|
||||
@ -35,21 +35,27 @@ There is currently support for the following device types within Home Assistant:
|
||||
- Switch
|
||||
- Fan
|
||||
|
||||
ZHA exception and deviation handling:
|
||||
## {% linkable_title ZHA exception and deviation handling %}
|
||||
|
||||
Zigbee devices that deviate from or do not fully conform to the standard specifications set by the [Zigbee Alliance](https://www.zigbee.org) may require the development of custom [ZHA Device Handlers](https://github.com/dmulcahey/zha-device-handlers) (ZHA custom quirks handler implementation) to for all their functions to work properly with the ZHA component in Home Assistant. These ZHA Device Handlers for Home Assistant can thus be used to parse custom messages to and from Zigbee devices.
|
||||
|
||||
The custom quirks implementations for zigpy implemented as ZHA Device Handlers for Home Assistant are a similar concept to that of [Hub-connected Device Handlers for the SmartThings Classics platform](https://docs.smartthings.com/en/latest/device-type-developers-guide/) as well as that of [Zigbee-Shepherd Converters as used by Zigbee2mqtt](https://www.zigbee2mqtt.io/how_tos/how_to_support_new_devices.html), meaning they are each virtual representations of a physical device that expose additional functionality that is not provided out-of-the-box by the existing integration between these platforms.
|
||||
|
||||
Known working Zigbee radio modules:
|
||||
## {% linkable_title Known working Zigbee radio modules %}
|
||||
|
||||
- EmberZNet based radios using the EZSP protocol (via the [bellows](https://github.com/zigpy/bellows) library for zigpy)
|
||||
- [Nortek GoControl QuickStick Combo Model HUSBZB-1 (Z-Wave & Zigbee USB Adapter)](https://www.nortekcontrol.com/products/2gig/husbzb-1-gocontrol-quickstick-combo/)
|
||||
- [Elelabs Zigbee USB Adapter](https://elelabs.com/products/elelabs_usb_adapter.html)
|
||||
- [Elelabs Zigbee Raspberry Pi Shield](https://elelabs.com/products/elelabs_zigbee_shield.html)
|
||||
- Telegesis ETRX357USB (Note! This first have to be flashed with other EmberZNet firmware)
|
||||
- Telegesis ETRX357USB-LRS (Note! This first have to be flashed with other EmberZNet firmware)
|
||||
- Telegesis ETRX357USB-LRS+8M (Note! This first have to be flashed with other EmberZNet firmware)
|
||||
- XBee Zigbee based radios (via the [zigpy-xbee](https://github.com/zigpy/zigpy-xbee) library for zigpy)
|
||||
- Digi XBee Series 3 (xbee3-24) modules
|
||||
- Digi XBee Series 2C (S2C) modules
|
||||
- Digi XBee Series 2 (S2) modules (Note! This first have to be flashed with Zigbee Coordinator API firmware)
|
||||
- Dresden-Elektronik deCONZ based Zigbee radios (via the [zigpy-deconz](https://github.com/zigpy/zigpy-deconz) library for zigpy)
|
||||
- [ConBee II (a.k.a. ConBee 2) USB adapter from Dresden-Elektronik](https://shop.dresden-elektronik.de/conbee-2.html)
|
||||
- [ConBee USB adapter from Dresden-Elektronik](https://www.dresden-elektronik.de/conbee/)
|
||||
- [RaspBee Raspberry Pi Shield from Dresden-Elektronik](https://www.dresden-elektronik.de/raspbee/)
|
||||
|
||||
|
||||
12
source/_cookbook/configuration_yaml_by_silvrrgit.markdow
Normal file
12
source/_cookbook/configuration_yaml_by_silvrrgit.markdow
Normal file
@ -0,0 +1,12 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Configuration.yaml by SilvrrGIT"
|
||||
description: ""
|
||||
date: 2019-04-12 09:45
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
ha_category: Example configuration.yaml
|
||||
ha_external_link: https://github.com/SilvrrGIT/HomeAssistant
|
||||
---
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Installation on FreeNAS 9.10"
|
||||
title: "Installation on FreeNAS 11.2"
|
||||
description: "Installation of Home Assistant on your FreeNAS."
|
||||
date: 2017-06-20 11:00
|
||||
sidebar: true
|
||||
@ -9,45 +9,142 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
[Freenas](http://www.freenas.org) is a free and open-source network-attached storage (NAS) software based on FreeBSD and the OpenZFS file system. It is licensed under the terms of the BSD License and runs on commodity x86-64 hardware.
|
||||
[FreeNAS](https://www.freenas.org) is a free and open-source network-attached storage (NAS) software based on FreeBSD and the OpenZFS file system. It is licensed under the terms of the BSD License and runs on commodity x86-64 hardware.
|
||||
|
||||
This has been tested on the FreeNAS 9.10. These instructions assume you already have a running and accessible jail. For more information on creating a jail follow the official FreeNAS 9.10.x documentation [HERE](https://doc.freenas.org/9.10/jails.html#adding-jails). Once you have the jail follow the steps below.
|
||||
This has been tested on FreeNAS 11.2 and should also work on FreeBSD 11.x as well. These instructions assume you already have a running and accessible jail. For more information on creating a jail read the official FreeNAS User Guide regarding [Jails](https://www.ixsystems.com/documentation/freenas/11.2/jails.html). Once you have the jail available, follow the steps below. Directories used follow standard BSD conventions but can be adjusted as you wish.
|
||||
|
||||
Install the necessary Python Packages.
|
||||
Create the user and group that Home Assistant will run as. The user/group ID of `8123` can be replaced if this is already in use in your environment.
|
||||
|
||||
```bash
|
||||
# pw groupadd -n homeassistant -g 8123
|
||||
# echo 'homeassistant:8123:8123::::::/bin/csh:' | adduser -f -
|
||||
```
|
||||
|
||||
Install the necessary Python packages:
|
||||
|
||||
```bash
|
||||
# pkg update
|
||||
# pkg upgrade
|
||||
# pkg install python35
|
||||
# pkg install py35-sqlite3
|
||||
# python3.5 -m ensurepip
|
||||
# pkg install -y python37 py37-sqlite3 ca_root_nss
|
||||
# python3.7 -m ensurepip
|
||||
```
|
||||
|
||||
Install Home Assistant itself.
|
||||
Create the configuration directory:
|
||||
|
||||
```bash
|
||||
# pip3 install homeassistant
|
||||
# mkdir -p /usr/local/homeassistant
|
||||
# chown -R homeassistant:homeassistant /usr/local/homeassistant
|
||||
```
|
||||
|
||||
Create an `/etc/rc.local` file to enable Home Assistant to start when the jail starts. The command in `/etc/rc.local` can also be run in a terminal session but Home Assistant will exit when that session is closed.
|
||||
|
||||
Create the installation directory:
|
||||
|
||||
```bash
|
||||
# cd / && mkdir -p /home/.homeassistant
|
||||
mkdir -p /usr/local/share/homeassistant
|
||||
chown -R homeassistant:homeassistant /usr/local/share/homeassistant
|
||||
```
|
||||
|
||||
Install Home Assistant itself:
|
||||
|
||||
```bash
|
||||
# /usr/local/bin/hass --open-ui --config /home/.homeassistant/ &
|
||||
# su homeassistant
|
||||
% cd /usr/local/share/homeassistant
|
||||
% source ./bin/activate.csh
|
||||
% virtualenv -p python3.7 .
|
||||
% pip3 install homeassistant
|
||||
% deactivate
|
||||
% exit
|
||||
```
|
||||
|
||||
Make `/etc/rc.local` executable so it runs on startup
|
||||
Create an `rc.d` script for the system-level service that enables Home Assistant to start when the jail starts. Create a file at `/usr/local/etc/rc.d/homeassistant` with the following contents:
|
||||
|
||||
```bash
|
||||
# chmod 755 /etc/rc.local
|
||||
#!/bin/sh
|
||||
#
|
||||
# Based upon work by tprelog at https://www.ixsystems.com/community/resources/fn-11-2-iocage-home-assistant-jail-plugins-for-node-red-mosquitto-amazon-dash-tasmoadmin.102/
|
||||
#
|
||||
# PROVIDE: homeassistant
|
||||
# REQUIRE: LOGIN
|
||||
# KEYWORD: shutdown
|
||||
#
|
||||
# homeassistant_enable: Set to YES to enable the homeassistant service.
|
||||
# Default: NO
|
||||
# homeassistant_user: The user account used to run the homeassistant daemon.
|
||||
# This is optional, however do not specifically set this to an
|
||||
# empty string as this will cause the daemon to run as root.
|
||||
# Default: homeassistant
|
||||
# homeassistant_group: The group account used to run the homeassistant daemon.
|
||||
# This is optional, however do not specifically set this to an
|
||||
# empty string as this will cause the daemon to run with group wheel.
|
||||
# Default: homeassistant
|
||||
# homeassistant_config_dir: Directory where config files are located.
|
||||
# Default: /usr/local/homeassistant
|
||||
# homeassistant_install_dir: Directory where Home Assistant is installed.
|
||||
# Default: /usr/local/share/homeassistant
|
||||
#
|
||||
# sysrc homeassistant_enable=yes
|
||||
# service homeassistant start
|
||||
|
||||
. /etc/rc.subr
|
||||
name=homeassistant
|
||||
rcvar=${name}_enable
|
||||
|
||||
pidfile_child="/var/run/${name}.pid"
|
||||
pidfile="/var/run/${name}_daemon.pid"
|
||||
|
||||
load_rc_config ${name}
|
||||
: ${homeassistant_enable:="NO"}
|
||||
: ${homeassistant_user:="homeassistant"}
|
||||
: ${homeassistant_group:="homeassistant"}
|
||||
: ${homeassistant_config_dir:="/usr/local/homeassistant"}
|
||||
: ${homeassistant_install_dir:="/usr/local/share/homeassistant"}
|
||||
|
||||
command="/usr/sbin/daemon"
|
||||
start_precmd=${name}_precmd
|
||||
homeassistant_precmd()
|
||||
{
|
||||
rc_flags="-f -P ${pidfile} -p ${pidfile_child} ${homeassistant_install_dir}/bin/hass --config ${homeassistant_config_dir} ${rc_flags}"
|
||||
|
||||
if [ ! -e "${pidfile_child}" ]; then
|
||||
install -g ${homeassistant_group} -o ${homeassistant_user} -- /dev/null "${pidfile_child}";
|
||||
fi
|
||||
|
||||
if [ ! -e "${pidfile}" ]; then
|
||||
install -g ${homeassistant_group} -o ${homeassistant_user} -- /dev/null "${pidfile}";
|
||||
fi
|
||||
|
||||
if [ ! -d "${homeassistant_config_dir}" ]; then
|
||||
install -d -g ${homeassistant_group} -o ${homeassistant_user} -- "${homeassistant_config_dir}";
|
||||
fi
|
||||
|
||||
echo "Performing check on Home Assistant configuration:"
|
||||
eval "${homeassistant_install_dir}/bin/hass" --config "${homeassistant_config_dir}" --script check_config
|
||||
}
|
||||
|
||||
stop_postcmd=${name}_postcmd
|
||||
homeassistant_postcmd()
|
||||
{
|
||||
rm -f -- "${pidfile}"
|
||||
rm -f -- "${pidfile_child}"
|
||||
}
|
||||
|
||||
run_rc_command "$1"
|
||||
```
|
||||
|
||||
Finally restart the jail from the FreeNAS GUI.
|
||||
Make the `rc.d` script executable:
|
||||
|
||||
```bash
|
||||
# chmod +x /usr/local/etc/rc.d/homeassistant
|
||||
```
|
||||
|
||||
Configure the service to start on boot and start the Home Assistant service:
|
||||
|
||||
```bash
|
||||
# sysrc homeassistant_enable="YES"
|
||||
# service homeassistant start
|
||||
```
|
||||
|
||||
You can also restart the jail to ensure that Home Assistant starts on boot.
|
||||
|
||||
<p class='note'>
|
||||
USB Z-wave sticks may give `dmesg` warnings similar to "data interface 1, has no CM over data, has no break". This doesn't impact the function of the Z-wave stick in Hass. Just make sure the proper `/dev/cu*` is used in the Home Assistant `configuration.yaml` file.
|
||||
USB Z-wave sticks may give `dmesg` warnings similar to "data interface 1, has no CM over data, has no break". This doesn't impact the function of the Z-Wave stick in Home Assistant. Just make sure the proper `/dev/cu*` is used in the Home Assistant `configuration.yaml` file.
|
||||
</p>
|
||||
|
||||
@ -33,7 +33,7 @@ entities:
|
||||
type: list
|
||||
hours_to_show:
|
||||
required: false
|
||||
description: Hours to show.
|
||||
description: Hours to show. Minimum is 10 hours, maximum of 80 hours.
|
||||
type: integer
|
||||
default: 24
|
||||
refresh_interval:
|
||||
|
||||
@ -160,6 +160,33 @@ If you run hass.io on an Intel NUC and haven't seen it yet, check out the VS Cod
|
||||
[yeelight docs]: /components/yeelight/
|
||||
[zha docs]: /components/zha/
|
||||
|
||||
## {% linkable_title Release 0.91.3 - April 10 %}
|
||||
|
||||
- Fix position of add_entities of binary sensor ([@AZDane] - [#22866]) ([concord232 docs])
|
||||
- More Mobile app sensor fixes ([@robbiet480] - [#22914]) ([mobile_app docs])
|
||||
- Add cloudhook and remote UI vals to get_config ([@robbiet480] - [#22921]) ([mobile_app docs])
|
||||
- Bugfix: pass protocol out of header to application layer ([@pvizeli] - [#22955]) ([hassio docs])
|
||||
|
||||
[#22866]: https://github.com/home-assistant/home-assistant/pull/22866
|
||||
[#22914]: https://github.com/home-assistant/home-assistant/pull/22914
|
||||
[#22921]: https://github.com/home-assistant/home-assistant/pull/22921
|
||||
[#22955]: https://github.com/home-assistant/home-assistant/pull/22955
|
||||
[@AZDane]: https://github.com/AZDane
|
||||
[@pvizeli]: https://github.com/pvizeli
|
||||
[@robbiet480]: https://github.com/robbiet480
|
||||
[concord232 docs]: /components/concord232/
|
||||
[hassio docs]: /components/hassio/
|
||||
[mobile_app docs]: /components/mobile_app/
|
||||
|
||||
## {% linkable_title Release 0.91.4 - April 16 %}
|
||||
|
||||
- Fix ingress bug with Firefox ([@pvizeli] - [#23121]) ([hassio docs]) ([http docs])
|
||||
|
||||
[#23121]: https://github.com/home-assistant/home-assistant/pull/23121
|
||||
[@pvizeli]: https://github.com/pvizeli
|
||||
[hassio docs]: /components/hassio/
|
||||
[http docs]: /components/http/
|
||||
|
||||
## {% linkable_title If you need help... %}
|
||||
|
||||
...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.
|
||||
|
||||
88
source/_posts/2019-04-15-hassio-ingress.markdown
Normal file
88
source/_posts/2019-04-15-hassio-ingress.markdown
Normal file
@ -0,0 +1,88 @@
|
||||
---
|
||||
layout: post
|
||||
title: "Introducing Hass.io Ingress"
|
||||
description: "Ingress allows Hass.io add-ons to seamlessly integrate their user interface with Home Assistant"
|
||||
date: 2019-04-15 00:00:00
|
||||
date_formatted: "April 15, 2019"
|
||||
author: Pascal Vizeli
|
||||
author_twitter: pvizeli
|
||||
comments: true
|
||||
categories: Announcements
|
||||
og_image: /images/blog/2019-04-hassio-ingress/blogpost.png
|
||||
---
|
||||
|
||||
Today we are proud to introduce a new feature for Hass.io called Ingress. Ingress allows Hass.io add-ons to seamlessly integrate their user interface with Home Assistant. Home Assistant will take care of the authentication and the secure connection, so users can start using the add-on directly, without any configuration necessary by the users. It just works. Even with Nabu Casa’s Home Assistant Cloud Remote UI!
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/blog/2019-04-hassio-ingress/ingress-demo.gif' alt='Ingress demo on Hass.io'>
|
||||
Demo with an add-on on Ingress.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Add-ons that already support Ingress %}
|
||||
|
||||
Some add-ons already have been upgraded to support the new Ingress feature. Here are a couple of add-ons that support Ingress and are available on the add-on store right now:
|
||||
|
||||
Core add-ons:
|
||||
* [Configurator](https://www.home-assistant.io/addons/configurator/)
|
||||
* [deCONZ](https://github.com/home-assistant/hassio-addons/tree/master/deconz#readme)
|
||||
|
||||
Community add-ons:
|
||||
* [Node-RED](https://github.com/hassio-addons/addon-node-red#readme)
|
||||
* [Visual Studio Code](https://github.com/hassio-addons/addon-vscode#readme)
|
||||
* [InfluxDB](https://github.com/hassio-addons/addon-influxdb#readme)
|
||||
* [SSH & Web Terminal](https://github.com/hassio-addons/addon-ssh#readme)
|
||||
* [AdGuard Home](https://github.com/hassio-addons/addon-adguard-home#readme)
|
||||
|
||||
You can recognize add-ons that support the Ingress feature by the Ingress icon on the add-on information tab:
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/blog/2019-04-hassio-ingress/ingress_sign.png' alt='Add-on view with Ingress support'>
|
||||
Screenshot of an Add-on view with ingress support.
|
||||
</p>
|
||||
|
||||
Please note, that in order to upgrade or install these Ingress enabled add-ons, you need to be running Home Assistant 0.91.3.
|
||||
|
||||
## {% linkable_title What’s next %}
|
||||
|
||||
Releasing the Ingress feature is just a start. It allows us to make even better integrations in the future. For the upcoming Home Assistant 0.92 release, we will be adding support to add links to your add-ons to the Home Assistant sidebar via a toggle on the add-on details page. The link will open the add-on Ingress interface, embedding the add-on in the Home Assistant UI. This will make it look and feel like a single system.
|
||||
|
||||
## {% linkable_title Other new things %}
|
||||
|
||||
While adding Ingress support, we have tweaked and polished some other things in the Hass.io user interface:
|
||||
|
||||
* Network ports in the add-on view now have a description, so you know what they are being used for.
|
||||
* Reloading the add-on store will now show a spinner to indicate that reloading is being done.
|
||||
|
||||
## {% linkable_title For add-on developers %}
|
||||
|
||||
Ingress is added as an additional feature that add-on authors can choose to support starting today, granted that the application in the add-on supports it. The old approach of exposing add-ons on different ports will remain available. It will be up to add-on authors to choose what to support, including an option to support both.
|
||||
|
||||
If an add-on is going to support both, you should not have the add-on exposed on a port enabled by default. Instead, allow users to enable the port access by assigning a port number in the “Network” section of the add-on configuration panel.
|
||||
|
||||
Are you an add-on developer looking to support Ingress on your add-on? [Check the developer documentation][dev-docs].
|
||||
|
||||
## {% linkable_title FAQ & Known Issues %}
|
||||
|
||||
Hass.io Ingress is a new and complex technology. Without a doubt, now that everybody starts using it, we will discover new issues. Here are some frequently asked questions and some currently known issues with the Ingress feature.
|
||||
|
||||
* **After upgrading the add-on, I’m unable to access it directly.**<br>
|
||||
Direct access to the add-on might now be disabled by default by the add-on developer. If the add-on supports running Ingress + direct access, you can re-enable direct access by setting a port number in the “Network” section of the add-on configuration.
|
||||
|
||||
* **After upgrading the add-on, my `panel_iframe` doesn’t work anymore.**<br>
|
||||
This is related to the question above. Once you enable direct access again, your iFrame panel will start working again. Until the automated panel integration lands in 0.92, you can also manually add a panel that points at Ingress.
|
||||
|
||||
* **I cannot upgrade my add-on: “This update is no longer compatible with your system.”**<br>
|
||||
Please update your Home Assistant installation to 0.91.3 or higher.
|
||||
|
||||
* **I cannot access the add-on via Ingress using the Tor Browser or Firefox.**<br>
|
||||
We found a last minute issue impacting Firefox based browsers (including the Tor Browser). There are some issues accessing add-ons that use WebSockets. We have identified the issue and expect it to be solved with the release of Home Assistant 0.91.4.
|
||||
|
||||
|
||||
[Configurator]: https://www.home-assistant.io/addons/configurator/
|
||||
[deCONZ]: https://github.com/home-assistant/hassio-addons/tree/master/deconz#readme
|
||||
[Node-RED]: https://github.com/hassio-addons/addon-node-red#readme
|
||||
[Visual Studio Code]: https://github.com/hassio-addons/addon-vscode#readme
|
||||
[InfluxDB]: https://github.com/hassio-addons/addon-influxdb#readme
|
||||
[SSH & Web Terminal]: https://github.com/hassio-addons/addon-ssh#readme
|
||||
[AdGuard Home]: https://github.com/hassio-addons/addon-adguard-home#readme
|
||||
[dev-docs]: https://developers.home-assistant.io/docs/en/next/hassio_addon_presentation.html#ingress
|
||||
@ -40,30 +40,6 @@ The first add-on we should install is the HASS Configurator. With the HASS Confi
|
||||
|
||||
Go to the add-on store (see the previous step), click on Configurator and click on "INSTALL". When installation is complete, the UI will go to the add-on details page for the configurator. Here you will be able to change settings, start and stop the add-on. Follow the steps below to setup the add-on.
|
||||
|
||||
- Set a password on the Config box, don't forget to use quotes on your password
|
||||
|
||||
```json
|
||||
{
|
||||
"username": "admin",
|
||||
"password": "YOUR_PASSWORD_WITH_QUOTES",
|
||||
"certfile": "fullchain.pem",
|
||||
"keyfile": "privkey.pem",
|
||||
"ssl": false,
|
||||
"allowed_networks": [
|
||||
"192.168.0.0/16"
|
||||
],
|
||||
"banned_ips": [
|
||||
"8.8.8.8"
|
||||
],
|
||||
"banlimit": 0,
|
||||
"ignore_pattern": [
|
||||
"__pycache__"
|
||||
],
|
||||
"dirsfirst": false
|
||||
}
|
||||
```
|
||||
|
||||
- Click on "SAVE" to save your new password
|
||||
- "START" the add-on
|
||||
- You will be able to click the "OPEN WEB UI" link to open the Web UI on a new window
|
||||
- Type your username and password that you recently saved
|
||||
|
||||
@ -53,6 +53,7 @@ Looking for [talking points](/help/talking-points/) or [trivia](/help/trivia)?
|
||||
|
||||
Don't miss the regular [Home Assistant podcasts](https://hasspodcast.io/).
|
||||
|
||||
- [Magical Smart Home Upgrade Lets Muggles Control Their Homes With a Wand Too](https://gizmodo.com/magical-smart-home-upgrade-lets-muggles-control-their-h-1833941228) - April 2019
|
||||
- [Thomas-Krenn-Award 2019 – The winners](https://www.thomas-krenn.com/de/tkmag/tk-insights/thomas-krenn-award-2019-gewinner/) - March 2019
|
||||
- [How to set up and use Home Assistant: For Dummies edition](https://www.the-ambient.com/how-to/set-up-use-home-assistant-644) - October 2018
|
||||
- [DINAcon begeistert 200 Teilnehmende und die Award-Gewinner 2018](https://dinacon.ch/wp-content/uploads/sites/4/2018/10/2018-10-19_DINAcon2018_Medienmitteilung.pdf) - October 2018
|
||||
|
||||
BIN
source/images/blog/2019-04-hassio-ingress/blogpost.png
Normal file
BIN
source/images/blog/2019-04-hassio-ingress/blogpost.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.6 KiB |
BIN
source/images/blog/2019-04-hassio-ingress/ingress-demo.gif
Normal file
BIN
source/images/blog/2019-04-hassio-ingress/ingress-demo.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.1 MiB |
BIN
source/images/blog/2019-04-hassio-ingress/ingress_sign.png
Normal file
BIN
source/images/blog/2019-04-hassio-ingress/ingress_sign.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 39 KiB |
@ -9,4 +9,4 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
<script>document.location.href = 'https://testflight.apple.com/join/XCUga7ko';</script>
|
||||
<script>document.location.href = 'https://testflight.apple.com/join/VBsqCiBv';</script>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user