Upgrading Mattermost Server

In most cases you can upgrade Mattermost Server in a few minutes, but the upgrade can take longer depending on several factors, including the size and complexity of your installation, and the version that you’re upgrading from.


Support for Mattermost Server v5.25 Extended Support Release has come to the end of its life cycle as of April 15, 2021. Upgrading to Mattermost Server v5.31 Extended Support Release or later is required.

Upgrading to the Latest Version

If you are upgrading from version 3.0 or later, these instructions apply to you. If you are upgrading from a version prior to 3.0.0, you must first upgrade to version 3.0.3.

Before you begin

Read these instructions carefully from start to finish. Make sure that you understand each step before starting the upgrade. If you have questions or concerns, you can ask on the Mattermost forum at https://forum.mattermost.org/.


Review the Important Upgrade Notes to make sure you are aware of any actions you need to take before or after upgrading from your particular version.


If you’re upgrading from a version prior to v5.0 be sure to also modify your service file to work with the binary changes introduced with 5.0. Your execution directory should point to the Mattermost base directory (i.e. /opt/mattermost) and your binary should point to the mattermost binary (i.e. /opt/mattermost/bin/mattermost).

You should gather the following information before starting the upgrade:

Existing install directory - {install-path}

If you don’t know where Mattermost Server is installed, use the whereis mattermost command. The output should be similar to /opt/mattermost/bin/mattermost. The install directory is everything before the first occurrence of the string /mattermost. In this example, the {install-path} is /opt. If that command does not produce any results because your version is older, try whereis platform instead.

Location of your local storage directory

The local storage directory contains all the files that users have attached to their messages. If you don’t know its location, open the System Console and go to Environment > File Storage (or Files > Storage in versions prior to 5.12) and read the value in Local Storage Directory. Relative paths are relative to the mattermost directory. For example, if the local storage directory is ./data/ then the absolute path is {install-path}/mattermost/data.

To upgrade Mattermost Server


If you’re upgrading a High Availability cluster, review these upgrade notes instead.

  1. Review the Important Upgrade Notes to make sure you are aware of any actions you need to take before or after upgrading from your particular version.

  2. In a terminal window on the server that hosts Mattermost, change to your home directory. If any, delete files and directories that might still exist from a previous download.

    cd /tmp
  3. Download the latest version of Mattermost Server. In the following command, replace X.X.X with the version that you want to download:

    wget https://releases.mattermost.com/X.X.X/mattermost-X.X.X-linux-amd64.tar.gz
  4. Extract the Mattermost Server files.

    tar -xf mattermost*.gz --transform='s,^[^/]\+,\0-upgrade,'

    The transform option adds a suffix to the topmost extracted directory so it does not conflict with the usual install directory.

  5. Stop your Mattermost server.

    sudo systemctl stop mattermost
  6. Back up your data and application.

    1. Back up your database using your organization’s standard procedures for backing up MySQL or PostgreSQL.

    2. Back up your application by copying into an archive folder (e.g. mattermost-back-YYYY-MM-DD-HH-mm).

      cd {install-path}
      sudo cp -ra mattermost/ mattermost-back-$(date +'%F-%H-%M')/
  7. Remove all files except special directories from within the current mattermost directory.

    The special directories within mattermost are config, logs, plugins, client/plugins, and data (unless you have a different value configured for local storage, as per Before you begin). The following command clears the contents of mattermost, preserving only those directories and their contents. You should first modify the last part to xargs echo rm -r to verify what will be executed.

    If you store TLSCert/TLSKey files or other information within your /opt/mattermost folder, you should add -o -path mattermost/yourFolderHere to the below command or you will have to manually copy the TLSCert/TLSKey files from the backup into the new install.

    sudo find mattermost/ mattermost/client/ -mindepth 1 -maxdepth 1 \! \( -type d \( -path mattermost/client -o -path mattermost/client/plugins -o -path mattermost/config -o -path mattermost/logs -o -path mattermost/plugins -o -path mattermost/data \) -prune \) | sort | sudo xargs rm -r
  8. Change ownership of the new files before copying them.

    sudo chown -hR mattermost:mattermost /tmp/mattermost-upgrade/


    If you didn’t use mattermost as the owner and group of the install directory, run sudo chown -hR {owner}:{group} tmp/mattermost-upgrade/.

    If you’re uncertain what owner or group was defined, use the ls -l {install-path}/mattermost/bin/mattermost command to obtain them.

  9. Copy the new files to your install directory and remove the temporary files.

    Note that the n (no-clobber) flag and trailing . on source are very important.

    sudo cp -an /tmp/mattermost-upgrade/. mattermost/
    sudo rm -r /tmp/mattermost-upgrade/
  10. If you want to use port 80 to serve your server, or if you have TLS set up on your Mattermost server, you must activate the CAP_NET_BIND_SERVICE capability to allow the new Mattermost binary to bind to low ports.

    cd {install-path}/mattermost
    sudo setcap cap_net_bind_service=+ep ./bin/mattermost
  11. Start your Mattermost server.

    sudo systemctl start mattermost
  12. If you’re using a High Availability deployment you need to apply the steps above on all the nodes in your cluster. Once complete, the Config File MD5 columns in the High Availability section of the system console should be green. If they’re yellow, please ensure that all nodes have the same server version and the same configuration.

If they still show yellow, then you need to trigger a config propagation across the cluster:

  1. Open the System Console and change a setting, then revert it. This will enable the Save button for that page.

  2. Click Save.

This will not change any config, but sends the existing config to all nodes in the cluster.

After the server is upgraded, users might need to refresh their browsers to experience any new features.


We only support a one minor version difference between the server versions when performing a rolling upgrade (for example v5.27.1 + v5.27.2 or v5.26.4 + v5.27.1 is supported, whereas v5.25.5 + v5.27.0 is not supported). Running two different versions of Mattermost in your cluster should not be done outside of an upgrade scenario.

Upgrading Team Edition to Enterprise Edition

To upgrade from the Team Edition to the Enterprise Edition, follow the normal upgrade instructions provided above, making sure that you download the Enterprise Edition in Step 3.

Uploading a License Key

When Enterprise Edition is running, open System Console > About > Editions and License and upload your license key.