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
This feature was moved to Team Edition in Mattermost v5.0, released June 16th, 2018. Prior to v5.0, this feature is available in legacy Enterprise Edition E10 and 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. If this field is empty, those links do not appear. String input. Default is |
|
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: From Mattermost v5.17, 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: From Mattermost v5.17, 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 |
|
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 |
|
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 |
|
Default client language
The default language for new users and pages where the user isn’t logged in. Options: Default is |
|
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 active and inactive 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 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
|
|
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 preview mode banner
|
|
Note: Cloud admins can’t modify this configuration setting. |
Enable email batching
|
|
Notes:
|
Email notification contents
Note
Available only on Enterprise plans
Available in legacy 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
|
|
Announcement banner
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 > Announcement Banner.
Enable announcement banner
|
|
Banner text
The text of the announcement banner. If no text is provided, the banner will not appear. String input. |
|
Banner color
The background color of the announcement banner. String input of a CSS color value. |
|
Banner text color
The color of the text in the announcement banner. String input of a CSS color value. |
|
Allow banner dismissal
|
|
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: Too many 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:
|
Collapsed reply threads
Important
Customers upgrading to v7.0 must review the administrator’s guide to enabling Collapsed Reply Threads prior to enabling this functionality.
|
|
Message priority
|
-
config.json setting: .ServiceSettings.PostPriority: true
|
Note: Mattermost Professional or Enterprise 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. |
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
|
|
Enable LaTeX code block rendering
|
|
Warning: Choose false to prevent Mattermost from crashing due to code outgrowing its assigned memory when it is rendered. |
Enable inline LaTeX rendering
|
|
Warning: Choose false to prevent Mattermost from crashing due to code outgrowing its assigned memory when it is rendered. |
Custom URL schemes
A list of URL schemes that will automatically create a link in message text, for example:
|
|
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:
|
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
Available in legacy Enterprise Edition E20
|
|
Allow file downloads on mobile
Note
Available only on Enterprise plans
Available in legacy 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
|
|