Getting Started with Mattermost is Easy
Mattermost is a secure collaboration platform that is open, flexible, and deeply integrated with the tools you love. Use Mattermost to bring your people and your processes together. Get started with Mattermost quickly by installing Mattermost using Docker or Omnibus.
Install Mattermost using Docker
You’ll need Docker Engine and Docker Compose (release 1.28 or later).
Follow the steps in the Mattermost Docker Setup README to install Mattermost in a production environment using Docker.
When Docker is done fetching the image, open
http://localhost:8065/in your browser.Create your first Mattermost System Admin user, invite more users, and explore the Mattermost platform.
Looking to explore Mattermost product functionality on a local machine instead?
You can install Mattermost in Preview Mode using the Mattermost Docker Preview Image. This Docker image installs the free, unlicensed Mattermost Enterprise version of Mattermost using the following 1-line command:
docker run --name mattermost-preview -d --publish 8065:8065 mattermost/mattermost-preview
Important
Don’t use the Mattermost Docker Preview image in production environments. It uses a known password string, contains other non-production configuration settings, keeps no persistent data (all data lives inside the container), and doesn’t support upgrades.
Mattermost Omnibus is a Debian package that bundles the components of a Mattermost deployment into a single installation. The package leverages the apt package manager to install and update the platform components, and uses a custom CLI and ansible recipes to link the components together and configure them.
Mattermost Omnibus currently supports Ubuntu’s bionic and focal distributions. The package bundles the free, unlicensed Mattermost Enterprise version of Mattermost.
Install Mattermost using Mattermost Omnibus
Run the following command in a terminal window to configure the repositories needed for a PostgreSQL database, configure an NGINX web server to act as a proxy, configure certbot to issue and renew the SSL certificate, and configure the Mattermost Omnibus repository so that you can run the install command:
curl -o- https://deb.packages.mattermost.com/repo-setup.sh | sudo bash
Run the following command to install the Omnibus package:
sudo apt install mattermost-omnibus -y
To issue the certificate, the installer requests a domain name and an email address from you. These are used to generate the certificate and deliver any related communications. After all the packages are installed, Omnibus runs ansible scripts that configure all the platform components and starts the server.
Open a browser, navigate to your Mattermost domain by domain name (e.g.
mymattermostserver.com), or by the server’s IP address if you’re not using a domain name.Create your first Mattermost user, invite more users, and explore the Mattermost platform.
Note
We recommend installing and configuring Omnibus with SSL enabled; however, you can run the following command to disable SSL: sudo MMO_HTTPS=false apt install mattermost-omnibus.
Update Mattermost Omnibus
Mattermost Omnibus is integrated with the apt package manager. When a new Mattermost version is released, run: sudo apt update && sudo apt upgrade to download and update your Mattermost instance.
Getting help
If you encounter issues during your Mattermost installation, see the Troubleshooting Mattermost Issues product documentation or join the Mattermost User Community where you can connect with thousands of contributors, customers, and users to build, share, and learn together.
Apply your license key
When you start a free Mattermost Enterprise trial, you’ll receive a Mattermost license key by email. You can apply that license key using the System Console, using mmctl, or using the CLI.
Note
You must be a Mattermost System Admin to apply the license key to your Mattermost instance. If you’re not a System Admin, contact your organization’s Mattermost System Admin for assistance.
Go go System Console > About > Edition and License.
Upload your license key.
Once the key is uploaded and installed, the details of your license are displayed.
Use the mmctl license upload command to upload the license key, or to replace an existing license key with a new one.
mmctl license upload [license] [flags]
When complete, restart the Mattermost server. If you’re running in a High Availability environment, the license key must be updated to every node.
Note
The legacy CLI is available for Mattermost v5.39 and earlier.
Use the mattermost license upload command to to upload a new license key, or to replace an existing license key with a new one.
mattermost license upload {license}
When complete, restart the Mattermost server. If you’re running in a High Availability environment, the new license key must be updated to every node.
Once your license key is uploaded to your Mattermost server, it’s stored in your SQL database at mattermost.Licenses. Verify what keys are on your server by running: select * from mattermost.Licenses;.
