Local Machine Setup using Docker

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

Note: This configuration should not be used in production, as it’s using a known password string and contains other non-production configuration settings, and it does not support upgrade.

If you’re looking for a production installation with Docker, please see the Mattermost Production Docker Deployment Guide.

Note

If you have any problems installing Mattermost, see the troubleshooting guide. For help with inviting users to your system, see inviting team members and other getting started information. To submit an improvement or correction, click Edit at the top of this page.

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

Otherwise, see step-by-step instructions:

macOS

  1. Install Docker for Mac
  2. Run: docker run --name mattermost-preview -d --publish 8065:8065 mattermost/mattermost-preview
  3. When docker is done fetching the image, open http://localhost:8065/ in your browser.

Windows 10

  1. Install Docker for Windows
  2. Run: docker run --name mattermost-preview -d --publish 8065:8065 mattermost/mattermost-preview
  3. When Docker is done fetching the image, open http://localhost:8065/ in your browser.

Ubuntu

  1. Follow the instructions at https://docs.docker.com/installation/ubuntulinux/ or use the summary below:

    sudo apt-get update
    sudo apt-get install wget
    wget -qO- https://get.docker.com/ | sh
    sudo usermod -aG docker <username>
    sudo service docker start
    newgrp docker
    
  2. Start Docker container:

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

Fedora

  1. Follow the instructions at https://docs.docker.com/engine/installation/linux/fedora/ or use the summary below:

    sudo dnf -y install dnf-plugins-core
    sudo dnf config-manager \
    --add-repo \
    https://download.docker.com/linux/fedora/docker-ce.repo
    sudo dnf install docker-ce docker-compose git # Accepting the new docker repository key
    sudo usermod -aG docker <username>
    sudo systemctl start docker
    
  2. Start Docker container:

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

Arch Linux

To install the preview on Arch Linux, see the installation guide on the Arch Linux wiki.

Configuration Settings

See Configuration Settings documentation to customize your deployment.

Updating Docker Preview

To delete your existing Docker preview and run a new version use:

docker stop mattermost-preview
docker rm -v mattermost-preview

Accessing Your Container

  • If you wish to gain access to a shell on the container use:

    docker exec -ti mattermost-preview /bin/bash