docs/main/administration-guide/configure/site-configuration-settings.mdx
Review and manage the following site configuration options in the System Console by selecting the Product menu, selecting System Console, and then selecting Site Configuration:
System admins managing a self-hosted Mattermost deployment can edit the config.json file as described in the following tables. Each configuration value below includes a JSON path to access the value programmatically in the config.json file using a JSON-aware tool. For example, the SiteName value is under TeamSettings.
cat config/config.json | jq '.TeamSettings.SiteName'config.json file manually, look for an object such as TeamSettings, then within that object, find the key SiteName.Access the following configuration settings in the System Console by going to Site Configuration > Customization.
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.
</Note>- Customers with a Mattermost subscription may replace or override the Acceptable Use Policy with their own acceptable use or conduct policies, based on contractual terms with Mattermost, so long as your own terms either incorporate the Acceptable Use Policy or include equivalent terms. If you change the default link to add your own terms for using the service you provide, your new terms must include a link to the default terms so end users are aware of the Mattermost Acceptable Use Policy for Mattermost software. - This setting is applicable to self-hosted deployments only and doesn't change the Terms of Use link in the About Mattermost window.
</Note>- This setting is applicable to self-hosted deployments only and doesn't change the Privacy Policy link in the About Mattermost window.
</Note>This setting is applicable to self-hosted deployments only.
</Note>This configuration setting applies to all Mattermost clients, including web, desktop app, and mobile app. You can control whether the Forgot Password link is visible or hidden in clients by going to Authentication > Password > Enable Forgot Password Link. See the configuration documentation for details.
</Note>With self-hosted deployments, you can specify how the Report a Problem option behaves in the Mattermost app via the Help menu:
This setting is applicable to self-hosted deployments only.
</Note>This setting is applicable to self-hosted deployments only.
</Note>This setting is applicable to self-hosted deployments only.
</Note>This setting is applicable to self-hosted deployments only.
</Note>This setting is applicable to self-hosted deployments only.
</Note>This setting is applicable to self-hosted deployments only.
</Note>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.
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.
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.
</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.
</Note>Enable work in progress languages in Mattermost to review translations and identify translation gaps.
<table> <colgroup> <col style={{width: '36%'}} /> <col style={{width: '63%'}} /> </colgroup> <tbody> <tr> <td><ul><li><strong>true</strong>: Work in progress languages are available in Mattermost in addition to officially supported languages.</li><li><strong>false</strong>: <strong>(Default)</strong> Only officially supported languages are available in Mattermost.</li></ul></td> <td><ul><li>System Config path: <strong>Site Configuration > Localization</strong></li><li><code>config.json</code> setting: <code>LocalizationSettings</code> > <code>EnableExperimentalLocales</code> > <code>false</code></li><li>Environment variable: <code>MM_LOCALIZATIONETTINGS_ENABLEEXPERIMENTALLOCALES</code></li></ul></td> </tr> </tbody> </table> <Note>Access the following configuration settings in the System Console by going to Site Configuration > Localization. These settings configure automatic translation of channel messages. See the Auto-translation setup guide for deployment details.
Access the following configuration settings in the System Console by going to Site Configuration > Users and Teams.
- From Mattermost v11, this configuration setting is always enabled and no longer configurable. Users can always access archived channels where they are members. - Cloud admins can't modify this configuration setting.
</Note>From Mattermost v11.8, channel category sorting is enabled by default. When enabled, channel admins can choose a default sidebar category when creating or editing a channel. Channel admins can select an existing category, type a new category name, or clear the default category from channel settings. Members who join the channel see it under that category in their sidebar. When disabled, the default category selector is hidden.
<table> <colgroup> <col style={{width: '54%'}} /> <col style={{width: '45%'}} /> </colgroup> <tbody> <tr> <td><ul><li><strong>true</strong>: <strong>(Default)</strong> When creating or editing supported channels, channel admins see a <strong>Default category (optional)</strong> field. They can select an existing category, enter a new category name, or clear the default category from channel settings. Members who join the channel see it under that category in their sidebar.</li><li><strong>false</strong>: The default category selector is hidden when creating or editing channels.</li></ul></td> <td><ul><li>System Config path: <strong>Site Configuration > Users and Teams</strong></li><li><code>config.json</code> setting: <code>TeamSettings</code> > <code>EnableChannelCategorySorting</code> > <code>true</code></li><li>Environment variable: <code>MM_TEAMSETTINGS_ENABLECHANNELCATEGORYSORTING</code></li></ul></td> </tr> </tbody> </table>Access the following configuration settings in the System Console by going to Site Configuration > Notifications.
- Cloud admins can't modify this configuration setting. - If this setting is false, and the SMTP server is set up, account-related emails (such as authentication messages) will be sent regardless of this setting. - Email invitations and account deactivation emails aren't affected by this setting. - If you don't plan on configuring Mattermost for email, disabling this configuration setting in larger deployments may improve server performance in the following areas, particularly in high-traffic environments where performance is a key concern:
Cloud admins can't modify this configuration setting.
</Note>Cloud admins can't modify this configuration setting.
</Note>See the performance monitoring documentation to learn more about Mattermost Notification Health metrics.
</Note>Access the following configuration settings in the System Console by going to Site Configuration > System-wide notifications.
Access the following configuration settings in the System Console by going to Site Configuration > Emoji.
While Mattermost supports up to 6000 custom emojis, an increase in custom emojis can slow your server's performance.
</Note>Access the following configuration settings in the System Console by going to Site Configuration > Posts.
- This setting is applicable to self-hosted deployments only. - This setting must be enabled for threaded discussions to function. - Enabling this setting does not automatically follow threads based on previous user actions. For example, threads a user participated in prior to enabling this setting won't be automatically followed, unless the user adds a new comment or is mentioned in the thread.
</Note>Customers upgrading from a legacy Mattermost release prior to v7.0 must review the administrator's guide to enabling threaded discussions (formerly known as Collapsed Reply Threads) prior to enabling this functionality.
<table> <colgroup> <col style={{width: '100%'}} /> </colgroup> <tbody> <tr> <td><dl><dt>- <strong>Always On</strong>: <strong>(Default)</strong> Enables <a href="mm-doc:%2Fend-user-guide%2Fcollaborate%2Forganize-conversations">threaded discussions | - System Config path: **Site Configuration > Posts** |</a> | - <code>config.json</code> setting: <code>ServiceSettings</code> > <code>CollapsedThreads</code></dt><dd><p>on the server and for all users. This is the recommended configuration for optimal user experience | - Environment variable: <code>MM_SERVICESETTINGS_COLLAPSEDTHREADS</code> | and to ensure consistency in how users read and respond to threaded conversations. | | <code>config.json</code> setting: <code>"always_on"</code> | |</p></dd></dl><ul><li><strong>Default On</strong>: Enables threaded discussions on the server and for all users. | |</li><li><strong>Default Off</strong>: Enables threaded discussions on the server but <strong>not</strong> for users. | |</li><li><strong>Disabled</strong>: Users cannot enable threaded discussions. <code>config.json</code> setting: <code>"disabled"</code> | |</li></ul></td> </tr> </tbody> </table>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.
</Tip> <table> <colgroup> <col style={{width: '48%'}} /> <col style={{width: '51%'}} /> </colgroup> <tbody> <tr> <td><ul><li><strong>true</strong>: <strong>(Default)</strong> Enables message priority for all users which enables them to set a visual indiciator for important or urgent root messages.</li><li><strong>false</strong>: Disables the ability to set message priority and request acknowledgements.</li></ul></td> <td><ul><li>System Config path: <strong>Site Configuration > Posts</strong></li><li><code>config.json</code> setting: <code>ServiceSettings</code> > <code>PostPriority</code> > <code>true</code></li><li>Environment variable: <code>MM_SERVICESETTINGS_POSTPRIORITY</code></li></ul></td> </tr> </tbody> </table> <Note>Disabling this configuration setting in larger deployments may improve server performance in the following areas, particularly in environments where performance and responsiveness are critical:
Burn-on-read messages have irreversible behavior:
Disabling this feature prevents users from sending new burn-on-read messages. Once disabled, users can interact with existing burn-on-read messages.
</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.
<table> <colgroup> <col style={{width: '73%'}} /> <col style={{width: '26%'}} /> </colgroup> <tbody> <tr> <td><ul><li><strong>true</strong>: The server generates a preview of the first website, image, or YouTube video linked in a message. Users can disable website previews, but not image or YouTube previews, under <strong>Settings > Display > Website Link Previews</strong>.</li><li><strong>false</strong>: <strong>(Default)</strong> All previews are disabled and the server does not request metadata for any links contained in messages.</li></ul></td> <td><ul><li>System Config path: <strong>Site Configuration > Posts</strong></li><li><code>config.json</code> setting: <code>ServiceSettings</code> > <code>EnableLinkPreviews</code> > <code>true</code></li><li>Environment variable: <code>MM_SERVICESETTINGS_ENABLELINKPREVIEWS</code></li></ul></td> </tr> </tbody> </table> <Note>Disabling this configuration setting in larger deployments may improve server performance in the following areas:
Disabling this configuration setting in larger deployments may improve server performance in the following areas, particularly in environments with high message throughput or limited resources:
Enabling SVGs is not recommended in environments where not all users are trusted.
</Warning>Enabling LaTeX rendering is not recommended in environments where not all users are trusted.
</Warning>Enabling LaTeX rendering isn't recommended in environments where not all users are trusted.
</Warning>This limit applies to all Mattermost clients, including web, desktop app, and mobile app.
</Note>While drafts can be very useful for maintaining work continuity, especially in collaborative environments, disabling draft synchronization across devices can lead to noticeable performance improvements by reducing the computational and data management overhead as follows:
Access the following configuration settings in the System Console by going to Site Configuration > Content Flagging.
Access the following configuration settings in the System Console by going to Site Configuration > File Sharing and Downloads.
This setting improves an organization's mobile security posture by restricting file access while still allowing essential file viewing capabilities.
<table> <colgroup> <col style={{width: '100%'}} /> </colgroup> <tbody> <tr> <td><ul><li><strong>true</strong>: Prevents file downloads, previews, and sharing for most file types, | - System Config path: <strong>Site Configuration > File sharing and downloads</strong> | even when the | - <code>config.json</code> setting: <code>FileSettings</code> > <code>MobileEnableSecureFilePreview</code> > <code>false</code> | <a href="mm-ref:administration-guide%2Fconfigure%2Fsite-configuration-settings%3Aallow%20file%20downloads%20on%20mobile">Allow file downloads on mobile</a> | - Environment variable: <code>MM_FILESETTINGS_MOBILEENABLESECUREFILEPREVIEW</code> configuration setting is enabled. Allows in-app previews for PDFs, | | videos, and images only. Files are stored temporarily in the app's cache and cannot be exported or shared. | |</li><li><strong>false</strong>: <strong>(Default)</strong> Secure file preview mode is disabled. | |</li></ul></td> </tr> </tbody> </table>This setting has no effect when the Secure file preview on mobile configuration setting is disabled.
</Note>With self-hosted deployments, you can access the following configuration settings in the System Console by going to Site Configuration > Public Links.
When set to false, anyone who tries to visit a previously created public link will receive an error message. If the setting is returned to true, previously created links will be accessible, unless the Public link salt has been regenerated.
</Note>Access the following configuration settings in the System Console by going to Site Configuration > Notices.
The following settings aren't available in the System Console and can only be set in config.json.
When connected workspaces are enabled, system admins can create and manage connected workspaces in the System Console by going to Site Configuration > Connected Workspaces.
Enable the ability to establish secure connections between Mattermost instances, and invite secured connections to shared channels where users can participate as they would in any public and private channel.
Connected workspaces requires Mattermost Enterprise servers running v10.2 or later.
By default, both configuration settings are disabled and must be enabled in order to share channels with secure connections. Enabling connected workspace functionality requires a server restart.
This feature's two config.json settings include:
ConnectedWorkspacesSettings.EnableRemoteClusterService: false with options true and false.ConnectedWorkspacesSettings.EnableSharedChannels: false with options true and false.config.json under ConnectedWorkspacesSettings.EnableSharedChannels and EnableRemoteClusterService are automatically converted to connected workspace configuration settings in the config.json file. The deprecated shared channels experimental settings remain in the config.json file to support backwards compatibility.Disable member status and availability synchronization between connected workspaces.
<table> <colgroup> <col style={{width: '52%'}} /> <col style={{width: '47%'}} /> </colgroup> <tbody> <tr> <td><ul><li><strong>true</strong>: Channel as well as member status and availability isn't synchronized.</li><li><strong>false</strong>: <strong>(Default)</strong> Channel as well as channel member status and availability is synchronized at regular intervals.</li></ul></td> <td><ul><li>System Config path: N/A</li><li><code>config.json</code> setting: <code>ConnectedWorkspacesSettings</code> > <code>DisableSharedChannelsStatusSync</code> > <code>false</code></li><li>Environment variable: N/A</li></ul></td> </tr> </tbody> </table> <Note>Enabling these features can increase the load on your Mattermost server’s CPU, memory, and database due to frequent updates, database queries, and API communication. Excessive sync frequency and retries can overwhelm system resources, potentially causing performance degradation or instability. Monitor your system carefully when enabling these features.
</Note>Automatically synchronize users when a new connection between workspaces is established. This ensures that remote users are immediately discoverable for direct and group messages without requiring them to post in a shared channel first.
<table> <colgroup> <col style={{width: '53%'}} /> <col style={{width: '46%'}} /> </colgroup> <tbody> <tr> <td><ul><li><strong>true</strong>: <strong>(Default)</strong> Users are automatically synchronized when a new connection is established.</li><li><strong>false</strong>: Users are not automatically synchronized when a new connection is established.</li></ul></td> <td><ul><li>System Config path: N/A</li><li><code>config.json</code> setting: <code>ConnectedWorkspacesSettings</code> > <code>SyncUsersOnConnectionOpen</code> > <code>true</code></li><li>Environment variable: N/A</li></ul></td> </tr> </tbody> </table> <Note>Enabling these features can increase the load on your Mattermost server’s CPU, memory, and database due to frequent updates, database queries, and API communication. Excessive sync frequency and retries can overwhelm system resources, potentially causing performance degradation or instability. Monitor your system carefully when enabling these features.
</Note>Enabling these features can increase the load on your Mattermost server’s CPU, memory, and database due to frequent updates, database queries, and API communication. Excessive sync frequency and retries can overwhelm system resources, potentially causing performance degradation or instability. Monitor your system carefully when enabling these features.
</Note>Enabling these features can increase the load on your Mattermost server’s CPU, memory, and database due to frequent updates, database queries, and API communication. Excessive sync frequency and retries can overwhelm system resources, potentially causing performance degradation or instability. Monitor your system carefully when enabling these features.
</Note>From Mattermost v11.8, system admins can configure classification markings in the System Console by going to Site Configuration > Classification Markings.
Classification markings define reusable classification levels that can be displayed as global or channel-level banners in the web and desktop apps. Each classification level includes a name, color, and rank order. You can select a preset, such as US DoD, NATO, UK GSCP, Canada, or Australia PSPF, or define custom classification levels.
<Note>Classification markings are informational only and aren't tied to access control decisions at this time.
</Note>Configure classification markings:
The following self-hosted deployment settings are only configurable in the config.json file and are not available in the System Console.