Local Machine Setup using Docker

Available in Mattermost Free and Starter subscription plans. Available for Mattermost Self-Hosted deployments.

The following instructions use Docker to install Mattermost in Preview Mode using the Mattermost Docker Preview Image for exploring product functionality on a single local machine.

Important

This configuration shouldn’t be used in production, as 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. For a production installation with Docker, see the Mattermost Docker Setup README.

Note

If you have problems installing Mattermost, see the troubleshooting guide. For help with inviting users to your system, see inviting team members and additional getting started information for Channels.

One-line Docker install

If you have Docker set up, Mattermost installs in one line:

docker run --name mattermost-preview -d --publish 8065:8065 mattermost/mattermost-preview

When Docker is done fetching the image, open http://localhost:8065/ in your browser.

If you don’t have Docker installed, follow the step-by-step instructions below based on your operating system.

  1. Install Docker for Mac

  2. Start the Mattermost container:

docker run --name mattermost-preview -d --publish 8065:8065 mattermost/mattermost-preview
  1. When Docker is done fetching the image and starting the container, open http://localhost:8065/ in your browser.

Configuration Settings

The default single-container Docker instance for Mattermost is designed for product evaluation, and sets SendEmailNotifications=false so the product can function without enabling email. See the Configuration Settings documentation to customize your deployment.

Updating Mattermost Preview

To update your Mattermost preview image and container, you must first stop and delete your existing mattermost-preview container by running the following commands:

docker pull mattermost/mattermost-preview
docker stop mattermost-preview
docker rm mattermost-preview

Once the new image is pulled and the container is stopped and deleted you need to run the docker run command from above.

Note

On Linux add a sudo in front of the docker commands.

Accessing Your Container

To access a shell inside the container, run the following command:

docker exec -ti mattermost-preview /bin/bash