Update the configuration sample

This commit is contained in:
Fabian Affolter 2018-07-09 14:17:30 +02:00
parent 72b4b53c78
commit 7640cd1662
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336

View File

@ -14,18 +14,28 @@ ha_iot_class: "Cloud Polling"
---
The `haveibeenpwned` sensor platform creates sensors that check for breached email accounts on [haveibeenpwned](https://haveibeenpwned.com).
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`, it will list every specified email address as a sensor showing
the number of breaches on that email account:
the number of breaches on that email account.
```yaml
# Example configuration.yaml entry using cloud based emoncms
sensor:
platform: haveibeenpwned
email:
- your_email1@domain.com
- your_email2@domain.com
- platform: haveibeenpwned
email:
- your_email1@domain.com
- your_email2@domain.com
```
{% configuration %}
email:
description: List of email addresses.
required: true
type: list
{% endconfiguration %}
## {% linkable_title Breach meta data %}
If one of your email accounts is breached the sensor will display breach meta data. It will list the title of the site where your email
@ -36,10 +46,6 @@ account has been breached as well as the added date of the breach data. This dat
<img src='/images/components/haveibeenpwned/sensor.png' />
</p>
## {% linkable_title Configuration variables %}
- **email** (*Required*): List of email addresses.
<p class='note warning'>
The sensor will scan all email addresses specified with a 5 second delay between all breach data requests on Home Assistant startup.
After this initial startup scanning, the sensor will only scan one email account per 15 minutes to prevent abuse, and not hammer "the