Production Docker deployment for Mattermost
This project enables deployment of a Mattermost server in a multi-node production configuration using Docker.
- The default Mattermost edition for this repo has changed from Team Edition to Enterprise Edition. Please see Choose Edition section.
- 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.
Choose Edition to Install
If you want to install Enterprise Edition, you can skip this section.
To install the Team Edition, comment out the following line in docker-compose.yaml file:
This repository offer a Docker image for the Mattermost database. It is a customized PostgreSQL image that you should configure with following environment variables :
POSTGRES_USER: database username
POSTGRES_PASSWORD: database password
POSTGRES_DB: database name
If deploying to AWS, you could also set following variables to enable Wal-E backup to S3 :
AWS_ACCESS_KEY_ID: AWS access key
AWS_SECRET_ACCESS_KEY: AWS secret
WALE_S3_PREFIX: AWS s3 bucket name
AWS_REGION: AWS region
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.
Application container run the Mattermost application. You should configure it with following environment variables :
MM_USERNAME: database username
MM_PASSWORD: database password
MM_DBNAME: database name
If your database use some custom host and port, it is also possible to configure them :
DB_HOST: database host address
DB_PORT_NUMBER: database port
If you use a Mattermost configuration file on a different location than the default one (
MM_CONFIG: configuration file location inside the container.
If you choose to use MySQL instead of PostgreSQL, you should set a different datasource :
Web server container
This image is optional, you should not use it you have your own reverse-proxy. It is a simple front Web server for the Mattermost app container.
MATTERMOST_ENABLE_SSL: whether to enable SSL
PLATFORM_PORT_80_TCP_PORT: port that Mattermost image is listening on
Install with SSL certificate
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.
Make sure to backup Mattermost data before proceeding.
docker-compose down git pull docker-compose build docker-compose up -d
Remove the containers
docker-compose stop && docker-compose rm
Remove the data and settings of your Mattermost instance
sudo rm -rf volumes
Upgrading to Team Edition 3.0.x from 2.x
You need to migrate your database before upgrading Mattermost to
2.x. Run these commands in the latest
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.
- Do not modify the Listen Address in Service Settings.
appcontainer fails to start because of "connection refused" to
database. Workaround: Restart the container.
If you want to know how to use docker-compose, see the overview
For the server configurations, see prod-ubuntu.rst of Mattermost.