Mattermost
5.37
About Mattermost
Product Overview
About the Mattermost Open Source Project
Mattermost Team Edition
Mattermost Enterprise Edition
Mattermost Enterprise Edition E10
Mattermost Enterprise Edition E20
Mattermost Cloud
Mattermost Cloud Professional
Mattermost Cloud Enterprise
Frequently Asked Questions About Mattermost Cloud (FAQs)
Security Overview
Security Features
Private Cloud Deployment with Secure Mobile Apps
Centralized Security and Administration
Transmission Security
Integrity and Audit Controls
Authentication Safeguards
Access Control Policy
Security Updates
Security Policies
HIPAA compliance*
FINRA compliance*
Integrations Overview
Pre-configured integrations
Open source, self-hosted integrations (private and public cloud)
Slack-compatible webhooks (private and public cloud)
Over 700 app integrations using Zapier (public cloud only)
Self-hosted bots interfacing to other systems (private and public cloud)
Custom integrations
Command line interface (private and public cloud)
Custom applications using APIs and drivers (private and public cloud)
Slack-compatible slash commands (private and public cloud)
Licensing and Subscription
Purchasing an Enterprise license
Applying the license key
Viewing license information
Adding more users to a purchased license
Renewing an Enterprise license
Frequently Asked Questions
Are my credit card details safe?
Why do I need to provide my name and physical address when purchasing a license?
What does Mattermost do with this information?
Who are the sanctioned people, companies, and entities?
What does “physical address” mean for software that will be used in many places?
How do I renew my license if I don’t have internet access?
I’m a Mattermost Cloud customer, how do I renew?
How is user defined for Enterprise Edition subscriptions?
Do I need to pay for deactivated users?
Can I use the same license key on multiple self-managed Enterprise Edition servers?
Is my license available immediately?
How will I know when to renew my license?
How long does it take to renew a license?
What happens to my license if I don’t renew in time?
What happens when my license expires?
Which features are affected when my Enterprise license expires?
Why can’t I dismiss the expiry notification banner?
Do you have a program for official non-profits, open source projects, and charities?
Do you have discounted licenses for academic institutions?
Is there a maximum number of users per subscription?
Can other members of my organization use this account to manage our subscription?
What happens if my department buys Mattermost Enterprise Edition and then central IT buys a high volume license that also covers my department?
Where can I find the license agreement for Mattermost Enterprise Edition?
How do I delete my Customer Portal account?
What happens to my license when I delete my account?
Corporate Directory Integration
Basic authentication
Security features for authentication
Active Directory/LDAP authentication
Authentication options outside of a private network
Future authentication methods
Certifications and Compliance Overview*
GDPR Compliance
Continual Commitment to the Principles of GDPR
Security Infrastructure
Contractual Obligations
Privacy Measures
Product Features
Accessibility Compliance
U.S. Export Compliance Overview
Summary Table
Overview
General Information
Export Classification and Licensing
Disclaimer
Frequently Asked Questions
To be compliant with GDPR, do I need to remove message contents of email notifications?
What information is shared when I click
Contact us
on a Mattermost Admin Advisor notification?
Are the server access logs containing IP addresses a GDPR compliance issue?
Do you have Fed or Department of Defense (DOD) Certification?
How do you ensure personal data stays within European Union?
Frequently Asked Questions (FAQ)
General Questions
Why was Mattermost created?
Why does the open source repository contain code specific to the commercial version of Mattermost?
Does Mattermost support 508 Compliance?
What’s the largest Mattermost deployment you have?
How do I deploy the open source Mattermost Team Edition under an MIT license?
Community Questions
How can I contribute to Mattermost?
Can contributors add themselves to the Mattermost company page on LinkedIn?
Notifications
What determines if a desktop notification should be triggered?
What determines if an email notification should be triggered?
What determines if a mobile push notification should be triggered?
Are mobile push notifications free?
Video, Audio, and Screen Sharing
What support is available for video and audio calling and screen sharing?
Enterprise Edition
What is Mattermost Enterprise Edition?
How can I be assured that my data will not be locked in to commercial software?
How does Mattermost scale from teams to enterprises?
What does it take to manage a Mattermost deployment?
How do you manage multiple messaging solutions in an enterprise?
What are the options to purchase a subscription to Mattermost Enterprise Edition?
What happens when the Enterprise Edition subscription expires?
What are Mattermost’s policies around licensing, terms of service, and privacy?
How does the licensing key work?
Do you have a program for official non-profits and charities?
Do you have discounted licenses for academic institutions?
Mattermost Source Available License
What is the Mattermost Source Available License?
How can I identify code licensed as source available?
Why are you changing the licensing model?
How are repositories changing?
To which repositories does this apply?
Will the repositories be public?
Can I still contribute?
Do I need to re-sign the Mattermost CLA?
Can I compile your plugins by myself?
Will you distribute open source plugin binaries without any licensing restrictions?
Can I continue to use the existing open source repositories without restriction?
Do I need to use the Mattermost Source Available License for plugins I create?
Can I publish my own plugin and rely on enterprise specific functionality?
Can’t someone compile out any license restrictions?
If I make my own plugin using your source available code, can I remove the license restriction?
Will you pursue legal action if this license is violated?
Is this a legal document?
What is the full text of the Mattermost Source Available License?
Integration
Can I use Mattermost to add messaging functionality to my proprietary SaaS service?
Use Cases
Does Mattermost support external guests?
Can I use Mattermost for customer service?
Does Mattermost have an official website-based plugin to offer anonymous chat to visitors?
Product Questions
What features are available on different Mattermost clients?
What feature quality levels does Mattermost have?
High Trust Questions
What are the trust benefits of Mattermost compared to third-party SaaS systems that let customers manage their own encryption keys?
What are the fundamental security challenges with Massive, Multi-Tenant Applications (MMTA)?
Design Decisions
Why does Mattermost disclose whether or not an account exists when a user enters an incorrect password?
Business Questions
How can I create an open source derivative work of Mattermost?
Will Mattermost complete questionnaires requiring confidential data without an NDA?
Why does Mattermost have a discount for certain kinds of non-profits but not for others?
Can I create a derivative work of the Mattermost /mattermost-server repository that is not open source?
Will Mattermost, Inc. offer the ability to resell Mattermost software without a reseller agreement?
Does Mattermost answer questions about open source licenses authored by other organizations?
Illicit Use
How do I report illicit use of Mattermost software?
Install, Deploy, Upgrade, and Scale
Getting Started
Architecture Overview
Basics
High Availability and Scalability
Reference Architectures
Light Install Guide
Installation
Add Users
Create a Notifications Hub
Enterprise Roll Out Checklist
Checklist Overview
Checklist Details
Administrator Tasks
Getting Started Tasks
Important Administration Notes
Common Tasks
User Experience Optimizations
Implementation Plan
1 Introduction
2 System Overview
3 Management Overview
4 Implementation Support
Welcome Email to End Users
Email Template
Install Mattermost
Mattermost Server
Software and Hardware Requirements
Installing on Ubuntu 20.04 LTS
Installing on Ubuntu 18.04 LTS
Installing Mattermost Omnibus
Installing Mattermost on Kubernetes
Installing the Operators via Helm
Installing on Debian Buster
Installing on RHEL 8
Installing on RHEL 7
Installing on CentOS, Oracle Linux, and Scientific Linux
Instructions On Setting Up a Socket-based Mattermost Database
MySQL Installation Troubleshooting
Enterprise Install and Upgrade
Configuring Transport Encryption
Configuring Proxy to Mattermost Transport Encryption
Configuring Database Transport Encryption
Configuring Cluster Transport Encryption (E20)
Deploy Mattermost on Bitnami
Local Machine Setup using Docker
AWS Elastic Beanstalk Docker Setup
Installing Mattermost Team Edition in GitLab Helm Chart
Troubleshooting Mattermost Issues
Mattermost Changelog
Mattermost Cloud Changelog
Desktop App
Install the Mattermost Desktop App
Desktop Application Install Guides
Desktop Managed Resources
Desktop MSI Installer and Group Policy Installation Guides (Beta)
Desktop Application Changelog
Mobile App
iOS Setup
Android Setup
Mattermost Mobile Apps Changelog
Deploy Mattermost
Mattermost Server
Deployment Overview
Image Proxy
Encryption Options
Backup and Disaster Recovery
Bleve Search (Experimental)
Desktop App
Desktop App Deployment Guide
Mobile Apps
Deploy Mattermost Mobile Apps
Using Mattermost’s Pre-Built Mobile Apps
Building and Distributing Your Own Custom Mattermost Mobile Apps
Deploying Mobile Apps Using an EMM Provider
AppConfig for EMM Solutions with Mattermost Mobile Apps
Consider Mobile VPN Options
Mobile Push Notifications
Mobile Apps FAQ
Troubleshooting Mobile Applications
Client-side Data Storage FAQ
Upgrade Mattermost
Upgrading Mattermost Server
Upgrading to the Latest Version
Upgrading Team Edition to Enterprise Edition
Uploading a License Key
Important Upgrade Notes
Version Archive
Mattermost Enterprise Edition
Mattermost Team Edition Server Archive
Extended Support Release
What is an Extended Support Release?
What is the life cycle of an Extended Support Release?
What is included in an Extended Support Release dot release?
Who should use an Extended Support Release?
How do I install the Extended Support Release?
What are the current supported Extended Support Release versions?
How do I restore a previous Extended Support Release?
Why is an Extended Support Release supported for 9 months and not longer?
Can customers pay for extended support?
How do we notify customers about new and deprecated Extended Support Releases?
Release Lifecycle
What is a Release Lifecycle?
Downgrading Mattermost Server
Downgrade from 5.0 to 4.10
Open Source Components
Desktop
Mobile
Redux
Server
Webapp
Release Definitions
Feature Release
Quality Release
Extended Support Release (ESR)
Scale Mattermost
Scaling for Enterprise
Single Machine Deployment
Multi Machine Deployment
Cluster-based Deployment
Sample Scaling Guide
Hosting Recommendation for 100,000+ users
High Availability Cluster (E20)
Requirements for Continuous Operation
Deployment Guide
Configuration and Compatibility
Upgrade Guide
Frequently Asked Questions (FAQ)
Troubleshooting
Elasticsearch (E20)
Deployment Guide
Limitations
Frequently Asked Questions (FAQ)
Performance Monitoring (E20)
Deployment Guide
Installing Prometheus
Installing Grafana
Getting Started
Statistics
Frequently Asked Questions
Mattermost Performance Alerting Guide
CPU Utilization Rate
Memory Usage
Number of Goroutines
Number of API Errors per Second
Mean API Request Time
Plugin Hooks
Other Alerts
Set Up, Manage, Onboard, and Comply
Set Up Mattermost
Self-Managed Deployments
Configuration Settings
Configuration in the Mattermost Database
Customizing Mattermost
Email Templates
Custom Branding Tools
SMTP Email Setup
Configuring CloudFront to host Mattermost static assets
Using an Outbound Proxy
Chinese, Japanese, and Korean Search
Configuring Apache2 (Unofficial)
Cloud Workspaces
Site Configuration
Onboard Users
All Mattermost Instances
Advanced Permissions (E10/E20)
Advanced Permissions: Backend Infrastructure
Additional System Admin Roles (E20)
Shared Channels (Experimental) (E20)
Active Directory/LDAP Setup
Multi-factor Authentication
OpenID Connect Single Sign-On (E20)
GitLab Single Sign-On
Google Single Sign-On (E20)
Office 365 Single Sign-On (E20)
Converting OAuth 2.0 Service Providers to OpenID Connect (E20)
Self-Managed Deployments
Provisioning Workflows
Bulk Loading Data
Guest Accounts (Beta) (E10/E20)
AD/LDAP Groups (E20)
Using AD/LDAP Synchronized Groups to Manage Team or Private Channel Membership
SAML Single Sign-On (E20)
SAML Single-Sign-On (E20): Technical Documentation
Configure SAML with OneLogin
Configure SAML with Okta
SSL Client Certificate Setup (Beta)
Certificate-Based Authentication (Experimental)
Migration Guide
Migrating from HipChat to Mattermost
Migration Announcement Email
Cloud Workspaces
Guest Accounts (Beta)
SAML Single Sign-On
SAML Single-Sign-On: Technical Documentation
AD/LDAP Groups
Manage Mattermost
All Mattermost Instances
Generating a Support Packet (E10/E20)
mmctl Command Line Tool (Beta)
Self-Managed Deployments
Managing Team and Channel Members (E20)
Command Line Tools
Scripts
Statistics
In-Product Notices
User Satisfaction Surveys
Health Check
Announcement Banner (E10)
Bulk Export Tool
Cloud Workspaces
Mattermost Cloud Billing
Statistics
User Satisfaction Surveys
Managing Team and Channel Members
Mattermost Compliance
Self-Managed Deployments
Electronic Discovery
Compliance Reporting and Oversight (E20)
Compliance Export Beta (E20)
Audit Log v2 (Experimental) (E20)
Data Retention Policy (E20)
Custom Terms of Service (Beta) (E20)
Cloud Workspaces
Compliance Reporting and Oversight
Compliance Export Beta
Data Retention Policy
Custom Terms of Service (Beta)
Messaging
Access Your Workspace
Welcome to Mattermost!
Access Your Workspace
Sign In Methods
Signing In
Email Address or Username Sign In
Single Sign-On
Switch Between Teams
About Teams, Channels, and Messages
Teams
Channels
Messages
Log Out of Mattermost Messaging
Work with Messages
Messaging Basics
Sending and Receiving Messages
Send a Message
Reply to Messages
Edit or Delete Messages
Link to Messages
Mark Messages as Unread
Organizing Conversations using Collapsed Reply Threads (Beta)
Enable Collapsed Reply Threads
Known Issues
Start or Reply to Threads
Follow Threads and Messages
View All Threads
Tutorial Video
Formatting Text
Text Style
Links
Headings
Lists
Code Block
In-line Code
In-line Images
Lines
Block quotes
Tables
Math Formulas
Using Emojis
Adding Emojis to messages
Typing an Emoji
Creating Custom Emojis
Mentioning Teammates
@Mentions
Words That Trigger Mentions
Recent Mentions
Confirmation Dialog Warnings
Highlighting
Sharing Files
Attach Files to Messages
Preview File Attachments
Attachment Limits and Sizes
Executing Commands
Built-in Commands
Custom Commands
Saving Messages
Saving a Message
Viewing Saved Messages
Unsaving Messages
Pinning Messages
Pin a Message
Unpin a Message
Searching
Searching for Message Contents
Searching for File Contents
Search Modifiers
Hashtags
Notes About All Searches
Technical Notes
Manage Teams, Channels, and Members
Creating Teams
Methods to Create a Team
Team Name and URL Selection
Best Practices for Using a Single Team vs. Multiple Teams
Team Settings
General
Import
Managing Channels
Creating a channel
Creating a Direct or Group Message
Joining a channel
Adding members to a channel
Removing members from a channel
Naming a channel
Leaving a channel
Archiving a channel
Unarchiving a channel
Converting Public channels to Private channels (and vice versa)
Favoriting a channel
Muting and unmuting a channel
Switching channels
Navigating recently viewed channels
Organizing Mattermost
The importance of channel names
How to navigate and organize channels
Channel naming examples
Channel Settings
Channel Notification Preferences
Channel Header
Channel Purpose
Channel Name
Managing Members
Inviting Team Members
User Roles
Removing a User from a Team or Leaving a Team
Customize Mattermost Messaging
Setting Your Status and Availability
Setting a Custom Status
Clearing a Custom Status
Setting Your Availability
Configuring Notifications
Desktop Notifications
Email Notifications
Mobile Push Notifications
Browser Tab Notifications
Muting a Channel
Ignoring Mentions
Organizing Your Sidebar
Channel types
Customizing your sidebar
Creating custom categories
Organizing channels in categories
Muting and unmuting categories
Sorting channels in categories
Group unread channels separately
Managing Direct Messages
Account Settings
General
Security
Notifications
Display
Sidebar
Advanced
Theme Colors
Import Theme from Slack
Custom Themes
Standard Themes
Desktop App Options
Dark Theme
Manage Servers
Adding Servers
Editing Servers
Removing Servers
Navigate Mattermost Messaging
Keyboard Accessibility
Region Navigation
Message Navigation
Channel Sidebar Navigation
Keyboard Shortcuts
Navigation
Files
Messages
Formatting
Browser Built-in
Extend Mattermost Messaging
Integrations
Incoming Webhooks
Outgoing Webhooks
Slash Commands
Incident Collaboration
Before You Begin
Overview
Getting Started
API Documentation
Planning
Planning a Playbook
Creating checklists
Configuring templates
Defining actions
Setting permissions
Editing a playbook
Launching
Running Playbooks
Slash commands
Joining a playbook run
Working with tasks
Changing owners
Providing a status update
Ending a playbook run
Restarting a playbook run
Learning
Refining and Improving
Creating and publishing retrospectives
Focalboard
Mattermost for Developers
Support Knowledge Base
Mattermost
Docs
»
API
Edit
API
¶
See the
API documentation
.
Options
Contribute
Report a Problem
Edit on GitHub
×
We've updated this site to make content easier to find. Use the feedback option at the bottom of any page to share your feedback with us.
Developers
Product
Pricing
Blog
Download
Trial
