diff --git a/README.md b/README.md index fb6e873..87e1959 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,51 @@ + + +--- + + + # Mattermost for YunoHost -[![Integration level](https://dash.yunohost.org/integration/mattermost.svg)](https://dash.yunohost.org/appci/app/mattermost) ![](https://ci-apps.yunohost.org/ci/badges/mattermost.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mattermost.maintain.svg) -[![Install Mattermost with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mattermost) +[![Integration level](https://dash.yunohost.org/integration/mattermost.svg)](https://dash.yunohost.org/appci/app/mattermost) ![](https://ci-apps.yunohost.org/ci/badges/mattermost.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mattermost.maintain.svg) +[![Install mattermost with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mattermost) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Mattermost quickly and simply on a YunoHost server. +> *This package allows you to install mattermost 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 -Mattermost is a self-hosted, open source instant messaging and service software. It's designed as an internal chat for organizations and businesses, and it's touted as an alternative to Slack. -**Shipped version:** 5.34.2 +Open source collaboration platform built for developers + +**Shipped version:** 5.34.2~ynh1 + + + ## Screenshots -![](https://ucarecdn.com/8cd90d9d-8902-4845-a15b-f4664e5fcfb3/-/format/auto/-/quality/lighter/-/max_icc_size/10/-/resize/1288x/) + + ![](./doc/screenshots/screenshot.png) + + + + +## Disclaimers / important information ## Configuration * How to configure this app: From an admin panel, a plain file with SSH. -## Documentation - - * Official documentation: https://docs.mattermost.com/ - * YunoHost documentation: https://yunohost.org/en/app_mattermost - ## YunoHost specific features This package can install the [*Entreprise Edition*](https://docs.mattermost.com/overview/product.html#mattermost-enterprise-edition) or the [*Team Edition*](https://docs.mattermost.com/overview/product.html#mattermost-team-edition). Mattermost Mobile and Desktop Apps are available [here](https://mattermost.com/download/) -#### Multi-user support - - * Are LDAP and HTTP auth supported? **No** - * Can the app be used by multiple users? **Yes** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mattermost.svg)](https://ci-apps.yunohost.org/ci/apps/mattermost/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mattermost.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mattermost/) - ## Limitations * LDAP integration is not supported (see #58) @@ -50,14 +54,16 @@ Mattermost Mobile and Desktop Apps are available [here](https://mattermost.com/d * This package can by installed on `ARM`, `ARM64` and `x86-64` architecture (only `x86-64` if you choose to install the *Entreprise Edition*). -## Links - * Report a bug: https://github.com/YunoHost-Apps/mattermost_ynh/issues - * App website: http://www.mattermost.org/ - * Upstream app repository: https://github.com/mattermost/mattermost-server - * YunoHost website: https://yunohost.org/ ---- +## Documentation and resources + +* Official app website: http://www.mattermost.org/ +* Official user documentation: https://yunohost.org/en/app_mattermost +* Official admin documentation: https://docs.mattermost.com/ +* Upstream app code repository: https://github.com/mattermost/mattermost-server +* YunoHost documentation for this app: https://yunohost.org/app_mattermost +* Report a bug: https://github.com/YunoHost-Apps/mattermost_ynh/issues ## Developer info @@ -69,3 +75,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/mattermost_ynh/tree/t or sudo yunohost app upgrade mattermost -u https://github.com/YunoHost-Apps/mattermost_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 124dc22..03fc98c 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,45 +1,41 @@ # Mattermost pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/mattermost.svg)](https://dash.yunohost.org/appci/app/mattermost) ![](https://ci-apps.yunohost.org/ci/badges/mattermost.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mattermost.maintain.svg) -[![Installer Mattermost avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mattermost) +[![Niveau d'intégration](https://dash.yunohost.org/integration/mattermost.svg)](https://dash.yunohost.org/appci/app/mattermost) ![](https://ci-apps.yunohost.org/ci/badges/mattermost.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mattermost.maintain.svg) +[![Installer mattermost avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mattermost) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Mattermost rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +> *This package allows you to install mattermost 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.* ## Vue d'ensemble -Mattermost est un logiciel et un service de messagerie instantanée libre auto-hébergeable. Il est conçu comme un chat interne pour les organisations et les entreprises, et il est présenté comme une alternative à Slack. -**Version incluse :** 5.34.2 +Plateforme de collaboration open source conçue pour les développeurs + +**Version incluse:** 5.34.2~ynh1 + + + ## Captures d'écran -![](https://ucarecdn.com/8cd90d9d-8902-4845-a15b-f4664e5fcfb3/-/format/auto/-/quality/lighter/-/max_icc_size/10/-/resize/1288x/) + + ![](./doc/screenshots/screenshot.png) + + + + +## Avertissements / informations importantes ## Configuration * Comment configurer cette application : via le panneau d'administration, un fichier brut en SSH. -## Documentation - - * Documentation officielle : https://docs.mattermost.com/ - * Documentation YunoHost : https://yunohost.org/fr/app_mattermost - ## Caractéristiques spécifiques YunoHost Ce paquet peut installer la version [*Entreprise Edition*](https://docs.mattermost.com/overview/product.html#mattermost-enterprise-edition) ou la version [*Team Edition*](https://docs.mattermost.com/overview/product.html#mattermost-team-edition). -#### Support multi-utilisateur - - * L'authentification LDAP et HTTP est-elle prise en charge ? **Non** - * L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mattermost.svg)](https://ci-apps.yunohost.org/ci/apps/mattermost/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mattermost.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mattermost/) - ## Limitations * L'intégration LDAP n'est pas gérée (see #58) @@ -48,14 +44,16 @@ Ce paquet peut installer la version [*Entreprise Edition*](https://docs.mattermo Ce paquet peut être installé sur les architectures `ARM`, `ARM64` et `x86-64` (mais uniquement `x86-64` si vous choisissez d'installer la version *Enterprise Edition*). -## Liens - * Signaler un bug : https://github.com/YunoHost-Apps/mattermost_ynh/issues - * Site de l'application : http://www.mattermost.org/ - * Dépôt de l'application principale : https://github.com/mattermost/mattermost-server - * Site web YunoHost : https://yunohost.org/ ---- +## Documentations et ressources + +* Site official de l'app : http://www.mattermost.org/ +* Documentation officielle utilisateur: https://yunohost.org/en/app_mattermost +* Documentation officielle de l'admin: https://docs.mattermost.com/ +* Dépôt de code officiel de l'app: https://github.com/mattermost/mattermost-server +* Documentation YunoHost pour cette app: https://yunohost.org/app_mattermost +* Signaler un bug: https://github.com/YunoHost-Apps/mattermost_ynh/issues ## Informations pour les développeurs @@ -64,6 +62,8 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno Pour essayer la branche testing, procédez comme suit. ``` sudo yunohost app install https://github.com/YunoHost-Apps/mattermost_ynh/tree/testing --debug -ou +or sudo yunohost app upgrade mattermost -u https://github.com/YunoHost-Apps/mattermost_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file