mirrors/gatus
1
0
Fork 0
mirror of https://github.com/TwiN/gatus.git synced 2026-09-20 23:04:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(alerting): Revise HomeAssistant alerts and add Home Assistant integration info (#1723)

Browse Source 
* Revise HomeAssistant alerts and add integration info

Updated HomeAssistant alerts section to indicate legacy status and added Home Assistant integration details.

* Fix typo

* Tweak wording from Legacy to Native

* Tweak on feedback

---------

Co-authored-by: TwiN <twin@linux.com>
This commit is contained in:
Hamish
2026-08-14 22:09:04 -04:00
committed by GitHub
co-authored by TwiN
parent 7a73be52c5
commit 0fd2520088
1 changed files with 60 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+60
View File
@@ -1304,6 +1304,10 @@ Here's an example of what the notifications look like:
#### Configuring HomeAssistant alerts
> [!NOTE]
> It is recommended to use the native Home Assistant integration instead (see below).
| Parameter | Description | Default Value |
|:-------------------------------------------|:---------------------------------------------------------------------------------------|:--------------|
| `alerting.homeassistant.url` | HomeAssistant instance URL | Required `""` |
@@ -1378,6 +1382,61 @@ To get your HomeAssistant long-lived access token:
5. Give it a name (e.g., "Gatus")
6. Copy the token - you'll only see it once!
##### Native Home Assistant Integration
Gatus can be integrated into [Home Assistant](https://www.home-assistant.io/) to monitor the status of your endpoints directly from your home automation dashboard.
[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=gatus)
<details>
<summary>Configuration & Automation Examples</summary>
###### Configuration
To add the integration, click the button above or:
1. In Home Assistant, navigate to **Settings** > **Devices & Services**.
2. Click **Add Integration** in the bottom-right corner.
3. Search for **Gatus** and select it.
4. Enter the base URL of your Gatus instance (e.g., `http://192.168.1.50:8080`).
Home Assistant will create a binary sensor for each endpoint configured in Gatus. Because these sensors use the `connectivity` device class, they will show as `Connected` (Up) when the endpoint is healthy, and `Disconnected` (Down) when the endpoint is unhealthy.
###### Automation Example
You can easily set up a UI automation in Home Assistant to receive mobile notifications if any endpoint goes down:
1. Navigate to **Settings** > **Automations & Scenes** > **Create Automation** > **Create new automation**.
2. Under **Triggers**, click **Add Trigger** and select **State**.
3. In the **Entity** field, select the Gatus binary sensor(s) you want to monitor.
4. Set the **To** field to `off` (since a state of `off` represents a disconnected/down endpoint).
5. Under **Actions**, click **Add Action** and select **Perform action**.
6. Select your notification service (e.g., `Send a notification via mobile_app_<your_device_name>`).
7. Set the **Message** field. You can use template values to dynamically include the endpoint name:
```yaml
message: "The endpoint {{ trigger.to_state.name }} is down!"
```
For advanced users, here is the YAML representation of the automation:
```yaml
alias: "Notify when Gatus endpoint goes down"
description: "Sends a mobile notification if a Gatus endpoint goes down"
trigger:
- platform: state
entity_id:
- binary_sensor.website
- binary_sensor.make_sure_header_is_rendered
to: "off"
action:
- action: notify.mobile_app_your_device_name
data:
title: "Gatus Alert"
message: "The endpoint {{ trigger.to_state.name }} is down!"
```
</details>
#### Configuring IFTTT alerts
@@ -2908,6 +2967,7 @@ To get more details, please check [chart's configuration](https://github.com/Twi
Gatus can be deployed on Kubernetes using Terraform by using the following module: [terraform-kubernetes-gatus](https://github.com/TwiN/terraform-kubernetes-gatus).
## Running the tests
```console
go test -v ./...