YunoHost-Apps/mattermost_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/mattermost_ynh.git synced 2024-09-03 19:36:29 +02:00
Code Issues Activity Actions

Merge pull request #248 from YunoHost-Apps/Add-automatic-README

Browse source 
Add automatic readme
This commit is contained in:
Pierre de La Morinerie 2021-05-23 15:36:52 +02:00 • committed by GitHub
commit 9e968d5867
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 112 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
README.md
View file

@ -1,47 +1,51 @@
---
<!--
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.
-->
# 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:** <span class="version">5.34.2</span>
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

60
README_fr.md
View file

@ -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 :** <span class="version">5.34.2</span>
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

16
check_process
View file

@ -1,8 +1,8 @@
;; Test with Enterprise Edition
; Manifest
domain="domain.tld" (DOMAIN)
path="/path" (PATH)
admin="john" (USER)
domain="domain.tld"
path="/path"
admin="john"
email="john@gmail.com"
admin_email="john@gmail.com"
password="admin!42"
@ -10,7 +10,7 @@
language="fr"
version="Enterprise"
team_display_name="Mon équipe"
is_public=1 (PUBLIC|public=1|private=0)
is_public=1
; Checks
pkg_linter=1
setup_sub_dir=1
@ -26,9 +26,9 @@
change_url=1
;; Test with Team Edition
; Manifest
domain="domain.tld" (DOMAIN)
path="/path" (PATH)
admin="john" (USER)
domain="domain.tld"
path="/path"
admin="john"
email="john@gmail.com"
admin_email="john@gmail.com"
password="admin!42"
@ -36,7 +36,7 @@
language="fr"
version="Team"
team_display_name="Mon équipe"
is_public=1 (PUBLIC|public=1|private=0)
is_public=1
; Checks
setup_sub_dir=1
setup_root=1

17
doc/DISCLAIMER.md Normal file
View file

@ -0,0 +1,17 @@
## Configuration
* How to configure this app: From an admin panel, a plain file with SSH.
## 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/)
## Limitations
* LDAP integration is not supported (see #58)
## Additional information
* This package can by installed on `ARM`, `ARM64` and `x86-64` architecture (only `x86-64` if you choose to install the *Entreprise Edition*).

15
doc/DISCLAIMER_fr.md Normal file
View file

@ -0,0 +1,15 @@
## Configuration
* Comment configurer cette application : via le panneau d'administration, un fichier brut en SSH.
## 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).
## Limitations
* L'intégration LDAP n'est pas gérée (see #58)
## Informations additionnelles
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*).

BIN
doc/screenshots/screenshot.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 434 KiB

7
manifest.json
View file

@ -8,6 +8,13 @@
},
"version": "5.34.2~ynh1",
"url": "http://www.mattermost.org/",
"upstream": {
"license": "GPL-3.0-only",
"website": "http://www.mattermost.org/",
"admindoc": "https://docs.mattermost.com/",
"userdoc": "https://yunohost.org/en/app_mattermost",
"code": "https://github.com/mattermost/mattermost-server"
},
"license": "GPL-3.0-only",
"maintainer": {
"name": "pmorinerie",