easidoo/mattermost-prod-app repository overview

Dockerfiles for Mattermost in production fine tuned for dc/os

Supports persistent data for portgres and external volumes for the mattermost data, so in case you wanted to move mattermost to another cluster or machine the db and file data would be safe.

See README.aws.md⁠ if you want to install it on AWS Elastic Beanstalk.

⁠Requirements

• docker⁠
• docker-compose⁠

⁠Installation

⁠Install with SSL certificate

1. Open docker-compose.yml and set MATTERMOST_ENABLE_SSL to true.

   environment:
     - MATTERMOST_ENABLE_SSL=true
   

   Copy

2. 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.

3. Build and run mattermost

   docker-compose up -d

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

⁠Install without SSL certificate

1. Open docker-compose.yml and set MATTERMOST_ENABLE_SSL to false.

   environment:
     - MATTERMOST_ENABLE_SSL=false
   

   Copy

2. Build and run mattermost

   docker-compose up -d

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

⁠Starting/Stopping

⁠Start

docker-compose start

⁠Stop

docker-compose stop

⁠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.

⁠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 informations

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

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