From 7640cd16623b1084e473081352b28249c44e54d4 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 9 Jul 2018 14:17:30 +0200 Subject: [PATCH] Update the configuration sample --- .../sensor.haveibeenpwned.markdown | 24 ++++++++++++------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/source/_components/sensor.haveibeenpwned.markdown b/source/_components/sensor.haveibeenpwned.markdown index 7a6b7bc1b30..56cb497b2ad 100644 --- a/source/_components/sensor.haveibeenpwned.markdown +++ b/source/_components/sensor.haveibeenpwned.markdown @@ -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

-## {% linkable_title Configuration variables %} - -- **email** (*Required*): List of email addresses. -

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