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 earlier than 3.0.0 but later than 2.0.0, you must first upgrade to version 3.0.3.

If you are upgrading from a version earlier than 2.0.0, you must first upgrade to version 2.0.

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/ or in the Mattermost Peer-to-peer Help channel at https://pre-release.mattermost.com/core/channels/peer-to-peer-help.

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 platform command. The output should be similar to /opt/mattermost/bin/platform. The install directory is everything before the last occurrence of the string /mattermost. In this example, the {install-path} is /opt.

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 Files > Storage 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.

Owner and group of the install directory - {owner} and {group}

Use the ls -l {install-path}/mattermost/bin/platform command to get the owner and group.

To upgrade Mattermost Server:

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 Server, change to your home directory.

cd ~

3. Delete any files and directories that might still exist from a previous download.

rm mattermost*.gz
rm -r mattermost

4. Download the latest version of Mattermost Server.

Enterprise Edition

wget https://releases.mattermost.com/4.0.1/mattermost-4.0.1-linux-amd64.tar.gz

Team Edition

wget https://releases.mattermost.com/4.0.1/mattermost-team-4.0.1-linux-amd64.tar.gz

5. Extract the Mattermost Server files.

tar -xzf mattermost*.gz

6. Make a copy of your configuration file. The existing file is overwritten during the upgrade, so it’s important that you don’t forget this step.

   cp {install-path}/mattermost/config/config.json config.json

7. Stop Mattermost Server.

On Ubuntu 14.04 and RHEL 6.6: sudo service mattermost stop

On Ubuntu 16.04 and RHEL 7.1: sudo systemctl stop mattermost

8. Back up your data.

1. Back up your database using your organization’s standard procedures for backing up MySQL or PostgreSQL.
2. If you’re using local file storage, back up the location where files are stored.

9. Copy the files that you extracted earlier to the install directory.

sudo cp -r mattermost {install-path}

10. Restore your configuration file.

sudo cp config.json {install-path}/mattermost/config

11. Change ownership of the new files.

sudo chown -R {owner}:{group} {install-path}/mattermost

12. Start Mattermost server.

On Ubuntu 14.04 and RHEL 6.6: sudo service mattermost start

On Ubuntu 16.04 and RHEL 7.1: sudo systemctl start mattermost

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

1. cd {install-path}
2. sudo setcap cap_net_bind_service=+ep ./bin/platform

14. Upgrade your config.json schema:

1. Open the System Console and a change a setting, then revert it. This should enable the Save button for that page.
2. Click Save.
3. Refresh the page.

Your current settings are preserved, and new settings are added with default values.

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 above, but make sure that you download the Enterprise Edition in Step 3.

After the Enterprise Edition is running, open the System Console and go to OTHER > Edition and License > License Key and upload your license key file.

Version Archive¶