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

46 lines
1.5 KiB
Markdown
Raw Normal View History

2015-10-21 13:03:49 +02:00
## Description
2015-10-21 16:39:34 +02:00
A Yunohost package for [Mattermost](http://www.mattermost.org/), an open-source, self-hosted alternative to Slack.
2015-10-21 13:03:49 +02:00
2017-01-20 21:10:52 +01:00
## Build status
2017-02-01 14:03:57 +01:00
See https://ci-apps.yunohost.org/jenkins/job/mattermost%20(Community)/ for checking current build status.
2017-01-20 21:10:52 +01:00
2015-10-21 13:03:49 +02:00
## Requirements
Mattermost requires:
* A x86_64 system (check with `uname -m`),
2017-01-20 21:05:34 +01:00
* MySQL 5.6 or higher, or MariaDB 10 or higher (check with `mysql --version`).
2015-10-21 13:03:49 +02:00
2016-08-31 10:23:40 +02:00
## Installing
2015-10-21 13:03:49 +02:00
You can either :
2017-09-12 11:41:45 +02:00
* Install from the Yunohost Admin web interface, by providing this URL: `https://github.com/YunoHost-Apps/mattermost_ynh`
* Install from the command-line: `yunohost app install https://github.com/YunoHost-Apps/mattermost_ynh`
2015-10-21 13:03:49 +02:00
2016-08-31 10:23:40 +02:00
## Upgrading
Mattermost upgrades tend to work only from one minor version to the other (3.0 to 3.1, 3.1 to 3.2, etc).
**Important**: to upgrade from Mattermost 2.2, you will need an extra manual step.
Run the upgrade from Yunohost, then follow [this guide](https://docs.mattermost.com/administration/upgrade.html).
2015-10-21 13:03:49 +02:00
## What works
* Installation on domain's root
2015-10-21 14:33:49 +02:00
* Notification emails
2015-10-21 13:03:49 +02:00
## TODO
* Allow installation in sub-directory (only root-domains work for now)
2015-10-21 13:58:56 +02:00
* LDAP integration
2017-05-25 13:29:31 +02:00
## About telemetrics
Mattermost is used to send some telemetrics about your usage of it.
But this data doesn't send to mattermost, but to a third party site named [segment.com](https://segment.com/).
You can find more information about his behavior on the [mattermost documentation](https://docs.mattermost.com/administration/telemetry.html).
This behavior can be turn on or off when you install this app.