Skip to content

Latest commit

 

History

History
107 lines (76 loc) · 4.15 KB

DOCS.md

File metadata and controls

107 lines (76 loc) · 4.15 KB
Raw

Home Assistant Community Add-on: Uptime Kuma

Uptime Kuma is an open source monitor tools, which can be best compared to a self-hosted variant of a commercial service like "Uptime Robot".

It enables you to monitor services over HTTP/S, TCP, DNS, and other protocols and it can send you notifications of downtime or trigger an Home Assistant automation webhook.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on.

  1. Click the Home Assistant My button below to open the add-on on your Home Assistant instance.

    Open this add-on in your Home Assistant instance.

  2. Click the "Install" button to install the add-on.

  3. Start the "Uptime Kuma" add-on.

  4. Check the logs of "Uptime Kuma" to see if everything went well.

  5. Click on the "OPEN WEB UI" button to jump into Uptime Kuma.

Please read the rest of this document further instructions.

Configuration

This add-on has no configuration options, everything can be managed and configured via the Uptime Kuma interface.

Known issues and limitations

  • Cloudflare is not installed in this add-on and thus not available as an option inside Uptime Kuma as of yet.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on [Keep a Changelog][keepchangelog].

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Support

Got questions?

You have several options to get them answered:

You could also open an issue here GitHub.

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright (c) 2022-2024 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.