diff --git a/README.md b/README.md new file mode 100644 index 0000000..4c254e8 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ + + +# Watchdog for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/watchdog.svg)](https://dash.yunohost.org/appci/app/watchdog) ![Working status](https://ci-apps.yunohost.org/ci/badges/watchdog.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/watchdog.maintain.svg) + +[![Install Watchdog with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=watchdog) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Watchdog 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 + +A Watchdog device makes sure that your server is still running. +The included service will regularly write to that watchdog device. If it stops doing so, most likely due to a freeze, then the server will be rebooted. + +This Watchdog better (only?) works if you have a hardware watchdog integrated in your server. It has only been tested on Raspberry Pi so far. + + +**Shipped version:** 5.16~ynh1 +## Documentation and resources + +* Upstream app code repository: +* YunoHost Store: +* Report a bug: + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/watchdog_ynh/tree/testing). + +To try the testing branch, please proceed like that. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/watchdog_ynh/tree/testing --debug +or +sudo yunohost app upgrade watchdog -u https://github.com/YunoHost-Apps/watchdog_ynh/tree/testing --debug +``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..fae502b --- /dev/null +++ b/README_fr.md @@ -0,0 +1,44 @@ + + +# Watchdog pour YunoHost + +[![Niveau d’intégration](https://dash.yunohost.org/integration/watchdog.svg)](https://dash.yunohost.org/appci/app/watchdog) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/watchdog.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/watchdog.maintain.svg) + +[![Installer Watchdog avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=watchdog) + +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d’installer Watchdog 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 + +A Watchdog device makes sure that your server is still running. +The included service will regularly write to that watchdog device. If it stops doing so, most likely due to a freeze, then the server will be rebooted. + +This Watchdog better (only?) works if you have a hardware watchdog integrated in your server. It has only been tested on Raspberry Pi so far. + + +**Version incluse :** 5.16~ynh1 +## Documentations et ressources + +* Dépôt de code officiel de l’app : +* YunoHost Store: +* Signaler un bug : + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/watchdog_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/watchdog_ynh/tree/testing --debug +ou +sudo yunohost app upgrade watchdog -u https://github.com/YunoHost-Apps/watchdog_ynh/tree/testing --debug +``` + +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file