gitlab-mattermost-backup

Gitlab ships mattermost in the omnibus package without backup script.

This repository contains a simple script to backup the mattermost data and uploads it to s3.

Prerequisites

The AWS cli must be installed for user root. See official install guide.

run aws configure or set the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY in config file.

Installation

Clone the repository and create a backup_mattermost.conf file.

git clone https://github.com/gitlab-tools/gitlab-mattermost-backup.git && cd gitlab-mattermost-backup && cp backup_mattermost.conf.sample backup_mattermost.conf

Configuration

See: backup_mattermost.conf.sample

Usage

Just execute the script:

./backup_mattermost.sh

Setup cron job

Run the backup everyday at 2:00 am everyday.

crontab -e

and add following line:

0 2 * * * /path/to/backup_mattermost/backup_mattermost.sh

Restore

Install gitlab omnibus and execute following commands:

tar -zxvf %s_%Y_%m_%d_mattermost.tar.gz -C /tmp/
mv /tmp/mattermost/data/* /var/opt/gitlab/mattermost/
su - mattermost -c "/opt/gitlab/embedded/bin/psql -U gitlab_mattermost -h /var/opt/gitlab/postgresql -p 5432 mattermost_production" < /tmp/mattermost/mattermost_production_backup.sql
rm -rf /tmp/mattermost