Configuration Settings Prior to v5.12

Note

This page is a reference to the organization of the configuration settings prior to the reorganization of the System Console in the June 16th, 2019 release. To view the configuration settings based on the organization of the System Console in versions v5.12 and later, please see this documentation.

Mattermost configuration settings are maintained in the configuration file config.json, located in the mattermost/config directory. You can modify the configuration file using the System Console, or by using a text editor to modify it directly.

The default location of config.json is in the mattermost/config directory. Mattermost must have write permissions to config.json, otherwise changes made in the System Console will have no effect.

Configuration in Database

Storing configuration in the database is supported in v5.10 and later. Please see more information on how to set this up here.

Environment Variables

Starting in Mattermost version 3.8, you can use environment variables to manage the configuration. Environment variables override settings in config.json. If a change to a setting in config.json requires a restart for it to take effect, then changes to the corresponding environment variable also require a server restart.

The name of the environment variable for any setting can be derived from the name of that setting in config.json. For example, to derive the name of the Site URL setting:

  1. Find the setting in config.json. In this case, ServiceSettings.SiteURL.
  2. Add MM_ to the beginning and convert all characters to uppercase and replace the . with _. For example, MM_SERVICESETTINGS_SITEURL.
  3. The setting becomes export MM_SERVICESETTINGS_SITEURL="http://example.com".

Finally, if a setting is configured through an environment variable, modifying it in the System Console is disabled.

For any setting that is not set in config.json or in environment variables, the Mattermost server uses the default value as documented here.

Note

If a setting is set through an environment variable and any other changes are made in the System Console, the value stored of the environment variable will be written back to the config.json as that setting’s value.

General

General settings for server configuration, language defaults, user and team management, privacy, compliance reporting and logs.

Configuration

Site URL

The URL that users will use to access Mattermost. The port number is required if it’s not a standard port such as 80 or 443.

This field is required in Mattermost v3.8 and later.

In Mattermost v5.1 and later, the URL may contain a subpath, like in "https://example.com/company/mattermost".

If Site URL is not set, the following features will operate incorrectly:

  • email notifications will contain broken links, and email batching will not work
  • authentication via OAuth 2.0, including GitLab, Google and Office 365, will fail
  • plugins may not work as expected

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "SiteURL": "" with string input.

Listen Address

The address and port to which to bind and listen. Specifying “:8065” will bind to all network interfaces. Specifying 127.0.0.1:8065 will only bind to the network interface having that IP address.

If you choose a port of a lower level (called “system ports” or “well-known ports”, in the range of 0-1023), you must have permissions to bind to that port.

On Linux you can use: sudo setcap cap_net_bind_service=+ep ./bin/mattermost to allow Mattermost to bind to well-known ports.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "ListenAddress": ":8065" with string input.

Forward port 80 to 443

True: Forwards all insecure traffic from port 80 to secure port 443.

False: When using a proxy such as NGINX in front of Mattermost this setting is unnecessary and should be set to false.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "Forward80To443": false with options true and false.

Connection Security

None: Mattermost will connect over an unsecure connection.

TLS: Encrypts the communication between Mattermost clients and your server. See documentation for more details.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "ConnectionSecurity": "" with options "" and "TLS".

TLS Certificate File

The path to the certificate file to use for TLS connection security.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "TLSCertFile": "" with string input.

TLS Key File

The path to the TLS key file to use for TLS connection security.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "TLSKeyFile": "" with string input.

Use Let’s Encrypt

True: Enable the automatic retrieval of certificates from Let’s Encrypt. The certificate will be retrieved when a client attempts to connect from a new domain. This will work with multiple domains. See Configuring TLS on Mattermost Server for more details on setting up Let’s Encrypt.

False: Manual certificate specification based on the TLS Certificate File and TLS Key File specified above.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "UseLetsEncrypt": false with options true and false.

Note

If Let’s Encrypt is enabled, forward port 80 through a firewall, with Forward80To443 config.json setting set to true to complete the Let’s Encrypt certification.

Let’s Encrypt Certificate Cache File

The path to the file where certificates and other data about the Let’s Encrypt service will be stored.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "LetsEncryptCertificateCacheFile": "./config/letsencrypt.cache" with string input.

Read Timeout

Maximum time allowed from when the connection is accepted to when the request body is fully read.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "ReadTimeout": 300 with numerical input.

Write Timeout

If using HTTP (insecure), this is the maximum time allowed from the end of reading the request headers until the response is written. If using HTTPS, it is the total time from when the connection is accepted until the response is written.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "WriteTimeout": 300 with numerical input.

Allow use of API v3 endpoints

Removed in June 16, 2018 release

Set to false to disable all version 3 endpoints of the REST API. Integrations that rely on API v3 will fail and can then be identified for migration to API v4. API v3 is deprecated and will be removed in the near future. See https://api.mattermost.com for details.

This feature’s config.json setting is "EnableAPIv3": false with options true and false.

Webserver Mode

gzip compression applies to the HTML, CSS, Javascript, and other static content files that make up the Mattermost web client. It is recommended to enable gzip to improve performance unless your environment has specific restrictions, such as a web proxy that distributes gzip files poorly.

gzip: The Mattermost server will serve static files compressed with gzip to improve performance.

Uncompressed: The Mattermost server will serve static files uncompressed.

Disabled: The Mattermost server will not serve static files.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "WebserverMode": "gzip" with options "gzip", "uncompressed" and "disabled".

Reload Configuration from Disk

Available in Enterprise Edition E20

This button resets the configuration settings by reloading the settings from the disk. The server will still need to be restarted if a setting requiring server restart was changed.

The workflow for failover without downing the server is to change the database line in the config.json file, click Reload Configuration from Disk then click Recycle Database Connections in the Advanced > Database section.

Purge All Caches

This button purges all the in-memory caches for sessions, accounts and channels. Deployments using High Availability will attempt to purge all the servers in the cluster. Purging the caches may adversely impact performance.

Localization

Default Server Language

Default language for system messages and logs.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "DefaultServerLocale": "en" with options "de", "en", "es", "fr", "it", "ja", "ko", "nl", "pl", "pt-br", "ro", "ru", "tr", "zh_CN", and "zh_TW".

Default Client Language

Default language for newly created users and pages where the user hasn’t logged in.

This feature’s config.json setting is "DefaultClientLocale": "en" with options "de", "en", "es", "fr", "it", "ja", "ko", "nl", "pl", "pt-br", "ro", "ru", "tr", "zh_CN", and "zh_TW".

Available Languages

Sets which languages are available for users in Account Settings > Display > Languages. Leave the field blank to add new languages automatically by default, or add new languages using the dropdown menu manually as they become available. If you’re manually adding new languages, the Default Client Language must be added before saving the setting.

Note

Servers which upgraded to v3.1 need to manually set this field blank to have new languages added by default.

This feature’s config.json setting is "AvailableLocales": "" with options "", "de", "en", "es", "fr", "it", "ja", "ko", "nl", "pl", "pt-br", "ro", "ru", "tr", "zh_CN", and "zh_TW".

Users and Teams

Enable Account Creation

True: Ability to create new accounts is enabled via inviting new members or sharing the team invite link.

False: Ability to create accounts is disabled. The Create Account button displays an error when trying to signup via an email invite or team invite link.

This feature’s config.json setting is "EnableUserCreation": true with options true and false.

Enable Account Deactivation

True: Ability for users to deactivate their own account from Account Settings > Advanced. If a user deactivates their own account, they will get an email notification confirming they were deactivated.

False: Ability for users to deactivate their own account is disabled.

This feature’s config.json setting is "EnableUserDeactivation": false with options true and false.

Enable Team Creation

This permission has been migrated to the database and changing the ``config.json`` value no longer takes effect after upgrading to v4.9, released on April 16th, 2018. This permission can be modified using the System Console user interface.

True: Ability to create a new team is enabled for all users.

False: Only System Admins can create teams from the team selection page. The Create A New Team button is hidden in the main menu UI.

This feature’s config.json setting is "EnableTeamCreation": true with options true and false.

Max Users Per Team

Maximum number of users per team, excluding inactive users.

The Max Users Per Team refers to the size of the “team site” which is workspace a “team of people” inhabits. A team of people is considered a small organization where people work closely together towards a specific shared goal and share the same etiquette. In the physical world, a team of people could typically be seated around a single table to have a meal and discuss their project.

The default maximum of 50 people, is at the extreme high end of a single team of people. At this point organizations are more often “multiple teams of people” and investments in explicitly defining etiquette, such as channel organization or turning on policy features in Enterprise Edition, are often used to scale the high levels of productivity found in a team of people using Mattermost to multiple teams of people.

In terms of technical performance, with appropriate hardware, Mattermost can easily scale to hundreds and even thousands of users, and provided the administrator believes the appropriate etiquette is in place, they should feel free to increase the default value.

This feature’s config.json setting is "MaxUsersPerTeam": 50 with numerical input.

Max Channels Per Team

Maximum number of channels per team, including both active and deleted channels.

This feature’s config.json setting is "MaxChannelsPerTeam": 2000 with numerical input.

Max Notifications Per Channel

Maximum total number of users in a channel before @all, @here, and @channel no longer send notifications to maximize performance.

If you want to increase this value, the recommendation is to increase it a little at a time and monitor system health with performance monitoring metrics. We also recommend only increasing this value if large channels have restricted permissions for who can post to the channel (for instance, a read-only Town Square channel).

This feature’s config.json setting is "MaxNotificationsPerChannel": 1000 with numerical input.

Show @channel and @all confirmation dialog

True: Users will be prompted to confirm when posting @channel and @all in channels with over five members.

False: No confirmation is required.

This feature’s config.json setting is "EnableConfirmNotificationsToChannel": true with options true and false.

Restrict account creation to specified email domains

Teams and user accounts can only be created by a verified email from this list of comma-separated domains (e.g. “corp.mattermost.com, mattermost.org”).

This setting only affects email login.

This feature’s config.json setting is "RestrictCreationToDomains": "" with string input.

Restrict Team Names

Removed in November 16th, 2016 release

True: Newly-created team names cannot contain the following restricted words: www, web, admin, support, notify, test, demo, mail, team, channel, internal, localhost, dockerhost, stag, post, cluster, api, oauth.

False: Newly-created team names are not restricted.

This feature’s config.json setting is "RestrictTeamNames": true with options true and false.

Enable users to open Direct Message channels with

Any user on the Mattermost server: The Direct Messages More menu has the option to open a Direct Message channel with any user on the server.

Any member of the team: The Direct Messages More menu only has the option to open a Direct Message channel with users on the current team, and CTRL/CMD+K channel switcher only lists users on the current team. If a user belongs to multiple teams, direct messages will still be received regardless of what team they are currently on.

This setting only affects the UI, not permissions on the server. For instance, a Direct Message channel can be created with anyone on the server regardless of this setting.

This feature’s config.json setting is "RestrictDirectMessage": "any" with options "any" and "team" for the above settings, respectively.

Allow Team Administrators to edit others posts

This permission is stored in the database and can be modified using the System Console user interface.

True: Team Administrators and System Administrators can edit other users’ posts.

False: Only System Administrators can edit other users’ posts.

This setting is only available for Team Edition servers. Enterprise Edition servers can use Advanced Permissions to configure this permission.

Enable Team Directory

Removed in May 16th, 2016 release

True: Teams that are configured to appear in the team directory will appear on the system main page. Teams can configure this setting from Team Settings > Include this team in the Team Directory.

False: Team directory on the system main page is disabled.

This feature’s config.json setting is "EnableTeamListing": false with options true and false.

Teammate Name Display

Specifies how names are displayed in the user interface.

Show username: Displays the user’s username.

Show nickname if one exists: Displays the user’s nickname. If the user does not have a nickname, their full name is displayed. If the user does not have a full name, their username is displayed.

Show first and last name: Displays the user’s full name. If the user does not have a full name, their username is displayed. Recommended when using SAML or LDAP if first name and last name attributes are configured.

This feature’s config.json setting is "TeammateNameDisplay": "username" with options "username", "nickname_full_name", and "full_name" for the above settings, respectively.

Policy

Removed in June 16, 2018 release

Permission policy settings are available in Enterprise Edition E10 and E20. In v5.0 and later, these settings are found in the Advanced Permissions page instead of configuration settings.

Enable sending team invites from

Removed in June 16, 2018 release

Set policy on who can invite others to a team using the Send Email Invite, Get Team Invite Link, and Add Members to Team options on the main menu. If Get Team Invite Link is used to share a link, you can expire the invite code from Team Settings > Invite Code after the desired users have joined the team. Options include:

All team members: Allows any team member to invite others using an email invitation, team invite link or by adding members to the team directly.

Team and System Admins: Hides the email invitation, team invite link, and the add members to team buttons in the Main Menu from users who are not Team Admins or System Admins.

System Admins: Hides the email invitation, team invite link, and add members to team buttons in the Main Menu from users who are not System Admins.

This feature’s config.json setting is "RestrictTeamInvite": "all" with options "all", "team_admin", and "system_admin" for the above settings, respectively.

Enable public channel creation for

Removed in June 16, 2018 release

Restrict the permission level required to create public channels.

All team members: Allow all team members to create public channels.

Team Admins and System Admins: Restrict creating public channels to Team Admins and System Admins.

System Admins: Restrict creating public channels to System Admins.

This feature’s config.json setting is "RestrictPublicChannelCreation": "all" with options "all", "team_admin", and "system_admin" for the above settings, respectively.

Enable public channel renaming for

Removed in June 16, 2018 release

Restrict the permission level required to rename and set the header or purpose for public channels.

All channel members: Allow all channel members to rename public channels.

Channel Admins, Team Admins, and System Admins: Restrict renaming public channels to Channel Admins, Team Admins, and System Admins who are members of the channel.

Team Admins and System Admins: Restrict renaming public channels to Team Admins and System Admins who are members of the channel.

System Admins: Restrict renaming public channels to System Admins who are members of the channel.

This feature’s config.json setting is "RestrictPublicChannelManagement": "all" with options "all", "channel_admin", "team_admin", and "system_admin" for the above settings, respectively.

Enable public channel deletion for

Removed in June 16, 2018 release

Restrict the permission level required to delete public channels. Deleted channels can be recovered from the database using a command line tool.

All channel members: Allow all channel members to delete public channels.

Channel Admins, Team Admins, and System Admins: Restrict deleting public channels to Channel Admins, Team Admins, and System Admins who are members of the channel.

Team Admins and System Admins: Restrict deleting public channels to Team Admins and System Admins who are members of the channel.

System Admins: Restrict deleting public channels to System Admins who are members of the channel.

This feature’s config.json setting is "RestrictPublicChannelDeletion": "all" with options "all", "channel_admin", "team_admin", and "system_admin" for the above settings, respectively.

Enable private channel creation for

Removed in June 16, 2018 release

Restrict the permission level required to create private channels.

All team members: Allow all team members to create private channels.

Team Admins and System Admins: Restrict creating private channels to Team Admins and System Admins.

System Admins: Restrict creating private channels to System Admins.

This feature’s config.json setting is "RestrictPrivateChannelCreation": "all" with options "all", "team_admin", and "system_admin" for the above settings, respectively.

