Uptime Kuma HACS integration

About

This integration exposes UptimeKuma monitors in HomeAssistant. Two sensors are created for each UptimeKuma monitor:

• Binary Sensor (On/Off)
• Sensor (State of UptimeKuma monitor)

Installation

Installation is done like any other Home Assistant HACS integration.

Requirements

In order to setup this integration you will need:

• A Home Assistant instance with HACS installed.
• An instance of UptimeKuma

HACS Installation

Search for "Uptime Kuma" in the HACS store. If you don't see it there, you can add this repository url as a HACS custom repository.

Home Assistant Integration

After installation, setup the integration via the web UI like any other integration. When prompted, provide the following:

HTTPS Connections:

• URL: Your UptimeKuma instance url (i.e. https://myuptimekuma.mydomain.com)
• Port: (Generally 443 if running behind reverse proxy)
• User: Your uptimekuma Username
• Password: API Key (UptimeKuma > Settings > API Keys)
• Verify SSL: (Generally checked)

HTTP Connections:

• URL: Your UptimeKuma instance url (i.e. http://xxx.xxx.xxx.xxx)
• Port : 3001
• User: Your uptimekuma Username
• Password: API Key (UptimeKuma > Settings > API Keys)
• Verify SSL: Unchecked

Troubleshooting

If you are having issues connecting, make sure you can successfully connect to http(s)://your_uptimekuma.url/metrics using a private browser window. There have also been reports of non-ssl instances not being entirely reliable. It is recommended to use a valid SSL certificate. This is made easy by projects like NGINXProxyManager, Traefik, Caddy, and others.

Contributions

Contributions are welcome!