uptime-kuma_ynh/README.md

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# Uptime Kuma for YunoHost

[![Integration level](https://dash.yunohost.org/integration/uptime-kuma.svg)](https://dash.yunohost.org/appci/app/uptime-kuma) ![Working status](https://ci-apps.yunohost.org/ci/badges/uptime-kuma.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/uptime-kuma.maintain.svg)  
[![Install Uptime Kuma with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=uptime-kuma)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Uptime Kuma quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

## Overview

It is a self-hosted monitoring tool like "Uptime Robot".

### Features

- Monitoring uptime for HTTP(s) / TCP / Ping / DNS Record / Push.
- Fancy, Reactive, Fast UI/UX.
- Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and 70+ notification services, click here for the full list.
- 20 second intervals.
- Multi Languages
- Simple Status Page
- Ping Chart
- Certificate Info


**Shipped version:** 1.16.0~ynh1

**Demo:** https://demo.uptime.kuma.pet

## Screenshots

![Screenshot of Uptime Kuma](./doc/screenshots/example.jpg)

## Disclaimers / important information

- Requires a full dedicated domain
- node_modules folder is backed up and shouldn't be (600Mo...)
- ARM architecture not supported
- This app needs a manual post-install
- Uses N to install specific nodejs version
- We could pre-configure mail notifications with YunoHost mail server as an improvement. See comments in file to try to do it with Curl and WebSockets or Sqlite.

## Documentation and resources

* Official app website: <https://uptime.kuma.pet/>
* Official user documentation: <https://github.com/louislam/uptime-kuma/wiki>
* Official admin documentation: <https://github.com/louislam/uptime-kuma/wiki>
* Upstream app code repository: <https://github.com/louislam/uptime-kuma>
* YunoHost documentation for this app: <https://yunohost.org/app_uptime-kuma>
* Report a bug: <https://github.com/YunoHost-Apps/uptime-kuma_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/uptime-kuma_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/uptime-kuma_ynh/tree/testing --debug
or
sudo yunohost app upgrade uptime-kuma -u https://github.com/YunoHost-Apps/uptime-kuma_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>