Deprecated Configuration Settings

Service Settings

Data Prefetch

Removed in February 16, 2021 release

True: Messages in all unread channels are pre-loaded from the server whenever the client reconnects to the network to eliminate loading time when users switch to unread channels.

False: Messages are fetched on-demand from the server when users switch channels.

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

Segment Write Key

Removed in March 16, 2017 release

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

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

Limit Access to Config Settings Prior to Login

Removed in December 16, 2018 release

Enable this setting to limit the number of config settings sent to users prior to login.

Supported for Mattermost server v5.1.0 and later, and Mattermost Mobile apps v1.10.0 and later.

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

Disable Legacy MFA API Endpoint

Deprecated. Not used in Mattermost v6.0 and later.

True: Disables the legacy checkMfa endpoint, which is only required for Mattermost Mobile Apps v1.16 or earlier when using multi-factor authentication (MFA). Recommended to set to true for additional security hardening.

False: Keeps the legacy checkMfa endpoint enabled to support mobile versions 1.16 and earlier. Keeping the endpoint enabled creates an information disclosure about whether a user has set up MFA.

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

SQL Settings

Amazon S3 Bucket Endpoint

Removed in November 16th, 2016 release

Set an endpoint URL for Amazon S3 buckets.

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

Amazon S3 Location Constraint

Removed in November 16th, 2016 release

True: S3 region is location constrained.

False: S3 region is not location constrained.

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

Amazon S3 Lowercase Bucket

Removed in November 16th, 2016 release

True: S3 bucket names are fully lowercase.

False: S3 bucket names may contain uppercase and lowercase letters.

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

Users and Teams

Enable Team Directory

Removed in May 16th, 2016 release

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

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

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

Allow Team Administrators to edit others’ posts

Deprecated. Not used in Mattermost v6.0 and later.

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

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

Note

System Admins and Team Admins can always delete other users’ posts. This setting is only available for Team Edition servers. Enterprise Edition servers can use Advanced Permissions to configure this permission.

Enable Team Creation

Deprecated. Not used in Mattermost v6.0 and later.

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

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

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

SAML 2.0

Use New SAML Library

Removed in December 16, 2020 release

True: Enable an updated SAML Library, which does not require the XML Security Library (xmlsec1) to be installed.

False: Continue using the existing implementation which uses the XML Security Library (xmlsec1).

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

Legacy Sidebar

Enable Legacy Sidebar

Deprecated. Not used in Mattermost v6.0 and later.

This setting re-enables the legacy sidebar functionality for all users on this server. We strongly recommend System Admins disable this setting so users can access enhanced sidebar features, including custom, collapsible channel categories, drag and drop, unread filtering, channel sorting options, and more.

False: Users can access all new channel sidebar features, including custom, collapsible channel categories, drag and drop, unread filtering, channel sorting options, and more. See the documentation for more information about these features.

True: When enabled, the legacy sidebar is enabled for all users on this server and users cannot access any new channel sidebar features. The legacy channel sidebar is scheduled to be deprecated, and is only recommended if your deployment is experiencing bugs or other issues with the new channel sidebar.

This feature’s config.json setting is "EnableLegacySidebar": false with options true or false.

Experimental Sidebar Features

Deprecated. Not used in Mattermost v5.32 and later

Note

This experimental configuration setting has been deprecated, and the ability to organize channels in the sidebar has been promoted to general availability from Mattermost v5.32. See the Organizing Your Sidebar documentation for details on customizing the sidebar.

Disabled: Users cannot access the experimental channel sidebar feature set.

Enabled (Default On): Enables the experimental sidebar features for all users on this server. Users can disable the features in Settings > Sidebar > Experimental Sidebar Features. Features include custom collapsible channel categories, drag and drop to reorganize channels, and unread filtering.

Enabled (Default Off): Users must enable the experimental sidebar features in Settings.

This feature’s config.json setting is "ExperimentalChannelSidebarOrganization": off with options off, default_on and default_off.

Enable X to Leave Channels from Left-Hand Sidebar

Deprecated. Not used in Mattermost v6.0 and later.

This setting applies to the legacy sidebar only. You must first enable the Enable Legacy Sidebar configuration setting if you want to see and enable this functionality in the System Console.

Note

This experimental setting is not recommended for production environments. The new channel sidebar matches and exceeds the feature set offered by this configuration setting.

We strongly recommend that you leave the Enable Legacy Sidebar configuration setting disabled so users can access new channel sidebar features, including custom, collapsible channel categories, drag and drop, unread filtering, channel sorting options, and more. See the channel sidebar documentation for more information about these features.

True: Users can leave Public and Private Channels by clicking the “x” beside the channel name.

False: Users must use the Leave Channel option from the channel menu to leave channels.

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

Autoclose Direct Messages in Sidebar

Deprecated. Not used in Mattermost v6.0 and later.

This setting applies to the legacy sidebar only. You must enable the Enable Legacy Sidebar configuration setting to see and enable this functionality in the System Console.

Note

This experimental setting is not recommended for production environments. The new channel sidebar matches and exceeds the feature set offered by this configuration setting.

We strongly recommend that you leave the Enable Legacy Sidebar configuration setting disabled so users can access new channel sidebar features, including custom, collapsible channel categories, drag and drop, unread filtering, channel sorting options, and more. See the channel sidebar documentation for more information about these features.

True: By default, direct message conversations with no activity for 7 days will be hidden from the sidebar. Users can disable this in Account Settings > Sidebar.

False: Conversations remain in the sidebar until they are manually closed.

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

Town Square

Town Square is Hidden in Left-Hand Sidebar

Deprecated. Not used in Mattermost v6.0 and later.

This setting applies to the legacy sidebar only. You must enable the Enable Legacy Sidebar configuration setting to see and enable this functionality in the System Console.