Enable private channel renaming for

Removed in June 16, 2018 release

Restrict the permission level required to rename and set the header or purpose for private channels.

All channel members: Allow all channel members to rename private channels.

Channel Admins, Team Admins, and System Admins: Restrict renaming private channels to Channel Admins, Team Admins, and System Admins who are members of the private channel.

Team Admins and System Admins: Restrict renaming private channels to Team Admins and System Admins who are members of the private channel.

System Admins: Restrict renaming private channels to System Admins who are members of the private channel.

This feature’s config.json setting is "RestrictPrivateChannelManagement": "all" with options "all", "channel_admin", "team_admin", and "system_admin" for the above settings, respectively.

Enable managing of private channel members for

Removed in June 16, 2018 release

Set policy on who can add and remove members from private channels.

All team members: Allow all team members to add and remove members.

Team Admins, Channel Admins, and System Admins: Allow only Team Admins, Channel Admins, and System Admins to add and remove members.

Team Admins, and System Admins: Allow only Team Admins and System Admins to add and remove members.

System Admins: Allow only System Admins to add and remove members.

This feature’s config.json setting is "RestrictPrivateChannelManageMembers": "all" with options "all", "channel_admin", "team_admin", and "system_admin" for the above settings, respectively.

Enable private channel deletion for

Removed in June 16, 2018 release

Restrict the permission level required to delete private channels. Deleted channels can be recovered from the database using a command line tool.

All channel members: Allow all channel members to delete private channels.

Channel Admins, Team Admins, and System Admins: Restrict deleting private channels to Channel Admins, Team Admins, and System Admins who are members of the private channel.

Team Admins and System Admins: Restrict deleting private channels to Team Admins and System Admins who are members of the private channel.

System Admins: Restrict deleting private channels to System Admins who are members of the private channel.

This feature’s config.json setting is "RestrictPrivateChannelDeletion": "all" with options "all", "channel_admin", "team_admin", and "system_admin" for the above settings, respectively.

Allow which users to delete messages

Removed in June 16, 2018 release

Restrict the permission level required to delete messages. Team Admins, Channel Admins, and System Admins can delete messages only in channels where they are members. Messages can be deleted any time.

Message authors can delete their own messages, and Administrators can delete any message: Allow authors to delete their own messages, and allow Team Admins, Channel Admins, and System Admins to delete any message.

Team Admins and System Admins: Allow only Team Admins and System Admins to delete messages.

System Admins: Allow only System Admins to delete messages.

This feature’s config.json setting is "RestrictPostDelete": "all" with options "all", "team_admin", and "system_admin" for the above settings, respectively.

Allow users to edit their messages

Removed in June 16, 2018 release

Set the time limit that users have to edit their messages after posting.

Any time: Allow users to edit their messages at any time after posting.

Never: Do not allow users to edit their messages.

{n} seconds after posting: Users can edit their messages within the specified time limit after posting. The time limit is applied using the config.json setting "PostEditTimeLimit" described below.

This feature’s config.json setting is "AllowEditPost": "always" with options "always", "never", and "time_limit" for the above settings, respectively.

Post edit time limit

When post editing is permitted, setting this to -1 allows editing anytime, and setting this to a positive integer restricts editing time in seconds. If post editing is disabled, this setting does not apply.

This feature’s config.json setting is "PostEditTimeLimit": -1 with numerical input.

Privacy

Settings to configure the name and email privacy of users on your system.

Show Email Address

True: Show email address of all users.

False: Hide email address of users from other users in the user interface, including Team Admins. This is designed for managing teams where users choose to keep their contact information private. System Admins will still be able to see email addresses in the UI.

This feature’s config.json setting is "ShowEmailAddress": true with options true and false.

Show Full Name

True: Show full name of all users.

False: Hide full name of users from other users including Team Admins. This is designed for managing teams where users choose to keep their contact information private. System Admins will still be able to see full names in the UI.

This feature’s config.json setting is "ShowFullName": true with options true and false.

Compliance

Available in Enterprise Edition E20

Settings used to enable and configure Mattermost compliance reports.

Enable Compliance Reporting

True: Compliance reporting is enabled in Mattermost.

False: Compliance reporting is disabled.

This feature’s config.json setting is "Enable": false with options true and false.

Compliance Report Directory

Sets the directory where compliance reports are written.

This feature’s config.json setting is "Directory": "./data/" with string input.

Enable Daily Report

True: Mattermost generates a daily compliance report.

False: Daily reports are not generated.

This feature’s config.json setting is "EnableDaily": false with options true and false.

Logging

Output logs to console

Note

Logs are rotated once the log file reaches a size of 100 MB or more.

True: Output log messages to the console based on ConsoleLevel option. The server writes messages to the standard output stream (stdout).

False: Output log messages are not written to the console.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "EnableConsole": true with options true and false.

Console Log Level

Level of detail at which log events are written to the console when EnableConsole = true.

DEBUG: Prints high detail for developers debugging issues.

ERROR: Outputs only error messages.

INFO: Outputs error messages and information around startup and initialization.

This feature’s config.json setting is "ConsoleLevel": "DEBUG" with options "DEBUG", "ERROR", and "INFO".

Output logs to file

Typically set to true in production. When true, logged events are written to the mattermost.log file in the directory specified by the FileLocation setting. The logs are archived to a file in the same directory, and given a name with a datestamp and serial number. For example, mattermost.2017-03-31.001.

True: Log files are written to files specified in FileLocation.

False: Log files are not written.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "EnableFile": true with options true and false.

Output console logs as JSON

Typically set to true in production. When true, logged events are written in a machine readable JSON format. Otherwise they are printed as plain text.

True: Logged events are written in a machine readable JSON format.

False: Logged events are written in plain text.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "ConsoleJson": true with options true and false.

File Log Level

Level of detail at which log events are written to log files when EnableFile = true.

ERROR: Outputs only error messages.

INFO: Outputs error messages and information around startup and initialization.

DEBUG: Prints high detail for developers debugging issues.

This feature’s config.json setting is "FileLevel": "INFO" with options "DEBUG", "ERROR", and "INFO".

File Log Directory

The location of the log files. If blank, they are stored in the ./logs directory. The path that you set must exist and Mattermost must have write permissions in it.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "FileLocation": "" with string input.

Output file logs as JSON

Typically set to true in production. When true, logged events are written in a machine readable JSON format. Otherwise they are printed as plain text.

True: Logged events are written in a machine readable JSON format.

False: Logged events are written in plain text.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "FileJson": true with options true and false.

Enable Webhook Debugging

True: Contents of incoming webhooks are printed to log files for debugging.

False: Contents of incoming webhooks are not printed to log files.

This feature’s config.json setting is "EnableWebhookDebugging": true with options true and false.

Enable Diagnostics and Error Reporting

True: To improve the quality and performance of future Mattermost updates, this option sends error reporting and diagnostic information to Mattermost, Inc. All diagnostics and error reporting is encrypted in transit and does not include personally identifiable information or message contents. To learn more about this feature, see Telemetry.

False: Diagnostics and error reporting are disabled.

This feature’s config.json setting is "EnableDiagnostics": true with options true and false.

Advanced Permissions

Available in Enterprise Edition E10 and higher

Advanced permissions offers Admins a way to restrict actions in Mattermost to authorized users only. See permissions documentation for more details.

Authentication

Authentication settings to enable account creation and sign in with email, GitLab, Google or Office 365 OAuth, AD/LDAP, or SAML.

Email Authentication

Enable account creation with email

True: Allow team creation and account signup using email and password.

False: Email signup is disabled. This limits signup to single sign-on services like OAuth or AD/LDAP.

This feature’s config.json setting is "EnableSignUpWithEmail": true with options true and false.

Enable sign-in with email

True: Mattermost allows account creation using email and password.

False: Sign in with email is disabled and does not appear on the login screen. Use this value when you want to limit sign up to a single sign-on service like AD/LDAP, SAML, or GitLab.

This feature’s config.json setting is "EnableSignInWithEmail": true with options true and false.

Enable sign-in with username

True: Mattermost allows users with email login to sign in using their username and password. This setting does not affect AD/LDAP login.

False: Sign in with username is disabled and does not appear on the login screen.

This feature’s config.json setting is EnableSignInWithUsername": true with options true and false.

OAuth 2.0

Settings to configure OAuth login for account creation and login.

Select OAuth 2.0 service provider

Choose whether OAuth can be used for account creation and login. Options include:

  • Do not allow sign-in via an OAuth 2.0 provider
  • GitLab (see GitLab Settings for more detail)
  • Google Apps (available in Enterprise Edition E20, see Google Settings for more detail)
  • Office 365 (Beta) (available in Enterprise Edition E20, see Office 365 Settings for more detail)

This feature’s setting does not appear in config.json.

GitLab

Enable authentication with GitLab

True: Allow team creation and account signup using GitLab OAuth. To configure, input the Secret and Id credentials.

False: GitLab OAuth cannot be used for team creation or account signup.

This feature’s config.json setting is "Enable": false with options true and false.

Note: For Enterprise, GitLab settigs can be found under OAuth 2.0.

Application ID

Obtain this value by logging into your GitLab account. Go to Profile Settings > Applications > New Application, enter a Name, then enter Redirect URLs https://<your-mattermost-url>/login/gitlab/complete (example: https://example.com:8065/login/gitlab/complete and https://<your-mattermost-url>/signup/gitlab/complete.

This feature’s config.json setting is "Id": "" with string input.

Application Secret Key

Obtain this value by logging into your GitLab account. Go to Profile Settings > Applications > New Application, enter a Name, then enter Redirect URLs https://<your-mattermost-url>/login/gitlab/complete (example: https://example.com:8065/login/gitlab/complete and https://<your-mattermost-url>/signup/gitlab/complete.

This feature’s config.json setting is "Secret": "" with string input.

User API Endpoint

Enter https://<your-gitlab-url>/api/v3/user (example: https://example.com:3000/api/v3/user). Use HTTP or HTTPS depending on how your server is configured.

This feature’s config.json setting is "UserApiEndpoint": "" with string input.

Auth Endpoint

Enter https://<your-gitlab-url>/oauth/authorize (example: https://example.com:3000/oauth/authorize). Use HTTP or HTTPS depending on how your server is configured.

This feature’s config.json setting is "AuthEndpoint": "" with string input.

Token Endpoint

Enter https://<your-gitlab-url>/oauth/token (example: https://example.com:3000/oauth/token). Use HTTP or HTTPS depending on how your server is configured.

This feature’s config.json setting is "TokenEndpoint": "" with string input.

Google

Available in Enterprise Edition E20

Enable authentication with Google by selecting Google Apps from OAuth 2.0 > Select OAuth 2.0 service provider

True: Allow team creation and account signup using Google OAuth. To configure, input the Client ID and Client Secret credentials. See the documentation for more detail.

False: Google OAuth cannot be used for team creation or account signup.

This feature’s config.json setting is "Enable": false with options true and false.

Client ID

Obtain this value by registering Mattermost as an application in your Google account.

This feature’s config.json setting is "Id": "" with string input.

Client Secret

Obtain this value by registering Mattermost as an application in your Google account.

This feature’s config.json setting is "Secret": "" with string input.

User API Endpoint

It is recommended to use "https://www.googleapis.com/plus/v1/people/me" as the User API Endpoint. Otherwise, enter a custom endpoint in config.json with HTTP or HTTPS depending on how your server is configured.

This feature’s config.json setting is "UserApiEndpoint": "https://www.googleapis.com/plus/v1/people/me" with string input.

Auth Endpoint

It is recommended to use "https://accounts.google.com/o/oauth2/v2/auth" as the Auth Endpoint. Otherwise, enter a custom endpoint in config.json with HTTP or HTTPS depending on how your server is configured.

This feature’s config.json setting is "AuthEndpoint": "https://accounts.google.com/o/oauth2/v2/auth" with string input.

Token Endpoint

It is recommended to use "https://www.googleapis.com/oauth2/v4/token" as the Token Endpoint. Otherwise, enter a custom endpoint in config.json with HTTP or HTTPS depending on how your server is configured.

This feature’s config.json setting is "TokenEndpoint": "https://www.googleapis.com/oauth2/v4/token" with string input.

Office 365

Available in Enterprise Edition E20

Note

In line with Microsoft ADFS guidance we recommend configuring intranet forms-based authentication for devices that do not support WIA.

Enable authentication with Office 365 by selecting Office 365 (Beta) from OAuth 2.0 > Select OAuth 2.0 service provider.

True: Allow team creation and account signup using Office 365 OAuth. To configure, input the Application ID and Application Secret Password credentials. See the documentation for more detail.

False: Office 365 OAuth cannot be used for team creation or account signup.

This feature’s config.json setting is "Enable": false with options true and false.

Application ID

Obtain this value by registering Mattermost as an application in your Microsoft or Office account.

This feature’s config.json setting is "Id": "" with string input.

Application Secret Password

Obtain this value by registering Mattermost as an application in your Microsoft or Office account.

This feature’s config.json setting is "Secret": "" with string input.

User API Endpoint

It is recommended to use "https://graph.microsoft.com/v1.0/me" as the User API Endpoint. Otherwise, enter a custom endpoint in config.json with HTTP or HTTPS depending on how your server is configured.

This feature’s config.json setting is "UserApiEndpoint": "https://graph.microsoft.com/v1.0/me" with string input.

Auth Endpoint

It is recommended to use "https://accounts.google.com/o/oauth2/v2/auth" as the Auth Endpoint. Otherwise, enter a custom endpoint in config.json with HTTP or HTTPS depending on how your server is configured.

This feature’s config.json setting is "AuthEndpoint": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize" with string input.

Token Endpoint

It is recommended to use "https://login.microsoftonline.com/common/oauth2/v2.0/token" as the Token Endpoint. Otherwise, enter a custom endpoint in config.json with HTTP or HTTPS depending on how your server is configured.

This feature’s config.json setting is "TokenEndpoint": "https://login.microsoftonline.com/common/oauth2/v2.0/token" with string input.

AD/LDAP

Available in Enterprise Edition E10 and higher

Enable sign-in with AD/LDAP

True: Mattermost allows login using AD/LDAP or Active Directory.

False: Login with AD/LDAP is disabled.

This feature’s config.json setting is "Enable": false with options true and false.

Enable Synchronization with AD/LDAP

True: Mattermost periodically synchronizes users from AD/LDAP.

False: AD/LDAP synchronization is disabled.

This feature’s config.json setting is "EnableSync": false with options true and false.

AD/LDAP Server

The domain or IP address of the AD/LDAP server.

This feature’s config.json setting is "LdapServer": "" with string input.

AD/LDAP Port

The port Mattermost will use to connect to the AD/LDAP server. Defaults to 389.

This feature’s config.json setting is "LdapPort": 389 with numerical input.

Connection Security

The type of connection security Mattermost uses to connect to AD/LDAP.

None: No encryption, Mattermost will not attempt to establish an encrypted connection to the AD/LDAP server.

TLS: Encrypts the communication between Mattermost and your server using TLS.

