diff --git a/README.md b/README.md index 167ae9c21..bef06a053 100644 --- a/README.md +++ b/README.md @@ -482,6 +482,19 @@ Manage your UniFi network using a web browser [:books: UniFi Network Application add-on documentation][addon-doc-unifi] +### ✓ [Uptime Kuma][addon-uptime-kuma] + +![Latest Version][uptime-kuma-version-shield] +![Supports armhf Architecture][uptime-kuma-armhf-shield] +![Supports armv7 Architecture][uptime-kuma-armv7-shield] +![Supports aarch64 Architecture][uptime-kuma-aarch64-shield] +![Supports amd64 Architecture][uptime-kuma-amd64-shield] +![Supports i386 Architecture][uptime-kuma-i386-shield] + +It is a self-hosted monitoring tool like "Uptime Robot" + +[:books: Uptime Kuma add-on documentation][addon-doc-uptime-kuma] + ### ✓ [VSCode Remote][addon-vscode-remote] ![Latest Version][vscode-remote-version-shield] @@ -654,6 +667,7 @@ on the correct GitHub repository matching the add-on. - [Open an issue for the add-on: Tor][tor-issue] - [Open an issue for the add-on: Traccar][traccar-issue] - [Open an issue for the add-on: UniFi Network Application][unifi-issue] +- [Open an issue for the add-on: Uptime Kuma][uptime-kuma-issue] - [Open an issue for the add-on: VSCode Remote][vscode-remote-issue] - [Open an issue for the add-on: Vaultwarden (Bitwarden)][bitwarden-issue] - [Open an issue for the add-on: WireGuard][wireguard-issue] @@ -1016,6 +1030,15 @@ SOFTWARE. [unifi-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg [unifi-armv7-shield]: https://img.shields.io/badge/armv7-no-red.svg [unifi-i386-shield]: https://img.shields.io/badge/i386-no-red.svg +[addon-uptime-kuma]: https://github.com/hassio-addons/addon-uptime-kuma/tree/ec85ac1 +[addon-doc-uptime-kuma]: https://github.com/hassio-addons/addon-uptime-kuma/blob/ec85ac1/README.md +[uptime-kuma-issue]: https://github.com/hassio-addons/addon-uptime-kuma/issues +[uptime-kuma-version-shield]: https://img.shields.io/badge/version-ec85ac1-blue.svg +[uptime-kuma-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[uptime-kuma-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[uptime-kuma-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[uptime-kuma-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[uptime-kuma-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [addon-vscode-remote]: https://github.com/hassio-addons/addon-vscode-remote/tree/6541b8e [addon-doc-vscode-remote]: https://github.com/hassio-addons/addon-vscode-remote/blob/6541b8e/README.md [vscode-remote-issue]: https://github.com/hassio-addons/addon-vscode-remote/issues diff --git a/uptime-kuma/CHANGELOG.md b/uptime-kuma/CHANGELOG.md new file mode 100644 index 000000000..59659e8f1 --- /dev/null +++ b/uptime-kuma/CHANGELOG.md @@ -0,0 +1 @@ +- ⬆️ Bump apprise from 0.9.8.3 to 0.9.9 in /uptime-kuma (#1) diff --git a/uptime-kuma/DOCS.md b/uptime-kuma/DOCS.md new file mode 100644 index 000000000..68ac2619b --- /dev/null +++ b/uptime-kuma/DOCS.md @@ -0,0 +1,107 @@ +# 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.][addon-badge]][addon] + +1. Click the "Install" button to install the add-on. +1. Start the "Uptime Kuma" add-on. +1. Check the logs of "Uptime Kuma" to see if everything went well. +1. 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][releases] +functionality. The format of the log is based on +[Keep a Changelog][keepchangelog]. + +Releases are based on [Semantic Versioning][semver], 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: + +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Franck Nijhof][frenck]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2022 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. + +[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg +[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_uptime-kuma&repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository +[contributors]: https://github.com/hassio-addons/addon-uptime-kuma/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/?u=frenck +[frenck]: https://github.com/frenck +[issue]: https://github.com/hassio-addons/addon-uptime-kuma/issues +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-uptime-kuma/releases +[semver]: http://semver.org/spec/v2.0.0.htm diff --git a/uptime-kuma/README.md b/uptime-kuma/README.md new file mode 100644 index 000000000..64d4b06d4 --- /dev/null +++ b/uptime-kuma/README.md @@ -0,0 +1,52 @@ +# Home Assistant Community Add-on: Uptime Kuma + +[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] + +[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] + +[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors] + +[![Support Frenck on Patreon][patreon-shield]][patreon] + +It is a self-hosted monitoring tool like "Uptime Robot". + +## About + +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. + +## WARNING! THIS IS AN EDGE VERSION! + +This Home Assistant Add-ons repository contains edge builds of add-ons. +Edge builds add-ons are based upon the latest development version. + +- They may not work at all. +- They might stop working at any time. +- They could have a negative impact on your system. + +This repository was created for: + +- Anybody willing to test. +- Anybody interested in trying out upcoming add-ons or add-on features. +- Developers. + +If you are more interested in stable releases of our add-ons: + + + +[discord-shield]: https://img.shields.io/discord/478094546522079232.svg +[discord]: https://discord.me/hassioaddons +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io/? +[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png +[github-sponsors]: https://github.com/sponsors/frenck +[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg +[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png +[patreon]: https://www.patreon.com/frenck +[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg +[release-shield]: https://img.shields.io/badge/version-ec85ac1-blue.svg +[release]: https://github.com/hassio-addons/addon-uptime-kuma/tree/ec85ac1 \ No newline at end of file diff --git a/uptime-kuma/config.yaml b/uptime-kuma/config.yaml new file mode 100644 index 000000000..9076564b7 --- /dev/null +++ b/uptime-kuma/config.yaml @@ -0,0 +1,19 @@ +arch: +- aarch64 +- amd64 +- armhf +- armv7 +- i386 +codenotary: codenotary@frenck.dev +description: It is a self-hosted monitoring tool like "Uptime Robot" +image: ghcr.io/hassio-addons/uptime-kuma/{arch} +init: false +name: Uptime Kuma +ports: + 3001/tcp: 3001 +ports_description: + 3001/tcp: Web interface +slug: uptime-kuma +url: https://github.com/hassio-addons/addon-uptime-kuma +version: ec85ac1 +webui: http://[HOST]:[PORT:3001] diff --git a/uptime-kuma/icon.png b/uptime-kuma/icon.png new file mode 100644 index 000000000..2ae33861b Binary files /dev/null and b/uptime-kuma/icon.png differ diff --git a/uptime-kuma/logo.png b/uptime-kuma/logo.png new file mode 100644 index 000000000..2ae33861b Binary files /dev/null and b/uptime-kuma/logo.png differ