Site configuration settings#
Available on all plans
Cloud and self-hosted deployments
Both self-hosted and Cloud admins can access the following configuration settings in the System Console by going to Site Configuration. Self-hosted admins can also edit the config.json
file as described in the following tables.
Customization#
Available on all plans
Cloud and self-hosted deployments
Access the following configuration settings in the System Console by going to Site Configuration > Customization.
Site name#
Name of the site shown in login screens and user interface. String input. Maximum 30 characters. Default is |
|
Site description#
Text displayed above the login form. When not specified, the phrase “Log in” is displayed. String input. |
|
Enable custom branding#
Also available in legacy Mattermost Enterprise Edition E10 or E20
See also the custom brand image and custom brand text configuration settings for more branding options. |
|
Custom brand image#
A JPG image for display on the login page. The image must be uploaded through the System Console. There is no Enable custom branding must be set to true to display the image. |
|
Custom brand text#
Text that will be shown below the Custom brand image on the login page. You can format this text using the same Markdown formatting as in Mattermost messages. String input. Maximum 500 characters. Enable custom branding must be set to true to display the text. |
|
Enable Ask Community link#
The link does not display on mobile apps. |
|
Help link#
This field sets the URL for the Help link on the login and sign up pages, as well as the Help Resources link under the Help menu in the channel header. String input. Default is |
|
Note: If this value is empty, the Help link is hidden on the login and sign up pages. However, the Help Resources link remains available under the Help menu. |
Terms of Use link#
Note
Available only for self-hosted deployments
This field sets the URL for the Terms of Use of a self-hosted site. A link to the terms appears at the bottom of the sign-up and login pages. The default URL links to a Terms of Use page hosted on String input. Default is |
|
Note: This setting doesn’t change the Terms of Use link in the About Mattermost window. |
Privacy Policy link#
Note
Available only for self-hosted deployments
This field sets the URL for the Privacy Policy of a self-hosted site. A link to the policy appears at the bottom of the sign-up and login pages. If this field is empty, the link does not appear. String input. Default is |
|
Note: This setting does not change the Privacy Policy link in the About Mattermost window. |
About link#
Note
Available only for self-hosted deployments
This field sets the URL for a page containing general information about a self-hosted site. A link to the About page appears at the bottom of the sign-up and login pages. If this field is empty the link does not appear. String input. Default is |
|
Forgot Password custom link#
When the Forgot Password link is enabled on the Mattermost login page, users are taken to a custom URL to recover or change their password. Leave this field blank to use Mattermost’s Password Reset workflow. |
|
Notes:
|
Report a Problem link#
Note
Available only for self-hosted deployments
This field sets the URL for the Report a Problem link in the channel header Help menu. If this field is empty the link does not appear. String input. Default is |
|
Mattermost apps download page link#
Note
Available only for self-hosted deployments
This field sets the URL for the Download Apps link in the Product menu. If this field is empty, the link does not appear. If you have an Enterprise App Store, set the link to the appropriate download page for your Mattermost apps. String input. Default is |
|
Android app download link#
Note
Available only for self-hosted deployments
This field sets the URL to download the Mattermost Android app. Users who access the Mattermost site on a mobile browser will be prompted to download the app through this link. If this field is empty, the prompt does not appear. If you have an Enterprise App Store, link to your Android app. String input. Default is |
|
iOS app download link#
Note
Available only for self-hosted deployments
This field sets the URL to download the Mattermost iOS app. Users who access the site on a mobile browser will be prompted to download the app through this link. If this field is empty, the prompt does not appear. If you use an Enterprise App Store, link to your iOS app. String input. Default is |
|
App custom URL schemes#
This setting isn’t available in the System Console and can only be set in config.json
.
Define valid custom URL schemes for redirect links provided by custom-built mobile Mattermost apps. This ensures users are redirected to the custom-built mobile app and not Mattermost’s mobile client.
When configured, after OAuth or SAML user authentication is complete, custom URL schemes sent by mobile clients are validated to ensure they don’t include default schemes such as http
or https
. Mobile users are then redirected back to the mobile app using the custom scheme URL provided by the mobile client. We recommend that you update your mobile client values as well with valid custom URL schemes.
This feature’s |
For example:
|
Localization#
Available on all plans
Cloud and self-hosted deployments
Access the following configuration settings in the System Console by going to Site Configuration > Localization. Changes to configuration settings in this section require a server restart before taking effect.
Default server language#
The default language for system messages and logs. Options: Default is |
|
Note: Changing this configuration setting changes the default server language for users who haven’t set a language preference via Settings. Mattermost applies the user’s language preference when specified. |
Default client language#
The default language for new users and pages where the user isn’t logged in. Options: Default is |
|
Note: Changing this configuration setting changes the default client language for users who haven’t set a language preference via Settings. Mattermost applies the user’s language preference when specified. |
Available languages#
Sets the list of languages users see under Settings > Display > Language.
If this field is left blank, users see all supported languages.
Newly supported languages are added automatically.
If this field is not blank, it must contain the Default client language,
in addition to any other languages. For example, to limit the language
choices to US English and Español (es), the string would be Options: Default is |
|
Users and teams#
Available on all plans
Cloud and self-hosted deployments
Access the following configuration settings in the System Console by going to Site Configuration > Users and Teams.
Max users per team#
The Max users per team is the maximum total number of users per team, including activated and deactivated users. In Mattermost, a team of people should be a small organization with a specific goal. In the physical world, a team could sit around a single table. The default maximum (50) should be enough for most teams, but with appropriate hardware, this limit can be increased to thousands of users. Channels are another way of organizing communications within teams on different topics. Numerical input. Default is 50 self-hosted deployments, and 10000 for Cloud deployments. |
|
Max channels per team#
The maximum number of channels per team, including both active and archived channels. Numerical input. Default is 2000 for self-hosted deployments, and 10000 for Cloud deployments. |
|
Enable join/leave messages by default#
Specify the default configuration of system messages displayed when users join or leave channels.
Users can override this default by going to Settings > Advanced > Enable Join/Leave Messages. |
|
Enable users to open direct message channels with#
This setting determines whether a user can open a direct message channel with anyone on the Mattermost server or only to members of the same team. This setting only affects the options presented in the user interface. It does not affect permissions on the backend server.
|
|
Teammate name display#
This setting determines how names appear in posts and under the Direct Messages list. Users can change this setting in their interface under Settings > Display > Teammate Name Display, unless this setting is locked by a system admin via the Lock teammate name display for all users configuration setting.
|
|
Lock teammate name display for all users#
Note
Available only on Enterprise plans
This setting controls whether users can change settings under Settings > Display > Teammate Name Display.
|
|
Allow users to view archived channels#
|
|
Note: Cloud admins can’t modify this configuration setting. |
Show email address#
|
|
Show full name#
|
|
Enable custom user statuses#
|
|
Enable last active time#
|
|
Enable custom user groups#
Note
Available only on Enterprise and Professional plans
|
|
User statistics update time#
Set the server time for updating the user post statistics, including each user’s total message count, and the timestamp of each user’s most recently sent message. Must be a 24-hour time stamp in the form |
|
Notifications#
Available on all plans
Cloud and self-hosted deployments
Access the following configuration settings in the System Console by going to Site Configuration > Notifications.
Show @channel, @all, or @here confirmation dialog#
|
|
Enable email notifications#
|
|
Notes:
|
Enable email batching#
|
|
Notes:
|
Email notification contents#
Note
Available only on Enterprise plans
Also available in legacy Mattermost Enterprise Edition E20
|
|
Notification display name#
Display name for email notifications sent from the Mattermost system. String input. No default setting. This field is required when changing settings in the System Console. |
|
Notification from address#
Email address for notification emails from the Mattermost system. This address should be monitored by a system admin. String input. Default is |
|
Support email address#
Sets a user support (or feedback) email address that is displayed on email notifications and during the Getting Started tutorial. This address should be monitored by a system admin. If no value is set, email notifications will not contain a way for users to request assistance. String input. Default is |
|
Notification reply-to address#
Email address used in the reply-to header when sending notification emails from the Mattermost system. This address should be monitored by a system admin. String input. Default is |
|
Push notification contents#
|
|
Enable notification monitoring#
Enable or disable notification metrics data collection.
|
|
See the performance monitoring documentation to learn more about Mattermost Notification Health metrics. |
System-wide notifications#
Available on Enterprise and Professional plans
Cloud and self-hosted deployments
Access the following configuration settings in the System Console by going to Site Configuration > System-wide notifications.
Enable system-wide notifications#
|
|
Emoji#
Available on all plans
Cloud and self-hosted deployments
Access the following configuration settings in the System Console by going to Site Configuration > Emoji.
Enable emoji picker#
|
|
Enable custom emoji#
|
|
Note: While Mattermost supports up to 6000 custom emojis, an increase in custom emojis can slow your server’s performance. |
Posts#
Available on all plans
Cloud and self-hosted deployments
Access the following configuration settings in the System Console by going to Site Configuration > Posts.
Automatically follow threads#
Note
Available only for self-hosted deployments
|
|
Notes:
|
Threaded discussions#
Important
Customers upgrading from a legacy Mattermost release prior to v7.0 must review the administrator’s guide to enabling threaded discussions (formally known as Collapsed Reply Threads) prior to enabling this functionality.
|
Message priority#
|
|
Note: Mattermost Enterprise or Professional customers can additionally request message acknowledgements to track that specific, time-sensitive messages have been seen and actioned. See the message priority documentation to learn more. |
Persistent notifications#
|
|
Maximum number of recipients for persistent notifications#
The maximum number of recipients users may send persistent notifications to. Numerical input. Default is 5. |
|
Frequency of persistent notifications#
The number of minutes between repeated notifications for urgent messages sent with persistent notifications. Numerical input. Default is 5. Minimum is 2. |
|
Total number of persistent notifications per post#
The maximum number of times users may receive persistent notifications. Numerical input. Default is 6. |
|
Enable website link previews#
|
|
Note: The server must be connected to the internet to generate previews. This connection can be established through a firewall or outbound proxy if necessary. |
Disable link previews for specific domains#
Use this setting to disable previews of links for specific domains. String input of a comma-separated list of domains, for example: |
|
Enable message link previews#
|
|
Enable SVGs#
|
|
Warning: Enabling SVGs is not recommended in environments where not all users are trusted. |
Enable LaTeX code block rendering#
|
|
Warning: Enabling LaTeX rendering is not recommended in environments where not all users are trusted. |
Enable inline LaTeX rendering#
|
|
Warning: Enabling LaTeX rendering isn’t recommended in environments where not all users are trusted. |
Custom URL schemes#
A list of URL schemes that will automatically create a link in message text, for example:
|
|
Maximum Markdown nodes#
The maximum number of Markdown elements (such as emojis, links, or table cells), that can be included in a single piece of text in a message. Numerical input. Default is 0 which applies a Mattermost-specified limit. |
|
Note: This limit applies to all Mattermost clients, including web, desktop app, and mobile app. |
Google API key#
Note
Available only for self-hosted deployments
If a key is provided in this setting, Mattermost displays titles of embedded YouTube videos and detects if a video is no longer available. Setting a key should also prevent Google from throttling access to embedded videos that receive a high number of views. String input. |
|
Notes:
|
Enable server syncing of message drafts#
Enable or disable the ability to synchronize draft messages across all supported Mattermost clients.
|
|
Unique emoji reaction limit#
Limit the number of unique emoji reactions on each message. Increasing this limit can lead to poor client performance. Numerical input. Default is 50. Maximum is 500. |
|
File sharing and downloads#
Available on all plans
Cloud and self-hosted deployments
Access the following configuration settings in the System Console by going to Site Configuration > File Sharing and Downloads.
Allow file sharing#
|
|
Allow file uploads on mobile#
Note
Available only on Enterprise plans
Also available in legacy Mattermost Enterprise Edition E20
|
|
Allow file downloads on mobile#
Note
Available only on Enterprise plans
Also available in legacy Mattermost Enterprise Edition E20
|
|
Public Links#
Available on all plans
self-hosted deployments
Access the following configuration settings in the System Console by going to Site Configuration > Public Links.
Enable public file links#
|
|
Note: When set to |
Public link salt#
32-character salt added to the URL of public file links. Changing this setting will invalidate all previously generated links. The salt is randomly generated when Mattermost is installed, and can be regenerated by selecting Regenerate in the System Console. String input. |
|
Notices#
Available on all plans
Cloud and self-hosted deployments
Access the following configuration settings in the System Console by going to Site Configuration > Notices.
Enable admin notices#
|
|
Enable end user notices#
|
|