STARTTLS: Takes an existing insecure connection and attempts to upgrade it to a secure connection using TLS.

If the “No encryption” option is selected it is highly recommended that the AD/LDAP connection is secured outside of Mattermost, for example, by adding a stunnel proxy.

This feature’s config.json setting is "ConnectionSecurity": "" with options "", "TLS", and "STARTTLS".

Skip Certificate Verification

(Optional) The attribute in the AD/LDAP server that will be used to populate the nickname of users in Mattermost.

True: Skips the certificate verification step for TLS or STARTTLS connections. Not recommended for production environments where TLS is required. For testing only.

False: Mattermost does not skip certificate verification.

This feature’s config.json setting is "SkipCertificateVerification": false with options true and false.

Base DN

The Base Distinguished Name of the location where Mattermost should start its search for users in the AD/LDAP tree.

This feature’s config.json setting is "BaseDN": "" with string input.

Bind Username

The username used to perform the AD/LDAP search. This should be an account created specifically for use with Mattermost. Its permissions should be limited to read-only access to the portion of the AD/LDAP tree specified in the Base DN field. When using Active Directory, Bind Username should specify domain in "DOMAIN/username" format. This field is required, and anonymous bind is not currently supported.

This feature’s config.json setting is "BindUsername": "" with string input.

Bind Password

Password of the user given in Bind Username. Anonymous bind is not currently supported.

This feature’s config.json setting is "BindPassword": "" with string input.

User Filter

(Optional) Enter an AD/LDAP Filter to use when searching for user objects (accepts general syntax). Only the users selected by the query will be able to access Mattermost.

Sample filters for Active Directory:

  • To filter out disabled users: (&(objectCategory=Person)(!(UserAccountControl:1.2.840.113556.1.4.803:=2))).
  • To filter out by group membership, determine the distinguishedName of your group, then use the group membership general syntax format as your filter.
    • For example, if the security group distinguishedName is CN=group1,OU=groups,DC=example,DC=com, then the user filter to use is: (memberOf=CN=group1,OU=groups,DC=example,DC=com). Note that the user must explicitly belong to this group for the filter to apply.

This filter uses the permissions of the Bind Username account to execute the search. Administrators should make sure to use a specially created account for Bind Username with read-only access to the portion of the AD/LDAP tree specified in the Base DN field.

This feature’s config.json setting is "UserFilter": "" with string input.

Group Filter

(Optional) Enter an AD/LDAP Filter to use when searching for group objects (accepts general syntax). Only the groups selected by the query will be able accessible to Mattermost.

This filter is defaulted to (|(objectClass=group)(objectClass=groupOfNames)(objectClass=groupOfUniqueNames)) when blank.

Note

This filter is used only when AD/LDAP Group Sync is enabled. See AD/LDAP Group Sync documentation for more information on enabling and configuring AD/LDAP Group Sync (Available in Enterprise Edition E20).

This feature’s config.json setting is "GroupFilter": "" with string input.

Group Display Name Attribute

(Required) Enter an AD/LDAP Group Display name attribute used to populate Mattermost Group names.

Note

This attribute is used only when AD/LDAP Group Sync is enabled. See AD/LDAP Group Sync documentation for more information on enabling and configuring AD/LDAP Group Sync (Available in Enterprise Edition E20).

This feature’s config.json setting is "GroupDisplayNameAttribute": "" with string input.

Group Id Attribute

(Required) Enter an AD/LDAP Group ID attribute to use as a unique identifier for Groups. This should be an AD/LDAP value that does not change.

Note

This attribute is used only when AD/LDAP Group Sync is enabled. See AD/LDAP Group Sync documentation for more information on enabling and configuring AD/LDAP Group Sync (Available in Enterprise Edition E20).

This feature’s config.json setting is "GroupIdAttribute": "" with string input.

First Name Attribute

(Optional) The attribute in the AD/LDAP server used to populate the first name of users in Mattermost. When set, users cannot edit their first name, since it is synchronized with the LDAP server. When left blank, users can set their first name in Account Settings.

This feature’s config.json setting is "FirstNameAttribute": "" with string input.

Last Name Attribute

(Optional) The attribute in the AD/LDAP server used to populate the last name of users in Mattermost. When set, users cannot edit their last name, since it is synchronized with the LDAP server. When left blank, users can set their last name in Account Settings.

This feature’s config.json setting is "LastNameAttribute": "" with string input.

Nickname Attribute

(Optional) The attribute in the AD/LDAP server used to populate the nickname of users in Mattermost. When set, users cannot edit their nickname, since it is synchronized with the LDAP server. When left blank, users can set their nickname in Account Settings.

This feature’s config.json setting is "NicknameAttribute": "" with string input.

Position Attribute

(Optional) The attribute in the AD/LDAP server used to populate the position field in Mattermost. When set, users cannot edit their position, since it is synchronized with the LDAP server. When left blank, users can set their position in Account Settings.

This feature’s config.json setting is "PositionAttribute": "" with string input.

Email Attribute

The attribute in the AD/LDAP server used to populate the email address field in Mattermost.

Email notifications will be sent to this email address, and this email address may be viewable by other Mattermost users depending on privacy settings choosen by the System Admin.

This feature’s config.json setting is "EmailAttribute": "" with string input.

Username Attribute

The attribute in the AD/LDAP server used to populate the username field in Mattermost. This may be the same as the Login ID Attribute.

This attribute will be used within the Mattermost user interface to identify and mention users. For example, if a Username Attribute is set to john.smith a user typing @john will see @john.smith in their auto-complete options and posting a message with @john.smith will send a notification to that user that they’ve been mentioned.

The Username Attribute may be set to the same value used to sign-in to the system, called a Login ID Attribute, or it can be mapped to a different value.

This feature’s config.json setting is "UsernameAttribute": "" with string input.

ID Attribute

The attribute in the AD/LDAP server used as a unique identifier in Mattermost. It should be an AD/LDAP attribute with a value that does not change.

If a user’s ID Attribute changes, it will create a new Mattermost account unassociated with their old one.

If you need to change this field after users have already logged in, use the mattermost ldap idmigrate CLI tool.

This feature’s config.json setting is "IdAttribute": "" with string input.

Login ID Attribute

The attribute in the AD/LDAP server used to log in to Mattermost. Normally this attribute is the same as the “Username Attribute” field above.

If your team typically uses domainusername to log in to other services with AD/LDAP, you may enter domainusername in this field to maintain consistency between sites.

This feature’s config.json setting is "LoginIdAttribute": "" with string input.

Login Field Name

The placeholder text that appears in the login field on the login page. Typically this would be whatever name is used to refer to AD/LDAP credentials in your company, so it is recognizable to your users. Defaults to AD/LDAP Username.

This feature’s config.json setting is "LoginFieldName": "" with string input.

Synchronization Interval (minutes)

Set how often Mattermost accounts synchronize attributes with AD/LDAP, in minutes. When synchronizing, Mattermost queries AD/LDAP for relevant account information and updates Mattermost accounts based on changes to attributes (first name, last name, and nickname). When accounts are disabled in AD/LDAP users are made inactive in Mattermost, and their active sessions are revoked once Mattermost synchronizes attributes. To synchronize immediately after disabling an account, use the AD/LDAP Synchronize Now button.

This feature’s config.json setting is "SyncIntervalMinutes": 60 with numerical input.

Maximum Page Size

The maximum number of users the Mattermost server will request from the AD/LDAP server at one time. Use this setting if your AD/LDAP server limits the number of users that can be requested at once. 0 is unlimited.

This feature’s config.json setting is "MaxPageSize": 0 with numerical input.

Query Timeout (seconds)

The timeout value for queries to the AD/LDAP server. Increase this value if you are getting timeout errors caused by a slow AD/LDAP server.

This feature’s config.json setting is "QueryTimeout": 60 with numerical input.

AD/LDAP Test

This button can be used to test the connection to the AD/LDAP server. If the test is successful, it shows a confirmation message and if there is a problem with the configuration settings it will show an error message.

AD/LDAP Synchronize Now

This button causes AD/LDAP synchronization to occur as soon as it is pressed. Use it whenever you have made a change in the AD/LDAP server you want to take effect immediately. After using the button, the next AD/LDAP synchronization will occur after the time specified by the Synchronization Interval.

You can monitor the status of the synchronization job in the table below this button.

Note

If synchronization Status displays as Pending and does not complete, make sure that the Enable Synchronization with AD/LDAP setting is set to true.

../_images/ldap-sync-table.png

SAML

Available in Enterprise Edition E20

Note

In line with Microsoft ADFS guidance we recommend configuring intranet forms-based authentication for devices that do not support WIA.

Enable Login With SAML

True: Mattermost allows login using SAML. Please see documentation to learn more about configuring SAML for Mattermost.

False: Login with SAML is disabled.

This feature’s config.json setting is "Enable": false with options true and false.

Enable Synchronizing SAML Accounts With AD/LDAP

True: Mattermost periodically synchronizes SAML user attributes, including user deactivation and removal, with AD/LDAP. Enable and configure synchronization settings at Authentication > AD/LDAP. See documentation to learn more.

False: Synchronization of SAML accounts with AD/LDAP is disabled.

This feature’s config.json setting is "EnableSyncWithLdap": false with options true and false.

Override SAML Bind Data with AD/LDAP Information

True: Mattermost overrides the SAML ID attribute with the AD/LDAP ID attribute if configured or overrides the SAML Email attribute with the AD/LDAP Email attribute if SAML ID attribute is not present. See documentation to learn more.

False: Mattermost uses the email attribute to bind users to SAML.

Note

Moving from true to false will prevent the override from happening. To prevent the disabling of user accounts, SAML IDs must match the LDAP IDs when this feature is enabled. This setting should be set to false unless LDAP sync is enabled.

This feature’s config.json setting is "EnableSyncWithLdapIncludeAuth": false with options true and false.

SAML SSO URL

The URL where Mattermost sends a SAML request to start login sequence.

This feature’s config.json setting is "IdpURL": "" with string input.

Identity Provider Issuer URL

The issuer URL for the Identity Provider you use for SAML requests.

This feature’s config.json setting is "IdpDescriptorUrl": "" with string input.

Identity Provider Public Certificate

The public authentication certificate issued by your Identity Provider.

This feature’s config.json setting is "IdpCertificateFile": "" with string input.

Verify Signature

True: Mattermost verifies that the signature sent from the SAML Response matches the Service Provider Login URL.

False: Not recommended for production environments. For testing only.

This feature’s config.json setting is "Verify": true with options true and false.

Service Provider Login URL

Enter https://<your-mattermost-url>/login/sso/saml (example: https://example.com/login/sso/saml). Make sure you use HTTP or HTTPS in your URL depending on your server configuration. This field is also known as the Assertion Consumer Service URL.

This feature’s config.json setting is "AssertionConsumerServiceURL": "" with string input.

Enable Encryption

True: Mattermost will decrypt SAML Assertions encrypted with your Service Provider Public Certificate.

False: Not recommended for production environments. For testing only.

This feature’s config.json setting is "Encrypt": true with options true and false.

Service Provider Private Key

The private key used to decrypt SAML Assertions from the Identity Provider.

This feature’s config.json setting is "PrivateKeyFile": "" with string input.

Service Provider Public Certificate

The certificate file used to generate the signature on a SAML request to the Identity Provider for a service provider initiated SAML login, when Mattermost is the Service Provider.

This feature’s config.json setting is "PublicCertificateFile": "" with string input.

Email Attribute

The attribute in the SAML Assertion that will be used to populate the email addresses of users in Mattermost.

Email notifications will be sent to this email address, and this email address may be viewable by other Mattermost users depending on privacy settings choosen by the System Admin.

This feature’s config.json setting is "EmailAttribute": "" with string input.

Username Attribute

The attribute in the SAML Assertion that will be used to populate the username field in Mattermost user interface. This attribute will be used within the Mattermost user interface to identify and mention users. For example, if a Username Attribute is set to john.smith a user typing @john will see @john.smith in their auto-complete options and posting a message with @john.smith will send a notification to that user that they’ve been mentioned.

This feature’s config.json setting is "UsernameAttribute": "" with string input.

Id Attribute

(Optional) The attribute in the SAML Assertion used to bind users from SAML to users in Mattermost.

This feature’s config.json setting is "IdAttribute": "" with string input.

First Name Attribute

(Optional) The attribute in the SAML Assertion that will be used to populate the first name of users in Mattermost.

This feature’s config.json setting is "FirstNameAttribute": "" with string input.

Last Name Attribute

(Optional) The attribute in the SAML Assertion that will be used to populate the last name of users in Mattermost.

This feature’s config.json setting is "LastNameAttribute": "" with string input.

Nickname Attribute

(Optional) The attribute in the SAML Assertion that will be used to populate the nickname of users in Mattermost.

This feature’s config.json setting is "NicknameAttribute": "" with string input.

Position Attribute

(Optional) The attribute in the SAML Assertion that will be used to populate the position field for users in Mattermost (typically used to describe a person’s job title or role at the company).

This feature’s config.json setting is "PositionAttribute": "" with string input.

Preferred Language Attribute

(Optional) The attribute in the SAML Assertion that will be used to populate the language of users in Mattermost.

This feature’s config.json setting is "LocaleAttribute": "" with string input.

Login Button Text

(Optional) The text that appears in the login button on the login page. Defaults to SAML.

This feature’s config.json setting is "LoginButtonText": "" with string input.

Scoping IDP Provider Id

Allows an authenticated user to skip the initial login page of their federated Azure AD server, and only require a password to log in.

This feature’s config.json setting is "ScopingIDPProviderId": "" with string input.

Scoping IDP Name

Adds the name associated with a user’s Scoping Identity Provider ID.

This feature’s config.json setting is "ScopingIDPName": "" with string input.

MFA

Configure security settings for multi-factor authentication.

The default recommendation for secure deployment is to host Mattermost within your own private network, with VPN clients on mobile, so everything works under your existing security policies and authentication protocols, which may already include multi-factor authentication.

If you choose to run Mattermost outside your private network, bypassing your existing security protocols, it is recommended you set up a multi-factor authentication service specifically for accessing Mattermost.

Enable Multi-factor Authentication

True: When true, users with LDAP and email authentication will be given the option to require a phone-based passcode, in addition to their password-based authentication, to sign in to the Mattermost server. Specifically, they will be asked to download the Google Authenticator app to their iOS or Android mobile device, connect the app with their account, and then enter a passcode generated by the app on their phone whenever they log in to the Mattermost server.

False: Multi-factor authentication is disabled.

This feature’s config.json setting is "EnableMultifactorAuthentication": false with options true and false.

Enforce Multi-factor Authentication

Available in Enterprise Edition E10 and higher

True: When true, multi-factor authentication (MFA) is required for login. New users will be required to configure MFA on sign-up. Logged in users without MFA configured are redirected to the MFA setup page until configuration is complete. If your system has users with login options other than AD/LDAP and email, MFA must be enforced with the authentication provider outside of Mattermost.

False: Multi-factor authentication is optional.

This feature’s config.json setting is "EnforceMultifactorAuthentication": false with options true and false.

Security

