Date: Mon, 20 Aug 2018 21:54:20 +0200
Subject: [PATCH 03/13] Document allow_hosts option
---
source/_addons/samba.markdown | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/source/_addons/samba.markdown b/source/_addons/samba.markdown
index 939d3c95505..aa7d509c18b 100644
--- a/source/_addons/samba.markdown
+++ b/source/_addons/samba.markdown
@@ -26,7 +26,12 @@ This addon allows you to set up a [Samba](https://samba.org/) server to access H
},
"username": "",
"password": "",
- "interface": "eth0"
+ "interface": "eth0",
+ "allow_hosts": [
+ "10.0.0.0/8",
+ "172.16.0.0/12",
+ "192.168.0.0/16"
+ ]
}
```
@@ -39,6 +44,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. If you are running on an Intel NUC this could also be `enp3s0` for ethernet or `wlp5s0` for wireless connection.
+- **allow_hosts** (*Optional*): The hosts that are allowed to connect to your Samba server. By default it is limited to people within the same local network.
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!
From b421c553d90313c14fe7b916b77507dc4f6c97b9 Mon Sep 17 00:00:00 2001
From: Tom
Date: Mon, 20 Aug 2018 21:45:33 +0100
Subject: [PATCH 04/13] Update sensor.iperf3.markdown (#6052)
Default is 10.
---
source/_components/sensor.iperf3.markdown | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/source/_components/sensor.iperf3.markdown b/source/_components/sensor.iperf3.markdown
index add891e3c17..0cb7cb2dabe 100644
--- a/source/_components/sensor.iperf3.markdown
+++ b/source/_components/sensor.iperf3.markdown
@@ -51,7 +51,7 @@ sensor:
duration:
description: Specify the test duration in seconds. Default is 10 and the valid range is from 5 to 10.
required: false
- default: 3
+ default: 10
type: int
parallel:
description: Specify the number of concurrent streams to connect to the server. Default is 1 and the valid range is from 1 to 20.
From 93fc628a2dd4102df23a78e83de193bfa3781b49 Mon Sep 17 00:00:00 2001
From: DubhAd
Date: Mon, 20 Aug 2018 21:46:12 +0100
Subject: [PATCH 05/13] Link has changed (#6051)
Updating the link to the Google docs - doesn't seem to redirect correctly for everybody
---
source/_components/tts.google.markdown | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/source/_components/tts.google.markdown b/source/_components/tts.google.markdown
index 1b0468c87d5..3056b50d94e 100644
--- a/source/_components/tts.google.markdown
+++ b/source/_components/tts.google.markdown
@@ -25,7 +25,7 @@ tts:
Configuration variables:
- **language** (*Optional*): The language to use. Defaults to `en`.
- - [Complete list of supported languages](https://cloud.google.com/speech/docs/languages).
+ - [Complete list of supported languages](https://cloud.google.com/speech-to-text/docs/languages).
A full configuration sample:
From 9991dc879e6aec18e1a80c832595ae86a87746da Mon Sep 17 00:00:00 2001
From: Paulus Schoutsen
Date: Tue, 21 Aug 2018 11:45:06 +0200
Subject: [PATCH 06/13] Release 0.76.2
---
_config.yml | 6 +++---
source/_posts/2018-08-17-release-76.markdown | 8 ++++++++
2 files changed, 11 insertions(+), 3 deletions(-)
diff --git a/_config.yml b/_config.yml
index 019e89f6b18..62c8df641b9 100644
--- a/_config.yml
+++ b/_config.yml
@@ -142,13 +142,13 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 76
-current_patch_version: 1
-date_released: 2018-08-19
+current_patch_version: 2
+date_released: 2018-08-21
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
# Major release:
-patch_version_notes: "#release-0761---august-19"
+patch_version_notes: "#release-0762---august-21"
# Minor release (Example #release-0431---april-25):
# Date we moved to Discourse for comments
diff --git a/source/_posts/2018-08-17-release-76.markdown b/source/_posts/2018-08-17-release-76.markdown
index 83edae20af5..2f72bd9b4c9 100644
--- a/source/_posts/2018-08-17-release-76.markdown
+++ b/source/_posts/2018-08-17-release-76.markdown
@@ -70,6 +70,14 @@ mqtt:
[notify docs]: /components/notify/
[tuya docs]: /components/tuya/
+## {% linkable_title Release 0.76.2 - August 21 %}
+
+- Forgiving add index in migration ([@balloob] - [#16092])
+- Fix push notifications toggle ([@balloob])
+
+[#16092]: https://github.com/home-assistant/home-assistant/pull/16092
+[@balloob]: https://github.com/balloob
+
## {% 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.
From 507017651d253c73d361289a0c57b379ca03885c Mon Sep 17 00:00:00 2001
From: Pascal Vizeli
Date: Tue, 21 Aug 2018 21:32:09 +0200
Subject: [PATCH 07/13] Remove RPI variants (#6060)
---
source/getting-started/index.markdown | 8 +-------
1 file changed, 1 insertion(+), 7 deletions(-)
diff --git a/source/getting-started/index.markdown b/source/getting-started/index.markdown
index d5a85f87355..e2587340ead 100644
--- a/source/getting-started/index.markdown
+++ b/source/getting-started/index.markdown
@@ -9,13 +9,7 @@ sharing: true
footer: true
---
-The goal of this getting started guide is to install [Hass.io](/hassio/) on a Raspberry Pi. Hass.io is our own all in one solution that turns your Raspberry Pi into the ultimate home automation hub.
-
-The following models are supported:
-- Raspberry Pi Zero and Zero W
-- Raspberry Pi 1 Model B
-- Raspberry Pi 2 Model B
-- Raspberry Pi 3 Model B and Model B+
+The goal of this getting started guide is to install [Hass.io](/hassio/) on a Raspberry Pi. Hass.io is our own all in one solution that turns your Raspberry Pi or other device into the ultimate home automation hub.
Follow this guide if you want to get started with Home Assistant easily, or if you have no or little Linux experience. For advanced users or if you have no Raspberry Pi at hand, check our [alternative installation methods](/docs/installation/). The [FAQ](/faq/#home-assistant-vs-hassio) explains more about the differences.
From 83b817b9d12e2908b67d07e87ed849c2193b5c13 Mon Sep 17 00:00:00 2001
From: Kevin Eifinger
Date: Tue, 21 Aug 2018 21:33:50 +0200
Subject: [PATCH 08/13] Update Xiaomi Aqara Button documentation (#6059)
Update the documentation to show the click event types supported by the 1st and 2nd generation.
https://github.com/home-assistant/home-assistant/issues/16097
---
source/_components/xiaomi_aqara.markdown | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown
index 203ffcdcf56..d56d8821538 100644
--- a/source/_components/xiaomi_aqara.markdown
+++ b/source/_components/xiaomi_aqara.markdown
@@ -24,7 +24,8 @@ The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/
- Temperature and Humidity Sensor (1st and 2nd generation)
- Motion Sensor (1st and 2nd generation)
- Door and Window Sensor (1st and 2nd generation)
-- Button (1st and 2nd generation)
+- Button 1st generation (Single, Double, long_click_press)
+- Button 2nd generation (Single, Double)
- Plug aka Socket (Zigbee version, reports power consumed, power load, state and if device in use)
- Wall Plug (reports power consumed, power load and state)
- Aqara Wall Switch (Single)
@@ -195,9 +196,9 @@ Removes a specific device. The removal is required if a device shall be paired w
## {% linkable_title Examples %}
-### {% linkable_title Long Press on Smart Button %}
+### {% linkable_title Long Press on Smart Button 1st Generation %}
-This example plays the sound of a dog barking when the button is held down and stops the sound when the button is pressed once.
+This example plays the sound of a dog barking when the button is held down and stops the sound when the button is pressed once. Only works for the round button of the 1st generation.
*Note: The sound will stop playing automatically when it has ended.*
From b88f94c067944410ce3a1da500d6ddf6f5887440 Mon Sep 17 00:00:00 2001
From: Eduard van Valkenburg
Date: Wed, 22 Aug 2018 16:18:42 +0200
Subject: [PATCH 09/13] Fixed links to sub components. (#6062)
---
source/_components/dyson.markdown | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/source/_components/dyson.markdown b/source/_components/dyson.markdown
index 145d6204d8e..adc8af1d33b 100644
--- a/source/_components/dyson.markdown
+++ b/source/_components/dyson.markdown
@@ -13,7 +13,7 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.47
---
-The `dyson` component is the main component to integrate all [Dyson](https://dyson.com) related platforms: [Fans](/components/fan/dyson/) and [Robot vacuum](/components/vacuum/dyson/).
+The `dyson` component is the main component to integrate all [Dyson](https://dyson.com) related platforms: [Fans](/components/fan.dyson/) and [Robot vacuum](/components/vacuum.dyson/).
## {% linkable_title Configuration %}
From 56895804dad30337ad0d4a8e1b724ca9f992b1f3 Mon Sep 17 00:00:00 2001
From: Sven-Hendrik Haase
Date: Fri, 24 Aug 2018 01:15:49 +0200
Subject: [PATCH 10/13] Update wording for Arch Linux (#6065)
The current wording has two problems:
1) It says that there is still i686 but that is wrong incorrect. i686 has been dropped.
2) It implies that there official Home Assistant packages which is also not the case.
---
source/_docs/installation/archlinux.markdown | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/source/_docs/installation/archlinux.markdown b/source/_docs/installation/archlinux.markdown
index 3e13bd26912..68c6c70ff11 100644
--- a/source/_docs/installation/archlinux.markdown
+++ b/source/_docs/installation/archlinux.markdown
@@ -9,7 +9,7 @@ sharing: true
footer: true
---
-[Arch Linux](https://www.archlinux.org/) is a lightweight and flexible Linux distribution. There are official packages optimized for the i686 and x86-64 architectures available.
+[Arch Linux](https://www.archlinux.org/) is a lightweight and flexible Linux distribution for x86_64.
Install the needed Python packages.
From ea9803e7e4a6841d20465cae2ef0ce6d3042accc Mon Sep 17 00:00:00 2001
From: bigwoof
Date: Fri, 24 Aug 2018 09:16:30 +1000
Subject: [PATCH 11/13] include required "sensor_type:" in example - remove
duplicate total_rain (#6064)
* include required "sensor_type:" in example - remove duplicate rain_total
updated the example to include sensor type as this is a required part of the configuration and is needed to make it a valid example
also removed duplicate sensor type for rain_total
* Minor changes
* Minor changes
---
source/_components/sensor.rflink.markdown | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/source/_components/sensor.rflink.markdown b/source/_components/sensor.rflink.markdown
index 7efee12d68c..60306416cb4 100644
--- a/source/_components/sensor.rflink.markdown
+++ b/source/_components/sensor.rflink.markdown
@@ -31,18 +31,18 @@ sensor:
- platform: rflink
devices:
alectov1_0334_temp:
- name: Temperature Outside
+ sensor_type: temperature
```
Configuration variables:
- **automatic_add** (*Optional*): Automatically add new/unconfigured devices to HA if detected (default: True).
-- **devices** (*Optional*): A list of devices with their name to use in the frontend.
+- **devices** (*Optional*): A list of devices with their name to use in the frontend.
Device configuration variables:
-- **name** (*Optional*): Name for the device, defaults to RFLink ID.
- **sensor_type** (*Required*): Override automatically detected type of sensor. For list of values see below.
+- **name** (*Optional*): Name for the device, defaults to RFLink ID.
- **unit_of_measurement** (*Optional*): Override automatically detected unit of sensor.
- **aliases** (*Optional*): Alternative RFLink ID's this device is known by.
@@ -68,7 +68,6 @@ Sensor type values:
- meter_value
- total_rain
- rain_rate
-- total_rain
- revision
- noise_level
- temperature
From b63d317dcb73819765a3cc530a9a7e1e4e982d2e Mon Sep 17 00:00:00 2001
From: Paulus Schoutsen
Date: Fri, 24 Aug 2018 14:15:00 +0200
Subject: [PATCH 12/13] Update dead url
---
source/_components/alarm_control_panel.spc.markdown | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/source/_components/alarm_control_panel.spc.markdown b/source/_components/alarm_control_panel.spc.markdown
index 5cc4025f001..5384d06def1 100644
--- a/source/_components/alarm_control_panel.spc.markdown
+++ b/source/_components/alarm_control_panel.spc.markdown
@@ -14,7 +14,7 @@ ha_iot_class: "Local Push"
---
-The `spc` alarm control panel platform allows you to control your [Vanderbilt SPC](http://www.spc-intruder-detection.com/ssp-spc/) alarms.
+The `spc` alarm control panel platform allows you to control your [Vanderbilt SPC](https://www.spcsupportinfo.com/) alarms.
The requirement is that you have setup your [SPC hub](/components/spc/).
From ce9d0751ea33de74cc136ad414e205729a9de7be Mon Sep 17 00:00:00 2001
From: Paulus Schoutsen
Date: Fri, 24 Aug 2018 17:07:45 +0200
Subject: [PATCH 13/13] Add auth docs (#6068)
* Add auth docs
* Minor tweak
* :pencil2: Spelling
* :pencil2: Spelling
* :pencil2: Spelling and grammar
* Remove impossible
---
source/_docs/authentication.markdown | 37 ++++++++
.../authentication/multi-factor-auth.markdown | 19 ++++
.../_docs/authentication/providers.markdown | 86 ++++++++++++++++++
source/_includes/asides/docs_navigation.html | 7 ++
source/images/docs/authentication/login.png | Bin 0 -> 38191 bytes
source/images/docs/authentication/profile.png | Bin 0 -> 57806 bytes
6 files changed, 149 insertions(+)
create mode 100644 source/_docs/authentication.markdown
create mode 100644 source/_docs/authentication/multi-factor-auth.markdown
create mode 100644 source/_docs/authentication/providers.markdown
create mode 100644 source/images/docs/authentication/login.png
create mode 100644 source/images/docs/authentication/profile.png
diff --git a/source/_docs/authentication.markdown b/source/_docs/authentication.markdown
new file mode 100644
index 00000000000..9ebb653c51a
--- /dev/null
+++ b/source/_docs/authentication.markdown
@@ -0,0 +1,37 @@
+---
+layout: page
+title: "Authentication"
+description: "Guide on authentication in Home Assistant."
+date: 2018-08-23 09:40
+redirect_from: /components/auth/
+sidebar: true
+comments: false
+sharing: true
+footer: true
+---
+
+Access to Home Assistant is secured by our authentication system. Each member of your household will get their own user account to log in and access Home Assistant.
+
+Home Assistant contains two different user types: the owner user account and normal users. The owner user account is created when you start Home Assitant for the first time. This account has some special privileges compared to the other users of the system:
+
+ - Manage users
+ - Configure integrations and other settings (soon)
+ - Configure Hass.io (soon)
+
+## {% linkable_title Authentication %}
+
+When a user wants to use Home Assistant, they have to log in. When navigating to the frontend without authentication, the user is asked for a login. The login page will always show you the website that you're logging in to.
+
+
+
+When logging in, make sure that the URL in the URL bar is showing the address of your Home Assistant instance.
+
+## {% linkable_title Profile %}
+
+Once you're logged in, you can access the profile page to change your user preferences. Here you can change your preferred language or password. You can also log out. You can access the profile page by clicking on your user badge in the sidebar.
+
+
+
+## {% linkable_title Multi-factor authentication %} (soon)
+
+As a user, you can setup multi-factor authentication like time-based one-time passwords. This is an extra challenge that you have to solve after you finish your login. You will be able to set up these challenges from the profile page once you're logged in.
diff --git a/source/_docs/authentication/multi-factor-auth.markdown b/source/_docs/authentication/multi-factor-auth.markdown
new file mode 100644
index 00000000000..751f2010569
--- /dev/null
+++ b/source/_docs/authentication/multi-factor-auth.markdown
@@ -0,0 +1,19 @@
+---
+layout: page
+title: "Multi-factor authentication"
+description: "Guide on configuring different multi-factor authentication providers."
+date: 2018-08-23 09:40
+redirect_from: /components/auth/
+sidebar: true
+comments: false
+sharing: true
+footer: true
+---
+
+
+This is an advanced feature. If misconfigured, you will not be able to access Home Assistant anymore!
+
+
+Besides the normal authentication providers, it's also possible to configure multi-factor authentication providers. These authentication providers will require the user to solve a second challenge besides just logging in. The idea is that you ask the user for something they know, their username/password, and something they have, like a time-based authentication token from their phone.
+
+This feature is currently a work in progress and no configurable multi-factor authentication providers are currently available.
diff --git a/source/_docs/authentication/providers.markdown b/source/_docs/authentication/providers.markdown
new file mode 100644
index 00000000000..1a190543355
--- /dev/null
+++ b/source/_docs/authentication/providers.markdown
@@ -0,0 +1,86 @@
+---
+layout: page
+title: "Authentication Providers"
+description: "Guide on configuring different auth providers."
+date: 2018-08-23 09:40
+redirect_from: /components/auth/
+sidebar: true
+comments: false
+sharing: true
+footer: true
+---
+
+
+This is an advanced feature. If misconfigured, you will not be able to access Home Assistant anymore!
+
+
+When a user logs in, it needs to authenticate against an auth provider. An auth provider will check the users' credentials, and if credentials are linked to a user in the system, allows the user to log in.
+
+By default, Home Assistant has enabled an auth provider that stores the users in the configuration directory. An owner account can manage these users from the frontend.
+
+To make the transition from API password to authentication system easier, we've added a legacy API password auth provider. This enables users to log in with the API password. This authentication provider is enabled by default if a user has an API password configured.
+
+## {% linkable_title Configuring auth providers %}
+
+
+By configuring your own instead of using the default configuration, you take full responsibility for the authentication of the system.
+
+
+Authentication providers are configured in your `configuration.yaml` under the `homeassistant:` block:
+
+```yaml
+homeassistant:
+ auth_providers:
+ - type: homeassistant
+ - type: legacy_api_password
+```
+
+## {% linkable_title Available auth providers %}
+
+Below is a list of currently available auth providers.
+
+### {% linkable_title Home Assistant auth provider %}
+
+This is the default auth provider which stores the users in your configuration directory. All passwords are stored hashed and with a salt, making it almost impossible for an attacker to figure out the password from the storage.
+
+Users for this auth provider can be managed via the UI by the owner. Navigate to the configuration panel and click on users.
+
+```yaml
+homeassistant:
+ auth_providers:
+ - type: homeassistant
+```
+
+### {% linkable_title Trusted Network %}
+
+With the trusted network auth provider you can whitelist an IP range for which no authentication will be required. The user will be prompted to pick a user to log in as.
+
+```yaml
+homeassistant:
+ auth_providers:
+ - type: trusted_networks
+
+# Temporary, this will be moved to be part of auth provider config
+# https://github.com/home-assistant/home-assistant/issues/16149
+http:
+ trusted_networks:
+ - 127.0.0.1
+ - ::1
+ - 192.168.0.0/24
+ - fd00::/8
+```
+
+### {% linkable_title Legacy API password %}
+
+Activating this auth provider will allow you to authenticate with the API password set in the HTTP component.
+
+```yaml
+homeassistant:
+ auth_providers:
+ - type: legacy_api_password
+
+http:
+ api_password: !secret http_password
+```
+
+Activating this auth provider will also allow you to provide the API password using an authentication header to make requests against the Home Assistant API. This feature will be dropped in the future in favor of long-lived access tokens.
diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html
index 8256e7e1e1a..4c9aef28624 100644
--- a/source/_includes/asides/docs_navigation.html
+++ b/source/_includes/asides/docs_navigation.html
@@ -41,6 +41,13 @@
{% active_link /docs/configuration/platform_options/ Entity component platform options %}
+
+ {% active_link /docs/authentication/ Authentication %}
+
+ - {% active_link /docs/authentication/providers/ Auth Providers %}
+ - {% active_link /docs/authentication/multi-factor-auth/ Multi Factor Auth %}
+
+
Core objects