mvdwetering / websitechecker

Custom integration for Home Assistant to monitor if websites are reachable or not

Websitechecker

Custom integration that checks if a website is reachable or not.

A website is considered OK when an HTTP request returned with a response code < 500. Or the other way around it is considered a problem if the HTTP request failed or returned a response code >= 500.

The sensor offers the following additional attributes:

• url: The configured URL for this sensor
• last_status: Status of last update. Some possible values are "200 - OK" or "Connection error". More error values exist.
• last_error_status: Status of last error, allows to easily see what the last issue was if it came back already.

Configuration examples

Basic

websitechecker:
  websites:
    - url: https://example.com
      name: Optional friendly name
    - url: http://does_not_exist.com
    - url: http://192.168.178.4:9000  # URLs with non-standard ports also work

Advanced

websitechecker:
  update_interval: 10  # Optional, value in minutes, defaults to 10
  websites:
    - url: https://example.com
      name: Optional friendly name
      verify_ssl: false  # Optional, default is true
    - url: http://does_not_exist.com
      update_interval: 5  # Optional, main `update_interval` used when not provided

Installation

Home Assistant Community Store (HACS)

Recommended as you get notifications of updates

HACS is a 3rd party downloader for Home Assistant to easily install and update custom integrations made by the community. More information and installation instructions can be found on their site https://hacs.xyz/

• Add this repository https://github.com/mvdwetering/websitechecker to HACS as a "custom repository" with category "integration". This option can be found in the ⋮ menu
• Install the integration from within HACS
• Add a configuraton section to configuration.yaml
• Restart Home Assistant

Manual

• Extract the Zip file in the custom_components directory
• Add a configuraton section to configuration.yaml
• Restart Home Assistant