Self-Managed Administrator’s Guide¶
In-depth documentation on installation, deployment, and administration of Mattermost.
Getting Started¶
Use the following materials as a template to help you plan and document the implementation of Mattermost at your organization.
Installing Mattermost¶
Learn how to get Mattermost running on your environment.
- 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 7
- Installing on RHEL 8
- Installing on CentOS, Oracle Linux, and Scientific Linux
- Instructions On Setting Up a Socket-based Mattermost Database
- Enterprise Install and Upgrade
- Configuring Transport Encryption
- Deploy Mattermost on Bitnami
- Local Machine Setup using Docker
- AWS Elastic Beanstalk Docker Setup
- Installing Mattermost Team Edition in GitLab Helm Chart
- Desktop Application Install Guides
- Desktop Managed Resources
- Desktop MSI Installer and Group Policy Installation Guides (Beta)
Deployment¶
Learn how to host Mattermost to meet your networking requirements.
Configure Mattermost¶
Learn how to configure settings to meet your unique requirements.
- Configuration Settings
- Configuration in Database
- Environment Variables
- Override Mattermost License File
- Load Custom Configuration Defaults
- About
- Reporting
- User Management
- Environment
- Site Configuration
- Authentication
- Plugins (Beta)
- Integrations
- Compliance
- Experimental
- Settings configurable only in
config.json - Experimental Settings only in
config.json - Deprecated Configuration Settings
- Configuration in the Mattermost Database
- Configuration Settings Prior to v5.12
- 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)
Incident Collaboration¶
Mobile Apps¶
Learn how to configure and administer Mattermost 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
- Consider Mobile VPN Options
- AppConfig for EMM Solutions with Mattermost Mobile Apps
- Mobile Push Notifications
- Mobile Apps FAQ
- Can I connect to multiple Mattermost servers using the mobile apps?
- Is there a tablet version of the mobile apps?
- Can the permanent sidebar on tablet devices be disabled?
- How is data handled on mobile devices after a user account is deactivated?
- Do I need to compile the mobile apps to host my own push notification server?
- How do push notifications work?
- What post metadata is sent in mobile push notifications?
- How can I use ID-Only Push Notifications to protect notification content from being exposed to third-party services?
- What are my options for securing the mobile apps?
- What are my options for securing push notifications?
- Why do I sometimes see a delay in receiving a push notification?
- How do I deploy Mattermost with Enterprise Mobility Management (EMM) providers?
- How do I host the Mattermost push notification service?
- How do I receive mobile push notifications if my IT policy requires the use of a corporate proxy server?
- How do I white label the app and customize build settings?
- How do I preconfigure the server URL for my users?
- How can I get Google SSO to work with the Mattermost mobile app?
- How do I configure deep linking?
- How do I connect users across internal and external networks?
- Troubleshooting Mobile Applications
- I keep getting a message “Cannot connect to the server. Please check your server URL and internet connection.”
- Login with ADFS/Office365 is not working
- I see a “Connecting…” bar that does not go away
- I’m not receiving push notifications on my device
- All my outbound connections need to go through a proxy. How can I connect to the Mattermost Hosted Push Notification Service?
- Build gets stuck at
bundleReleaseJsAndAssets - No image previews available in the mobile app
- None of these solve my problem!
Onboard Users¶
Learn how to get your users into and comfortable using Mattermost.
- Bulk Loading Data
- Migration Guide
- Migrating from HipChat to Mattermost
- Migration Announcement Email
- Provisioning Workflows
- Additional System Admin Roles (E20)
- Active Directory/LDAP Setup
- Multi-factor Authentication
- AD/LDAP Groups (E20)
- Overview
- Pre-installation Notes
- Enabling AD/LDAP Group Synchronization
- Using AD/LDAP Group Synchronization
- Linking AD/LDAP Groups to Mattermost Groups
- Configuring the Group
- Adding Default Teams or Channels For The Group
- Synchronizing Teams and Channels
- Removing Configured Teams and Channels From a Group
- Viewing Users Belonging to The Group
- Disabling and Re-activating AD/LDAP Users
- Managing Groups
- Deleting Groups
- Using AD/LDAP Synchronized Groups to Manage Team or Private Channel Membership
- Frequently Asked Questions
- Using AD/LDAP Synchronized Groups to Manage Team or Private Channel Membership
- SAML Single Sign-On (E20)
- SAML Single-Sign-On (E20): Technical Documentation
- 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)
- SSL Client Certificate Setup (Beta)
- Certificate-Based Authentication (Experimental)
- Managing Team and Channel Members (E20)
- Advanced Permissions (E10/E20)
- Advanced Permissions: Backend Infrastructure
- Guest Accounts (Beta) (E10/E20)
- Enabling Guest Accounts
- Guest Authentication
- Inviting Guests to the Mattermost Server via Email
- Configuring AD/LDAP Authentication
- Configuring SAML 2.0 Authentication
- Guest Permission Settings
- Guest Identification
- Managing Guests
- Disabling Guest Accounts
- Reinstating Guest Accounts
- Frequently Asked Questions
Administration¶
Learn how to maintain your Mattermost system.
- Command Line Tools
- Using the CLI
- Using the CLI on GitLab Omnibus
- Using the CLI on Docker Install
- Using the CLI on Docker Preview
- mattermost
- mattermost channel
- mattermost command
- mattermost config
- mattermost db init
- mattermost export
- mattermost extract-documents-content
- mattermost group
- mattermost group channel
- mattermost group team
- mattermost help
- mattermost import
- mattermost integrity
- mattermost jobserver
- mattermost ldap
- mattermost license
- mattermost logs
- mattermost permissions
- mattermost plugin
- mattermost reset
- mattermost roles
- mattermost sampledata
- mattermost server
- mattermost team
- mattermost user
- mattermost version
- mattermost webhook
- Executing a command hangs and doesn’t complete
- mmctl Command Line Tool (Beta)
- Installing mmctl
- Building mmctl
- Local mode
- Running mmctl tests
- mmctl auth
- mmctl bot
- mmctl channel
- mmctl command
- mmctl completion
- mmctl config
- mmctl docs
- mmctl export
- mmctl group
- mmctl group channel
- mmctl group team
- mmctl import
- mmctl integrity
- mmctl ldap
- mmctl license
- mmctl logs
- mmctl permissions
- mmctl plugin
- mmctl plugin marketplace
- mmctl post
- mmctl roles
- mmctl system
- mmctl team
- mmctl team users
- mmctl token
- mmctl user
- mmctl version
- mmctl webhook
- mmctl websocket
- Scripts
- Statistics
- User Satisfaction Surveys
- In-Product Notices
- Health Check
- Announcement Banner (E10)
- Bulk Export Tool
- Generating a Support Packet (E10/E20)
Troubleshooting¶
Understand potential issues and how to address them.
Upgrade Mattermost¶
Learn how to keep Mattermost current with fixes and new features.
- Upgrading Mattermost Server
- Important Upgrade Notes
- Mattermost Changelog
- Release v5.36 - Feature Release
- Release v5.35 - Feature Release
- Release v5.34 - Feature Release
- Release v5.33 - Feature Release
- Release v5.32 - Feature Release
- Release v5.31 - ESR
- Release v5.30 - Feature Release
- Release v5.29 - Quality Release
- Release v5.28 - Feature Release
- Release v5.27 - Quality Release
- Release v5.26 - Feature Release
- Release v5.25 - ESR
- Release v5.24 - Feature Release
- Release v5.23 - Quality Release
- Release v5.22 - Feature Release
- Release v5.21 - Quality Release
- Release v5.20 - Feature Release
- Release v5.19 - ESR
- Release v5.18 - Feature Release
- Release v5.17 - Quality Release
- Release v5.16 - Feature Release
- Release v5.15 - Quality Release
- Release v5.14 - Feature Release
- Release v5.13 - Quality Release
- Release v5.12 - Feature Release
- Release v5.11 - Quality Release
- Release v5.10 - Feature Release
- Release v5.9 - ESR
- Release v5.8 - Feature Release
- Release v5.7 - Quality Release
- Release v5.6 - Feature Release
- Release v5.5 - Quality Release
- Release v5.4 - Feature Release
- Release v5.3 - Feature Release
- Release v5.2 - Feature Release
- Release v5.1 - Feature Release
- Release v5.0 - Feature Release
- Release v4.10 - ESR
- Release v4.9 - Feature Release
- Release v4.8 - Feature Release
- Release v4.7 - Feature Release
- Release v4.6 - Feature Release
- Release v4.5 - Feature Release
- Release v4.4.5 - Feature Release
- Release v4.3.4 - Feature Release
- Release v4.2.2 - Feature Release
- Release v4.1.2 - Feature Release
- Release v4.0.5 - Feature Release
- Release v3.10.3
- Release v3.9.2
- Release v3.8.3
- Release v3.7.5
- Release v3.6.7
- Release v3.5.1
- Release v3.4.0
- Release v3.3.0
- Release v3.2.0
- Release v3.1.0
- Release v3.0.3
- Release v2.2.0
- Release v2.1.0
- Release v2.0.0
- Release v1.4.0
- Release v1.3.0
- Release v1.2.1
- Release v1.2.0 (Redacted Release)
- Release v1.1.1 (Quality Release)
- Release v1.1.0
- Release v1.0.0
- Release v0.7.0 (Beta1)
- Release v0.6.0 (Alpha)
- Release v0.5.0 (Preview)
- Desktop Application Changelog
- Release v4.7
- Release v4.6
- Release v4.5
- Release v4.4
- Release v4.3
- Release v4.2.3
- Release v4.2.2
- Release v4.2.1
- Release v4.2.0
- Release v4.1.2
- Release v4.1.1
- Release v4.1.0
- Release v4.0.1
- Release 4.0.0
- Release 3.7.1
- Release 3.7.0
- Release 3.6.0
- Release v3.5.0
- Release v3.4.1
- Release v1.3.0
- Release v1.2.1 (Beta)
- Release v1.1.1 (Beta)
- Mattermost Mobile Apps Changelog
- 1.44.0 Release
- 1.43.0 Release
- 1.42.1 Release
- 1.42.0 Release
- 1.41.1 Release
- 1.41.0 Release
- 1.40.0 Release
- 1.39.0 Release
- 1.38.1 Release
- 1.38.0 Release
- 1.37.0 Release
- 1.36.0 Release
- 1.35.1 Release
- 1.35.0 Release
- 1.34.1 Release
- 1.34.0 Release
- 1.33.1 Release
- 1.33.0 Release
- 1.32.2 Release
- 1.32.1 Release
- 1.32.0 Release
- 1.31.2 Release
- 1.31.1 Release
- 1.31.0 Release
- 1.30.1 Release
- 1.30.0 Release
- 1.29.0 Release
- 1.28.0 Release
- 1.27.1 Release
- 1.27.0 Release
- 1.26.2 Release
- 1.26.1 Release
- 1.26.0 Release
- 1.25.1 Release
- 1.25.0 Release
- 1.24.0 Release
- 1.23.1 Release
- 1.23.0 Release
- 1.22.1 Release
- 1.22.0 Release
- 1.21.2 Release
- 1.21.1 Release
- 1.21.0 Release
- 1.20.2 Release
- 1.20.1 Release
- 1.20.0 Release
- 1.19.0 Release
- 1.18.1 Release
- 1.18.0 Release
- 1.17.0 Release
- 1.16.1 Release
- 1.16.0 Release
- 1.15.2 Release
- 1.15.1 Release
- 1.15.0 Release
- 1.14.0 Release
- 1.13.1 Release
- v1.13.0 Release
- v1.12.0 Release
- v1.11.0 Release
- v1.10.0 Release
- 1.9.3 Release
- 1.9.2 Release
- 1.9.1 Release
- v1.9.0 Release
- v1.8.0 Release
- v1.7.1 Release
- v1.7.0 Release
- v1.6.1 Release
- v1.6.0 Release
- v1.5.3 Release
- v1.5.2 Release
- v1.5.1 Release
- v1.5 Release
- v1.4.1 Release
- v1.4 Release
- v1.3 Release
- v1.2 Release
- v1.1 Release
- v1.0.1 Release
- v1.0 Release
- Beta Release
- Version 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
- Downgrading Mattermost Server
- Open Source Components
- Release Definitions
Mattermost Integrations¶
Learn how to extend Mattermost by integrating your workflows.
Mattermost Compliance¶
Learn how to adhere to your security and regulations.
Scaling Mattermost¶
Learn how to support growth within Mattermost.
Community-Managed Documentation¶
Documentation on early previews and unofficial functionality.
