mirror of
https://github.com/YunoHost-Apps/mattermost_ynh.git
synced 2024-09-03 19:36:29 +02:00
89 lines
No EOL
4.3 KiB
Markdown
89 lines
No EOL
4.3 KiB
Markdown
<!--
|
||
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
|
||
|
||
[](https://dash.yunohost.org/appci/app/mattermost)  
|
||
[](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.
|
||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||
|
||
## Overview
|
||
|
||
## Mattermost Team Edition
|
||
A free-to-use, open source, self-hosted alternative to proprietary SaaS messaging. Team Edition is your open source “virtual office”, offering all the core productivity benefits of competing SaaS solutions. It deploys as a single Linux binary with MySQL under an MIT license.
|
||
|
||
## Mattermost Enterprise Edition
|
||
To explore the benefits of Mattermost’s enterprise features, you can replace the Mattermost Team Edition binary with a Mattermost Enterprise Edition binary. This version supports upgrading to Mattermost Enterprise Edition E10 or E20.
|
||
|
||
## Features include:
|
||
|
||
- One-to-one and group messaging, file sharing, and unlimited search history
|
||
- Native apps for iOS, Android, Windows, Mac, Linux
|
||
- Threaded messaging, emoji, and custom emoji
|
||
- Tools for custom branding
|
||
- Continuous archiving
|
||
- Multi-factor authentication
|
||
- Highly customizable third-party bots, integrations, and command line tools
|
||
- Extensive integration support via webhooks, APIs, drivers, and third-party extensions
|
||
- Easily scalable to dozens of users per team
|
||
- Runtime profiling data and system monitoring reports
|
||
- New features and improvements released regularly
|
||
- Multiple languages including U.S. English, Australian English, Bulgarian, Chinese (Simplified and Traditional), Dutch, French, German, Hungarian, Italian, Japanese, Korean, Polish, Brazilian Portuguese, Romanian, Russian, Turkish, Spanish, Swedish, and Ukrainian
|
||
|
||
|
||
**Shipped version:** 6.1.0~ynh2
|
||
|
||
|
||
|
||
## Screenshots
|
||
|
||
|
||
|
||
## Disclaimers / important information
|
||
|
||
## Configuration
|
||
|
||
* How to configure this app: From an admin panel, a plain file with SSH.
|
||
* How to change from edition version to another (Team<->Enterprise) : Modify the `settings.yml` in the apps directory `/etc/yunohost/apps/mattermost_instance/settings.yml` and replace the version to wich you whant : Team or Enterprise. Update your apps and verify the *About* on your 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/)
|
||
|
||
## 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*).
|
||
|
||
## Documentation and resources
|
||
|
||
* Official app website: http://www.mattermost.org/
|
||
* Official user documentation: https://docs.mattermost.com/guides/messaging.html
|
||
* Official admin documentation: https://docs.mattermost.com/guides/deployment.html
|
||
* 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
|
||
|
||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mattermost_ynh/tree/testing).
|
||
|
||
To try the testing branch, please proceed like that.
|
||
```
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/mattermost_ynh/tree/testing --debug
|
||
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 |