Configure security settings for account creation, login, public links, and connection requests.

Sign Up

Require Email Verification

True: Require email verification after account creation prior to allowing login.

False: Users do not need to verify their email address prior to login. Developers may set this field to false so skip sending verification emails for faster development.

This feature’s config.json setting is "RequireEmailVerification": false with options true and false.

Enable Open Server

True: Users can sign up to the server from the root page without an invite.

False: Users can only sign up to the server if they receive an invite.

This feature’s config.json setting is "EnableOpenServer": false with options true and false.

Enable Email Invitations

True: Users can invite others to the Mattermost system by email.

False: Email invitations are disabled.

This feature’s config.json setting is "EnableEmailInvitations": false with options true and false.

Password

Minimum Password Length

This feature was moved to Team Edition in Mattermost v5.0, released June 16th, 2018. In previous versions, this feature is available in Enterprise Edition E10 and higher.

Minimum number of characters required for a valid password. Must be a whole number greater than or equal to 5 and less than or equal to 64.

This feature’s config.json setting is "MinimumLength": 5 with numerical input.

Password Requirements

This feature was moved to Team Edition in Mattermost v5.0, released June 16th, 2018. In previous versions, this feature is available in Enterprise Edition E10 and higher.

Set the required character types to be included in a valid password. Defaults to allow any characters unless otherwise specified by the checkboxes. The error messasage previewed in the System Console will appear on the account creation page if a user enters an invalid password.

  • At least one lowercase letter: Select this checkbox if a valid password must contain at least one lowercase letter.
  • At least one uppercase letter: Select this checkbox if a valid password must contain at least one uppercase letter.
  • At least one number: Select this checkbox if a valid password must contain at least one number.
  • At least one symbol: Select this checkbox if a valid password must contain at least one symbol. Valid symbols include: !"#$%&'()*+,-./:;<=>?@[]^_`|~.

This feature’s config.json settings are, respectively:

"Lowercase": false with options true and false.
"Number": false with options true and false.
"Uppercase": false with options true and false.
"Symbol": false with options true and false.

Maximum Login Attempts

Failed login attempts allowed before a user is locked out and required to reset their password via email.

This feature’s config.json setting is "MaximumLoginAttempts": 10 with numerical input.

Sessions

User sessions are cleared when a user tries to log in. Additionally, a job runs every 24 hours to clear sessions from the sessions database table.

Session length for email and AD/LDAP authentication (days)

Set the number of days from the last time a user entered their credentials to the expiry of the user’s session on email and AD/LDAP authentication.

After changing this setting, the new session length will take effect after the next time the user enters their credentials.

This feature’s config.json setting is "SessionLengthWebInDays": 180 with numerical input.

Session length for mobile apps (days)

Set the number of days from the last time a user entered their credentials to the expiry of the user’s session on mobile apps.

After changing this setting, the new session length will take effect after the next time the user enters their credentials.

This feature’s config.json setting is "SessionLengthMobileInDays": 180 with numerical input.

Session length for GitLab SSO authentication (days)

Set the number of days from the last time a user entered their credentials to the expiry of the user’s session. If the authentication method is SAML or GitLab, the user may automatically be logged back in to Mattermost if they are already logged in to SAML or GitLab.

After changing this setting, the setting will take effect after the next time the user enters their credentials.

This feature’s config.json setting is "SessionLengthSSOInDays": 30 with numerical input.

Session Cache (minutes)

Set the number of minutes to cache a session in memory.

This feature’s config.json setting is "SessionCacheInMinutes": 10 with numerical input.

Session Idle Timeout (minutes)

The number of minutes from the last time a user was active on the system to the expiry of the user’s session. Once expired, the user will need to log in to continue. Minimum is 5 minutes, and 0 is unlimited.

Applies to the desktop app and browsers. For mobile apps, use an EMM provider to lock the app when not in use. In High Availability mode, enable IP hash load balancing for reliable timeout measurement.

This feature’s config.json setting is "SessionIdleTimeoutInMinutes": 43200 with numerical input.

Connections

Enable cross-origin requests from

Enable HTTP cross-origin requests from specific domains separated by spaces. Type * to allow CORS from any domain or leave it blank to disable it.

Note

Please make sure you have entered your Site URL before enabling this setting to prevent losing access to the System Console after saving. If you experience lost access to the System Console after changing this setting, you can set your Site URL through the config.json file.

This feature’s config.json setting is "AllowCorsFrom": "" with string input.

CORS Exposed Headers

Whitelist of headers that will be accessible to the requester.

This feature’s config.json setting is "CorsExposedHeaders": "" with string input.

CORS Allow Credentials

True: Requests that pass validation will include the Access-Control-Allow-Credentials header.

False: Requests won’t include the Access-Control-Allow-Credentials header.

This feature’s config.json setting is "CorsAllowCredentials": false with options true and false.

CORS Debug

True: Prints messages to the logs to help when developing an integration that uses CORS. These messages will include the structured key value pair "source": "cors".

False: Debug messages not printed to the logs.

This feature’s config.json setting is "CorsDebug": false with options true and false.

Enable Insecure Outgoing Connections

True: Outgoing HTTPS requests can accept unverified, self-signed certificates. For example, outgoing webhooks to a server with a self-signed TLS certificate, using any domain, will be allowed.

False: Only secure HTTPS requests are allowed.

Security note: Enabling this feature makes these connections susceptible to man-in-the-middle attacks.

This feature’s config.json setting is "EnableInsecureOutgoingConnections": false with options true and false.

Notifications

Settings to configure email and mobile push notifications.

Email

Enable Email Notifications

True: Enables sending of email notifications.

False: Disables email notifications for developers who may want to skip email setup for faster development. To remove the Preview Mode: Email notifications have not been configured banner, also set Enable Preview Mode Banner to false.

This feature’s config.json setting is "SendEmailNotifications": false with options true and false.

Enable Preview Mode Banner

True: Preview Mode banner is displayed to all users when "SendEmailNotifications": false so users are aware that email notifications are disabled.

False: Preview Mode banner is not displayed to users.

This feature’s config.json setting is "EnablePreviewModeBanner": true with options true and false.

Enable Email Batching

True: Users can select how often to receive email notifications, and multiple notifications within that timeframe will be combined into a single email. Batching will occur at a default interval of 15 minutes, configurable in Account Settings > Notifications.

Note

Email batching cannot be enabled unless the SiteURL is configured. Email batching in High Availability mode is planned but not yet supported.

False: If email notifications are enabled in Account Settings, emails will be sent individually for every mention or direct message received.

This feature’s config.json setting is "EnableEmailBatching": false with options true and false.

Enable Notification Contents

Available in Enterprise Edition E20

Send full message contents: Sender name and channel are included in email notifications.

Send generic description with only sender name: The team name and name of the person who sent the message, with no information about channel name or message contents, is included in email notifications. Typically used for compliance reasons if Mattermost contains confidential information and policy dictates it cannot be stored in email.

This feature’s config.json setting is "EmailNotificationContentsType": "full" with options "full" and "generic" for the above settings, respectively.

Notification Display Name

Name displayed on email account used when sending notification emails from Mattermost system.

This feature’s config.json setting is "FeedbackName": "" with string input.

Notification From Address

Address displayed on email account used when sending notification emails from Mattermost system.

So you don’t miss messages, please make sure to change this value to an email your system administrator receives, such as "admin@yourcompany.com".

This feature’s config.json setting is "FeedbackEmail": "" with string input.

Notification Reply-To Address

Email address used in the Reply-To header when sending notification emails from Mattermost.

This feature’s config.json setting is "ReplyToAddress": "" with string input.

SMTP Server

Location of SMTP email server.

This feature’s config.json setting is "SMTPServer": "" with string input.

SMTP Server Port

Port of SMTP email server.

This feature’s config.json setting is "SMTPPort": "" with string input.

Enable SMTP Authentication

True: SMTP username and password are used for authenticating to the SMTP server.

False: Mattermost doesn’t attempt to authenticate to the SMTP server.

This feature’s config.json setting is "EnableSMTPAuth": false with options true and false.

SMTP Server Username

The username for authenticating to the SMTP server.

This feature’s config.json setting is "SMTPUsername": "" with string input.

SMTP Server Password

The password associated with the SMTP username.

This feature’s config.json setting is "SMTPPassword": "" with string input.

Connection Security

None: Send email over an unsecure connection.

TLS: Communication between Mattermost and your email server is encrypted.

STARTTLS: Attempts to upgrade an existing insecure connection to a secure connection using TLS.

This feature’s config.json setting is "ConnectionSecurity": "" with options "", "TLS", and "STARTTLS".

Skip Server Certificate Verification

True: Mattermost will not verify the email server certificate.

False: Mattermost will verify the email server certificate.

This feature’s config.json setting is "SkipServerCertificateVerification": false with options true and false.

Enable Security Alerts

True: Enable System Admins to be notified by email if a relevant security fix alert is announced. Requires email to be enabled. To learn more about this feature, see Telemetry.

False: Security alerts are disabled.

This feature’s config.json setting is "EnableSecurityFixAlert": true with options true and false.

Mobile Push

Enable Push Notifications

True: Your Mattermost server sends mobile push notifications to the server specified in PushNotificationServer.

False: Mobile push notifications are disabled.

This feature’s config.json setting is "SendPushNotifications": false with options true and false.

Push Notification Server

Location of Mattermost Push Notification Service (MPNS), which re-sends push notifications from Mattermost to services like Apple Push Notification Service (APNS) and Google Cloud Messaging (GCM).

To confirm push notifications are working, connect to the Mattermost iOS App on iTunes or the Mattermost Android App on Google Play:

  • For Enterprise Edition, enter https://push.mattermost.com for the push notification server hosted in the United States. If you prefer to use a push notification server hosted in Germany, enter https://hpns-de.mattermost.com/.
  • For Team Edition, enter https://push-test.mattermost.com.

Please review the full documentation on push notifications and mobile applications including guidance on compiling your own mobile apps and MPNS before deploying to production.

Note

The https://push-test.mattermost.com server is provided for testing push notifications prior to compiling your own service please make sure to read about its limitations.

This feature’s config.json setting is "PushNotificationServer": "https://push-test.mattermost.com" with string input.

Push Notification Contents

Send generic description with only sender name: Push notifications include only the name of the person who sent the message but no information about channel name or message text.

Send generic description with user and channel names: Push notifications include names of users and channels but no specific details from the message text.

Send full message snippet: Selecting “Send full message snippet” sends excerpts from messages triggering notifications with specifics and may include confidential information sent in messages. If your Push Notification Service is outside your firewall, it is HIGHLY RECOMMENDED this option only be used with an “https” protocol to encrypt the connection.

This feature’s config.json setting is "PushNotificationContents": "generic" with options "generic_no_channel", "generic", and "full" for the above settings, respectively.

Troubleshooting Push Notifications

To confirm push notifications are working:

  1. Go to System Console > Notifications > Mobile Push > Send Push Notifications and select Use TPNS connection to send notifications to iOS and Android apps.
  2. Set Push Notification Server to https://push.mattermost.com if using Enterprise Edition. If using Team Edition, set the value to https://push-test.mattermost.com.
  3. To confirm push notifications are working, connect to the Mattermost iOS App on iTunes or the Mattermost Android App on Google Play and log in to your team site.
  4. Close the app on your device, and close any other connections to your team site.
  5. Wait 5 minutes and have another team member send you a direct message, which should trigger a push notification to the Mattermost app on your mobile device.
  6. You should receive a push notification on your device alerting you of the direct message.

If you did not receive an alert:

  1. Set System Console > General > Logging > File Log Level to DEBUG (make sure to set this back to INFO after troubleshooting to save disk space).
  2. Repeat the above steps.
  3. Go to System Console > Logs and copy the log output into a file.
  4. For Enterprise Edition customers, submit a support request with the file attached. For Team Edition users, please start a thread in the troubleshooting forum for peer-to-peer support.

Integrations

Settings to configure webhooks, slash commands, and external integration services.

Custom Integrations

Enable Incoming Webhooks

Developers building integrations can create webhook URLs for public channels and private channels. Please see our documentation page to learn about creating webhooks, view samples, and to let the community know about integrations you have built.

True: Incoming webhooks will be allowed. To manage incoming webhooks, go to Account Settings > Integrations. The webhook URLs created in Account Settings can be used by external applications to create posts in any public or private channels that you have access to.

False: The Integrations > Incoming Webhooks section of Account Settings is hidden and all incoming webhooks are disabled.

Security note: By enabling this feature, users may be able to perform phishing attacks by attempting to impersonate other users. To combat these attacks, a BOT tag appears next to all posts from a webhook. Enable at your own risk.

This feature’s config.json setting is "EnableIncomingWebhooks": true with options true and false.

Enable Outgoing Webhooks

Developers building integrations can create webhook tokens for public channels. Trigger words are used to fire new message events to external integrations. For security reasons, outgoing webhooks are only available in public channels. Please see our documentation page to learn about creating webhooks and view samples.

True: Outgoing webhooks will be allowed. To manage outgoing webhooks, go to Account Settings > Integrations.

False: The Integrations > Outgoing Webhooks section of Account Settings is hidden and all outgoing webhooks are disabled.

Security note: By enabling this feature, users may be able to perform phishing attacks by attempting to impersonate other users. To combat these attacks, a BOT tag appears next to all posts from a webhook. Enable at your own risk.

This feature’s config.json setting is "EnableOutgoingWebhooks": true with options true and false.

Enable Custom Slash Commands

Slash commands send events to external integrations that send a response back to Mattermost.

True: Allow users to create custom slash commands from Main Menu > Integrations > Commands.

False: Slash commands are hidden in the Integrations user interface.

This feature’s config.json setting is "EnableCommands": false with options true and false.

Enable OAuth 2.0 Service Provider

True: Mattermost acts as an OAuth 2.0 service provider allowing Mattermost to authorize API requests from external applications.

False: Mattermost does not function as an OAuth 2.0 service provider.

This feature’s config.json setting is "EnableOAuthServiceProvider": false with options true and false.

Restrict managing integrations to Admins

This permission has been migrated to the database and changing the ``config.json`` value no longer takes effect after upgrading to v4.9, released on April 16th, 2018. This permission can be modified using the System Console user interface.

True: When true, webhooks and slash commands can only be created, edited, and viewed by Team and System Admins, and OAuth 2.0 applications by System Admins. Integrations are available to all users after they have been created by the System Admin.

False: Any team members can create webhooks, slash commands, and OAuth 2.0 applications from Main Menu > Integrations.

Note

OAuth 2.0 applications can be authorized by all users if they have the Client ID and Client Secret for an app setup on the server.

This feature’s config.json setting is "EnableOnlyAdminIntegrations": true with options true and false.

Enable integrations to override usernames

True: Webhooks, slash commands, OAuth 2.0 apps, and other integrations such as Zapier, will be allowed to change the username they are posting as. If no username is present, the username for the post is the same as it would be for a setting of False.

False: Custom slash commands can only post as the username of the user who used the slash command. OAuth 2.0 apps can only post as the username of the user who set up the integration. For incoming webhooks and outgoing webhooks, the username is “webhook”. See https://docs.mattermost.com/guides/integration.html for more details.

