Get Started with Mattermost
Mattermost is an open source developer collaboration suite offering workplace messaging across web, desktop and mobile, project management, incident management and integration with toolchains and apps.
You can run Mattermost as an MIT-licensed Linux binary working with MySQL or PostgreSQL via cloud and self-hosted environments.
1 - Setup Mattermost
:cloud: Sign-up to Mattermost Cloud
Cloud is the fastest, easiest way to try out the Mattermost suite:
Mattermost Cloud - To use Mattermost as a SaaS service sign-up online.
:computer: Install Self-Hosted Mattermost
Want 100% control of your deployment and data? Here’s the two fastest ways to start with Mattermost self-hosted:
Mattermost Omnibus Quick Install - Fastest, easiest self-host path with an Ubuntu server.
Local Machine Docker Preview - Preview locally on Mac OS, Windows, Ubuntu or Fedora using Docker.
Once you’re deployed, customize your server settings to meet your internal IT security requirements:
Configure end-user security settings - Configure your Mattermost server to strike the right balance between convenience and secure-by-default settings ahead of end user onboarding.
:wave: 2 - Invite Users
Get users on your team excited to try out the Mattermost suite:
Customize an email announcement to share with your team: XXX
Share demo videos and tutorials to explain the system: XXX
:tada: 3 - Try out the suite
Share out links to use case guides to help educate and on-board users into the free version of the Mattermost suite:
Developer Productivity - XXX
Site Reliability Engineering - XXX
Security Operations - XXX
:raising_hand: 4 - Consider joining the Mattermost community
Have a question, or want to learn from peers?
Review and join our peer-to-peer troubleshooting forum
Check out our open Mattermost community server at XXX
Sign-up for our monthly newsletter
Self-hosting Mattermost in a secure environment?
Join our security bulletin mailing list for notification on security updates.
:construction_worker: Install Guide
Install Mattermost Server and Mattermost Desktop and Mobile Applications in environments meeting software and hardware requirements.
:floppy_disk: Server Installation
Most Popular Self-Hosted Installation Guides:
Mattermost Omnibus (Recommended for up to 1,000 users) - The fastest, easiest self-hosted deployment option if you have root on a clean Ubuntu server.
Local Machine Docker Preview (Recommended for evaluation only) - Preview Mattermost locally on Mac, Windows, Ubuntu or Fedora using a single-node Docker image. NOTE: Should only be used for evaluation, not production use.
Kubernetes Operator (Recommended for 500+ users) - Deploy to a self-hosted Kubernetes production environment or services like Amazon EKS, Azure Kubernetes Service, Google Kubernetes Engine, DigitalOcean Kubernetes.
:pager: Desktop and Mobile App Installation
Mattermost Desktop App Setup - Full install guide for Windows, macOS, and Linux–also see simple instructions.
iOS Setup - Install iOS app on Apple iPhone, iPad, and iPod devices.
Android Setup - Install Android app on Android phone and tablet devices.
Test Mobile Push Notifications - Verify that push notifications can flow properly from server to mobile devices.
:crystal_ball: Troubleshooting
Need help installing on server, desktop or mobile?
Check out our troubleshooting guide for common errors, fixes and where to find system logs.
Free peer-to-peer support is available in our troubleshooting forum and on our community server.
If you have a paid subscription to a Mattermost offering you can also open support tickets online.
:trolleybus: Upgrade Guide
:trolleybus: Deployment Guide
The deployment guide is for administrators who are ready to integrate Mattermost with their organization’s IT infrastructure.
Server deployment
Deployment overview - Learn the basics of the Mattermost user experience, communication protocols, network access, data storage, and deployment options.
Architectural Overview - Understand user authentication, notifications, data management services, network connectivity, high availability architectures from 5,000 to 50,000+ users.
Implementation Plan Template - Use this plan template to organize a production rollout to hundreds of users, from project goals, end user groups, technical environment, deployment steps, staffing, training and support.
Enterprise Roll Out Guide - Extend your implementation plan to a rollout to serveral thousand users with analytics, performance monitoring and performance tuning.
