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

fix readme and docs

Browse source
This commit is contained in:
Hadrien 2021-11-02 00:38:22 +03:00
parent 7bf99f3db4
commit 1c38f8d16a
5 changed files with 92 additions and 87 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

76
README.md
View file

@ -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
---
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator 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. It shall NOT be edited by hand.
--> -->
# 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) [![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 example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![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)* *[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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## 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 **Shipped version:** 1.0~ynh1
**Demo:** https://demo.example.com **Demo:** https://demo.uptime.kuma.pet
## Screenshots ## Screenshots
![](./doc/screenshots/example.jpg) ![](./doc/screenshots/example.jpg)
## Disclaimers / important information ## 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
<!-- * Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain ? * requiring a full dedicated domain ?
* architectures not supported ? * architectures not supported ?
* not-working single-sign on or LDAP integration ? * not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly * the app requires an important amount of RAM / disk / .. to install or to work properly
* etc... * etc...
* Other infos that people should be aware of, such as:
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
* how to configure / administrate the application if it ain't obvious
* upgrade process / specificities / things to be aware of ?
* security considerations ?
- Other infos that people should be aware of, such as:
- any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
- how to configure / administrate the application if it ain't obvious
- upgrade process / specificities / things to be aware of ?
- security considerations ? -->
## Documentation and resources ## Documentation and resources
* Official app website: https://example.com * Official app website: https://uptime.kuma.pet/
* Official user documentation: https://yunohost.org/apps * Official user documentation: https://github.com/louislam/uptime-kuma/wiki
* Official admin documentation: https://yunohost.org/packaging_apps * Official admin documentation: https://github.com/louislam/uptime-kuma/wiki
* Upstream app code repository: https://some.forge.com/example/example * Upstream app code repository: https://github.com/louislam/uptime-kuma/
* YunoHost documentation for this app: https://yunohost.org/app_example * YunoHost documentation for this app: https://yunohost.org/app_uptime-kuma
* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues * Report a bug: https://github.com/YunoHost-Apps/uptime-kuma_ynh/issues
## Developer info ## 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. 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 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 **More info regarding app packaging:** https://yunohost.org/packaging_apps

68
README_fr.md
View file

@ -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) [![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 example avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![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)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install example quickly and simply on a YunoHost server. > *Ce package vous permet d'installer Uptime Kuma rapidement et simplement sur un serveur YunoHost.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## 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 ## Captures d'écran
![](./doc/screenshots/example.jpg) ![](./doc/screenshots/example.jpg)
## Avertissements / informations importantes ## 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
<!-- * Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain ? * requiring a full dedicated domain ?
* architectures not supported ? * architectures not supported ?
* not-working single-sign on or LDAP integration ? * not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly * the app requires an important amount of RAM / disk / .. to install or to work properly
* etc... * etc...
* Other infos that people should be aware of, such as:
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
* how to configure / administrate the application if it ain't obvious
* upgrade process / specificities / things to be aware of ?
* security considerations ?
- Other infos that people should be aware of, such as:
- any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
- how to configure / administrate the application if it ain't obvious
- upgrade process / specificities / things to be aware of ?
- security considerations ? -->
## Documentations et ressources ## Documentations et ressources
* Site official de l'app : https://example.com * Site officiel de l'app : https://uptime.kuma.pet/
* Documentation officielle utilisateur: https://yunohost.org/apps * Documentation officielle utilisateur : https://github.com/louislam/uptime-kuma/wiki
* Documentation officielle de l'admin: https://yunohost.org/packaging_apps * Documentation officielle de l'admin : https://github.com/louislam/uptime-kuma/wiki
* Dépôt de code officiel de l'app: https://some.forge.com/example/example * Dépôt de code officiel de l'app : https://github.com/louislam/uptime-kuma/
* Documentation YunoHost pour cette app: https://yunohost.org/app_example * Documentation YunoHost pour cette app : https://yunohost.org/app_uptime-kuma
* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues * Signaler un bug : https://github.com/YunoHost-Apps/uptime-kuma_ynh/issues
## Informations pour les développeurs ## 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. Pour essayer la branche testing, procédez comme suit.
``` ```
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 ou
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
``` ```
**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps **Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

16
doc/DESCRIPTION.md
View file

@ -2,11 +2,11 @@ It is a self-hosted monitoring tool like "Uptime Robot".
### Features ### Features
Monitoring uptime for HTTP(s) / TCP / Ping / DNS Record / Push. - Monitoring uptime for HTTP(s) / TCP / Ping / DNS Record / Push.
Fancy, Reactive, Fast UI/UX. - Fancy, Reactive, Fast UI/UX.
Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and 70+ notification services, click here for the full list. - Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and 70+ notification services, click here for the full list.
20 second intervals. - 20 second intervals.
Multi Languages - Multi Languages
Simple Status Page - Simple Status Page
Ping Chart - Ping Chart
Certificate Info - Certificate Info

15
doc/DISCLAIMER.md
View file

@ -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
<!-- * Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain ? * requiring a full dedicated domain ?
* architectures not supported ? * architectures not supported ?
* not-working single-sign on or LDAP integration ? * not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly * the app requires an important amount of RAM / disk / .. to install or to work properly
* etc... * etc...
* Other infos that people should be aware of, such as:
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - Other infos that people should be aware of, such as:
* how to configure / administrate the application if it ain't obvious - any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
* upgrade process / specificities / things to be aware of ? - how to configure / administrate the application if it ain't obvious
* security considerations ? - upgrade process / specificities / things to be aware of ?
- security considerations ? -->

BIN
doc/screenshots/example.jpg
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 99 KiB