This feature’s config.json setting is "EnablePostUsernameOverride": false with options true and false.

Enable integrations to override profile picture icons

True: Webhooks, slash commands, and other integrations, such as Zapier, will be allowed to change the profile picture they post with.

False: Webhooks, slash commands, and OAuth 2.0 apps can only post with the profile picture of the account they were set up with. See https://docs.mattermost.com/guides/integration.html for more details.

This feature’s config.json setting is "EnablePostIconOverride": false with options true and false.

Enable Personal Access Tokens

True: When true, users can create personal access tokens for integrations in Account Settings > Security. They can be used to authenticate against the API and give full access to the account.

To manage who can create personal access tokens or to search users by token ID, go to the System Console > Users page.

False: Personal access tokens are disabled on the server.

This feature’s config.json setting is "EnableUserAccessTokens": false with options true and false.

External Services

Google API Key

Mattermost offers the ability to embed YouTube videos from URLs shared by end users. Set this key and add YouTube Data API v3 as a service to your key to enable the display of titles for embedded YouTube video previews. Without the key, YouTube previews will still be created based on hyperlinks appearing in messages or comments but they will not show the video title. If Google detects the number of views is exceedingly high, they may throttle embed access. Should this occur, you can remove the throttle by registering for a Google Developer Key and entering it in this field following these instructions: https://www.youtube.com/watch?v=Im69kzhpR3I. Your Google Developer Key is used in client-side Javascript.

Using a Google API Key allows Mattermost to detect when a video is no longer available and display the post with a Video not found label.

This feature’s config.json setting is "GoogleDeveloperKey": "" with string input.

Plugins (Beta)

Settings to configure plugins.

Management

Enable Plugins

True: Enables plugins on your Mattermost server. Use plugins to integrate with third-party systems, extend functionality or customize the user interface of your Mattermost server. See documentation to learn more.

False: Disables plugins on your Mattermost server.

This feature’s config.json setting is "Enable": true with options true and false.

Plugin Settings

Settings specific to each plugin.

This feature’s config.json setting is "Plugins": {} with object input mapping plugin IDs as keys to objects containing plugin-specific data.

Installed Plugin State

Lists installed plugins on your Mattermost server and whether they are enabled. Pre-packaged plugins are installed by default and can be deactivated, but not removed.

This feature’s config.json setting is "PluginStates": {} with object input mapping plugin IDs as keys to objects, each of which contains a key "Enable": false with options true or false.

Jira (Beta)

Enable Jira

True: You can configure Jira webhooks to post message in Mattermost. To help combat phishing attacks, all posts are labelled by a BOT tag.

False: Jira webhook integration is not enabled.

This feature’s config.json setting is "Enabled": false with options true and false.

User

Select the username that this integration is attached to.

This feature’s config.json setting is "UserName": "" with string input.

Secret

The secret used to authenticate to Mattermost. Regenerating the secret for the webhook URL endpoint invalidates your existing Jira integrations.

This feature’s config.json setting is "Secret": "" with string input.

Note that to set up a Jira integration via config.json, you can use the following format in "Plugins":

"Plugins": {
    "jira": {
        "Enabled": true,
        "Secret": "k-ZtjoTrmIdPs7eAGjalDEK_3Q8r3gXJ",
        "UserName": "jira"
    }
}

where "Enabled", "Secret" and "UserName" are specified above.

Files

Mattermost currently supports storing files on the local filesystem and Amazon S3 or S3-compatible containers.

Note

We have tested Mattermost with MinIO and Digital Ocean Spaces products but not all S3-compatible containers on the market. If you are looking to use other S3-compatible containers we advise completing your own testing.

Storage

File Storage System

config.json setting DriverName
Allowed Values "local" (default) "amazons3"

This selects which file storage system is used: Local File System, Amazon S3, or MinIO (using the same DriverName as Amazon S3: "amazons3").

Local File System: Files and images are stored in the specified local file directory.

Amazon S3: Files and images are stored on Amazon S3 based on the provided access key, bucket, and region fields. The "amazons3" driver is compatible with MinIO (Beta) and Digital Ocean Spaces based on the provided access key, bucket, and region fields.

MinIO: MinIO is an open source, self-hosted alternative to Amazon S3 and thus finds common ground with our community, providing cloud-like functionality but in a secure, self-hosted environment and is fully compatible with our S3 driver. To get started with MinIO you can download and run it locally from this page: Download MinIO.

Local Storage Directory

The local directory to which files are written when the File Storage System is set to "local". This is relative to the directory Mattermost is installed to and defaults to "./data" When File Storage System is set to S3 this setting has no effect.

config.json setting Directory
Allowed Values Any directory writeable by the user Mattermost is running as. Defaults to "./data/".

Amazon S3 Bucket

The name of the bucket for your S3-compatible object storage instance.

Note

For MinIO, you can find this name in the left side bar of your MinIO browser if you want use an existing MinIO bucket or you can create a new one with the desired name.

config.json setting AmazonS3Bucket
Allowed Values A string with the S3-compatible bucket name.

Amazon S3 Region

The AWS region you selected when creating your S3 bucket. If no region is set, Mattermost attempts to get the appropriate region from AWS and sets it to "us-east-1" if none is found.

Note

For Digital Ocean Spaces leave this setting empty.
For MinIO you can leave it empty or set it to "None".
config.json setting AmazonS3Region
Allowed Values A string with the AWS region containing the bucket.

Amazon S3 Endpoint

Hostname of your S3-compatible instance. Defaults to "s3.amazonaws.com".

Note

For Digital Ocean Spaces, the hostname should be set to "<region>.digitaloceanspaces.com", where <region> is the abbreviation for the region you chose when setting up the Space. It can be nyc3, ams3, or sgp1.
For MinIO, the hostname is the URL at which you have hosted your MinIO instance, or "localhost:9000" if you are hosting it locally.
config.json setting AmazonS3Endpoint
Allowed Values A string with the hostname of the S3-compatible storage instance.

Amazon S3 Access Key ID

This is required for access unless you are using an Amazon S3 IAM Role with Amazon S3. Your EC2 administrator can supply you with the access key ID.

Note

For MinIO, you can find this in your terminal window with the name AccessKey when you start a new MinIO server.

config.json setting AmazonS3AccessKeyId
Allowed Values A string with the access key for the S3-compatible storage instance.

Amazon S3 Secret Access Key

The secret access key associated with your Amazon S3 Access Key ID.

Note

For MinIO, you can find this in your terminal window with the name SecretKey when you start a new MinIO server.

config.json setting AmazonS3SecretAccessKey
Allowed Values A string with the secret access key for the S3-compatible storage instance.

Enable Secure Amazon S3 Connections

True: Enables only secure Amazon S3 Connections.

False: Allows insecure connections to Amazon S3.

Note

When using MinIO locally, set this option to false or use OpenSSL and install a new SSL Certificate or use a tunneling service like ngrok.

config.json setting AmazonS3SSL
Allowed Values true or false. Defaults to true.

Enable Server-Side Encryption for Amazon S3

Available in Enterprise Edition E20

True: Encrypts files in Amazon S3 using server-side encryption with Amazon S3-managed keys.

False: Doesn’t encrypt files in Amazon S3.

Note

Server-Side Encryption only works with Amazon S3.

config.json setting AmazonS3SSE
Allowed Values true or false. Defaults to false.

Enable Amazon S3 Debugging

True: When true, log additional debugging information to the system logs. Typically set to false in production.

False: No Amazon S3 debugging information is included in the system logs.

config.json setting AmazonS3Trace
Allowed Values true or false. Defaults to false.

Test Connection

Ensures that the user can access the server and that the settings are valid.

Allow File Sharing

When false, disables file sharing on the server. All file and image uploads on messages are forbidden across clients and devices, including mobile.

This feature’s config.json setting is "EnableFileAttachments": true with options true and false.

Allow File Uploads on Mobile

Available in Enterprise Edition E20

When false, disables file uploads on mobile apps. All file and image uploads on messages are forbidden across clients and devices, including mobile.

This feature’s config.json setting is "EnableMobileUpload": true with options true and false.

Allow File Downloads on Mobile

Available in Enterprise Edition E20

When false, disables file downloads on mobile apps. Users can still download files from a mobile web browser.

This feature’s config.json setting is "EnableMobileDownload": true with options true and false.

Maximum File Size

Maximum file size for message attachments entered in megabytes in the System Console UI. Converted to bytes in config.json at 1048576 bytes per megabyte.

This feature’s config.json setting is "MaxFileSize": 52428800 with numerical input.

Warning

Verify server memory can support your setting choice. Large file sizes increase the risk of server crashes and failed uploads due to network disruptions.

Enable Image Proxy

When true, enables an image proxy for loading external images. The image proxy is used by the Mattermost apps to prevent them from connecting directly to remote servers. This anonymizes their connections and prevents them from accessing insecure content.

See the documentation to learn more.

This feature’s config.json setting is "Enable": true with options true and false.

Image Proxy Type

The type of image proxy used by Mattermost. There are two options:

local: The Mattermost server itself acts as the image proxy. This is the default option.

atmos/camo: An external atmos/camo image proxy is used.

See the documentation to learn more.

This feature’s config.json setting is "ImageProxyType": "local", with options "local" and "atmos/camo" for the above settings, respectively.

Remote Image Proxy URL

The URL of the atmos/camo proxy. This setting is not needed when using the local image proxy.

This feature’s config.json setting is "RemoteImageProxyURL": "" with string input.

Remote Image Proxy Options

The URL signing key passed to an atmos/camo image proxy. This setting is not needed when using the local image proxy.

See the documentation to learn more.

This feature’s config.json setting is "RemoteImageProxyOptions": "" with string input.

Images

Attachment Thumbnail Width

Removed in July 16th, 2017 release

Width of thumbnails generated from uploaded images. Updating this value changes how thumbnail images render in future, but does not change images created in the past.

This feature’s config.json setting is "ThumbnailWidth": 120 with numerical input.

Attachment Thumbnail Height

Removed in July 16th, 2017 release

Height of thumbnails generated from uploaded images. Updating this value changes how thumbnail images render in future, but does not change images created in the past.

This feature’s config.json setting is "ThumbnailHeight": 100 with numerical input.

Image Preview Width

Removed in July 16th, 2017 release

Maximum width of preview image. Updating this value changes how preview images render in future, but does not change images created in the past.

This feature’s config.json setting is "PreviewWidth": 1024 with numerical input.

Image Preview Height

Removed in July 16th, 2017 release

Maximum height of preview image. Setting this value to 0 instructs Mattermost to auto-size the preview image height based on the source image aspect ratio and the preview image width. Updating this value changes how preview images render in future, but does not change images created in the past.

This feature’s config.json setting is "PreviewHeight": 0 with numerical input.

Profile Picture Width

Removed in July 16th, 2017 release

The width to which profile pictures are resized after being uploaded via Account Settings.

This feature’s config.json setting is "ProfileWidth": 128 with numerical input.

Profile Picture Height

Removed in July 16th, 2017 release

The height to which profile pictures are resized after being uploaded via Account Settings.

This feature’s config.json setting is "ProfileHeight": 128 with numerical input.

Customization

Settings to customize your deployment with custom branding and legal and support links.

Custom Branding

Site Name

Name of service shown in login screens and UI. Maximum 30 characters.

This feature’s config.json setting is "SiteName": "Mattermost" with string input.

Enable Custom Branding

This feature was moved to Team Edition in Mattermost v5.0, released June 16th, 2018. In previous versions, this feature is available in Enterprise Edition E10 and higher.

True: Enables custom branding to show a JPG image some custom text on the server login page.

False: Custom branding is disabled.

This feature’s config.json setting is "EnableCustomBrand": false with options true and false.

Custom Brand Image

Custom JPG image is displayed on left side of server login page. Recommended maximum image size is less than 2 MB because image will be loaded for every user who logs in.

This features has no config.json setting and must be set in the System Console user interface.

Custom Brand Text

Custom text will be shown below custom brand image on left side of server login page. Maximum 500 characters allowed. You can format this text using the same Markdown formatting codes as using in Mattermost messages.

This feature’s config.json setting is "CustomBrandText": "" with string input.

Site Description

Description of service shown in login screens and UI. When not specified, “All team communication in one place, searchable and accessible anywhere” is displayed.

This feature’s config.json setting is "CustomDescriptionText": "" with string input.

Announcement Banner

Enable Announcement Banner

Enable an announcement banner across all teams. The banner is displayed at the top of the screen and is the entire width of the screen. By default, users can dismiss the banner until you either change the text of the banner or until you re-enable the banner after it has been disabled. You can prevent users from dismissing the banner, and you can control the text color and the background color.

True: Enable the announcement banner. The banner is displayed only if BannerText has a value.

False: Disable the announcement banner.

This feature’s config.json setting is "EnableBanner": false with options true and false.

Allow Banner Dismissal

True: Users can dismiss the banner until the next time they log in or the banner is updated.

False: The banner is permanently visible until it is turned off by the System Admin.

This feature’s config.json setting is ""AllowBannerDismissal": true with options true and false.

Emoji

Enable Emoji Picker

True: Enables an emoji picker that allows users to select emoji to add as reactions or use in messages. Enabling the emoji picker with a large number of custom emoji may slow down performance.

False: Emoji picker is disabled.

This feature’s config.json setting is "EnableEmojiPicker": true with options true and false.

Enable Custom Emoji

True: Enables a Custom Emoji option in the Main Menu, where users can go to create customized emoji.

False: Custom Emojis are disabled.

This feature’s config.json setting is "EnableCustomEmoji": false with options true and false.

Restrict Custom Emoji Creation

This permission has been migrated to the database and changing the ``config.json`` value no longer takes effect after upgrading to v4.9, released on April 16th, 2018. This permission can be modified using the System Console user interface.

Available in Enterprise Edition E10 and higher

Allow everyone to create custom emoji: Allows everyone to create Custom Emoji from the Main Menu > Custom Emoji.

Allow System and Team Admins to create custom emoji: The Custom Emoji option is hidden from the Main Menu for users who are not System or Team Admins.

Only allow System Admins to create custom emoji: The Custom Emoji option is hidden from the Main Menu for users who are not System Admins.

This feature’s config.json setting is "RestrictCustomEmojiCreation": "all" with options "all", "admin", and "system_admin" for the above settings, respectively.

GIF (Beta)

Enable GIF Picker

True: Allow users to select GIFs from the emoji picker via a Gfycat integration.

False: GIFs cannot be selected in the emoji picker.

This feature’s config.json setting is "EnableGifPicker": false with options true and false.

Note

Mattermost deployments which are restricted to access behind a firewall must open port 443 to both https://api.gfycat.com/v1 and https://gfycat.com/<id> (for all request types) for this feature to work.

Gfycat API Key

When blank, uses the default API key provided by Gfycat. Alternatively, a unique API key can be requested at https://developers.gfycat.com/signup/#/. Enter the client ID you receive via email to this field.

This feature’s config.json setting is "GfycatApiKey": "2_KtH_W5" with string input.

Gfycat API Secret

