1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/uptime-kuma_ynh.git synced 2024-10-01 13:34:58 +02:00
uptime-kuma_ynh/README.md

61 lines
2.2 KiB
Markdown
Raw Normal View History

2021-11-01 18:18:52 +01:00
<!--
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.
-->
2021-11-01 22:38:22 +01:00
# Uptime Kuma for YunoHost
2021-11-01 18:18:52 +01:00
2023-02-14 07:23:03 +01:00
[![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)
2021-11-01 22:38:22 +01:00
[![Install Uptime Kuma with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=uptime-kuma)
2021-11-01 18:18:52 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2021-11-01 22:38:22 +01:00
> *This package allows you to install Uptime Kuma quickly and simply on a YunoHost server.
2021-11-01 18:18:52 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2023-08-29 21:17:24 +02:00
Uptime Kuma is a self-hosted monitoring tool like "Uptime Robot".
2021-11-01 18:18:52 +01:00
2021-11-01 22:38:22 +01:00
### Features
2021-11-01 18:18:52 +01:00
2021-11-01 22:38:22 +01:00
- Monitoring uptime for HTTP(s) / TCP / Ping / DNS Record / Push.
2023-03-21 09:44:15 +01:00
- Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP)...
- 20 second intervals
2021-11-01 22:38:22 +01:00
- Multi Languages
- Simple Status Page
- Ping Chart
- Certificate Info
2021-11-01 18:18:52 +01:00
2023-02-14 07:23:03 +01:00
2023-12-02 17:18:31 +01:00
**Shipped version:** 1.23.8~ynh1
2021-11-01 18:18:52 +01:00
2021-11-01 22:38:22 +01:00
**Demo:** https://demo.uptime.kuma.pet
2021-11-01 18:18:52 +01:00
2021-11-01 22:38:22 +01:00
## Screenshots
2021-11-01 18:18:52 +01:00
2022-05-27 08:12:34 +02:00
![Screenshot of Uptime Kuma](./doc/screenshots/example.jpg)
2021-11-01 18:18:52 +01:00
## Documentation and resources
2022-05-27 08:12:34 +02:00
* Official app website: <https://uptime.kuma.pet/>
* Official user documentation: <https://github.com/louislam/uptime-kuma/wiki>
* Upstream app code repository: <https://github.com/louislam/uptime-kuma>
2023-11-13 17:18:22 +01:00
* YunoHost Store: <https://apps.yunohost.org/app/uptime-kuma>
2022-05-27 08:12:34 +02:00
* Report a bug: <https://github.com/YunoHost-Apps/uptime-kuma_ynh/issues>
2021-11-01 18:18:52 +01:00
## Developer info
2021-11-01 22:38:22 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/uptime-kuma_ynh/tree/testing).
2021-11-01 18:18:52 +01:00
To try the testing branch, please proceed like that.
2022-05-27 08:12:34 +02:00
``` bash
2021-11-01 22:38:22 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/uptime-kuma_ynh/tree/testing --debug
2021-11-01 18:18:52 +01:00
or
2021-11-01 22:38:22 +01:00
sudo yunohost app upgrade uptime-kuma -u https://github.com/YunoHost-Apps/uptime-kuma_ynh/tree/testing --debug
2021-11-01 18:18:52 +01:00
```
2022-05-27 08:12:34 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>