jeshan/mattermost-team-edition repository overview

** This repo still a WIP**

⁠Production Docker deployment for Mattermost

This project enables deployment of a Mattermost server in a multi-node production configuration using Docker.

Notes:

• The default Mattermost edition is team edition
• To install this Docker project on AWS Elastic Beanstalk please see AWS Elastic Beanstalk Guide⁠.
• To run Mattermost on Kubernetes you can start with the manifest examples in the kubernetes folder⁠
• To install Mattermost without Docker directly onto a Linux-based operating systems, please see Admin Guide⁠.

⁠Installation using Docker Compose

The following instructions deploy Mattermost in a production configuration using multi-node Docker Compose set up.

⁠Requirements

• docker⁠
• docker-compose⁠

⁠Database

Make sure to set the appropriate values for MM_USERNAME, MM_PASSWORD and MM_DBNAME.

⁠Install with SSL certificate

1. Put your SSL certificate as ./volumes/web/cert/cert.pem and the private key that has no password as ./volumes/web/cert/key-no-password.pem. If you don't have them you may generate a self-signed SSL certificate.

2. Build and run mattermost

docker-compose up -d

1. Open https://your.domain with your web browser.

⁠Install without SSL certificate

1. Build and run mattermost

docker-compose up -d

1. Open http://your.domain with your web browser.

⁠Starting/Stopping

⁠Start

docker-compose start

⁠Stop

docker-compose stop

⁠Update

Make sure to backup Mattermost data before proceeding.

docker-compose down
git pull
docker-compose build
docker-compose up -d

⁠Removing

⁠Remove the containers

docker-compose stop && docker-compose rm

⁠Remove the data and settings of your mattermost instance

sudo rm -rf volumes

⁠Database Backup

When AWS S3 environment variables are specified on db docker container, it enables Wal-E⁠ backup to S3.

docker run -d --name mattermost-db \
    -e AWS_ACCESS_KEY_ID=XXXX \
    -e AWS_SECRET_ACCESS_KEY=XXXX \
    -e WALE_S3_PREFIX=s3://BUCKET_NAME/PATH \
    -e AWS_REGION=us-east-1
    -v ./volumes/db/var/lib/postgresql/data:/var/lib/postgresql/data
    -v /etc/localtime:/etc/localtime:ro
    db

All four environment variables are required. It will enable completed WAL segments sent to archive storage (S3). The base backup and clean up can be done through the following command:

# base backup
docker exec mattermost-db su - postgres sh -c "/usr/bin/envdir /etc/wal-e.d/env /usr/local/bin/wal-e backup-push /var/lib/postgresql/data"
# keep the most recent 7 base backups and remove the old ones
docker exec mattermost-db su - postgres sh -c "/usr/bin/envdir /etc/wal-e.d/env /usr/local/bin/wal-e delete --confirm retain 7"

Those tasks can be executed through a cron job or systemd timer.

⁠Customization

Customization can be done through environment variables.

⁠Mattermost App Image

• MM_USERNAME: database username, must be the same as one in DB image
• MM_PASSWORD: database password, must be the same as one in DB image
• MM_DBNAME: database name, must be the same as one in DB image
• DB_HOST: database host address
• DB_PORT_NUMBER: database port
• MM_CONFIG: configuration file location. It can be used when config is mounted in a different location.

⁠Mattermost DB Image

• MM_USERNAME: database username, must be the same as on in App image
• MM_PASSWORD: database password, must be the same as on in App image
• MM_DBNAME: database name, must be the same as on in App image
• AWS_ACCESS_KEY_ID: aws access key, used for db backup
• AWS_SECRET_ACCESS_KEY: aws secret, used for db backup
• WALE_S3_PREFIX: aws s3 bucket name, used for db backup
• AWS_REGION: aws region, used for db backup

⁠Mattermost Web Image

• MATTERMOST_ENABLE_SSL: whether to enable SSL
• PLATFORM_PORT_80_TCP_PORT: port that Mattermost image is listening on

⁠Upgrading to Team Edition 3.0.x from 2.x

You need to migrate your database before upgrading mattermost to 3.0.x from 2.x. Run these commands in the latest mattermost-docker directory.

docker-compose rm -f app
docker-compose build app
docker-compose run app -upgrade_db_30
docker-compose up -d

See the offical Upgrade Guide⁠ for more details.

⁠Known Issues

• Do not modify the Listen Address in Service Settings.
• Rarely 'app' container fails to start because of "connection refused" to database. Workaround: Restart the container.

⁠More information

If you want to know how to use docker-compose, see the overview page⁠.

For the server configurations, see prod-ubuntu.rst⁠ of mattermost.