The API secret generated by Gfycat for your API key. When blank, uses the default API secret provided by Gfycat.

This feature’s config.json setting is "GfycatApiSecret": "3wLVZPiswc3DnaiaFoLkDvB4X0IV6CpMkj4tf2inJRsBY6-FnkT08zGmppWFgeof" with string input.

Posts

Custom URL Schemes

A list of URL schemes that are used for autolinking in message text. http, https, ftp, tel, and mailto always create links.

This feature’s config.json setting is "CustomUrlSchemes": [] with string array input consisting of URL schemes, such as ["git", "smtp"].

Custom Terms of Service

Available in Enterprise Edition E20.

Enable Custom Terms of Service

Note

This page can only be modified using the System Console user interface.

True: When true, new users must accept the terms of service before accessing any Mattermost teams on desktop, web or mobile. Existing users must accept them after login or a page refresh. To update terms of service link displayed in account creation and login pages, go to System Console > Legal and Support > Terms of Service Link.

False: During account creation or login, users can review terms of service by accessing the link configured via System Console > Legal and Support > Terms of Service link.

Custom Terms of Service Text

Text that will appear in your custom Terms of Service. Supports Markdown-formatted text.

Re-Acceptance Period

The number of days before Terms of Service acceptance expires, and the terms must be re-accepted.

Defaults to 365 days. 0 indicates the terms do not expire.

Compliance

Data Retention Policy

Available in Enterprise Edition E20

Changes to this setting require a server restart before taking effect.

Warning

Once a message or a file is deleted, the action is irreversible. Please be careful when setting up a custom data retention policy.

Message Retention

Set how long Mattermost keeps messages in channels and direct messages.

If Keep messages for a set amount of time is chosen, set how many days messages are kept in Mattermost. Messages, including file attachments older than the duration you set will be deleted nightly. The minimum time is one day.

This feature’s config.json setting is "EnableMessageDeletion": false with options true and false.

and

This feature’s config.json setting is "MessageRetentionDays": 365 with numerical input.

File Retention

Set how long Mattermost keeps file uploads in channels and direct messages.

If Keep files for a set amount of time is chosen, set how many days file uploads are kept in Mattermost. Files older than the duration you set will be deleted nightly. The minimum time is one day.

This feature’s config.json setting is "EnableFileDeletion": false with options true and false.

and

This feature’s config.json setting is "FileRetentionDays": 365 with numerical input.

Data Deletion Time

Set the start time of the daily scheduled data retention job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form HH:MM.

This setting is based on the local time of the server.

This feature’s config.json setting is "DeletionJobStartTime": "02:00" with 24-hour timestamp input in the form "HH:MM".

Run Deletion Job Now

This button initiates a Data Retention deletion job immediately.

You can monitor the status of the job in the data deletion job table below this button.

Compliance Export (Beta)

Available as an add-on to Enterprise Edition E20

Enable Compliance Export

True: Mattermost will generate a compliance export file that contains all messages that were posted in the last 24 hours. The export task is scheduled to run once per day. See the documentation to learn more.

False: Mattermost doesn’t generate a compliance export file.

This feature’s config.json setting is "EnableExport": false with options true and false.

Compliance Export Time

Set the start time of the daily scheduled compliance export job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form HH:MM.

This setting is based on the local time of the server.

This feature’s config.json setting is "DailyRunTime": 01:00 with 24-hour timestamp input in the form "HH:MM".

Export File Format

File format of the compliance export. Corresponds to the system that you want to import the data into.

Currently supported formats are CSV, Actiance XML, and Global Relay EML.

If Global Relay is chosen, the following options will be presented:

Global Relay Customer Account

Type of Global Relay customer account your organization has, either A9/Type 9 or A10/Type 10.

This feature’s config.json setting is "CustomerType": "A9/Type 9" with options "A9/Type 9" and "A10/Type 10".

Global Relay SMTP Username

The username for authenticating to the Global Relay SMTP server.

This feature’s config.json setting is "SmtpUsername": "" with string input.

Global Relay SMTP Password

The password associated with the Global Relay SMTP username.

This feature’s config.json setting is "SmtpPassword": "" with string input.

Global Relay Email Address

The email address your Global Relay server monitors for incoming compliance exports.

This feature’s config.json setting is "EmailAddress": "" with string input.

Run Compliance Export Job Now

This button initiates a Compliance Export job immediately.

You can monitor the status of the job in the compliance export job table below this button.

Advanced

Advanced settings to configure rate limiting, databases, and developer options.

Rate Limiting

Changes to this setting require a server restart before taking effect.

Enable Rate Limiting

True: APIs are throttled at the rate specified by PerSec.

False: APIs are not throttled.

This feature’s config.json setting is "Enable": false with options true and false.

Maximum Queries per Second

Throttle API at this number of requests per second if rate limiting is enabled.

This feature’s config.json setting is "PerSec": 10 with numerical input.

Maximum Burst Size

Maximum number of requests allowed beyond the per second query limit.

This feature’s config.json setting is "MaxBurst": 100 with numerical input.

Memory Store Size

Maximum number of user sessions connected to the system as determined by VaryByRemoteAddr and VaryByHeader variables.

Typically set to the number of users in the system.

This feature’s config.json setting is "MemoryStoreSize": 10000 with numerical input.

Vary rate limit by remote address

True: Rate limit API access by IP address. Recommended to set to true if you’re using a proxy.

False: Rate limiting does not vary by IP address.

This feature’s config.json setting is "VaryByRemoteAddr": true with options true and false.

Vary rate limit by HTTP header

Vary rate limiting by HTTP header field specified (e.g. when configuring Ngnix set to X-Real-IP, when configuring AmazonELB set to X-Forwarded-For). Recommended to be set if you’re using a proxy.

This feature’s config.json setting is "VaryByHeader": "" with string input.

Vary rate limit by user

True: Rate limit API access by user authentication token. Recommended to set to true if you’re using a proxy.

False: Rate limiting does not vary by user authentication token.

This feature’s config.json setting is "VaryByUser": false with options true and false.

Database

Changes to this setting require a server restart before taking effect.

Driver Name

This setting can only be changed from config.json file, it cannot be changed from the System Console user interface.

mysql: Enables driver to MySQL database.

postgres: Enables driver to PostgreSQL database.

This feature’s config.json setting is "DriverName": "mysql" with string input.

Data Source

This is the connection string to the master database. When DriverName is set to postgres, use a connection string in the form postgres://mmuser:password@localhost:5432/mattermost_test?sslmode=disable&connect_timeout=10. This setting can only be changed from config.json file.

Note

To enable SSL, add &tls=true to your database connection string if your SQL driver supports it. Add &tls=skip-verify if you use self-signed certificates.

This feature’s config.json setting is "DataSource": "" with string input.

Maximum Idle Connections

Maximum number of idle connections held open to the database.

This feature’s config.json setting is "MaxIdleConns": 10 with numerical input.

Maximum Open Connections

Maximum number of open connections held open to the database.

This feature’s config.json setting is "MaxOpenConns": 300 with numerical input.

SQL Query Timeout

The number of seconds to wait for a response from the database after opening a connection and sending the query. Errors that you see in the UI or in the logs as a result of a query timeout can vary depending on the type of query.

This feature’s config.json setting is "QueryTimeout": 30 with numerical input.

Maximum Connection Lifetime

Maximum lifetime for a connection to the database, in milliseconds. Use this setting to configure the maximum amount of time a connection to the database may be reused. Defaults to an hour (3,600,000 milliseconds).

This feature’s config.json setting is "ConnMaxLifetimeMilliseconds": 3600000 with numerical input.

Minimum Hashtag Length

Minimum number of characters in a hashtag. This must be greater than or equal to 2. MySQL databases must be configured to support searching strings shorter than three characters, see documentation.

This feature’s config.json setting is "MinimumHashtagLength": 3 with numerical input.

At Rest Encrypt Key

A 32-character key for encrypting and decrypting sensitive fields in the database. You can generate your own cryptographically random alphanumeric string, or you can go to System Console > Advanced > Database and click Regenerate, which displays the value until you click Save.

When using High Availability, the salt must be identical in each instance of Mattermost.

This feature’s config.json setting is "AtRestEncryptKey": "" with string input.

Trace

True: Executing SQL statements are written to the log for development.

False: SQL statements are not written to the log.

This feature’s config.json setting is "Trace": false with options true and false.

Recycle Database Connections

Available in Enterprise Edition E20

This button reconnects to the database listed in the configuration settings. All old connections are closed after 20s.

The workflow for failover without downing the server is to change the database line in the config.json file, click Reload Configuration from Disk in the General > Configuration section then click Recycle Database Connections.

Elasticsearch

Available in Enterprise Edition E20

Changes to properties in this section require a server restart before taking effect.

Enable Elasticsearch Indexing

True: Indexing of new posts occurs automatically. Search queries will use database search until “Enable Elasticsearch for search queries” is enabled. Learn more about Elasticsearch in our documentation.

False: Elasticsearch indexing is disabled and new posts are not indexed. If indexing is disabled and re-enabled after an index is created, it is recommended to purge and rebuild the index to ensure complete search results.

This feature’s config.json setting is "EnableIndexing": false with options true and false.

Server Connection Address

The address of the Elasticsearch server. Learn more about Elasticsearch in our documentation.

This feature’s config.json setting is "ConnectionUrl": "" with string input.

Server Username

(Optional) The username to authenticate to the Elasticsearch server.

This feature’s config.json setting is "Username": "" with string input.

Server Password

(Optional) The password to authenticate to the Elasticsearch server.

This feature’s config.json setting is "Password": "" with string input.

Enable Cluster Sniffing

True: Sniffing finds and connects to all data nodes in your cluster automatically.

False: Sniffing is disabled.

This feature’s config.json setting is "Sniff": false with options true and false.

Bulk Indexing

This button starts a bulk index of all existing posts in the database. If the indexing process is cancelled the index and search results will be incomplete.

Purge Indexes

This button purges the entire Elasticsearch index. Typically only used if the index has corrupted and search is not behaving as expected. After purging the index a new index can be created with the Bulk Index button.

Enable Elasticsearch for search queries

True: Elasticsearch will be used for all search queries using the latest index. Search results may be incomplete until a bulk index of the existing post database is finished.

False: Database search is used for search queries.

This feature’s config.json setting is "EnableSearching": false with options true and false.

Developer

Enable Testing Commands

True: /test slash command is enabled to load test accounts and test data.

False: /test slash command is disabled.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "EnableTesting": false with options true and false.

Enable Developer Mode

True: Javascript errors are shown in a purple bar at the top of the user interface. Not recommended for use in production.

False: Users are not alerted to Javascript errors.

This feature’s config.json setting is "EnableDeveloper": false with options true and false.

Allow untrusted internal connections to

This setting limits the ability for the Mattermost server to make untrusted requests within its local network. A request is considered “untrusted” when it’s made on behalf of a client. The following features make untrusted requests and are affected by this setting:

  • Integrations using webhooks, slash commands, or message actions. This prevents them from requesting endpoints within the local network.
  • Link previews. When a link to a local network address is posted in a chat message, this prevents a link preview from being displayed.
  • The local image proxy. If the local image proxy is enabled, images located on the local network cannot be used by integrations or posted in chat messages.

Requests that can only be configured by Admins are considered trusted and will not be affected by this setting. Trusted URLs include ones used for OAuth login or for sending push notifications.

Warning

This setting is intended to prevent users located outside your local network from using the Mattermost server to request confidential data from inside your network. Care should be used when configuring this setting to prevent unintended access to your local network.

Some examples of when you may want to modify this setting include:

  • When installing a plugin that includes its own images, such as Matterpoll, you will need to add the Mattermost server’s domain name to this list.
  • When running a bot or webhook-based integration on your local network, you will need to add the hostname of the bot/integration to this list.
  • If your network is configured in such a way that publicly accessible webpages or images are accessed by the Mattermost server using their internal IP address, the hostnames for those servers must be added to this list.

This setting is a whitelist of local network addresses that can be requested by the Mattermost server. It is configured as a whitespace separated list of hostnames, IP addresses and CIDR ranges that can be accessed such as webhooks.internal.example.com 127.0.0.1 10.0.16.0/28. Since v5.9 the public IP of the Mattermost application server itself is also considered a reserved IP.

IP address and domain name rules are applied before host resolution. CIDR rules are applied after host resolution. For example, if the domain “webhooks.internal.example.com” resolves to the IP address 10.0.16.20, a webhook with the URL “https://webhooks.internal.example.com/webhook” can be whitelisted using webhooks.internal.example.com or 10.0.16.16/28, but not 10.0.16.20.

This feature’s config.json setting is "AllowedUntrustedInternalConnections": "" with string input.

High Availability

Available in Enterprise Edition E20

Changes to properties in this section require a server restart before taking effect.

When High Availability mode is enabled, the System Console is set to read-only and settings can only be changed by editing the configuration file directly. However, for testing and validating a High Availability setup, you can set ReadOnlyConfig to false, which allows changes made in the System Console to be saved back to the configuration file.

To learn more about configuring High Availability, see High Availability Cluster.

Enable High Availability Mode

True: The Mattermost Server will attempt inter-node communication with the other servers in the cluster that have the same Cluster Name. This sets the System Console to read-only mode to keep the servers config.json files in sync.

False: Mattermost high availability is disabled.

This feature’s config.json setting is "Enable": false with options true and false.

Cluster Name

The cluster to join by name. Only nodes with the same cluster name will join together. This is to support blue-green deployments or staging pointing to the same database.

This feature’s config.json setting is "ClusterName": "" with string input.

Override Hostname

If blank, Mattermost attempts to get the hostname from the OS or use the IP address. You can override the hostname of this server with this property. It is not recommended to override the Hostname unless needed. This property can also be set to a specific IP address if needed. Also see cluster discovery for more details.

This feature’s config.json setting is "OverrideHostname": "" with string input.

Use IP Address

True: The cluster attempts to communicate using the IP address.

False: The cluster attempts to communicate using the hostname.

This feature’s config.json setting is "UseIpAddress": true with options true and false.

Use Experimental Gossip

True: The server attempts to communicate via the gossip protocol over the gossip port.

False: The server attempts to communicate over the streaming port.

Note that the gossip port and gossip protocol are used to determine cluster health even when this setting is false.

This feature’s config.json setting is "UseExperimentalGossip": false with options true and false.

Read Only Config

True: Changes made to settings in the System Console are ignored.

False: Changes made to settings in the System Console are written to config.json.

When running in production it is recommended to set this to true.

This feature’s config.json setting is "ReadOnlyConfig": true with options true and false.

Gossip Port

The port used for the gossip protocol. Both UDP and TCP should be allowed on this port.

This feature’s config.json setting is "GossipPort": 8074 with numerical input.

Streaming Port

The port used for streaming data between servers.

This feature’s config.json setting is "StreamingPort": 8075 with numerical input.

Inter-Node Listen Address

Deprecated. Not used in version 4.0 and later

The address the Mattermost Server will listen on for inter-node communication. When setting up your network you should secure the listen address so that only machines in the cluster have access to that port. This can be done in different ways, for example, using IPsec, security groups, or routing tables.

