https://github.com/meichthys/uptime_kuma

Uptime Kuma HACS integration
https://github.com/meichthys/uptime_kuma

hacs-default home-assistant-custom-component homeassistant-custom-component integration uptime-kuma

Last synced: 3 days ago
JSON representation

Uptime Kuma HACS integration

• Host: GitHub
• URL: https://github.com/meichthys/uptime_kuma
• Owner: meichthys
• Created: 2022-02-11T15:19:58.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-26T13:07:39.000Z (about 2 months ago)
• Last Synced: 2025-02-11T09:32:51.683Z (10 days ago)
• Topics: hacs-default, home-assistant-custom-component, homeassistant-custom-component, integration, uptime-kuma
• Language: Python
• Homepage:
• Size: 91.8 KB
• Stars: 120
• Watchers: 6
• Forks: 22
• Open Issues: 29
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://hacs.xyz/) 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](https://hacs.xyz/docs/faq/custom_repositories).

[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/meichthys/uptime_kuma)

## Home Assistant Integration

[![Open your Home Assistant instance and start setting up a new integration of a specific brand.](https://my.home-assistant.io/badges/brand.svg)](https://my.home-assistant.io/redirect/brand/?brand=+Uptime+Kuma)

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](https://nginxproxymanager.com/), [Traefik](https://doc.traefik.io/traefik/), [Caddy](https://caddyserver.com/), and others.

## Contributions

Contributions are welcome!