Skip to content

Commit fd32e9f

Browse files
tjorimfabaff
authored andcommitted
Update Updater configuration (home-assistant#7021)
Use new configuration variables
1 parent 8a27a51 commit fd32e9f

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

source/_components/updater.markdown

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,32 @@ ha_qa_scale: internal
1414

1515
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.
1616

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 %}
1820

1921
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
2022

2123
```yaml
2224
updater:
2325
```
2426
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`.
2641

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`.
2843

2944
```json
3045
"components": [
@@ -41,7 +56,7 @@ It is possible to report the components that you are using to the Home Assistant
4156
]
4257
```
4358

44-
### {% linkable_title Notification %}
59+
## {% linkable_title Notification %}
4560

4661
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.
4762

@@ -57,4 +72,3 @@ automation:
5772
data:
5873
message: 'Update for Home Assistant is available.'
5974
```
60-

0 commit comments

Comments
 (0)