This feature’s config.json setting is "InterNodeListenAddress": ":8075" with string input.

Inter-Node URLs

Deprecated. Not used in version 4.0 and later

A list of all the machines in the cluster, separated by commas, for example, ["http://10.10.10.2", "http://10.10.10.4"]. It is recommended to use the internal IP addresses so all the traffic can be secured.

This feature’s config.json setting is "InterNodeUrls": [] with string array input consisting of the machines in the cluster.

Performance Monitoring

Available in Enterprise Edition E20

Changes to properties in this section require a server restart before taking effect.

Enable Performance Monitoring

True: Mattermost enables performance monitoring collection and profiling. Please see documentation to learn more about configuring performance monitoring for Mattermost.

False: Mattermost performance monitoring is disabled.

This feature’s config.json setting is "Enable": false with options true and false.

Listen Address

The address the Mattermost server will listen on to expose performance metrics.

This feature’s config.json setting is "InterNodeListenAddress": ":8067" with string input.

Settings configurable only in config.json

There are a number of settings customizable in config.json unavailable in the System Console and require updating from the file itself.

Service Settings

WebSocket URL

This setting allows the server to instruct clients where they should try to connect WebSockets to.

This feature’s config.json setting is "WebsocketURL": "" with string input.

License File Location

Path and filename of the license file on disk. On startup, if Mattermost cannot find a valid license in the database from a previous upload, it looks here. It can be an absolute path or a path relative to the mattermost directory.

This feature’s config.json setting is "LicenseFileLocation": "" with string input.

TLS Minimum Version

The minimum TLS version used by the Mattermost server. TLS v1.2 is default given insecurities for TLS 1.0 and 1.1.

This setting only takes effect if you are using the built-in server binary directly, and not using a reverse proxy layer such as NGINX.

This feature’s config.json setting is "TLSMinVer": "1.2" with string input.

Enable Strict Transport Security (HSTS)

True: Adds the Strict Transport Security (HSTS) header to all responses, forcing the browser to request all resources via HTTPS. Learn more here.

False: No restrictions on TLS transport. Strict Transport Security (HSTS) header is not added to responses.

This feature’s config.json setting is "TLSStrictTransport": false with options true and false.

Secure TLS Transport Expiry

The time in seconds that the browser remembers a site is only to be accessed using HTTPS. After this period, a site can be accessed using HTTP unless TLSStrictTransport is set to true. Defaults to two years. Learn more here.

This feature’s config.json setting is "TLSStrictTransportMaxAge": 63072000 with numerical input.

TLS Cipher Overwrites

Set TLS ciphers overwrites to meet requirements from legacy clients which don’t support modern ciphers, or to limit the types of accepted ciphers.

If none specified, the Mattermost server assumes a set of currently considered secure ciphers, and allows overwrites in the edge case. See the ServerTLSSupportedCiphers variable in /model/config.go for the list of ciphers considered secure.

This setting only takes effect if you are using the built-in server binary directly, and not using a reverse proxy layer such as NGINX.

This feature’s config.json setting is "TLSStrictTransportMaxAge": 63072000 with numerical input.

Go Routine Health Threshold

Set a threshold on the number of Go Routines when the Mattermost system is considered to be in a healthy state. When Go Routines exceed this limit, a warning is returned in the server logs.

To turn off checking for the threshold, set this value to -1.

This feature’s config.json setting is "GoroutineHealthThreshold": -1 with numerical input.

Allow Cookies for Subdomains

True: Allows cookies for subdomains by setting the domain parameter on Mattermost cookies.

False: Cookies not allowed for subdomains.

This feature’s config.json setting is "AllowCookiesForSubdomains": true with options true and false.

Cluster Log Timeout

This setting defines the frequency of cluster request time logging for Performance Monitoring (E20), measured in milliseconds.

This feature’s config.json setting is "ClusterLogTimeoutMilliseconds": 2000 with numerical input.

Enable Searching of Posts

If this setting is enabled, users can search messages. Disabling search can result in a performance increase, but users get an error message when they attempt to use the search box.

This feature’s config.json setting is "EnablePostSearch": true with options true and false.

Enable User Typing Messages

This setting determines whether “user is typing…” messages are displayed below the message box. Disabling the setting in larger deployments may improve server performance.

This feature’s config.json setting is "EnableUserTypingMessages": true with options true and false.

Time Between User Typing Updates

This setting defines how frequently “user is typing…” messages are updated, measured in milliseconds.

This feature’s config.json setting is "TimeBetweenUserTypingUpdatesMilliseconds": 5000 with numerical input.

Enable User Status Updates

Turn status updates off to improve performance. When status updates are off, users appear online only for brief periods when posting a message, and only to members of the channel in which the message is posted.

This feature’s config.json setting is "EnableUserStatuses": true with options true and false.

Enable Channel Viewed WebSocket Messages

This setting determines whether channel_viewed WebSocket events are sent, which synchronize unread notifications across clients and devices. Disabling the setting in larger deployments may improve server performance.

This feature’s config.json setting is "EnableChannelViewedMessages": true with options true and false.

Segment Write Key

Removed in March 16, 2017 release

For deployments seeking additional tracking of system behavior using Segment.com, you can enter a Segment WRITE_KEY using this field. This value works like a tracking code and is used in client-side Javascript and will send events to Segment.com attributed to the account you used to generate the WRITE_KEY.

This feature’s config.json setting is "SegmentDeveloperKey": "" with string input.

WebSocket Secure Port

(Optional) This setting defines the port on which the secured WebSocket will listen using the wss protocol. Defaults to 443. When the client attempts to make a WebSocket connection it first checks to see if the page is loaded with HTTPS. If so, it will use the secure WebSocket connection. If not, it will use the unsecure WebSocket connection. IT IS HIGHLY RECOMMENDED PRODUCTION DEPLOYMENTS ONLY OPERATE UNDER HTTPS AND WSS.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "WebsocketSecurePort" : 443 with numerical input.

WebSocket Port

(Optional) This setting defines the port on which the unsecured WebSocket will listen using the ws protocol. Defaults to 80. When the client attempts to make a WebSocket connection it first checks to see if the page is loaded with HTTPS. If so, it will use the secure WebSocket connection. If not, it will use the unsecure WebSocket connection. IT IS HIGHLY RECOMMENDED PRODUCTION DEPLOYMENTS ONLY OPERATE UNDER HTTPS AND WSS.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is WebsocketPort": 80 with numerical input.

Enable API Team Deletion

True: The api/v4/teams/{teamid}?permanent=true API endpoint can be called by Team and System Admins to permanently delete a team.

False: The API endpoint cannot be called. Note that api/v4/teams/{teamid} can still be used to soft delete a team.

This feature’s config.json setting is "EnableAPITeamDeletion": false with options true and false.

SQL Settings

Enable Public Channels Materialization

Removed in December 16, 2018 release. The public channel materialization feature has become a permanent feature after thoroughly tested for performance.

True: Enables materialization of public channels to increase channel search performance in the channel switcher (CTRL/CMD+K), channel autocomplete (~) and elsewhere in the UI. Notably, this allows the database to exclude direct messages for many queries, resulting in better query plans and more efficient indexes.

False: Disables materialization for public channels.

If this feature is disabled and then later re-enabled, an offline migration is necessary to synchronize the materialized table. Use the following steps:

  1. Shut down your application servers.
  2. Connect to your Mattermost database.
  3. Execute the following queries:
DELETE FROM PublicChannels;
INSERT INTO PublicChannels
    (Id, DeleteAt, TeamId, DisplayName, Name, Header, Purpose)
SELECT
    c.Id, c.DeleteAt, c.TeamId, c.DisplayName, c.Name, c.Header, c.Purpose
FROM
    Channels c
WHERE
    c.Type = 'O';

The queries above rebuild the materialized PublicChannels table without modifying the authoritative Channels table.

This feature’s config.json setting is "EnablePublicChannelsMaterialization": true with options true and false.

Read Replicas (Enterprise Edition)

Specifies the connection strings for the read replica databases. Each string must be in the same form as used for the Data Source setting.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "DataSourceReplicas": [] with string array input consisting of database connection strings.

Search Replicas (Enterprise Edition)

Specifies the connection strings for the search replica databases. A search replica is similar to a read replica, but is used only for handling search queries. Each string must be in the same form as used for the Data Source setting.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "DataSourceSearchReplicas": [] with string array input consisting of database connection strings.

Team Settings

User Status Away Timeout

This setting defines the number of seconds after which the user’s status indicator changes to “Away”, when they are away from Mattermost.

This feature’s config.json setting is "UserStatusAwayTimeout": 300 with numerical input.

File Settings

Initial Font

Font used in auto-generated profile pics with colored backgrounds.

This feature’s config.json setting is "InitialFont": "luximbi.ttf" with string input.

Amazon S3 Bucket Endpoint

Set an endpoint URL for Amazon S3 buckets.

Removed in November 16th, 2016 release

This feature’s config.json setting is "AmazonS3BucketEndpoint": "" with string input.

Amazon S3 Location Constraint

True: S3 region is location constrained.

False: S3 region is not location constrained.

Removed in November 16th, 2016 release

This feature’s config.json setting is "AmazonS3LocationConstraint": false with options true and false.

Amazon S3 Lowercase Bucket

True: S3 bucket names are fully lowercase.

False: S3 bucket names may contain uppercase and lowercase letters.

Removed in November 16th, 2016 release

This feature’s config.json setting is "AmazonS3LowercaseBucket": false with options true and false.

Amazon S3 Signature V2

By default, Mattermost uses Signature V4 to sign API calls to AWS, but under some circumstances, V2 is required. For more information about when to use V2, see https://docs.aws.amazon.com/general/latest/gr/signature-version-2.html

True: Use Signature Version 2 Signing Process.

False: Use Signature Version 4 Signing Process.

This feature’s config.json setting is "AmazonS3SignV2": false with options true and false.

Email Settings

Email Batching Buffer Size

Specify the maximum number of notifications batched into a single email.

This feature’s config.json setting is EmailBatchingBufferSize": 256 with numerical input.

Email Batching Interval

Specify the maximum frequency, in seconds, which the batching job checks for new notifications. Longer batching intervals will increase performance.

This feature’s config.json setting is EmailBatchingInterval": 30 with numerical input.

Skip Server Certificate Verification

True: Do not validate SMTP servers when connecting to them.

False: Validate SMTP servers when connecting to them.

This feature’s config.json setting is "SkipServerCertificateVerification": false with options true and false.

Login Button Color

Specify the color of the email login button for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile apps.

This feature’s config.json setting is "LoginButtonColor": "" with string input.

Login Button Border Color

Specify the color of the email login button border for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile apps.

This feature’s config.json setting is "LoginButtonBorderColor": "" with string input.

Login Button Text Color

Specify the color of the email login button text for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile apps.

This feature’s config.json setting is "LoginButtonTextColor": "" with string input.

GitLab Settings

Scope

Standard setting for OAuth to determine the scope of information shared with OAuth client. Not currently supported by GitLab OAuth.

This feature’s config.json setting is "Scope": "" with string input.

Google Settings

Scope

Standard setting for OAuth to determine the scope of information shared with OAuth client. Recommended setting is profile email.

This feature’s config.json setting is "Scope": "profile email" with string input.

Office 365 Settings

Scope

Standard setting for OAuth to determine the scope of information shared with OAuth client. Recommended setting is User.Read.

This feature’s config.json setting is "Scope": "User.Read" with string input.

AD/LDAP Settings

Login Button Color

Specify the color of the AD/LDAP login button for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile apps.

This feature’s config.json setting is "LoginButtonColor": "" with string input.

Login Button Border Color

Specify the color of the AD/LDAP login button border for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile apps.

This feature’s config.json setting is "LoginButtonBorderColor": "" with string input.

Login Button Text Color

Specify the color of the AD/LDAP login button text for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile apps.

This feature’s config.json setting is "LoginButtonTextColor": "" with string input.

SAML Settings

Login Button Color

Specify the color of the SAML login button for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile apps.

This feature’s config.json setting is "LoginButtonColor": "" with string input.

Login Button Border Color

Specify the color of the SAML login button border for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile apps.

This feature’s config.json setting is "LoginButtonBorderColor": "" with string input.

Login Button Text Color

Specify the color of the SAML login button text for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile apps.

This feature’s config.json setting is "LoginButtonTextColor": "" with string input.

Cluster Settings

Maximum Idle Connections

The maximum number of idle connections held open from one server to all others in the cluster.

This feature’s config.json setting is "MaxIdleConns": 100 with numerical input.

Maximum Idle Connections per Host

The maximum number of idle connections held open from one server to another server in the cluster.

This feature’s config.json setting is "MaxIdleConnsPerHost": 128 with numerical input.

Idle Connection Timeout (in Milliseconds)

The number of milliseconds to leave an idle connection open between servers in the cluster.

This feature’s config.json setting is "IdleConnTimeoutMilliseconds": 90000 with numerical input.

Metrics Settings

Block Profile Rate

Value that controls the fraction of goroutine blocking events reported in the blocking profile.

The profiler aims to sample an average of one blocking event per rate nanoseconds spent blocked.

To include every blocking event in the profile, set the rate to 1. To turn off profiling entirely, set the rate to 0.

Changes to this setting require a server restart before taking effect.

This feature’s config.json setting is "BlockProfileRate": 0 with options 0 and 1.

Experimental Settings

Available in Enterprise Edition E20

Enable Client-Side Certification

True: Enables client-side certification for your Mattermost server. See documentation to learn more.

False: Client-side certification is disabled.

This feature’s config.json setting is "ClientSideCertEnable": false with options true and false.

Client-Side Certification Login Method

Used in combination with the ClientSideCertEnable setting.

Primary: After the client side certificate is verified, user’s email is retrieved from the certificate and is used to log in without a password.

Secondary: After the client side certificate is verified, user’s email is retrieved from the certificate and matched against the one supplied by the user. If they match, the user logs in with regular email/password credentials.

This feature’s config.json setting is "ClientSideCertCheck": "secondary" with options "primary" and "secondary".

Disable Post Metadata

True: Disabling post metadata is only recommended if you are experiencing a significant decrease in performance around channel and post load times.

False: Load channels with more accurate scroll positioning by loading post metadata.

This feature’s config.json setting is "DisablePostMetadata": false with options true and false.

Analytics Settings

Available in Enterprise Edition E10 and higher

Maximum Users for Statistics

Sets the maximum number of users on the server before statistics for total posts, total hashtag posts, total file posts, posts per day, and active users with posts per day are disabled.

This setting is used to maximize performance for large Enterprise deployments.

This feature’s config.json setting is "MaxUsersForStatistics": 2500 with numerical input.

Elasticsearch Settings (Beta)

Post Index Replicas

The number of replicas to use for each post index. If this setting is changed, it only applies to newly created indexes. To apply the change to existing indexes, purge and rebuild the index after changing this setting.

This feature’s config.json setting is "PostIndexReplicas": 2 with numerical input.

Post Index Shards

The number of shards to use for each post index. If this setting is changed, it only applies to newly created indexes. To apply the change to existing indexes, purge and rebuild the index after changing this setting.

