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

73 lines
3.3 KiB
Markdown
Raw Normal View History

2021-05-22 12:31:52 +02:00
<!--
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.
-->
2020-10-15 09:22:09 +02:00
# Mattermost for YunoHost
2015-10-21 13:03:49 +02:00
[![Integration level](https://dash.yunohost.org/integration/mattermost.svg)](https://dash.yunohost.org/appci/app/mattermost) ![Working status](https://ci-apps.yunohost.org/ci/badges/mattermost.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mattermost.maintain.svg)
2021-06-15 08:35:11 +02:00
[![Install Mattermost with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mattermost)
2021-01-11 23:46:48 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2021-06-15 08:35:11 +02:00
> *This package allows you to install Mattermost quickly and simply on a YunoHost server.
2021-01-11 23:46:48 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
2015-10-21 13:03:49 +02:00
2020-10-15 09:22:09 +02:00
## Overview
2021-01-11 23:46:48 +01:00
## Mattermost Team Edition
Packaging format v2 (#406) * backup script for PostgreSQL (#376) Inspired from https://github.com/YunoHost-Apps/moodle_ynh/blob/master/scripts/backup * Adapt to PostgreSQL (#375) Question: in https://docs.mattermost.com/install/install-debian.html#install-postgresql-database-server, I see `BindsTo=postgresql.service` while in the original file here I find `Requires=mysql.service`. I don't know which one makes sense, so I keep the orinigal Yunohost version (Requires) * config.json for PostgreSQL (#374) Inspired from the original MySQL config.json and from Mattermost documentation https://docs.mattermost.com/install/install-debian.html#install-postgresql-database-server * Install with PostgreSQL (#373) I took inspiration from https://github.com/YunoHost-Apps/commento_ynh/blob/master/scripts/install * install postgresql * Reordering * reset config file * Update _common.sh * Update config.json * Fix * Migration (#382) * add migration * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Fix * Fix * Fix * Update install * Update upgrade * Fix * Update install * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update install * Fix * Fix * Fix * Update upgrade * Cleaning up * Update upgrade * Update _common.sh * Update check_process * Update _common.sh * Fix * Update mysql-to-pg.conf * Update upgrade * Update systemd.service * Cleaning * Update _common.sh * Fix * Update upgrade * Update _common.sh * Update upgrade * Update backup * Fix * Fix * Update upgrade * Update upgrade * Update systemd.service * Update _common.sh * Revert "Update _common.sh" This reverts commit d880150af94cc164c69802f4ae46d7e6529482f9. * Cleaning * Fix * Update check_process * Fix * Update _common.sh * Fix * Update _common.sh * Fix * Update manifest.json * Update install * Update _common.sh * Update upgrade * Fix * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Auto-update README * Update _common.sh * Upgrade to v7.4.0 * Auto-update README * Upgrade to v7.5.2 * Auto-update README * Update config.json * [fix] mariadb to postgres migration * Auto-update README * [fix] Update manifest requirements * Update manifest.json * Update config.json * upgrade config to upstream * Fix linter * Update _common.sh * v2 * Fix * Auto-update README * Fix * Auto-update README * Update upgrade * Fix * Cleaning * add apt * Auto-update README * cleaning * fix data path var * fix * Auto-update README * Update backup * add more apt * Update manifest.toml * Update tests.toml * Fix * Update _common.sh * Update upgrade * Update restore * Update remove * cleaning * Update install * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update manifest.toml * 7.7.1 * Update manifest.json * Auto-update README * Update config.json * Auto-update README * cleaning * Auto-update README * Update ADMIN.md * Update ADMIN_fr.md * fix * Delete check_process * 7.8.1 * Auto-update README * Auto-update README * Update manifest.toml * Auto-update README * fix migration from 7.3.0 * Update manifest.toml * fix migration from 7.3.0 * cleaning * Update manifest.toml * src * Update upgrade * Update upgrade * Update tests.toml * remove src * 7.9.1 * Auto-update README * Update config.json * Update doc/DESCRIPTION.md Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Auto-update README * Update tests.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update upgrade * Update install * Update DESCRIPTION_fr.md * Auto-update README * Update _common.sh * Update manifest.toml * Update manifest.toml * Auto-update README * Update manifest.toml * Update upgrade * Update manifest.toml * Auto-update README * cleaning * Auto-update README * Update nginx.conf * Update manifest.toml * Auto-update README * cleaning * Update doc/ADMIN.md Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * Update doc/ADMIN_fr.md Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * 8.0.0 * Auto-update README * Update manifest.toml * Auto-update README * 8.1.0 * Auto-update README * Update upgrade * Update tests.toml * Update tests.toml * Update _common.sh * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update tests.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml * DEBUG: see if other migrations pass (#430) * Update manifest.toml * Auto-update README * Revert "DEBUG: see if other migrations pass (#430)" This reverts commit 8532bd3ba2d60c77527a1b92f63e5c6b1dd3659b. * Update tests.toml * scripts: fix MySQL migration The PostgreSQL database has already been created, no need to create it manually. * scripts: improve DB migration comment * Update config.json * Update tests.toml * Fix v2 database deletion on error (#434) * scripts: improve comments * scripts: manually remove MariaDB database if needed --------- Co-authored-by: biva <biva@users.noreply.github.com> Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: yunohost-bot <yunohost-bot@users.noreply.github.com> Co-authored-by: ljf <ljf+git@grimaud.me> Co-authored-by: Kay0u <pierre@kayou.io> Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org>
2023-09-11 10:48:35 +02:00
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 PosgreSQL under an MIT license.
## Mattermost Enterprise Edition
Packaging format v2 (#406) * backup script for PostgreSQL (#376) Inspired from https://github.com/YunoHost-Apps/moodle_ynh/blob/master/scripts/backup * Adapt to PostgreSQL (#375) Question: in https://docs.mattermost.com/install/install-debian.html#install-postgresql-database-server, I see `BindsTo=postgresql.service` while in the original file here I find `Requires=mysql.service`. I don't know which one makes sense, so I keep the orinigal Yunohost version (Requires) * config.json for PostgreSQL (#374) Inspired from the original MySQL config.json and from Mattermost documentation https://docs.mattermost.com/install/install-debian.html#install-postgresql-database-server * Install with PostgreSQL (#373) I took inspiration from https://github.com/YunoHost-Apps/commento_ynh/blob/master/scripts/install * install postgresql * Reordering * reset config file * Update _common.sh * Update config.json * Fix * Migration (#382) * add migration * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Fix * Fix * Fix * Update install * Update upgrade * Fix * Update install * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update install * Fix * Fix * Fix * Update upgrade * Cleaning up * Update upgrade * Update _common.sh * Update check_process * Update _common.sh * Fix * Update mysql-to-pg.conf * Update upgrade * Update systemd.service * Cleaning * Update _common.sh * Fix * Update upgrade * Update _common.sh * Update upgrade * Update backup * Fix * Fix * Update upgrade * Update upgrade * Update systemd.service * Update _common.sh * Revert "Update _common.sh" This reverts commit d880150af94cc164c69802f4ae46d7e6529482f9. * Cleaning * Fix * Update check_process * Fix * Update _common.sh * Fix * Update _common.sh * Fix * Update manifest.json * Update install * Update _common.sh * Update upgrade * Fix * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Auto-update README * Update _common.sh * Upgrade to v7.4.0 * Auto-update README * Upgrade to v7.5.2 * Auto-update README * Update config.json * [fix] mariadb to postgres migration * Auto-update README * [fix] Update manifest requirements * Update manifest.json * Update config.json * upgrade config to upstream * Fix linter * Update _common.sh * v2 * Fix * Auto-update README * Fix * Auto-update README * Update upgrade * Fix * Cleaning * add apt * Auto-update README * cleaning * fix data path var * fix * Auto-update README * Update backup * add more apt * Update manifest.toml * Update tests.toml * Fix * Update _common.sh * Update upgrade * Update restore * Update remove * cleaning * Update install * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update manifest.toml * 7.7.1 * Update manifest.json * Auto-update README * Update config.json * Auto-update README * cleaning * Auto-update README * Update ADMIN.md * Update ADMIN_fr.md * fix * Delete check_process * 7.8.1 * Auto-update README * Auto-update README * Update manifest.toml * Auto-update README * fix migration from 7.3.0 * Update manifest.toml * fix migration from 7.3.0 * cleaning * Update manifest.toml * src * Update upgrade * Update upgrade * Update tests.toml * remove src * 7.9.1 * Auto-update README * Update config.json * Update doc/DESCRIPTION.md Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Auto-update README * Update tests.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update upgrade * Update install * Update DESCRIPTION_fr.md * Auto-update README * Update _common.sh * Update manifest.toml * Update manifest.toml * Auto-update README * Update manifest.toml * Update upgrade * Update manifest.toml * Auto-update README * cleaning * Auto-update README * Update nginx.conf * Update manifest.toml * Auto-update README * cleaning * Update doc/ADMIN.md Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * Update doc/ADMIN_fr.md Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * 8.0.0 * Auto-update README * Update manifest.toml * Auto-update README * 8.1.0 * Auto-update README * Update upgrade * Update tests.toml * Update tests.toml * Update _common.sh * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update tests.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml * DEBUG: see if other migrations pass (#430) * Update manifest.toml * Auto-update README * Revert "DEBUG: see if other migrations pass (#430)" This reverts commit 8532bd3ba2d60c77527a1b92f63e5c6b1dd3659b. * Update tests.toml * scripts: fix MySQL migration The PostgreSQL database has already been created, no need to create it manually. * scripts: improve DB migration comment * Update config.json * Update tests.toml * Fix v2 database deletion on error (#434) * scripts: improve comments * scripts: manually remove MariaDB database if needed --------- Co-authored-by: biva <biva@users.noreply.github.com> Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: yunohost-bot <yunohost-bot@users.noreply.github.com> Co-authored-by: ljf <ljf+git@grimaud.me> Co-authored-by: Kay0u <pierre@kayou.io> Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org>
2023-09-11 10:48:35 +02:00
To explore the benefits of Mattermosts 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.
Packaging format v2 (#406) * backup script for PostgreSQL (#376) Inspired from https://github.com/YunoHost-Apps/moodle_ynh/blob/master/scripts/backup * Adapt to PostgreSQL (#375) Question: in https://docs.mattermost.com/install/install-debian.html#install-postgresql-database-server, I see `BindsTo=postgresql.service` while in the original file here I find `Requires=mysql.service`. I don't know which one makes sense, so I keep the orinigal Yunohost version (Requires) * config.json for PostgreSQL (#374) Inspired from the original MySQL config.json and from Mattermost documentation https://docs.mattermost.com/install/install-debian.html#install-postgresql-database-server * Install with PostgreSQL (#373) I took inspiration from https://github.com/YunoHost-Apps/commento_ynh/blob/master/scripts/install * install postgresql * Reordering * reset config file * Update _common.sh * Update config.json * Fix * Migration (#382) * add migration * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Fix * Fix * Fix * Update install * Update upgrade * Fix * Update install * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update install * Fix * Fix * Fix * Update upgrade * Cleaning up * Update upgrade * Update _common.sh * Update check_process * Update _common.sh * Fix * Update mysql-to-pg.conf * Update upgrade * Update systemd.service * Cleaning * Update _common.sh * Fix * Update upgrade * Update _common.sh * Update upgrade * Update backup * Fix * Fix * Update upgrade * Update upgrade * Update systemd.service * Update _common.sh * Revert "Update _common.sh" This reverts commit d880150af94cc164c69802f4ae46d7e6529482f9. * Cleaning * Fix * Update check_process * Fix * Update _common.sh * Fix * Update _common.sh * Fix * Update manifest.json * Update install * Update _common.sh * Update upgrade * Fix * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Update _common.sh * Auto-update README * Update _common.sh * Upgrade to v7.4.0 * Auto-update README * Upgrade to v7.5.2 * Auto-update README * Update config.json * [fix] mariadb to postgres migration * Auto-update README * [fix] Update manifest requirements * Update manifest.json * Update config.json * upgrade config to upstream * Fix linter * Update _common.sh * v2 * Fix * Auto-update README * Fix * Auto-update README * Update upgrade * Fix * Cleaning * add apt * Auto-update README * cleaning * fix data path var * fix * Auto-update README * Update backup * add more apt * Update manifest.toml * Update tests.toml * Fix * Update _common.sh * Update upgrade * Update restore * Update remove * cleaning * Update install * Update upgrade * Update upgrade * Update upgrade * Update upgrade * Update manifest.toml * 7.7.1 * Update manifest.json * Auto-update README * Update config.json * Auto-update README * cleaning * Auto-update README * Update ADMIN.md * Update ADMIN_fr.md * fix * Delete check_process * 7.8.1 * Auto-update README * Auto-update README * Update manifest.toml * Auto-update README * fix migration from 7.3.0 * Update manifest.toml * fix migration from 7.3.0 * cleaning * Update manifest.toml * src * Update upgrade * Update upgrade * Update tests.toml * remove src * 7.9.1 * Auto-update README * Update config.json * Update doc/DESCRIPTION.md Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Auto-update README * Update tests.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update upgrade * Update install * Update DESCRIPTION_fr.md * Auto-update README * Update _common.sh * Update manifest.toml * Update manifest.toml * Auto-update README * Update manifest.toml * Update upgrade * Update manifest.toml * Auto-update README * cleaning * Auto-update README * Update nginx.conf * Update manifest.toml * Auto-update README * cleaning * Update doc/ADMIN.md Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * Update doc/ADMIN_fr.md Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> * 8.0.0 * Auto-update README * Update manifest.toml * Auto-update README * 8.1.0 * Auto-update README * Update upgrade * Update tests.toml * Update tests.toml * Update _common.sh * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update tests.toml Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> * Update manifest.toml * DEBUG: see if other migrations pass (#430) * Update manifest.toml * Auto-update README * Revert "DEBUG: see if other migrations pass (#430)" This reverts commit 8532bd3ba2d60c77527a1b92f63e5c6b1dd3659b. * Update tests.toml * scripts: fix MySQL migration The PostgreSQL database has already been created, no need to create it manually. * scripts: improve DB migration comment * Update config.json * Update tests.toml * Fix v2 database deletion on error (#434) * scripts: improve comments * scripts: manually remove MariaDB database if needed --------- Co-authored-by: biva <biva@users.noreply.github.com> Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: yunohost-bot <yunohost-bot@users.noreply.github.com> Co-authored-by: ljf <ljf+git@grimaud.me> Co-authored-by: Kay0u <pierre@kayou.io> Co-authored-by: Pierre de La Morinerie <kemenaran@gmail.com> Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org>
2023-09-11 10:48:35 +02:00
## 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/)
## Features include:
- One-to-one and group messaging, file sharing, and unlimited search history
- 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
2021-01-11 23:46:48 +01:00
2023-10-25 18:07:24 +02:00
**Shipped version:** 9.1.0~ynh1
2021-01-11 23:46:48 +01:00
2021-05-22 12:31:52 +02:00
## Screenshots
2021-01-11 23:46:48 +01:00
2022-06-15 08:09:53 +02:00
![Screenshot of Mattermost](./doc/screenshots/screenshot.png)
2017-01-20 21:10:52 +01:00
2021-05-22 12:31:52 +02:00
## Documentation and resources
2022-06-15 08:09:53 +02:00
* 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>
* Report a bug: <https://github.com/YunoHost-Apps/mattermost_ynh/issues>
2017-05-25 13:29:31 +02:00
2021-01-11 23:46:48 +01:00
## Developer info
2017-05-25 13:29:31 +02:00
2021-01-11 23:46:48 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mattermost_ynh/tree/testing).
2017-10-16 06:20:15 +02:00
2021-01-11 23:46:48 +01:00
To try the testing branch, please proceed like that.
2022-06-15 08:09:53 +02:00
``` bash
2021-01-11 23:46:48 +01:00
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
```
2021-05-22 12:31:52 +02:00
2022-06-15 08:09:53 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>