diff --git a/README.md b/README.md index 2fc83c9..f380941 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,53 @@ + + # Cachet for YunoHost [![Integration level](https://dash.yunohost.org/integration/cachet.svg)](https://dash.yunohost.org/appci/app/cachet) ![](https://ci-apps.yunohost.org/ci/badges/cachet.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/cachet.maintain.svg) -[![Install cachet with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=cachet) +[![Install Cachet with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cachet) -> *This package allows you to install Cachet quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Cachet 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 + [Cachet](https://cachethq.io/) is a free, open source status page for your API, service or company. Built with all of the features that you'd expect from a status page, Cachet comes with a powerful API, a metric system, multiple user support, two factor authentication for added security and is easy to get setup. A powerful, self-hosted alternative to StatusPage.io and Status.io. -**Shipped version:** 2.3.18 + +**Shipped version:** 2.4.0~ynh4 + +**Demo:** https://demo.cachethq.io ## Screenshots -![](https://github.com/CachetHQ/Assets/raw/master/screenshots/main-interface.png) +![](./doc/screenshots/main-interface.png) -## Demo - -* [Official demo](https://demo.cachethq.io/) +## Disclaimers / important information ## Configuration Totally configurable through the Cachet application dashboard. -## Documentation - - * Official documentation: https://docs.cachethq.io/ - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Multi-user support - -* LDAP or HTTP authentication aren't supported (see limitations below). -* This package supports multiple instances installation. - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/cachet%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/cachet/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/cachet%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/cachet/) - ## Limitations - Must necessarily be installed on domain root (see upstream issue [here](https://github.com/CachetHQ/Cachet/issues/1696)) - Can't integrate with YunoHost SSO as LDAP support is not implemented yet (see upstream issue [here](https://github.com/CachetHQ/Cachet/issues/2108)) +## Documentation and resources -## Additional information +* Official app website: https://cachethq.io +* Official admin documentation: https://docs.cachethq.io +* Upstream app code repository: https://github.com/CachetHQ/Cachet +* YunoHost documentation for this app: https://yunohost.org/app_cachet +* Report a bug: https://github.com/YunoHost-Apps/cachet_ynh/issues -None. +## Developer info -## Links - - * Report a bug: https://github.com/YunoHost-Apps/cachet_ynh/issues - * App website: https://cachethq.io/ - * Upstream app repository: https://github.com/CachetHQ/Cachet - * YunoHost website: https://yunohost.org/ - ---- - -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/cachet_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/cachet_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -69,3 +55,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/cachet_ynh/tree/testi or sudo yunohost app upgrade cachet -u https://github.com/YunoHost-Apps/cachet_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 new file mode 100644 index 0000000..5400c93 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,55 @@ +# Cachet pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/cachet.svg)](https://dash.yunohost.org/appci/app/cachet) ![](https://ci-apps.yunohost.org/ci/badges/cachet.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/cachet.maintain.svg) +[![Installer Cachet avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cachet) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Cachet 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 + +[Cachet](https://cachethq.io/) is a free, open source status page for your API, service or company. Built with all of the features that you'd expect from a status page, Cachet comes with a powerful API, a metric system, multiple user support, two factor authentication for added security and is easy to get setup. A powerful, self-hosted alternative to StatusPage.io and Status.io. + + +**Version incluse :** 2.4.0~ynh4 + +**Démo :** https://demo.cachethq.io + +## Captures d'écran + +![](./doc/screenshots/main-interface.png) + +## Avertissements / informations importantes + +## Configuration + +Totally configurable through the Cachet application dashboard. + +## Limitations + +- Must necessarily be installed on domain root (see upstream issue [here](https://github.com/CachetHQ/Cachet/issues/1696)) +- Can't integrate with YunoHost SSO as LDAP support is not implemented yet (see upstream issue [here](https://github.com/CachetHQ/Cachet/issues/2108)) + +## Documentations et ressources + +* Site officiel de l'app : https://cachethq.io +* Documentation officielle de l'admin : https://docs.cachethq.io +* Dépôt de code officiel de l'app : https://github.com/CachetHQ/Cachet +* Documentation YunoHost pour cette app : https://yunohost.org/app_cachet +* Signaler un bug : https://github.com/YunoHost-Apps/cachet_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/cachet_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/cachet_ynh/tree/testing --debug +ou +sudo yunohost app upgrade cachet -u https://github.com/YunoHost-Apps/cachet_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file