This feature’s config.json setting is "PostIndexShards": 1 with numerical input.

Aggregate Search Indexes

Elasticsearch indexes over the age specified by this setting will be aggregated during the daily scheduled job.

This feature’s config.json setting is "AggregatePostsAfterDays": 365 with numerical input.

Post Aggregator Start Time

The start time of the daily scheduled aggregator job. Must be a 24-hour time stamp in the form HH:MM.

This setting is based on the local time of the server.

This feature’s config.json setting is "PostsAggregatorJobStartTime": "03:00" with 24-hour timestamp input in the form "HH:MM".

Index Prefix

Prefix on the Elasticsearch index name. Enables the use of Mattermost Elasticsearch on a shared Elasticsearch cluster.

This feature’s config.json setting is "IndexPrefix": "" with string input.

Live Indexing Batch Size

Determines how many new posts are batched together before they are added to the Elasticsearch index. It may be necessary to increase this value to avoid hitting the rate limit of your Elasticsearch cluster on installs handling multiple messages per second.

This feature’s config.json setting is "LiveIndexingBatchSize": 1 with numerical input.

Request Timeout

Timeout in seconds for Elasticseaerch calls.

This feature’s config.json setting is "RequestTimeoutSeconds": 30 with numerical input.

Bulk Indexing Time Window

Determines the maximum time window for a batch of posts being indexed by the Bulk Indexer. This setting servers as a performance optimisation for installs with over ~10 million posts in the database. Approximate this value based on the average number of seconds for 2,000 posts to be added to the database on a typical day in production. Setting this value too low will cause Bulk Indexing jobs to run slowly.

This feature’s config.json setting is "BulkIndexingTimeWindowSeconds": 3600 with numerical input.

Message Export Settings

Export From Timestamp

Set the Unix timestamp (seconds since epoch, UTC) to export data from.

This feature’s config.json setting is "ExportFromTimestamp": 0 with numerical input.

File Location

Set the file location of the compliance exports.

By default, they are written to the exports subdirectory of the configured Local Storage directory <https://docs.mattermost.com/administration/config-settings.html#storage>.

This feature’s config.json setting is "FileLocation": "export" with string input.

Batch Size

Determines how many new posts are batched together to a compliance export file.

This feature’s config.json setting is "BatchSize": 10000 with numerical input.

Plugin Settings (Beta)

Enable Plugin Uploads

True: Enables plugin uploads by System Admins at Plugins > Management. If you do not plan to upload a plugin, set to false to control which plugins are installed on your server. See documentation to learn more.

False: Disables plugin uploads on your Mattermost server.

This feature’s config.json setting is "EnableUploads": false with options true and false.

Directory

The location of the plugin files. If blank, they are stored in the ./plugins directory. The path that you set must exist and Mattermost must have write permissions in it.

This feature’s config.json setting is "Directory": "./plugins" with string input.

Experimental Settings

There are a number of settings considered “experimental” and these may be replaced or removed in a future release.

Service Settings

Enable Tutorial (Experimental)

True: Users are prompted with a tutorial when they open Mattermost for the first time after account creation.

False: The tutorial is disabled. Users are placed in Town Square when they open Mattermost for the first time after account creation.

This feature’s config.json setting is "EnableTutorial": true with options true and false.

Enable Default Channel Leave/Join System Messages

This setting determines whether team leave/join system messages are posted in the default town-square channel.

True: Enables leave/join system messages in the default town-square channel.

False: Disables leave/join messages from the default town-square channel. These system messages won’t be added to the database either.

This feature’s config.json setting is "ExperimentalEnableDefaultChannelLeaveJoinMessages": true with options true and false.

Allow Authentication Transfer (Experimental)

Available in Enterprise Edition E10 and higher

True: Users can change their sign-in method to any that is enabled on the server, either via Account Settings or the APIs.

False: Users cannot change their sign-in method, regardless of which authentication options are enabled.

This feature’s config.json setting is "ExperimentalEnableAuthenticationTransfer": true with options true and false.

Autoclose Direct Messages in Sidebar (Experimental)

True: By default, direct message conversations with no activity for 7 days will be hidden from the sidebar. Users can disable this in Account Settings > Sidebar.

False: Conversations remain in the sidebar until they are manually closed.

This feature’s config.json setting is "CloseUnusedDirectMessages": false with options true and false.

Enable Preview Features (Experimental)

True: Preview features can be enabled from Account Settings > Advanced > Preview pre-release features.

False: Disables and hides preview features from Account Settings > Advanced > Preview pre-release features.

This feature’s config.json setting is "EnablePreviewFeatures": true with options true and false.

Group Unread Channels (Experimental)

Removed in December 16, 2018 release and replaced by a new ExperimentalChannelOrganization setting

Disabled: Unread channels section is disabled for all users.

Default On: Enables the unread channels sidebar section by default. Users can turn it off in Account Settings > Sidebar.

Default Off: Disables the unread channels sidebar section by default. Users can turn it on in Account Settings > Sidebar.

This feature’s config.json setting is "ExperimentalGroupUnreadChannels": "disabled" with options "disabled", "default_on", and "default_off".

Enable Hardened Mode (Experimental)

True: Enables a hardened mode for Mattermost that makes user experience trade-offs in the interest of security.

False: Disables hardened mode.

Changes made when hardened mode is enabled:

  • Failed login returns a generic error message instead of a specific message for username and password.
  • If multi-factor authentication (MFA) is enabled, the route to check if a user has MFA enabled always returns true. This causes the MFA input screen to appear even if the user does not have MFA enabled. The user may enter any value to pass the screen. Note that hardened mode does not affect user experience when MFA is enforced.
  • Password reset does not inform the user that they can not reset their SSO account through Mattermost and instead claims to have sent the password reset email.
  • Mattermost sanitizes all 500 errors before returned to the client. Use the supplied request_id to match user facing errors with the server logs.
This feature’s config.json setting is "ExperimentalEnableHardenedMode": false with options true and false.

Enable AD/LDAP Group Sync (Experimental)

Available in Enterprise Edition E20

True: Enables AD/LDAP Group Sync configurable under Access Controls > Groups.

False: Disables AD/LDAP Group Sync and removes the Access Controls > Groups from the System Console.

For more information on AD/LDAP Group Sync, please see the AD/LDAP Group Sync documentation.

This feature’s config.json setting is "ExperimentalLdapGroupSync": false with options true and false.

Strict CSRF Token Enforcement (Experimental)

True: Enables CSRF protection tokens for additional hardening compared to the currently used custom header. When the user logs in, an additional cookie is created with the CSRF token contained.

False: Disables CSRF protection tokens.

This feature’s config.json setting is "ExperimentalStrictCSRFEnforcement": false with options true and false.

Limit Access to Config Settings Prior to Login

Removed in December 16, 2018 release

Enable this setting to limit the number of config settings sent to users prior to login.

Supported for Mattermost server v5.1.0 and later, and Mattermost Mobile apps v1.10.0 and later.

This feature’s config.json setting is "ExperimentalLimitClientConfig": "false" with options true and false.

Disable Legacy MFA API Endpoint

True: Disables the legacy checkMfa endpoint, which is only required for Mattermost Mobile Apps on version 1.16 or earlier when using multi-factor authentication (MFA). Recommended to set to true for additional security hardening.

False: Keeps the legacy checkMfa endpoint enabled to support mobile versions 1.16 and earlier. Keeping the endpoint enabld creates an information disclosure about whether a user has set up MFA.

This feature’s config.json setting is "DisableLegacyMFA": true, with options true and false.

Restrict System Admin (Experimental)

True: Restricts the System Admin from viewing and modifying a subset of server configuration settings from the System Console. Not recommended for use in on-prem installations. This is intended to support Mattermost Private Cloud in giving the System Admin role to users but restricting certain actions only for Cloud Administrators.

False: No restrictions are applied to the System Admin role.

This feature’s config.json setting is "RestrictSystemAdmin": false, with options true and false.

Team Settings

Primary Team (Experimental)

The primary team of which users on the server are members. When a primary team is set, the options to join other teams or leave the primary team are disabled.

If the team URL of the primary team is https://example.mattermost.com/myteam/, then set the value to myteam in config.json.

This feature’s config.json setting is "ExperimentalPrimaryTeam": "" with string input.

Default Channels (Experimental)

Default channels every user is added to automatically after joining a new team. Only applies to public channels, but affects all teams on the server.

When not set, every user is added to off-topic and town-square channel by default.

Note that even if town-square is not listed, every user is added to that channel after joining a new team.

This feature’s config.json setting is "ExperimentalDefaultChannels": [] with string array input consisting of channel names, such as ["announcement", "developers"].

Enable X to Leave Channels from Left-Hand Sidebar (Experimental)

True: Users can leave Public and Private Channels by clicking the “x” beside the channel name.

False: Users must use the Leave Channel option from the channel menu to leave channels.

This feature’s config.json setting is "EnableXToLeaveChannelsFromLHS": false with options true and false.

Town Square is Read-Only (Experimental)

Available in Enterprise Edition E10 and higher

True: Only System Admins can post in Town Square. Other members are not able to post, reply, upload files, emoji react, or pin messages to Town Square, nor are they able to change the channel name, header, or purpose.

False: Anyone can post in Town Square.

This feature’s config.json setting is "ExperimentalTownSquareIsReadOnly": false with options true and false.

Town Square is Hidden in Left-Hand Sidebar (Experimental)

Available in Enterprise Edition E10 and higher

True: Hides Town Square in the left-hand sidebar if there are no unread messages in the channel.

False: Town Square is always visible in the left-hand sidebar even if all messages have been read.

This feature’s config.json setting is "ExperimentalHideTownSquareinLHS": false with options true and false.

Allow Users to View Archived Channels (Experimental)

True: Allows users to view permalinks and search for content of channels that have been archived. Users can only view the content in channels of which they were a member before the channel was archived.

False: Users are unable to view permalinks and search for content of channels that have been archived.

This feature’s config.json setting is "ViewArchivedChannels": false with options true and false.

Enable Automatic Replies (Experimental)

True: Users can enable Automatic Replies in Account Settings > Notifications. Users set a custom message that will be automatically sent in response to Direct Messages.

False: Disables the Automatic Direct Message Replies feature and hides it from Account Settings.

This feature’s config.json setting is "ExperimentalEnableAutomaticReplies": false with options true and false.

Email Settings

Use Channel Name in Email Notifications (Experimental)

True: Channel and team name appears in email notification subject lines. Useful for servers using only one team.

False: Only team name appears in email notification subject line.

This feature’s config.json setting is "UseChannelInEmailNotifications": false with options true and false.

Client Requirement Settings (Experimental)

Latest Android Version

The latest version of the Android React Native app that is recommended for use.

This feature’s config.json setting is "AndroidLatestVersion": "" with string input corresponding to a version string, such as "1.2.0".

Minimum Android Version

The minimum version of the Android React Native app that is required to be used.

This feature’s config.json setting is "AndroidMinVersion": "" with string input corresponding to a version string, such as "1.2.0".

Latest Desktop Version

The latest version of the desktop app that is recommended for use.

This feature’s config.json setting is "DesktopLatestVersion": "" with string input corresponding to a version string, such as "1.2.0".

Minimum Destop Version

The minimum version of the desktop app that is required to be used.

This feature’s config.json setting is "DesktopMinVersion": "" with string input corresponding to a version string, such as "1.2.0".

Latest iOS Version

The latest version of the iOS app that is recommended for use.

This feature’s config.json setting is "IosLatestVersion": "" with string input corresponding to a version string, such as "1.2.0".

Minimum iOS Version

The minimum version of the iOS React Native app that is required to be used.

This feature’s config.json setting is "IosMinVersion": "" with string input corresponding to a version string, such as "1.2.0".

Theme Settings (Experimental)

Enable Theme Selection

Available in Enterprise Edition E10 and higher

True: Enables the Display > Theme tab in Account Settings so users can select their theme.

False: Users cannot select a different theme. The Display > Theme tab is hidden in Account Settings.

This feature’s config.json setting is "EnableThemeSelection": true with options true and false.

Default Theme

Available in Enterprise Edition E10 and higher

Set a default theme that applies to all new users on the system.

This feature’s config.json setting is "DefaultTheme": "default" with options "default", "organization", "mattermostDark", and "windows10".

Allow Custom Themes

Available in Enterprise Edition E10 and higher

True: Enables the Display > Theme > Custom Theme section in Account Settings.

False: Users cannot use a custom theme. The Display > Theme > Custom Theme section is hidden in Account Settings.

This feature’s config.json setting is "AllowCustomThemes": true with options true and false.

Allowed Themes

Available in Enterprise Edition E10 and higher

Select the themes that can be chosen by users when "EnableThemeSelection" is set to true.

This feature’s config.json setting is "AllowedThemes": [] with string array input consisting of the options "default", "organization", "mattermostDark", and "windows10", such as ["mattermostDark", "windows10"].

Display Settings (Experimental)

Timezone

Select the timezone used for timestamps in the user interface and email notifications.

True: The Timezone setting is visible in the Account Settings and a time zone is automatically assigned in the next active session.

False: The Timezone setting is hidden in the Account Settings.

This feature’s config.json setting is "ExperimentalTimezone": false with options true and false.

Supported Timezones Path

Removed in April 16, 2019 release

Set the path of the JSON file that lists supported timezones when ExperimentalTimezone is set to true.

The file must be in the same directory as your config.json file if you set a relative path. Defaults to timezones.json.

This feature’s config.json setting is "SupportedTimezonesPath": "timezones.json" with string input.

Jobs

Settings to configure the how Mattermost schedules and completes periodic tasks such as the deletion of old posts with Data Retention enabled or indexing of posts with Elasticsearch. These settings control which Mattermost servers are designated as a Scheduler, a server that queues the tasks at the correct times, and as a Worker, a server that completes the given tasks.

  • When running Mattermost on a single machine, both RunJobs and RunScheduler should be enabled. Without both of these enabled, Mattermost will not function properly.
  • When running Mattermost in High Availability mode, RunJobs should be enabled on one or more servers while RunScheduler should be enabled on all servers under normal circumstances. A High Availability cluster will have one Scheduler and one or more Workers. See the below sections for more information.

Run Jobs

Set whether or not this Mattermost server will handle tasks created by the Scheduler.

  • When running Mattermost on a single machine, this setting should always be enabled.
  • When running Mattermost in High Availablity mode, one or more servers should have this setting enabled. It is recommended that a High Availability cluster has one or more dedicated Workers with this setting enabled while the remaining Mattermost app servers have it disabled.
This feature’s config.json setting is "RunJobs": true with options true and false.

Run Scheduler

Set whether or not this Mattermost server will schedule tasks that will be completed by a Worker.

  • When running Mattermost on a single machine, this setting should always be enabled.
  • When running Mattermost in High Availablity mode, this setting should always be enabled. In a High Availability cluster, exactly one of the servers will be designated as the Scheduler at a time to ensure that duplicate tasks aren’t created. See High Availability documentation for more details.
This feature’s config.json setting is "RunScheduler": true with options true and false.