Upgrading Mattermost Server¶

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

Upgrading Mattermost Server¶

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

   cd /tmp
   

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

3. Confirm no other Mattermost zip folders exist in your /tmp directory. If another version’s zip file does exist, delete or rename the file.

   ls -- mattermost*.gz
   

   If anything except the new release is returned above, rename this file or delete it completely.

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 data and custom directories from within the current mattermost directory by running ls on your Mattermost install directory to identify what default folders exist. If your folders match the structure specified in the following note, you can jump to step 9 below.

A default Mattermost installation has the following files and directories:

$ ls /opt/mattermost
ENTERPRISE-EDITION-LICENSE.txt README.md  client  data   i18n  manifest.txt  prepackaged_plugins
NOTICE.txt                      bin        config  fonts  logs  plugins       templates

By default, your data directories will be preserved with the following commands:config, logs, plugins, client/plugins, and data (unless you have a different value configured for local storage). Custom directories are any directories that you’ve added to Mattermost and are not preserved by default. Generally, these are TLS keys or other custom information.

If using Bleve Search, the index directory path won’t be preserved with the commands below if the directory exists within the mattermost directory.

• You can either move the bleve index directory out from the mattermost directory before upgrading or, following an upgrade, you can copy the contents of the bleve index directory from the backup directory.

• You can then store that directory or re-index as preferred.

• The bleve indexes can be migrated without reindexing between Mattermost versions. See our Configuration Settings documentation for details on setting the bleve index directory.

8. Identify if any custom directories from the above step need to be preserved. For each custom directory within the Mattermost folder that you wish to preserve, ensure you add -o -path  mattermost/yourFolderHere to the following command. See the example below where the folder yourFolderHere is preserved by adding -o -path  mattermost/yourFolderHere.

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 -o -path  mattermost/yourFolderHere \) -prune \) | sort | xargs echo rm -r

9. You should first modify the last part to xargs echo rm -r to verify what will be executed. If you’ve added custom directories to the command in step b, then add those to the following command. For example:

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 | xargs echo rm -r

10. Clear the contents of this directory. If you’ve added custom directories to the command, be sure to add those to the following command. For example:

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

11. Change ownership of the new files before copying them. For example:

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

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

sudo cp -an /tmp/mattermost-upgrade/. mattermost/
sudo rm -r /tmp/mattermost-upgrade/
sudo rm -i /tmp/mattermost*.gz

13. 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. For example:

cd {install-path}/mattermost
sudo setcap cap_net_bind_service=+ep ./bin/mattermost

14. Start your Mattermost server.

sudo systemctl start mattermost

15. 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 continue to display as yellow, trigger a configuration propagation across the cluster by opening the System Console, changing a setting, and reverting it. This will enable the Save button for that page. Then, select Save. This will not change any configuration, but sends the existing configuration to all nodes in the cluster.

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

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.