mirror of
https://github.com/YunoHost-Apps/uptime-kuma_ynh.git
synced 2024-10-01 13:34:58 +02:00
fix readme and docs
This commit is contained in:
Hadrien
parent
7bf99f3db4
commit
1c38f8d16a
5 changed files with 92 additions and 87 deletions
76
README.md
76
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
|
||||
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
# Example app for YunoHost
|
||||
# Uptime Kuma for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/uptime-kuma)  
|
||||
[](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
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 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 ?
|
||||
* architectures not supported ?
|
||||
* not-working single-sign on or LDAP integration ?
|
||||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||
* 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
|
||||
|
||||
* 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
|
||||
68
README_fr.md
68
README_fr.md
|
|
@ -1,66 +1,74 @@
|
|||
# Example app pour YunoHost
|
||||
# Uptime Kuma pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/uptime-kuma)  
|
||||
[](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
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 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 ?
|
||||
* architectures not supported ?
|
||||
* not-working single-sign on or LDAP integration ?
|
||||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||
* 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
|
||||
|
||||
* 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
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 ?
|
||||
* architectures not supported ?
|
||||
* not-working single-sign on or LDAP integration ?
|
||||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||
* 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 ? -->
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 99 KiB |
Loading…
Reference in a new issue