diff --git a/README.md b/README.md index d58287b..c28ecfb 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,78 @@ - -# Packaging your an app, starting from this example - -- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo. -- Edit the `manifest.json` with app specific info. -- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`. - - Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers) -- Add a `LICENSE` file for the package. -- Edit `doc/DISCLAIMER*.md` -- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator - - ---- - -# Example app for YunoHost +# Uptime Kuma for YunoHost -[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) -[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) +[![Integration level](https://dash.yunohost.org/integration/uptime-kuma.svg)](https://dash.yunohost.org/appci/app/uptime-kuma) ![](https://ci-apps.yunohost.org/ci/badges/uptime-kuma.status.svg) ![](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 example quickly and simply on a YunoHost server. +> *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 -Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps) +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.0~ynh1 -**Demo:** https://demo.example.com - +**Demo:** https://demo.uptime.kuma.pet ## Screenshots - - ![](./doc/screenshots/example.jpg) - - - +![](./doc/screenshots/example.jpg) ## Disclaimers / important information -* Any known limitations, constrains or stuff not working, such as (but not limited to): +- Not working yet +- Uses N to install specific nodejs version + ## Documentation and resources -* Official app website: https://example.com -* Official user documentation: https://yunohost.org/apps -* Official admin documentation: https://yunohost.org/packaging_apps -* Upstream app code repository: https://some.forge.com/example/example -* YunoHost documentation for this app: https://yunohost.org/app_example -* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues +* 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/example_ynh/tree/testing). +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. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/uptime-kuma_ynh/tree/testing --debug or -sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +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 \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index d856bf9..6902053 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,66 +1,74 @@ -# Example app pour YunoHost +# Uptime Kuma pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) -[![Installer example avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) +[![Niveau d'intégration](https://dash.yunohost.org/integration/uptime-kuma.svg)](https://dash.yunohost.org/appci/app/uptime-kuma) ![](https://ci-apps.yunohost.org/ci/badges/uptime-kuma.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/uptime-kuma.maintain.svg) +[![Installer Uptime Kuma avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=uptime-kuma) *[Read this readme in english.](./README.md)* *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install example 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.* +> *Ce package vous permet d'installer Uptime Kuma rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## Vue d'ensemble -Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps) +It is a self-hosted monitoring tool like "Uptime Robot". -**Version incluse:** 1.0~ynh1 +### Features -**Démo:** https://demo.example.com +- 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 +**Version incluse :** 1.0~ynh1 + +**Démo :** https://demo.uptime.kuma.pet + ## Captures d'écran - - ![](./doc/screenshots/example.jpg) - - - +![](./doc/screenshots/example.jpg) ## Avertissements / informations importantes -* Any known limitations, constrains or stuff not working, such as (but not limited to): +- Not working yet +- Uses N to install specific nodejs version + ## Documentations et ressources -* Site official de l'app : https://example.com -* Documentation officielle utilisateur: https://yunohost.org/apps -* Documentation officielle de l'admin: https://yunohost.org/packaging_apps -* Dépôt de code officiel de l'app: https://some.forge.com/example/example -* Documentation YunoHost pour cette app: https://yunohost.org/app_example -* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues +* Site officiel de l'app : https://uptime.kuma.pet/ +* Documentation officielle utilisateur : https://github.com/louislam/uptime-kuma/wiki +* Documentation officielle de l'admin : https://github.com/louislam/uptime-kuma/wiki +* Dépôt de code officiel de l'app : https://github.com/louislam/uptime-kuma/ +* Documentation YunoHost pour cette app : https://yunohost.org/app_uptime-kuma +* Signaler un bug : https://github.com/YunoHost-Apps/uptime-kuma_ynh/issues ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/uptime-kuma_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug -or -sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/uptime-kuma_ynh/tree/testing --debug +ou +sudo yunohost app upgrade uptime-kuma -u https://github.com/YunoHost-Apps/uptime-kuma_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index cd85e93..9af13b8 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -2,11 +2,11 @@ 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 +- 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 diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index aded581..8580ccc 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,12 +1,15 @@ -* Any known limitations, constrains or stuff not working, such as (but not limited to): +- Not working yet +- Uses N to install specific nodejs version + diff --git a/doc/screenshots/example.jpg b/doc/screenshots/example.jpg index a1efa1a..5b1b755 100644 Binary files a/doc/screenshots/example.jpg and b/doc/screenshots/example.jpg differ