You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/updater.markdown
+19-5Lines changed: 19 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -14,17 +14,32 @@ ha_qa_scale: internal
14
14
15
15
The `updater` component will check daily for new releases. It will show a badge in the frontend if a new version is found. As [Hass.io](/hassio/) has its own schedule for release it doesn't make sense to use this component on Hass.io.
16
16
17
-
The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91). For further information about the Updater's data, please check the [detailed overview](/docs/backend/updater/).
17
+
The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91).
18
+
19
+
## {% linkable_title Configuration %}
18
20
19
21
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
20
22
21
23
```yaml
22
24
updater:
23
25
```
24
26
25
-
If you choose not to share any information when checking for updates, you can add `reporting: False`.
27
+
{% configuration %}
28
+
reporting:
29
+
description: Whether or not to share system information when checking for updates.
30
+
required: false
31
+
type: boolean
32
+
default: true
33
+
include_used_components:
34
+
description: Whether or not to report the components that you are using in Home Assistant.
35
+
required: false
36
+
type: boolean
37
+
default: false
38
+
{% endconfiguration %}
39
+
40
+
For further information about the Updater's data, please check the [detailed overview](/docs/backend/updater/). If you choose not to share any information when checking for updates, you can set `reporting: false`.
26
41
27
-
It is possible to report the components that you are using to the Home Assistant developers. This will help them focus on improving the popular ones. To enable this option, you have to add `include_used_components: True`.
42
+
It is possible to report the components that you are using to the Home Assistant developers. This will help them focus on improving the popular ones. To enable this option, you have to add `include_used_components: true`.
28
43
29
44
```json
30
45
"components": [
@@ -41,7 +56,7 @@ It is possible to report the components that you are using to the Home Assistant
41
56
]
42
57
```
43
58
44
-
### {% linkable_title Notification %}
59
+
## {% linkable_title Notification %}
45
60
46
61
For an added bonus, an automation component can be created to send a message with a notifier when that state of this component's entity changes.
47
62
@@ -57,4 +72,3 @@ automation:
57
72
data:
58
73
message: 'Update for Home Assistant is available.'
0 commit comments