Note

This experimental setting is not recommended for production environments. The new channel sidebar matches and exceeds the feature set offered by this configuration setting.

We strongly recommend that you leave the Enable Legacy Sidebar configuration setting disabled so users can access new channel sidebar features, including custom, collapsible channel categories, drag and drop, unread filtering, channel sorting options, and more. See the channel sidebar documentation for more information about these features.

True: Hides Town Square in the left-hand sidebar if there are no unread messages in the channel.

False: Town Square is always visible in the left-hand sidebar even if all messages have been read.

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

Town Square is Read-Only

Deprecated. Not used in Mattermost v6.0 and later.

True: Only System Admins can post in Town Square. Other members are not able to post, reply, upload files, react using emojis, pin messages to Town Square, nor are they able to change the channel name, header, or purpose.

False: Anyone can post in Town Square.

Note

In Mattermost v.6.0, this feature has been deprecated in favor of channel moderation settings which allow you to set any channel as read-only, including Town Square

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

Custom Emoji

Restrict Custom Emoji Creation

Deprecated. Not used in Mattermost v6.0 and later.

Allow everyone to create custom emoji: Allows everyone to add custom emojis from the emoji picker.

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

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

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

Timezone

Timezone

This configuration setting has been promoted to General Availability and is no longer configurable in Mattermost v6.0 and later.

Select the timezone used for timestamps in the user interface and email notifications.

True: The Timezone setting is visible in the Settings and a timezone is automatically assigned in the next active session.

False: The Timezone setting is hidden in the Settings.

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

High-Availability

Inter-Node Listen Address

Deprecated. Not used in Mattermost v4.0 and later

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

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

Inter-Node URLs

Deprecated. Not used in Mattermost v4.0 and later

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

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

REST API V3

Allow use of API v3 endpoints

Removed in June 16, 2018 release

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

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

Integrations

Restrict managing integrations to Admins

Deprecated. Not used in Mattermost v6.0 and later.

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

False: Any team members can create webhooks, slash commands` and OAuth 2.0 applications from Product menu > Integrations.

Note

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

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

Policy

Removed in June 16, 2018 release

Note

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

Enable sending team invites from

Removed in June 16, 2018 release

Note

From v5.0 this has been replaced by advanced permissions which offers Admins a way to restrict actions in Mattermost to authorized users only. See the Advanced Permissions documentation for more details.

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

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

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

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

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

Enable public channel creation for

Removed in June 16, 2018 release

Note

From v5.0 this has been replaced by advanced permissions which offers Admins a way to restrict actions in Mattermost to authorized users only. See the Advanced Permissions documentation for more details.

Restrict the permission level required to create public channels.

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

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

System Admins: Restrict creating public channels to System Admins.

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

Enable public channel renaming for

Removed in June 16, 2018 release

Note

From v5.0 this has been replaced by advanced permissions which offers Admins a way to restrict actions in Mattermost to authorized users only. See the Advanced Permissions documentation for more details.

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

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

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

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

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

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

Enable public channel deletion for

Removed in June 16, 2018 release

Note

From v5.0 this has been replaced by advanced permissions which offers Admins a way to restrict actions in Mattermost to authorized users only. See the Advanced Permissions documentation for more details.

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

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

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

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

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

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

Enable private channel creation for

Removed in June 16, 2018 release

Note

From v5.0 this has been replaced by advanced permissions which offers Admins a way to restrict actions in Mattermost to authorized users only. See the Advanced Permissions documentation for more details.

Restrict the permission level required to create Private channels.

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

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

System Admins: Restrict creating Private channels to System Admins.

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

Enable private channel renaming for

Removed in June 16, 2018 release

Note

From v5.0 this has been replaced by advanced permissions which offers Admins a way to restrict actions in Mattermost to authorized users only. See the Advanced Permissions documentation for more details.

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

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

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

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

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

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

Enable managing of private channel members for

Removed in June 16, 2018 release

Note

From v5.0 this has been replaced by advanced permissions which offers Admins a way to restrict actions in Mattermost to authorized users only. See the Advanced Permissions documentation for more details.

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

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

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

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

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

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

Enable private channel deletion for

Removed in June 16, 2018 release

Note

From v5.0 this has been replaced by advanced permissions which offers Admins a way to restrict actions in Mattermost to authorized users only. See the Advanced Permissions documentation for more details.

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

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

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

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

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

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

Allow which users to delete messages

Removed in June 16, 2018 release

Note

From v5.0 this has been replaced by advanced permissions which offers Admins a way to restrict actions in Mattermost to authorized users only. See the Advanced Permissions documentation for more details.

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

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

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

System Admins: Allow only System Admins to delete messages.

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

Allow users to edit their messages

Removed in June 16, 2018 release

Note

From v5.0 this has been replaced by advanced permissions which offers Admins a way to restrict actions in Mattermost to authorized users only. See the Advanced Permissions documentation for more details.

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

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

Never: Do not allow users to edit their messages.

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

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

Post edit time limit

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

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

Images

Attachment Thumbnail Width

Removed in July 16th, 2017 release

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

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

Attachment Thumbnail Height

Removed in July 16th, 2017 release

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

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

Image Preview Width

Removed in July 16th, 2017 release

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

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

Image Preview Height

Removed in July 16th, 2017 release

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

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

Profile Picture Width

Removed in July 16th, 2017 release

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

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

Profile Picture Height

Removed in July 16th, 2017 release

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

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

Display Settings (Experimental)

Supported Timezones Path

Removed in April 16, 2019 release

Set the path of the JSON file that lists supported timezones when ExperimentalTimezone is set to true.

The file must be in the same directory as your config.json file if you set a relative path. Defaults to timezones.json.

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