From 33a60bc9c2f7daecf335311c498d55817683030c Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Tue, 23 Oct 2018 00:15:54 +0200 Subject: [PATCH] Update Updater configuration Use new configuration variables --- source/_components/updater.markdown | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/source/_components/updater.markdown b/source/_components/updater.markdown index 2b6c2997a7aa..873fab8fef26 100644 --- a/source/_components/updater.markdown +++ b/source/_components/updater.markdown @@ -14,7 +14,9 @@ ha_qa_scale: internal 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. -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/). +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). + +## {% linkable_title Configuration %} To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: @@ -22,9 +24,22 @@ To integrate this into Home Assistant, add the following section to your `config updater: ``` -If you choose not to share any information when checking for updates, you can add `reporting: False`. +{% configuration %} +reporting: + description: Whether or not to share system information when checking for updates. + required: false + type: boolean + default: true +include_used_components: + description: Whether or not to report the components that you are using in Home Assistant. + required: false + type: boolean + default: false +{% endconfiguration %} + +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`. -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`. +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`. ```json "components": [ @@ -41,7 +56,7 @@ It is possible to report the components that you are using to the Home Assistant ] ``` -### {% linkable_title Notification %} +## {% linkable_title Notification %} 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. @@ -57,4 +72,3 @@ automation: data: message: 'Update for Home Assistant is available.' ``` -