Site Configuration Settings
import useBaseUrl from '@docusaurus/useBaseUrl';
Review and manage the following site configuration options in the System Console by selecting the Product <img src={useBaseUrl('/img/ui/products_E82F.svg')} alt="Navigate between Channels, collaborative playbooks, and boards using the product menu icon." className="theme-icon" /> menu, selecting System Console, and then selecting Site Configuration:
- Customization
- Localization
- Auto-translation
- Users and Teams
- Notifications
- System-wide notifications
- Emoji
- Posts
- File Sharing and Downloads
- Public Links
- Notices
- Connected Workspaces
- Classification Markings
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.
- If using a tool such as jq, you'd enter:
cat config/config.json | jq '.TeamSettings.SiteName' - When working with the
config.jsonfile manually, look for an object such asTeamSettings, then within that object, find the keySiteName.
Customization¶
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¶
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. | - System Config path: Site Configuration > Customization | You can format this text using the same Markdown formatting | - config.json setting: TeamSettings > CustomBrandText as in Mattermost messages. | - Environment variable: MM_TEAMSETTINGS_CUSTOMBRANDTEXT | | | String input. Maximum 500 characters. Enable custom branding | | must be set to true to display the text. | | |
Enable theme selection¶
|
|
Allow custom themes¶
|
|
Allowed themes¶
Restrict the themes users can select in Display > Theme to a comma-separated list of theme names. Requires Enable theme selection to be set to true. String array input consisting of the options |
|
Default theme¶
Set a default theme that applies to all new users on the system. String input. One of |
|
Enable Ask Community link¶
|
|
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 |
|
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¶
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 |
|
- 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.
Privacy Policy link¶
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 |
|
- This setting is applicable to self-hosted deployments only and doesn't change the Privacy Policy link in the About Mattermost window.
About link¶
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 |
|
This setting is applicable to self-hosted deployments only.
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. |
|
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.
Report a Problem¶
With self-hosted deployments, you can specify how the Report a Problem option behaves in the Mattermost app via the Help menu:
- Default: Customers with a Mattermost license can open a support case by email with the Mattermost support team. Unlicensed Mattermost deployments are directed to the troubleshooting forums.
- Email address: Enables you to enter an email address that users will be prompted to send a message to when they choose Report a Problem in Mattermost.
- Custom link: Enables you to enter a URL that users will be directed to when they choose Report a Problem in Mattermost.
- Hide link: Removes the Report a Problem option from Mattermost.
Report a Problem link¶
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 |
|
This setting is applicable to self-hosted deployments only.
Report a Problem email address¶
This field sets the email address for the Report a Problem link in the channel header Help menu. String input. Cannot be left blank. |
|
This setting is applicable to self-hosted deployments only.
Allow mobile app log downloads¶
Enable users to download mobile app logs for troubleshooting. When the Report a Problem link is shown, mobile logs can be downloaded as part of the reporting flow.
|
|
This setting is applicable to self-hosted deployments only.
Mattermost apps download page link¶
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 |
|
This setting is applicable to self-hosted deployments only.
Android app download link¶
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 |
|
This setting is applicable to self-hosted deployments only.
iOS app download link¶
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 |
|
This setting is applicable to self-hosted deployments only.
Enable tutorial¶
|
|
Enable onboarding¶
|
|
Enable desktop app landing page¶
|
|
Minimum desktop app version¶
Specify the minimum version of the Mattermost Desktop App required to connect to this server | - System Config path: Site Configuration > Customization | (e.g., 5.10.0). Users connecting with a Desktop App version below this minimum are shown | - config.json setting: ServiceSettings > MinimumDesktopAppVersion | an update required screen and cannot use the application until they update. | - Environment variable: MM_SERVICESETTINGS_MINIMUMDESKTOPAPPVERSION | | | The update screen includes a download link configured via the | | Mattermost apps download page link setting. | | | Must be a valid semantic version (e.g., 5.0.0). Leave blank to allow all Desktop App | | versions to connect. | | | | String input. Default is empty (no minimum enforced). | | |
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 config.json setting is "NativeAppSettings.AppCustomURLSchemes" with an array of strings as input separated by spaces. |
For example:
|
Mobile external browser¶
From Mattermost v10.2 and Mobile v2.2.1, this setting configures the mobile app to use an external mobile browser to perform SSO authentication.
|
|
- This setting is applicable to self-hosted deployments only.
- We recommend enabling this configuration setting when there are issues with the mobile app SSO redirect flow.
Localization¶
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 |
|
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 |
|
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 |
|
Auto-translation¶
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.
Enable auto-translation¶
Enable or disable automatic translation of channel messages.
|
|
Translation provider¶
The translation provider to use for autotranslation.
Default is |
|
LibreTranslate URL¶
The URL of the LibreTranslate server used for translations. The Mattermost server must be able to reach this URL. String value. |
|
LibreTranslate API key¶
The API key for authenticated access to the LibreTranslate server. Leave blank if the LibreTranslate server doesn't require authentication. String value. |
|
Agents LLM service ID¶
The service ID of the LLM configured in the Mattermost Agents plugin to use for translations. Configure LLM services in the Agents plugin settings. String value. |
|
Languages allowed¶
The languages that all messages in autotranslation-enabled channels are translated into. Every message is translated into each language in this list, regardless of who is in the channel. Specify languages as an array of language codes. Default is |
|
Translation timeout¶
The maximum time in milliseconds to wait for a translation to complete. If a translation exceeds this timeout, it is skipped. Numerical value. Default is 5000 (5 seconds). |
|
Restrict autotranslation in direct and group messages¶
Restrict autotranslation from being enabled in direct and group messages.
|
|
Translation workers¶
The number of concurrent translation workers per node. Higher values increase translation throughput but use more resources. This setting is not available in the System Console and can only be set via Numerical value. Default is 6. |
|
Users and teams¶
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, | - System Config path: Site Configuration > Users and Teams | including activated and deactivated users. | - config.json setting: TeamSettings > MaxUsersPerTeam > 50 | | - Environment variable: MM_TEAMSETTINGS_MAXUSERSPERTEAM | 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 various 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. From Mattermost v12.0, channel members with permission to manage channel settings can also hide join/leave messages in a specific channel for all channel members, regardless of this setting or users' own preferences. |
|
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¶
This setting controls whether users can change settings under Settings > Display > Teammate Name Display.
|
|
Lock profile fields for email users¶
This setting controls whether users who sign in with email and password can change their own profile fields under Settings > Profile. System admins are always exempt and can edit any user's profile through the System Console or the API. Users authenticating through an external provider (AD/LDAP, SAML, or OAuth) aren't affected; their fields remain governed by the provider's attribute settings.
Empty first and last names can be filled in once by the user, so people who join through a team invite link or open server signup aren't left without a name. Once set, the name is locked. When this setting is enabled, anyone with the Invite Users permission can pre-set the first name, last name, and username for each email invitation they send. The invited person sees the pre-set username on the account creation page and cannot change it. We recommend restricting the Invite Users permission through advanced permissions to people trusted to enter this information correctly. For a display name convention of "First Last" across the workspace, combine this setting with Teammate Name Display set to Show first and last name and Lock Teammate Name Display set to true. |
|
Show email address¶
|
|
Show full name¶
|
|
Enable anonymous team and channel URLs¶
From Mattermost v11.6.0, when enabled, team and channel URLs are anonymized, meaning the URL no longer contains the team or channel name. This prevents team and channel names from being identified through web addresses. When this setting is enabled, the team and channel creation workflows no longer include a step for users to define a URL; teams and channels are created with an automatically generated anonymous URL. This applies only to newly created teams and channels; existing teams and channels are not affected.
|
|
Enable custom user statuses¶
|
|
Enable last active time¶
|
|
User status away timeout¶
The number of seconds of inactivity after which a user's status indicator changes to Away. Numerical input in seconds. Default is 300 (5 minutes). |
|
Enable custom user groups¶
|
|
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 |
|
Enable account deactivation¶
Available only when authentication is set to use email and password. Not available when authentication uses SAML or AD/LDAP. |
|
Channel category sorting¶
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.
|
|
Notifications¶
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¶
|
|
- 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:
- Reduced Server Load: Generating and sending emails requires processing power and resources. By disabling email notifications, you reduce the load on the server, which can be reallocated to other tasks.
- Decreased I/O Operations: Sending emails involves input/output (I/O) operations, such as writing to logs and databases, and handling communication with the email server. Reducing these I/O operations can improve overall system efficiency.
- Lowered Network Traffic: Each email sent contributes to network traffic. Disabling email notifications decreases the amount of data being transmitted, which can lead to better performance, especially in environments with limited bandwidth.
- Faster Response Times: With fewer background tasks (like sending emails) to handle, the application can potentially respond to user requests more quickly, improving perceived performance.
- Resource Allocation: Resources like CPU cycles, memory, and network bandwidth that would have been used for sending emails can be used elsewhere, possibly improving the performance of other critical components of the system.
- However, disabling email notifications can negatively impact user experience, communication efficiency, and overall productivity. It's important to balance performance improvements with the needs of your organization and users.
Enable preview mode banner¶
|
|
Cloud admins can't modify this configuration setting.
Enable email batching¶
|
|
- Cloud admins can't modify this configuration setting.
- The Site Url and SMTP Email Server must be configured to allow email batching.
- Regardless of how this setting is configured, users can disable email-based notifications altogether.
- When email batching is enabled, users can customize how often to receive batched notifications. The default frequency is 15 minutes.
- Email batching in High Availability Mode is planned, but not yet supported.
Email batching buffer size¶
Specify the maximum number of notifications batched into a single email. Numerical input. Default is |
|
- Cloud admins can't modify this configuration setting.
- This setting only applies when email batching is enabled.
- We recommend increasing the buffer size from the default value if you see the following error in the Mattermost logs:
Email batching job's receiving buffer was full. Please increase the EmailBatchingBufferSize. Falling back to sending immediate mail.Increasing this value will ensure emails are queued up, without impacting server performance. - Notifications are sent immediately when the receiving buffer is full.
Email batching interval¶
Specify the maximum frequency, in seconds, which the batching job checks for new notifications. Numerical input in seconds. Default is |
|
- Cloud admins can't modify this configuration setting.
- This setting only applies when email batching is enabled.
- Longer batching intervals may increase performance.
- Notifications are sent immediately when the receiving buffer is full. If that occurs, increase Email batching buffer size.
Email notification contents¶
|
|
Use channel name in email notifications¶
|
|
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. Must be a valid email address if set. Default is |
|
Cloud admins can't modify this configuration setting.
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. Must be a valid email address if set. 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. Must be a valid email address if set. Default is |
|
Notification footer mailing address¶
Optional setting to include the organization's name and mailing address in the footer of email notifications. If not set, nothing will appear. String input. |
|
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¶
Access the following configuration settings in the System Console by going to Site Configuration > System-wide notifications.
Enable system-wide notifications¶
|
|
|
Banner text¶
The text of the system-wide notification, when enabled. String input. |
|
|
Banner color¶
The background color of system-wide notifications. String input of a CSS color value. |
|
Banner text color¶
The color of the text in system-wide notifications. String input of a CSS color value. |
|
Allow banner dismissal¶
|
|
Emoji¶
Access the following configuration settings in the System Console by going to Site Configuration > Emoji.
Enable emoji picker¶
|
|
Enable custom emoji¶
|
|
While Mattermost supports up to 6000 custom emojis, an increase in custom emojis can slow your server's performance.
Posts¶
Access the following configuration settings in the System Console by going to Site Configuration > Posts.
Automatically follow threads¶
|
|
- 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.
Threaded discussions¶
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.
|
Message priority¶
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.
|
|
Disabling this configuration setting in larger deployments may improve server performance in the following areas, particularly in environments where performance and responsiveness are critical:
- Simplified Processing: When post priority is enabled, the system has to manage and prioritize posts based on their designated priority levels. This adds additional processing overhead as the system must evaluate and sort posts accordingly. By disabling this feature, all posts are treated equally, which simplifies the processing logic and reduces the computational load.
- Reduced Latency: With post priority enabled, there might be delays introduced while the system determines the priority of each post and processes them in the correct order. Disabling post priority can lead to more consistent and potentially quicker handling of posts because the system processes them on a first-come, first-served basis.
- Lower Resource Utilization: Managing post priorities can consume additional system resources such as CPU and memory. Disabling this feature can free up these resources, allowing the system to allocate them to other tasks, thereby improving overall performance.
- Improved Scalability: In a high-traffic environment, the complexity of managing post priorities can become more pronounced. Disabling this feature simplifies the system's operations, making it easier to scale as the number of users and posts increases.
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 burn-on-read messages¶
Burn-on-read messages have irreversible behavior:
- Once a recipient reveals a burn-on-read message, it can't be hidden again.
- Once a burn-on-read message expires or is burned, it is permanently deleted and can't be recovered.
- Recipients can't reply to, edit, or thread burn-on-read messages.
Enable or disable burn-on-read messages.
|
|
Disabling this feature prevents users from sending new burn-on-read messages. Once disabled, users can interact with existing burn-on-read messages.
Burn-on-read duration¶
Sets the countdown duration for burn-on-read messages once they are revealed. After a recipient reveals a burn-on-read message, the message is deleted for that user after the specified duration. This setting applies to all burn-on-read messages. Numerical input in seconds. Must be greater than 0. Default is 600 seconds (10 minutes). |
|
Maximum time to live for burn-on-read messages¶
Sets the maximum duration that burn-on-read messages can exist after they are sent. The message is deleted after the specified duration, even if it hasn't been revealed by all recipients. Numerical input in seconds. Must be greater than 0. Default is 604800 seconds (7 days). |
|
Enable website link previews¶
The server must be connected to the internet to generate previews. This connection can be established through a firewall or outbound proxy if necessary.
|
|
Disabling this configuration setting in larger deployments may improve server performance in the following areas:
- Reduced Network Requests: When link previews are enabled, the system needs to fetch metadata (such as title, description, or image) from the linked webpage. This requires additional network requests, which can slow down the system.
- Lower Server Load: Creating link previews involves parsing the content of the linked pages. If many users are sharing links, the server will have to perform numerous network requests and process a lot of additional data, increasing the load on the server.
- Less Data Processing: Every link shared needs to be processed to extract the necessary preview information. This processing consumes CPU and memory resources, which can otherwise be reserved for other tasks.
- Decreased Client-Side Rendering Time: On the client side, rendering link previews (adding text, images, and layouts) takes time and resources. Disabling link previews means that clients do not need to render these elements, leading to faster message display.
- Saved Bandwidth: Link previews often include images and other data from the linked content. By disabling them, you save the bandwidth that would be used to download these additional resources.
- However, disabling link previews can negatively impact user experience, communication efficiency, and overall productivity. It's important to balance performance improvements with the needs of your organization and users.
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¶
|
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:
- Reduced Server Load: When permalink previews are enabled, the server has to generate preview summaries for each shared link. This generates additional requests to fetch metadata and may involve parsing web pages, which increases the processing load on the server.
- Less Data Transfer: Permalink previews include additional metadata such as images, titles, and descriptions. Disabling previews reduces the amount of data that needs to be transferred, which can decrease bandwidth usage and improve message load times, particularly for channels with a high volume of links.
- Faster Message Rendering: On the client-side, rendering messages with multimedia previews takes more time compared to plain text messages. Disabling previews can reduce rendering complexity and improve client performance, especially on devices with limited resources.
- Network Latency: Fetching metadata for link previews may introduce network latency, as the server must reach out to external resources. Disabling this can eliminate these delays, ensuring faster message processing and display.
- Simplified Message Handling: In the absence of previews, messages are simpler and less resource-intensive to store, retrieve, and display. This can contribute to overall improved system responsiveness and efficiency.
- However, disabling permalink previews can negatively impact user experience, communication efficiency, and overall productivity. It's important to balance performance improvements with the needs of your organization and users.
Enable SVGs¶
|
|
Enabling SVGs is not recommended in environments where not all users are trusted.
Enable LaTeX code block rendering¶
|
Enabling LaTeX rendering is not recommended in environments where not all users are trusted.
Enable inline LaTeX rendering¶
|
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. |
|
This limit applies to all Mattermost clients, including web, desktop app, and mobile app.
Google API key¶
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. |
|
- This setting is applicable to self-hosted deployments only.
- This key is used in client-side Javascript, and must have the YouTube Data API added as a service.
Enable server syncing of message drafts¶
Enable or disable the ability to synchronize draft messages across all supported Mattermost clients.
|
|
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:
- Reduced Data Synchronization: When drafts are enabled and synchronized across devices, the system needs to handle those data synchronization operations which can consume significant bandwidth and computing resources. Disabling draft syncing reduces the load on servers and networks.
- Lower Storage Usage: Storing drafts requires additional database operations and storage space. Each draft is an extra piece of data that needs to be saved, managed, and retrieved. Without drafts, the system has fewer records to keep, which can streamline database operations.
- Decreased Client Processing: On the client side, draft management involves monitoring changes, saving drafts periodically, and handling conflict resolution if multiple drafts are edited from different devices. Disabling drafts reduces these client-side processes, thus freeing up memory and CPU resources.
- Simplified Architecture: Maintaining synced drafts often requires complex backend logic to ensure consistency and avoid data conflicts. Simplifying this architecture by removing draft syncing can lead to more efficient and faster backend operations.
- Improved User Experience: Users may experience faster load times and reduced latency without the overhead of draft syncing. This can be particularly noticeable in environments with limited or variable internet connectivity.
- However, disabling draft synchronization can negatively impact user experience, communication efficiency, and overall productivity. It's important to balance performance improvements with the needs of your organization and users.
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. |
|
Enable user typing messages¶
This setting determines whether "user is typing..." messages are displayed below the message box.
|
|
Disabling this configuration setting in larger deployments may improve server performance in the following areas:
- Reduced Server Load: Typing events generate additional websocket traffic. Disabling them can reduce the amount of data that needs to be handled by the server, improving the overall response time and decreasing server load.
- Lower Network Traffic: When typing events are enabled, every keystroke generates a network event. This can lead to a significant amount of network traffic, particularly in busy channels. Disabling these events reduces the amount of information transmitted over the network.
- Client Performance: On the client side, processing typing events requires resources. By not having to handle these events, the client can be more responsive and use less memory and CPU.
User typing timeout¶
The number of milliseconds to wait between emitting user typing websocket events, which determines how frequently "user is typing..." messages are updated. Numerical input in milliseconds. Default is 5000. Minimum is 1000. |
|
This setting only applies when Enable user typing messages is set to true.
Content flagging¶
Access the following configuration settings in the System Console by going to Site Configuration > Content Flagging.
Enable content flagging¶
|
|
Notification settings¶
Default notification recipients for each event:
Default mappings include:
|
|
Additional settings¶
Specify the reasons for flagging. Default reasons include:
|
|
Require reporters to add comment¶
|
|
Require reviewers to add comment¶
|
|
Hide message from channel while it is being reviewed¶
|
|
Same reviewers for all teams¶
|
|
System administrators as reviewers¶
|
|
Team administrators as reviewers¶
|
|
From Mattermost v12.0, the following settings control post delivery audit logging, which records an audit log entry for each delivery of a message in an eligible channel. Delivery records require an audit log target that consumes the audit-delivery log level. See Post delivery audit logging for details.
Post delivery audit logging is currently in Beta. It requires the feature flag MM_FEATUREFLAGS_POSTDELIVERYTRACKING, which is disabled by default, and a server restart after you enable it. It also requires an audit log target that consumes the audit-delivery log level.
Enable post delivery audit logging¶
|
|
Delivery records are written to the audit log only, and aren't surfaced anywhere in the Mattermost interface.
Delivery records are discarded unless an audit log target consumes the audit-delivery log level. Setting this to true without configuring such a target records nothing, and Mattermost doesn't block the configuration. See Post delivery audit logging.
Record deliveries in¶
|
|
Recording deliveries in all eligible channels is the most complete option, and also the most expensive. Direct and group messages are never eligible, regardless of this setting.
Channels to record deliveries in¶
The channels in which message deliveries are recorded. Applies only when Record deliveries in is set to Selected channels, in which case at least one channel is required. Stored in the database, so there's no Direct and group message channels can't be selected. |
|
File sharing and downloads¶
Access the following configuration settings in the System Console by going to Site Configuration > File Sharing and Downloads.
Allow file sharing¶
|
|
Enable file search¶
|
|
To let users search documents by their content as well as by filename, also enable document search by content. Disabling file search in larger deployments may improve performance by removing file search queries against the database or search engine.
Allow file uploads on mobile¶
|
|
Allow file downloads on mobile¶
|
|
Enable secure file preview on mobile¶
This setting improves an organization's mobile security posture by restricting file access while still allowing essential file viewing capabilities.
|
Allow PDF link navigation on mobile¶
|
|
This setting has no effect when the Secure file preview on mobile configuration setting is disabled.
Public Links¶
With self-hosted deployments, you can access the following configuration settings in the System Console by going to Site Configuration > Public Links.
Enable public file 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.
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¶
Access the following configuration settings in the System Console by going to Site Configuration > Notices.
Enable admin notices¶
|
Enable end user notices¶
|
Connected workspaces¶
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 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: falsewith optionstrueandfalse.ConnectedWorkspacesSettings.EnableSharedChannels: falsewith optionstrueandfalse.
- Neither setting is available in the System Console and can only be set in
config.jsonunderConnectedWorkspacesSettings. - System admins for Cloud deployments can submit a request to have these required configuration settings enabled for their Cloud deployment instance.
- Following an upgrade to Mattermost v10.2 or later, existing configuration values for shared channels, including
EnableSharedChannelsandEnableRemoteClusterServiceare automatically converted to connected workspace configuration settings in theconfig.jsonfile. The deprecated shared channels experimental settings remain in theconfig.jsonfile to support backwards compatibility.
Disable shared channel status sync¶
Disable member status and availability synchronization between connected workspaces.
|
|
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.
Default maximum posts per sync¶
Define the default maximum number of messages to synchronize at a time. Must be greater than 0. Default is 50. |
|
Sync users on connection open¶
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.
|
|
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.
Global user sync batch size¶
The number of users to sync in each batch when performing global user synchronization between connected workspaces. Must be greater than 0. Default is 25. |
|
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.
Member sync batch size¶
The number of channel members to sync in each batch when synchronizing channel membership between connected workspaces. Must be greater than 0. Default is 20. |
|
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.
Classification Markings¶
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. Levels are ordered using the same Ranked attribute type available in Attribute management, so each level sits at a defined position from lowest to highest.
Classification markings and channel attributes are informational in this release. They aren't evaluated by access policies and don't control access to channels, messages, or files.
Configure classification markings:
- Go to System Console > Site Configuration > Classification Markings.
- Enable Enable classification markings.
- Select a Classification preset, or create custom classification levels.
- Configure classification level names, colors, and rank order.
- Optionally enable the Global Classification Banner under Global Classification Indicators.
-
Select the Banner visibility:
-
Top only
-
Top and bottom
-
Select the Global classification level to display.
- Select Save.
Classification and channel attributes¶
From Mattermost v12.0, when the ChannelAttributes feature flag is enabled, Classification is also represented as a global attribute under System Attributes > Attribute Management. Its definition is read-only there: classification levels, ranks, colors, and the global banner continue to be managed on the Classification Markings page. The resources Classification applies to and its channel display locations are managed from Attribute Management.
When Classification Markings are enabled, Mattermost adds a Channels resource to Classification and configures it for banner display by default. Channel admins then assign the classification value from Channel Info or Channel Settings > Info. The previous Classification control under Channel Settings > Configuration is hidden.
When Classification is included in a channel banner, the selected level's color controls the banner color. A channel banner manager can customize the banner text and combine Classification with other channel attributes. Removing the Classification token from the banner returns control of the banner color to the channel without clearing the classification value.
See Channel attributes for configuration, assignment, upgrade, and banner behavior.
config.json-only settings¶
The following self-hosted deployment settings are only configurable in the config.json file and are not available in the System Console.
Cross-team search¶
Disable the ability to search across all teams or a specific team.
|
|