Administrator’s Guide¶
In-depth documentation on installation, deployment and administration of Mattermost system.
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 & Hardware Requirements
- Installing on Ubuntu 16.04 LTS
- Installing on Ubuntu 18.04 LTS
- Installing on Debian Stretch
- Installing on RHEL 6
- Installing on RHEL 7
- Installing on CentOS, Oracle Linux, and Scientific Linux
- Enterprise Install and Upgrade
- Deploy Mattermost on Bitnami
- Local Machine Setup using Docker
- Production Docker Deployment
- AWS Elastic Beanstalk Docker Setup
- Deploy Mattermost on Cloudron (Unofficial)
- Installing Mattermost Team Edition in GitLab Helm Chart
- Troubleshooting
- Desktop Application Install Guides
- Desktop MSI Installer and Group Policy Installation Guides (Alpha)
- SMTP Email Setup
- Configuring CloudFront to host Mattermost static assets
- Using an Outbound Proxy
- Chinese, Japanese & Korean Search
- Configuring Apache2 (Unofficial)
Deployment¶
Learn how to host Mattermost to meet your networking requirements.
Configure Mattermost¶
Learn how to configure settings to meet your unique requirements.
Mobile Apps¶
Learn how to configure and administer Mattermost apps.
- Mobile Applications Guide
- AppConfig for EMM Solutions with Mattermost Mobile Apps
- Hosted Push Notification Service
- Mobile Apps FAQ
- Can I connect to multiple Mattermost servers using the mobile apps?
- Is there a tablet version of the mobile apps?
- 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?
- What are my options for securing the mobile apps?
- What are my options for securing push notifications?
- How do I white label the app and customize build settings?
- How do I pre-configure the server URL for my users?
- How can I get Google SSO to work with the Mattermost Mobile Apps?
- 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
- Active Directory/LDAP Setup (E10/E20)
- Multi-Factor Authentication
- AD/LDAP Groups (Experimental) (E20)
- Overview
- Pre-installation notes
- Enable AD/LDAP group synchronization
- AD/LDAP group synchronization
- Linking AD/LDAP groups to Mattermost groups
- Configure the group
- Add default teams or channels for the group
- Teams and channels membership synchronization
- Remove configured teams and channels from a group
- View users belonging to the group
- Disabling and re-activating LDAP/AD users
- Managing groups
- Deleting groups
- Frequently Asked Questions
- SAML Single-Sign-On (E20)
- GitLab Single Sign-On
- Google Single Sign-On (E20)
- Office 365 Single Sign-On (E20)
- SSL Client Certificate Setup (Beta)
- Certificate-Based Authentication (Experimental)
- Advanced Permissions (E10/E20)
- Advanced Permissions: Backend Infrastructure
Administration¶
Learn how to maintain your Mattermost system.
Upgrade Mattermost¶
Learn how to keep Mattermost current with fixes and new features.
- Upgrading Mattermost Server
- Important Upgrade Notes
- Mattermost Changelog
- Release v5.11
- Release v5.10
- Release v5.9
- Release v5.8
- Release v5.7
- Release v5.6
- Release v5.5
- Release v5.4
- Release v5.3
- Release v5.2
- Release v5.1
- Release v5.0
- Release v4.10
- Release v4.9
- Release v4.8
- Release v4.7
- Release v4.6
- Release v4.5
- Release v4.4.5
- Release v4.3.4
- Release v4.2.2
- Release v4.1.2
- Release v4.0.5
- 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 (Bug Fix Release)
- Release v1.1.0
- Release v1.0.0
- Release v0.7.0 (Beta1)
- Release v0.6.0 (Alpha)
- Release v0.5.0 (Preview)
- Version Archive
- Extended Support Release
- Downgrading Mattermost Server
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.
Unofficial Enhancements¶
Documentation on early previews and unofficial functionality.
