Giter Club home page Giter Club logo

uptime_kuma's Introduction

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.

hacs_badge

Home Assistant Integration

Open your Home Assistant instance and start setting up a new integration of a specific brand.

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

HTTPS Connections:

  • Your UptimeKuma instance url (i.e. https://myuptimekuma.mydomain.com)
  • Port (Generally 443 if running behind reverse proxy)
  • Your uptimekuma credentials
    • NOTE: If you have issues connecting, try creating an uptimekuma API key and using that with NO username for the credentials. If you are still having issues,make sure you can successfully connect to http(s)://your_uptimekuma.url/metrics
  • Verify SSL (Generally checked)

HTTP Connections:

  • Your UptimeKuma instance url : http://xxx.xxx.xxx.xxx
  • Port : 3001
  • Your uptimekuma credentials:
    • user: (i.e admin)
    • pass : API password from within UptimeKuma
  • Verify SSL: Unchecked

Contributions

Contributions are welcome!

uptime_kuma's People

Contributors

m1ckyb avatar meichthys avatar jayakornk avatar tjorim avatar dependabot[bot] avatar philippmundhenk avatar viper5000 avatar alexdelprete avatar ceskydj avatar stapxs avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.