diff --git a/source/configure/experimental-configuration-settings.rst b/source/configure/experimental-configuration-settings.rst index 3c936e174d2..c3057bf1801 100644 --- a/source/configure/experimental-configuration-settings.rst +++ b/source/configure/experimental-configuration-settings.rst @@ -27,25 +27,27 @@ Experimental System Console configuration settings .. config:setting:: adldap-login-button-color :displayname: AD/LDAP login button color (Experimental) :systemconsole: Experimental > Features - :configjson: LoginButtonColor - :environment: N/A - :description: Specify the color of the AD/LDAP login button for white labeling purposes. Use a hex code with a #-sign before the code. + :configjson: LdapSettings.LoginButtonColor + :environment: MM_LDAPSETTINGS_LOGINBUTTONCOLOR + :description: Specify the color of the AD/LDAP login button for white labeling purposes. Use a hex code that begins with # before the code. Default is **#0000**. AD/LDAP login button color ~~~~~~~~~~~~~~~~~~~~~~~~~~ -Specify the color of the AD/LDAP login button for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. - -+-------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"LoginButtonColor": ""`` with string input. | -+-------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| Specify the color of the AD/LDAP login button for white labeling purposes. | - System Config path: **Experimental > Features** | +| Use a hex code with a #-sign before the code. | - ``config.json`` setting: ``LdapSettings`` > ``LoginButtonColor`` > ``"#0000"`` | +| This setting only applies to the mobile app. | - Environment variable: ``MM_LDAPSETTINGS_LOGINBUTTONCOLOR`` | +| | | +| String input. Default is **#0000**. | | ++-------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ .. config:setting:: adldap-login-button-border-color :displayname: AD/LDAP login button border color (Experimental) :systemconsole: Experimental > Features - :configjson: LoginButtonBorderColor - :environment: N/A - :description: Specify the color of the AD/LDAP login button border for white labeling purposes. Use a hex code with a #-sign before the code. + :configjson: LdapSettings.LoginButtonBorderColor + :environment: MM_LDAPSETTINGS_LOGINBUTTONBORDERCOLOR + :description: Specify the color of the AD/LDAP login button border for white labeling purposes. Use a hex code that begins with # before the code. Default is **#2389D7** AD/LDAP login button border color ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -53,18 +55,20 @@ AD/LDAP login button border color .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -Specify the color of the AD/LDAP login button border for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. - -+-------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"LoginButtonBorderColor": ""`` with string input. | -+-------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +| Specify the color of the AD/LDAP login button border for white labeling purposes. | - System Config path: **Experimental > Features** | +| Use a hex code with a #-sign before the code. | - ``config.json`` setting: ``LdapSettings`` > ``LoginButtonBorderColor`` > ``"#2389D7"`` | +| This setting only applies to the mobile app. | - Environment variable: ``MM_LDAPSETTINGS_LOGINBUTTONBORDERCOLOR`` | +| | | +| String input. Default is **#2389D7**. | | ++---------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ .. config:setting:: adldap-login-button-text-color :displayname: AD/LDAP login button text color (Experimental) :systemconsole: Experimental > Features - :configjson: LoginButtonTextColor - :environment: N/A - :description: Specify the color of the AD/LDAP login button text for white labeling purposes. Use a hex code with a #-sign before the code. + :configjson: LdapSettings.LoginButtonTextColor + :environment: MM_LDAPSETTINGS_LOGINBUTTONTEXTCOLOR + :description: Specify the color of the AD/LDAP login button text for white labeling purposes. Use a hex code that begins with # before the code. Default is **#2389D7** AD/LDAP login button text color ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -72,17 +76,19 @@ AD/LDAP login button text color .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -Specify the color of the AD/LDAP login button text for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. - -+-------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"LoginButtonTextColor": ""`` with string input. | -+-------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| Specify the color of the AD/LDAP login button text for white labeling purposes. | - System Config path: **Experimental > Features** | +| Use a hex code with a #-sign before the code. | - ``config.json`` setting: ``LdapSettings`` > ``LoginButtonTextColor`` > ``"#2389D7"`` | +| This setting only applies to the mobile app. | - Environment variable: ``MM_LDAPSETTINGS_LOGINBUTTONTEXTCOLOR`` | +| | | +| String input. Default is **#2389D7**. | | ++--------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. config:setting:: change-authentication-method :displayname: Change authentication method (Experimental) :systemconsole: Experimental > Features - :configjson: ExperimentalEnableAuthenticationTransfer - :environment: N/A + :configjson: ServiceSettings.ExperimentalEnableAuthenticationTransfer + :environment: MM_SERVICESETTINGS_EXPERIMENTALENABLEAUTHENTICATIONTRANSFER - **true**: **(Default)** Users can change their sign-in method to any that is enabled on the server, either via their Profile or the APIs. - **false**: Users cannot change their sign-in method, regardless of which authentication options are enabled. @@ -93,145 +99,162 @@ Change authentication method .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -**True**: Users can change their sign-in method to any that is enabled on the server, either via their Profile or the APIs. - -**False**: Users cannot change their sign-in method, regardless of which authentication options are enabled. - -+-------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExperimentalEnableAuthenticationTransfer": true`` with options ``true`` and ``false``. | -+-------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| This setting controls whether users can change their authentication method to any method | - System Config path: **Experimental > Features** | +| that is enabled on the server. | - ``config.json`` setting: ``ServiceSettings`` > ``ExperimentalEnableAuthenticationTransfer`` > ``true`` | +| | - Environment variable: MM_SERVICESETTINGS_EXPERIMENTALENABLEAUTHENTICATIONTRANSFER | +| - **True**: Users can change their sign-in method to any that is enabled on the server, | | +| either via their Profile or the APIs. | | +| - **False**: Users can't change their sign-in method, regardless of which authentication | | +| options are enabled. | | ++----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: link-metadata-timeout :displayname: Link metadata timeout (Experimental) :systemconsole: Experimental > Features - :configjson: LinkMetadataTimeoutMilliseconds - :environment: N/A - :description: Adds a configurable timeout for requests made to return link metadata. Default is **5000** milliseconds. + :configjson: ServiceSettings.LinkMetadataTimeoutMilliseconds + :environment: MM_EXPERIMENTALSETTINGS_LINKMETADATATIMEOUTMILLISECONDS + :description: Adds a configurable timeout for requests made to return link metadata. Must be a value greater than **0**. Default is **5000** milliseconds. Link metadata timeout ~~~~~~~~~~~~~~~~~~~~~ -Adds a configurable timeout for requests made to return link metadata. If the metadata is not returned before this timeout expires, the message will post without requiring metadata. This timeout covers the failure cases of broken URLs and bad content types on slow network connections. - -+---------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"LinkMetadataTimeoutMilliseconds``: 5000`` with numerical input. | -+---------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| Adds a configurable timeout for requests made to return link metadata. | - System Config path: **Experimental > Features** | +| If the metadata is not returned before this timeout expires, the message | - ``config.json`` setting: ``ExperimentalSettings`` > ``LinkMetadataTimeoutMilliseconds`` > ``5000`` | +| will be posted without requiring metadata. This timeout covers the failure | - Environment variable: ``MM_EXPERIMENTALSETTINGS_LINKMETADATATIMEOUTMILLISECONDS`` | +| cases of broken URLs and bad content types on slow network connections. | | +| | | +| Numerical input. Default is **5000** milliseconds. | | ++-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ .. config:setting:: email-batching-buffer-size :displayname: Email batching buffer size (Experimental) :systemconsole: Experimental > Features - :configjson: EmailBatchingBufferSize - :environment: N/A + :configjson: EmailSettings.EmailBatchingBufferSize + :environment: MM_EMAILSETTINGS_EMAILBATCHINGBUFFERSIZE :description: Specify the maximum number of notifications batched into a single email. Default is **256** notifications. Email batching buffer size ~~~~~~~~~~~~~~~~~~~~~~~~~~ -Specify the maximum number of notifications batched into a single email. ++-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| Specify the maximum number of notifications batched into a single email. | - System Config path: **Experimental > Features** | +| | - ``config.json`` setting: ``EmailSettings`` > ``EmailBatchingBufferSize`` > ``256`` | +| Numerical input. Default is **256** notifications. | - Environment variable: ``MM_EMAILSETTINGS_EMAILBATCHINGBUFFERSIZE`` | ++-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ .. note:: - 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 will be sent instantly if the queue of emails exceeds the `email batching interval <#id1>`_ configured. - -+--------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``EmailBatchingBufferSize``: 256`` with numerical input. | -+--------------------------------------------------------------------------------------------------------------------------+ + - Notifications will be sent instantly if the queue of emails exceeds the `email batching interval <#email-batching-interval>`__ value configured. .. config:setting:: email-batching-interval :displayname: Email batching interval (Experimental) :systemconsole: Experimental > Features - :configjson: EmailBatchingInterval - :environment: N/A + :configjson: EmailSettings.EmailBatchingInterval + :environment: MM_EMAILSETTINGS_EMAILBATCHINGINTERVAL :description: Specify the maximum frequency, in seconds, which the batching job checks for new notifications. Default is **30** seconds. Email batching interval ~~~~~~~~~~~~~~~~~~~~~~~ -Specify the maximum frequency, in seconds, which the batching job checks for new notifications. ++--------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| Specify the maximum frequency, in seconds, | - System Config path: **Experimental > Features** | +| in which the batching job checks for new notifications. | - ``config.json`` setting: ``EmailSettings`` > ``EmailBatchingInterval`` > ``30`` | +| | - Environment variable: ``MM_EMAILSETTINGS_EMAILBATCHINGINTERVAL`` | +| Numerical input. Default is **30** seconds. | | ++--------------------------------------------------------------+-----------------------------------------------------------------------------------+ .. note:: - We recommend decreasing the email batching interval 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.``. - Longer batching intervals may increase performance. - - Notifications will be sent instantly if the `queue of emails <#email-batching-buffer-size>`_ exceeds the email batching interval configured. - -+-----------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``EmailBatchingInterval": 30`` with numerical input. | -+-----------------------------------------------------------------------------------------------------------------------+ + - Notifications will be sent instantly if the `queue of emails <#email-batching-buffer-size>`_ exceeds the email batching interval configured. .. config:setting:: email-login-button-color :displayname: Email login button color (Experimental) :systemconsole: Experimental > Features - :configjson: LoginButtonColor - :environment: N/A - :description: Specify the color of the email login button for white labeling purposes. Use a hex code with a #-sign before the code. + :configjson: EmailSettings.LoginButtonColor + :environment: MM_EMAILSETTINGS_LOGINBUTTONCOLOR + :description: Specify the color of the email login button for white labeling purposes. Use a hex code that begins with # before the code. Default is **#0000**. Email login button color ~~~~~~~~~~~~~~~~~~~~~~~~ -Specify the color of the email login button for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. - -+-------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"LoginButtonColor": ""`` with string input. | -+-------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| Specify the color of the email login button for white labeling purposes. | - System Config path: **Experimental > Features** | +| Use a hex code with a #-sign before the code. | - ``config.json`` setting: ``EmailSettings`` > ``LoginButtonColor`` > ``"#0000"`` | +| This configuration setting only applies to the mobile app. | - Environment variable: ``MM_EMAILSETTINGS_LOGINBUTTONCOLOR`` | +| | | +| String input. Default is **#0000**. | | ++-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ .. config:setting:: email-login-button-border-color :displayname: Email login button border color (Experimental) :systemconsole: Experimental > Features - :configjson: LoginButtonBorderColor - :environment: N/A - :description: Specify the color of the email login button border for white labeling purposes. Use a hex code with a #-sign before the code. + :configjson: EmailSettings.LoginButtonBorderColor + :environment: MM_EMAILSETTINGS_LOGINBUTTONBORDERCOLOR + :description: Specify the color of the email login button border for white labeling purposes. Use a hex code that begins with # before the code. Default is **#2389D7** Email login button border color ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Specify the color of the email login button border for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. - -+-------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"LoginButtonBorderColor": ""`` with string input. | -+-------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| Specify the color of the email login button border for white labeling purposes. | - System Config path: **Experimental > Features** | +| Use a hex code with a #-sign before the code. | - ``config.json`` setting: ``EmailSettings`` > ``LoginButtonBorderColor`` > ``"#2389D7"`` | +| This setting only applies to the mobile app. | - Environment variable: ``MM_EMAILSETTINGS_LOGINBUTTONBORDERCOLOR`` | +| | | +| String input. Default is **#2389D7**. | | ++----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ .. config:setting:: email-login-button-text-color :displayname: Email login button text color (Experimental) :systemconsole: Experimental > Features - :configjson: LoginButtonTextColor - :environment: N/A - :description: Specify the color of the email login button text for white labeling purposes. Use a hex code with a #-sign before the code. + :configjson: EmailSettings.LoginButtonTextColor + :environment: MM_EMAILSETTINGS_LOGINBUTTONTEXTCOLOR + :description: Specify the color of the email login button text for white labeling purposes. Use a hex code that begins with # before the code. Default is **#2389D7** Email login button text color ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Specify the color of the email login button text for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. - -+-------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"LoginButtonTextColor": ""`` with string input. | -+-------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| Specify the color of the email login button text for white labeling purposes. | - System Config path: **Experimental > Features** | +| Use a hex code with a #-sign before the code. This setting only applies to the | - ``config.json`` setting: ``EmailSettings`` > ``LoginButtonTextColor`` > ``"#2389D7"`` | +| mobile app. | - Environment variable: ``MM_EMAILSETTINGS_LOGINBUTTONTEXTCOLOR`` | +| | | +| String input. Default is **#2389D7**. | | ++-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+ .. config:setting:: enable-account-deactivation :displayname: Enable account deactivation (Experimental) :systemconsole: Experimental > Features - :configjson: EnableUserDeactivation - :environment: N/A + :configjson: TeamSettings.EnableUserDeactivation + :environment: MM_TEAMSETTINGS_ENABLEUSERDEACTIVATION - - **true**: Ability for users to deactivate their own account from **Settings > Advanced** is enabled. - - **false**: **(Default)** Ability for users to deactivate their own account is disabled. + - **true**: Users can deactivate their own account from **Settings > Advanced** is enabled. + - **false**: **(Default)** Users can't deactivate their own account. Enable account deactivation ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**True**: Ability for users to deactivate their own account from **Settings > Advanced > Deactivate Account**. If a user deactivates their own account, they will get an email notification confirming they were deactivated. Available only when authentication is set to use email/password. Not available when authentication uses SAML or AD/LDAP. - -**False**: Ability for users to deactivate their own account is disabled. - -+--------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableUserDeactivation": false`` with options ``true`` and ``false``. | -+--------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| This setting controls whether users can deactivate their own accounts from the Account | - System Config path: **Experimental > Features** | +| Settings menu. | - ``config.json`` setting: ``TeamSettings`` > ``EnableUserDeactivation`` > ``false`` | +| | - Environment variable: ``MM_TEAMSETTINGS_ENABLEUSERDEACTIVATION`` | +| - **True**: Users can deactivate their own account from | | +| **Settings > Advanced > Deactivate Account**. If a user deactivates | | +| their own account, they will get an email notification confirming they | | +| were deactivated. Available only when authentication is set to use email/password. | | +| Not available when authentication uses SAML or AD/LDAP. | | +| | | +| - **False**: **(Default)** Users can't deactivate their own account. | | ++------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ .. config:setting:: enable-automatic-replies :displayname: Enable automatic replies :systemconsole: Experimental > Features - :configjson: ExperimentalEnableAutomaticReplies + :configjson: ServiceSettings.ExperimentalEnableAutomaticReplies :environment: N/A - **true**: Users can enable Automatic Replies in **Settings > Notifications**. @@ -240,45 +263,51 @@ Enable account deactivation Enable automatic replies ~~~~~~~~~~~~~~~~~~~~~~~~ -**True**: Users can enable Automatic Replies in **Settings > Notifications**. Users set a custom message that will be automatically sent in response to Direct Messages. - -**False**: Disables the Automatic Direct Message Replies feature and hides it from **Settings**. - -+--------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExperimentalEnableAutomaticReplies": false`` with options ``true`` and ``false``. | -+--------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| This setting controls whether users can set up automatic replies to direct messages. | - System Config path: **Experimental > Features** | +| | - ``config.json`` setting: ``ServiceSettings`` > ``ExperimentalEnableAutomaticReplies`` > ``false`` | +| - **True**: Users can enable Automatic Replies in **Settings > Notifications**. | - Environment variable: N/A | +| Users set a custom message that will be automatically sent in response to | | +| Direct Messages. | | +| | | +| - **False**: **(Default)** Disables the Automatic Direct Message Replies feature and | | +| hides it from **Settings**. | | ++----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ .. config:setting:: enable-channel-viewed-websocket-messages :displayname: Enable channel viewed websocket messages (Experimental) :systemconsole: Experimental > Features - :configjson: EnableChannelViewedMessages - :environment: N/A + :configjson: ServiceSettings.EnableChannelViewedMessages + :environment: Environment Variable: MM_SERVICESETTINGS_ENABLECHANNELVIEWEDMESSAGES :description: This setting determines whether ``channel_viewed WebSocket`` events are sent, which synchronize unread notifications across clients and devices. Default is **true**. Enable channel viewed websocket messages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting determines whether ``channel_viewed WebSocket`` events are sent, which synchronize unread notifications across clients and devices. - -+------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableChannelViewedMessages": true`` with options ``true`` and ``false``. | -+------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| This setting determines whether ``channel_viewed WebSocket`` events are sent, which synchronize unread | - System Config path: **Experimental > Features** | +| notifications across clients and devices. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableChannelViewedMessages`` > ``true`` | +| | - Environment variable: Environment Variable: MM_SERVICESETTINGS_ENABLECHANNELVIEWEDMESSAGES | +| - **true**: **(Default)** Channel viewed WebSocket events are sent. | | +| - **false**: Channel viewed WebSocket events are not sent. | | ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. note:: Disabling this experimental configuration setting in larger deployments may improve server performance in the following areas: - - Reduced Database Load: When channel_viewed events are disabled, the server no longer needs to log these events in the database. This reduces the number of write and update operations, which can be substantial in a busy server with many users frequently switching channels. - - Decreased Network Traffic: Disabling these events means there are fewer messages sent between the server and clients. This reduction in network traffic can lower latency and improve the overall responsiveness of the server, especially for users with slower connections. - - Lower Server CPU Usage: Processing channel_viewed events requires CPU resources to handle database transactions and network communication. Without these events, the server's CPU can be utilized more efficiently for other tasks, improving the overall performance. - - Improved User Experience: With reduced server load and network traffic, users may experience faster loading times and a more fluid interaction with the application. - - However, disabling this configuration setting affects some functionality, such as accurate tracking of read and unread messages in channels. It’s important to balance performance improvements with the needs of your organization and users. + - **Reduced Database Load**: When channel_viewed events are disabled, the server no longer needs to log these events in the database. This reduces the number of write and update operations, which can be substantial in a busy server with many users frequently switching channels. + - **Decreased Network Traffic**: Disabling these events means there are fewer messages sent between the server and clients. This reduction in network traffic can lower latency and improve the overall responsiveness of the server, especially for users with slower connections. + - **Lower Server CPU Usage**: Processing channel_viewed events requires CPU resources to handle database transactions and network communication. Without these events, the server's CPU can be utilized more efficiently for other tasks, improving the overall performance. + - **Improved User Experience**: With reduced server load and network traffic, users may experience faster loading times and a more fluid interaction with the application. + + However, disabling this configuration setting affects some functionality, such as accurate tracking of read and unread messages in channels. It's important to balance performance improvements with the needs of your organization and users. .. config:setting:: enable-default-channel-leavejoin-system-messages :displayname: Enable default channel leave/join system messages (Experimental) :systemconsole: Experimental > Features - :configjson: ExperimentalEnableDefaultChannelLeaveJoinMessages - :environment: N/A + :configjson: ServiceSettings.ExperimentalEnableDefaultChannelLeaveJoinMessages + :environment: MM_SERVICESETTINGS_EXPERIMENTALENABLEDEFAULTCHANNELLEAVEJOINMESSAGES :description: This setting determines whether team leave/join system messages are posted in the default ``town-square`` channel. - **true**: **(Default)** Enables leave/join system messages in the default ``town-square`` channel. @@ -287,21 +316,20 @@ This setting determines whether ``channel_viewed WebSocket`` events are sent, wh Enable default channel leave/join system messages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting determines whether team leave/join system messages are posted in the default ``town-square`` channel. - -**True**: Enables leave/join system messages in the default ``town-square`` channel. - -**False**: Disables leave/join messages from the default ``town-square`` channel. These system messages won't be added to the database either. - -+----------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExperimentalEnableDefaultChannelLeaveJoinMessages": true`` with options ``true`` and ``false``. | -+----------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| This setting determines whether team leave/join system messages are posted in the default | - System Config path: **Experimental > Features** | +| ``town-square`` channel. | - ``config.json`` setting: ``ServiceSettings`` > ``ExperimentalEnableDefaultChannelLeaveJoinMessages`` > ``true`` | +| | - Environment variable: ``MM_SERVICESETTINGS_EXPERIMENTALENABLEDEFAULTCHANNELLEAVEJOINMESSAGES`` | +| - **true**: **(Default)** Enables leave/join system messages in the default ``town-square`` channel. | | +| - **false**: Disables leave/join messages from the default ``town-square`` channel. These system | | +| messages won't be added to the database either. | | ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: enable-hardened-mode :displayname: Enable hardened mode (Experimental) :systemconsole: Experimental > Features - :configjson: ExperimentalEnableHardenedMode - :environment: N/A + :configjson: ServiceSettings.ExperimentalEnableHardenedMode + :environment: MM_SERVICESETTINGS_EXPERIMENTALENABLEHARDENEDMODE - **true**: Enables a hardened mode for Mattermost that makes user experience trade-offs in the interest of security. - **false**: **(Default)** Disables hardened mode. @@ -309,27 +337,28 @@ This setting determines whether team leave/join system messages are posted in th Enable hardened mode ~~~~~~~~~~~~~~~~~~~~ -**True**: Enables a hardened mode for Mattermost that makes user experience trade-offs in the interest of security. - -**False**: Disables hardened mode. ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| This setting enables or disables hardened mode, which makes user experience trade-offs in the interest | - System Config path: **Experimental > Features** | +| of security. | - ``config.json`` setting: ``ServiceSettings`` > ``ExperimentalEnableHardenedMode`` > ``false`` | +| | - Environment variable: MM_SERVICESETTINGS_EXPERIMENTALENABLEHARDENEDMODE | +| - **true**: Enables a hardened mode for Mattermost that makes user experience trade-offs in the | | +| interest of security. | | +| - **false**: **(Default)** Disables hardened mode. | | ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ Changes made when hardened mode is enabled: - Failed login returns a generic error message instead of a specific message for username and password. -- If :doc:`multi-factor authentication (MFA) ` is enabled, the route to check if a user has MFA enabled always returns true. This causes the MFA input screen to appear even if the user does not have MFA enabled. The user may enter any value to pass the screen. Note that hardened mode does not affect user experience when MFA is enforced. +- When :doc:`multi-factor authentication (MFA) ` is enabled, the route to check if a user has MFA enabled always returns true. This causes the MFA input screen to appear even if the user does not have MFA enabled. The user may enter any value to pass the screen. Note that hardened mode does not affect user experience when MFA is enforced. - Password reset does not inform the user that they can not reset their SSO account through Mattermost and instead claims to have sent the password reset email. - Mattermost sanitizes all 500 errors before returned to the client. Use the supplied ``request_id`` to match user facing errors with the server logs. - Standard users authenticated via username and password can't use post props reserved for integrations, such as ``override_username`` or ``override_icon_url``. -+----------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExperimentalEnableHardenedMode": false`` with options ``true`` and ``false``. | -+----------------------------------------------------------------------------------------------------------------------------+ - .. config:setting:: enable-theme-selection :displayname: Enable theme selection (Experimental) :systemconsole: Experimental > Features - :configjson: EnableThemeSelection - :environment: N/A + :configjson: ThemeSettings.EnableThemeSelection + :environment: MM_THEMESETTINGS_ENABLETHEMESELECTION - **true**: **(Default)** Enables the **Display > Theme** tab in **Settings** so users can select their theme. - **false**: Users cannot select a different theme. The **Display > Theme** tab is hidden in **Settings**. @@ -340,19 +369,20 @@ Enable theme selection .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -**True**: Enables the **Display > Theme** tab in **Settings** so users can select their theme. - -**False**: Users cannot select a different theme. The **Display > Theme** tab is hidden in **Settings**. - -+-----------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableThemeSelection": true`` with options ``true`` and ``false``. | -+-----------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ +| This setting controls whether users can select different themes for their Mattermost interface. | - System Config path: **Experimental > Features** | +| | - ``config.json`` setting: ``ThemeSettings`` > ``EnableThemeSelection`` > ``true`` | +| - **true**: **(Default)** Enables the **Display > Theme** tab in **Settings** so users can select | - Environment variable: ``MM_THEMESETTINGS_ENABLETHEMESELECTION`` | +| their theme. | | +| - **false**: Users cannot select a different theme. The **Display > Theme** tab is hidden in | | +| **Settings**. | | ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ .. config:setting:: allow-custom-themes :displayname: Allow custom themes (Experimental) :systemconsole: Experimental > Features - :configjson: AllowCustomThemes - :environment: N/A + :configjson: ThemeSettings.AllowCustomThemes + :environment: MM_THEMESETTINGS_ALLOWCUSTOMTHEMES - **true**: **(Default)** Enables the **Display > Theme > Custom Theme** section in **Settings**. - **false**: Users cannot use a custom theme. The **Display > Theme > Custom Theme** section is hidden in **Settings**. @@ -363,19 +393,19 @@ Allow custom themes .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -**True**: Enables the **Display > Theme > Custom Theme** section in **Settings**. - -**False**: Users cannot use a custom theme. The **Display > Theme > Custom Theme** section is hidden in **Settings**. - -+--------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"AllowCustomThemes": true`` with options ``true`` and ``false``. | -+--------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| This setting controls whether users can create and use custom themes beyond the default theme options. | - System Config path: **Experimental > Features** | +| | - ``config.json`` setting: ``ThemeSettings`` > ``AllowCustomThemes`` > ``true`` | +| - **true**: **(Default)** Enables the **Display > Theme > Custom Theme** section in **Settings**. | - Environment variable: ``MM_THEMESETTINGS_ALLOWCUSTOMTHEMES`` | +| - **false**: Users cannot use a custom theme. The **Display > Theme > Custom Theme** section is | | +| hidden in **Settings**. | | ++----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ .. config:setting:: default-theme :displayname: Default theme (Experimental) :systemconsole: Experimental > Features - :configjson: DefaultTheme - :environment: N/A + :configjson: ThemeSettings.DefaultTheme + :environment: MM_THEMESETTINGS_DEFAULTTHEME :description: Set a default theme that applies to all new users on the system. Default is **default**. Default theme @@ -384,17 +414,17 @@ Default theme .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -Set a default theme that applies to all new users on the system. - -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"DefaultTheme": "default"`` with options ``"default"``, ``"organization"``, ``"mattermostDark"``, and ``"windows10"``. | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| Set a default theme that applies to all new users on the system. | - System Config path: **Experimental > Features** | +| | - ``config.json`` setting: ``ThemeSettings`` > ``DefaultTheme`` > ``"default"`` | +| Options include ``"default"``, ``"organization"``, ``"mattermostDark"``, and ``"windows10"``. | - Environment variable: ``MM_THEMESETTINGS_DEFAULTTHEME`` | ++--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ .. config:setting:: enable-tutorial :displayname: Enable tutorial (Experimental) :systemconsole: Experimental > Features - :configjson: EnableTutorial - :environment: N/A + :configjson: ServiceSettings.EnableTutorial + :environment: MM_SERVICESETTINGS_ENABLETUTORIAL - **true**: **(Default)** Users are prompted with a tutorial when they open Mattermost for the first time after account creation. - **false**: The tutorial is disabled. Users are placed in Town Square when they open Mattermost for the first time after account creation. @@ -402,19 +432,20 @@ Set a default theme that applies to all new users on the system. Enable tutorial ~~~~~~~~~~~~~~~ -**True**: Users are prompted with a tutorial when they open Mattermost for the first time after account creation. - -**False**: The tutorial is disabled. Users are placed in Town Square when they open Mattermost for the first time after account creation. - -+--------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ServiceSettings.EnableTutorial": true`` with options ``true`` and ``false``. | -+--------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| This setting controls whether new users are shown a tutorial when they first open Mattermost. | - System Config path: **Experimental > Features** | +| | - ``config.json`` setting: ``ServiceSettings`` > ``EnableTutorial`` > ``true`` | +| - **true**: **(Default)** Users are prompted with a tutorial when they open Mattermost for the first | - Environment variable: MM_SERVICESETTINGS_ENABLETUTORIAL | +| time after account creation. | | +| - **false**: The tutorial is disabled. Users are placed in Town Square when they open Mattermost for | | +| the first time after account creation. | | ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ .. config:setting:: enable-onboarding-flow :displayname: Enable onboarding flow (Experimental) :systemconsole: Experimental > Features - :configjson: EnableOnboardingFlow - :environment: N/A + :configjson: ServiceSettings.EnableOnboardingFlow + :environment: MM_SERVICESETTINGS_ENABLEONBOARDINGFLOW - **true**: **(Default)** New Mattermost users are shown key tasks to complete as part of initial onboarding. - **false**: User onboarding tasks are disabled. Users are placed in Town Square when they open Mattermost for the first time after account creation. @@ -422,29 +453,32 @@ Enable tutorial Enable onboarding flow ~~~~~~~~~~~~~~~~~~~~~~ -**True**: New Mattermost users are shown key tasks to complete as part of initial onboarding. - -**False**: User onboarding tasks are disabled. Users are placed in Town Square when they open Mattermost for the first time after account creation. - -+--------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ServiceSettings.EnableOnboardingFlow": true`` with options ``true`` and ``false``. | -+--------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| This setting controls whether new users are shown onboarding tasks when they first use Mattermost. | - System Config path: **Experimental > Features** | +| | - ``config.json`` setting: ``ServiceSettings`` > ``EnableOnboardingFlow`` > ``true`` | +| - **true**: **(Default)** New Mattermost users are shown key tasks to complete as part of initial | - Environment variable: MM_SERVICESETTINGS_ENABLEONBOARDINGFLOW | +| onboarding. | | +| - **false**: User onboarding tasks are disabled. Users are placed in Town Square when they open | | +| Mattermost for the first time after account creation. | | ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ .. config:setting:: enable-user-typing-messages :displayname: Enable user typing messages (Experimental) :systemconsole: Experimental > Features - :configjson: EnableUserTypingMessages - :environment: N/A + :configjson: ServiceSettings.EnableUserTypingMessages + :environment: MM_SERVICESETTINGS_ENABLEUSERTYPINGMESSAGES :description: This setting determines whether "user is typing..." messages are displayed below the message box. Default is **true**. Enable user typing messages ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting determines whether "user is typing..." messages are displayed below the message box when using Mattermost in a web browser or the desktop app. - -+---------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableUserTypingMessages": true`` with options ``true`` and ``false``. | -+---------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| This setting determines whether "user is typing..." messages are displayed below the message box when | - System Config path: **Experimental > Features** | +| using Mattermost in a web browser or the desktop app. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableUserTypingMessages`` > ``true`` | +| | - Environment variable: MM_SERVICESETTINGS_ENABLEUSERTYPINGMESSAGES | +| - **true**: **(Default)** "User is typing..." messages are displayed. | | +| - **false**: "User is typing..." messages are not displayed. | | ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. note:: @@ -457,34 +491,36 @@ This setting determines whether "user is typing..." messages are displayed below .. config:setting:: user-typing-timeout :displayname: User typing timeout (Experimental) :systemconsole: Experimental > Features - :configjson: TimeBetweenUserTypingUpdatesMilliseconds + :configjson: ServiceSettings.TimeBetweenUserTypingUpdatesMilliseconds :environment: N/A :description: This setting defines how frequently "user is typing..." messages are updated, measured in milliseconds. Default is **5000** milliseconds. User typing timeout ~~~~~~~~~~~~~~~~~~~ -This setting defines how frequently "user is typing..." messages are updated, measured in milliseconds. - -+----------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"TimeBetweenUserTypingUpdatesMilliseconds": 5000`` with numerical input. | -+----------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ +| This setting defines how frequently "user is typing..." | - System Config path: **Experimental > Features** | +| messages are updated, measured in milliseconds. | - ``config.json`` setting: ``ServiceSettings`` > ``TimeBetweenUserTypingUpdatesMilliseconds`` > ``5000`` | +| | - Environment variable: N/A | +| Numerical input. Default is **5000** milliseconds. | | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ .. config:setting:: users-status-and-profile-fetching-poll-interval :displayname: User's status and profile fetching poll interval (Experimental) :systemconsole: Experimental > Features - :configjson: UsersStatusAndProfileFetchingPollIntervalMilliseconds - :environment: N/A - :description: The number of milliseconds to wait between fetching user statuses and profiles periodically. + :configjson: ExperimentalSettings.UsersStatusAndProfileFetchingPollIntervalMilliseconds + :environment: MM_EXPERIMENTALSETTINGS_USERSSTATUSANDPROFILEFETCHINGPOLLINTERVALMILLISECONDS + :description: The number of milliseconds to wait between fetching user statuses and profiles periodically. Default is **3000** milliseconds. Set to **0** to disable. User's status and profile fetching poll interval ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting configures the number of milliseconds to wait between fetching user statuses and profiles periodically. Set to ``0`` to disable. - -+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExperimentalSettings.UsersStatusAndProfileFetchingPollIntervalMilliseconds": 3000`` with numerical input. | -+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| This setting configures the number of milliseconds to wait between fetching user statuses and profiles | - System Config path: **Experimental > Features** | +| periodically. Set to **0** to disable. | - ``config.json`` setting: ``ExperimentalSettings`` > ``UsersStatusAndProfileFetchingPollIntervalMilliseconds`` > ``3000`` | +| | - Environment variable: MM_EXPERIMENTALSETTINGS_USERSSTATUSANDPROFILEFETCHINGPOLLINTERVALMILLISECONDS | +| Numerical input. Default is **3000** milliseconds. Set to **0** to disable. | | ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ .. note:: @@ -493,27 +529,30 @@ This setting configures the number of milliseconds to wait between fetching user .. config:setting:: primary-team :displayname: Primary team (Experimental) :systemconsole: Experimental > Features - :configjson: ExperimentalPrimaryTeam + :configjson: ServiceSettings.ExperimentalPrimaryTeam :environment: N/A :description: The primary team of which users on the server are members. When a primary team is set, the options to join other teams or leave the primary team are disabled. Primary team ~~~~~~~~~~~~ -The primary team of which users on the server are members. When a primary team is set, the options to join other teams or leave the primary team are disabled. - -If the team URL of the primary team is ``https://example.mattermost.com/myteam/``, then set the value to ``myteam`` in ``config.json``. - -+-----------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExperimentalPrimaryTeam": ""`` with string input. | -+-----------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +| The primary team of which users on the server are members. | - System Config path: **Experimental > Features** | +| When a primary team is set, the options to join other teams or leave | - ``config.json`` setting: ``ServiceSettings`` > ``ExperimentalPrimaryTeam`` > ``""`` | +| the primary team are disabled. | - Environment variable: N/A | +| | | +| If the team URL of the primary team is ``https://example.mattermost.com/myteam/``, | | +| then set the value to **myteam** in ``config.json``. | | +| | | +| String input. | | ++------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ .. config:setting:: saml-login-button-color :displayname: SAML login button color (Experimental) :systemconsole: Experimental > Features - :configjson: LoginButtonColor - :environment: N/A - :description: Specify the color of the SAML login button for white labeling purposes. Use a hex code with a #-sign before the code. + :configjson: SamlSettings.LoginButtonColor + :environment: MM_SAMLSETTINGS_LOGINBUTTONCOLOR + :description: Specify the color of the SAML login button for white labeling purposes. Use a hex code that begins with # before the code. Default is **#34a28b** SAML login button color ~~~~~~~~~~~~~~~~~~~~~~~ @@ -521,18 +560,20 @@ SAML login button color .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -Specify the color of the SAML login button for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. - -+-------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"LoginButtonColor": ""`` with string input. | -+-------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| Specify the color of the SAML login button for white labeling purposes. | - System Config path: **Experimental > Features** | +| Use a hex code that begins with # before the code. | - ``config.json`` setting: ``SamlSettings`` > ``LoginButtonColor`` > ``"#34a28b"`` | +| This setting only applies to the mobile app. | - Environment variable: ``MM_SAMLSETTINGS_LOGINBUTTONCOLOR`` | +| | | +| String input. Default is **#34a28b**. | | ++------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ .. config:setting:: saml-login-button-border-color :displayname: SAML login button border color (Experimental) :systemconsole: Experimental > Features - :configjson: LoginButtonBorderColor - :environment: N/A - :description: Specify the color of the SAML login button border for white labeling purposes. Use a hex code with a #-sign before the code. + :configjson: SamlSettings.LoginButtonBorderColor + :environment: MM_SAMLSETTINGS_LOGINBUTTONBORDERCOLOR + :description: Specify the color of the SAML login button border for white labeling purposes. Use a hex code that begins with # before the code. Default is **#2389D7**. SAML login button border color ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -540,18 +581,20 @@ SAML login button border color .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -Specify the color of the SAML login button border for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. - -+-------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"LoginButtonBorderColor": ""`` with string input. | -+-------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +| Specify the color of the SAML login button border for white labeling purposes. | - System Config path: **Experimental > Features** | +| Use a hex code with a #-sign before the code. | - ``config.json`` setting: ``SamlSettings`` > ``LoginButtonBorderColor`` > ``"#2389D7"`` | +| This setting only applies to the mobile app. | - Environment variable: ``MM_SAMLSETTINGS_LOGINBUTTONBORDERCOLOR`` | +| | | +| String input. Default is **#2389D7**. | | ++----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ .. config:setting:: saml-login-button-text-color :displayname: SAML login button text color (Experimental) :systemconsole: Experimental > Features - :configjson: LoginButtonTextColor - :environment: N/A - :description: Specify the color of the SAML login button text for white labeling purposes. Use a hex code with a #-sign before the code. + :configjson: SamlSettings.LoginButtonTextColor + :environment: MM_SAMLSETTINGS_LOGINBUTTONTEXTCOLOR + :description: Specify the color of the SAML login button text for white labeling purposes. Use a hex code that begins with # before the code. Default is **#ffffff**. SAML login button text color ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -559,17 +602,19 @@ SAML login button text color .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -Specify the color of the SAML login button text for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. - -+-------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"LoginButtonTextColor": ""`` with string input. | -+-------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| Specify the color of the SAML login button text for white labeling purposes. | - System Config path: **Experimental > Features** | +| Use a hex code with a #-sign before the code. | - ``config.json`` setting: ``SamlSettings`` > ``LoginButtonTextColor`` > ``"#ffffff"`` | +| This setting only applies to the mobile app. | - Environment variable: ``MM_SAMLSETTINGS_LOGINBUTTONTEXTCOLOR`` | +| | | +| String input. Default is **#ffffff**. | | ++-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. config:setting:: use-channel-name-in-email-notifications :displayname: Use channel name in email notifications (Experimental) :systemconsole: Experimental > Features - :configjson: UseChannelInEmailNotifications - :environment: N/A + :configjson: SamlSettings.UseChannelInEmailNotifications + :environment: MM_EMAILSETTINGS_USECHANNELINEMAILNOTIFICATIONS - **true**: Channel and team name appears in email notification subject lines. - **false**: **(Default)** Only team name appears in email notification subject line. @@ -577,81 +622,122 @@ Specify the color of the SAML login button text for white labeling purposes. Use Use channel name in email notifications ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**True**: Channel and team name appears in email notification subject lines. Useful for servers using only one team. - -**False**: Only team name appears in email notification subject line. - -+----------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"UseChannelInEmailNotifications": false`` with options ``true`` and ``false``. | -+----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| This setting controls whether channel names are included in email notification subject lines. | - System Config path: **Experimental > Features** | +| | - ``config.json`` setting: ``ServiceSettings`` > ``UseChannelInEmailNotifications`` > ``false`` | +| - **true**: Channel and team name appears in email notification subject lines. Useful for servers | - Environment variable: MM_EMAILSETTINGS_USECHANNELINEMAILNOTIFICATIONS | +| using only one team. | | +| - **false**: **(Default)** Only team name appears in email notification subject line. | | ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ .. config:setting:: user-status-away-timeout :displayname: User status away timeout (Experimental) :systemconsole: Experimental > Features - :configjson: UserStatusAwayTimeout - :environment: N/A + :configjson: SamlSettings.UserStatusAwayTimeout + :environment: MM_TEAMSETTINGS_USERSTATUSAWAYTIMEOUT :description: This setting defines the number of seconds after which the user's status indicator changes to "Away", when they are away from Mattermost. Default is **300** seconds. User status away timeout ~~~~~~~~~~~~~~~~~~~~~~~~ -This setting defines the number of seconds after which the user's status indicator changes to "Away", when they are away from Mattermost. ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| This setting defines the number of seconds after which | - System Config path: **Experimental > Features** | +| the user's status indicator changes to **Away**, when they | - ``config.json`` setting: ``ServiceSettings`` > ``UserStatusAwayTimeout`` > ``300`` | +| are away from Mattermost. | - Environment variable: MM_TEAMSETTINGS_USERSTATUSAWAYTIMEOUT | +| | | +| Numerical input. Default is **300** seconds. | | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------+ + +.. config:setting:: disable-data-refetching-on-browser-refocus + :displayname: Disable data refetching on browser refocus (Experimental) + :systemconsole: Experimental > Features + :configjson: ExperimentalSettings.DisableRefetchingOnBrowserFocus + :environment: MM_EXPERIMENTALSETTINGS_DISABLEREFETCHINGONBROWSERFOCUS + :description: This setting disables re-fetching of channel and channel members on browser focus. -+--------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"UserStatusAwayTimeout": 300`` with numerical input. | -+--------------------------------------------------------------------------------------------------+ + - **true**: Mattermost won't refetch channels and channel members when the browser regains focus. + - **false**: **(Default)** Mattermost will refetch channels and channel members when the browser regains focus. Disable data refetching on browser refocus ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting disables re-fetching of channel and channel members on browser focus. - -**True**: Mattermost won't refetch channels and channel members when the browser regains focus. This may result in improved performance for users with many channels and channel members. - -**False**: (Default) Mattermost will refetch channels and channel members when the browser regains focus. ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| This setting disables re-fetching of channel and channel members on browser focus. | - System Config path: **Experimental > Features** | +| | - ``config.json`` setting: ``ExperimentalSettings`` > ``DisableRefetchingOnBrowserFocus`` > ``false`` | +| - **true**: Mattermost won't refetch channels and channel members when the browser regains focus. | - Environment variable: MM_EXPERIMENTALSETTINGS_DISABLEREFETCHINGONBROWSERFOCUS | +| This may result in improved performance for users with many channels and channel members. | | +| - **false**: **(Default)** Mattermost will refetch channels and channel members when the browser | | +| regains focus. | | ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. config:setting:: disable-wake-up-reconnect-handler + :displayname: Disable wake up reconnect handler (Experimental) + :systemconsole: Experimental > Features + :configjson: ExperimentalSettings.DisableWakeUpReconnectHandler + :environment: MM_EXPERIMENTALSETTINGS_DISABLEWAKEUPRECONNECTHANDLER + :description: This setting disables attempts to detect when the computer has woken up and refetch data. -+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExperimentalSettings.DisableRefetchingOnBrowserFocus": false`` with options ``true`` and ``false``. | -+--------------------------------------------------------------------------------------------------------------------------------------------------+ + - **true**: Mattermost won't attempt to detect when the computer has woken up and refetch data. + - **false**: **(Default)** Mattermost attempts to detect when the computer has woken up and refreshes data. Disable wake up reconnect handler ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting disables attempts to detect when the computer has woken up and refetch data. - -**True**: Mattermost won't attempt to detect when the computer has woken up and refetch data. This might reduce the amount of regular network traffic the app is sending. - -**False**: (**Default**) Mattermost attempts to detect when the computer has woken up and refreshes data. ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| This setting disables attempts to detect when the computer has woken up and refetch data. | - System Config path: **Experimental > Features** | +| | - ``config.json`` setting: ``ExperimentalSettings`` > ``DisableWakeUpReconnectHandler`` > ``false`` | +| - **true**: Mattermost won't attempt to detect when the computer has woken up and refetch data. | - Environment variable: MM_EXPERIMENTALSETTINGS_DISABLEWAKEUPRECONNECTHANDLER | +| This might reduce the amount of regular network traffic the app is sending. | | +| - **false**: **(Default)** Mattermost attempts to detect when the computer has woken up and refreshes | | +| data. | | ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + +.. config:setting:: delay-channel-autocomplete + :displayname: Delay channel autocomplete (Experimental) + :systemconsole: Experimental > Features + :configjson: ExperimentalSettings.DelayChannelAutocomplete + :environment: MM_EXPERIMENTALSETTINGS_DELAYCHANNELAUTOCOMPLETE + :description: This setting controls whether the channel link autocomplete triggers immediately when a tilde is typed when composing a message. -+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExperimentalSettings.DisableWakeUpReconnectHandler": false`` with options ``true`` and ``false``. | -+--------------------------------------------------------------------------------------------------------------------------------------------------+ + - **true**: The autocomplete appears after the user types a tilde followed by two or more characters. + - **false**: **(Default)** The autocomplete appears immediately after the user types a tilde. Delay channel autocomplete ~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting controls whether or not the channel link autocomplete triggers immediately when after a tilde is typed when composing a message. This setting makes the channel autocomplete, such as ``~town-square``, less obtrusive for people who use tildes ``~`` as punctuation. - -**True**: The autocomplete appears after the user types a tilde followed by two or more characters. For example, typing ``~to`` will show the autocomplete, but typing ``~`` will not. - -**False**: **(Default)** The autocomplete appears immediately after the user types a tilde. For example, typing ``~`` will show the autocomplete. ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| This setting controls whether or not the channel link autocomplete triggers immediately when after a | - System Config path: **Experimental > Features** | +| tilde is typed when composing a message. This setting makes the channel autocomplete, such as | - ``config.json`` setting: ``ExperimentalSettings`` > ``DelayChannelAutocomplete`` > ``false`` | +| ``~town-square``, less obtrusive for people who use tildes ``~`` as punctuation. | - Environment variable: MM_EXPERIMENTALSETTINGS_DELAYCHANNELAUTOCOMPLETE | +| | | +| - **true**: The autocomplete appears after the user types a tilde followed by two or more characters. | | +| For example, typing ``~to`` will show the autocomplete, but typing ``~`` will not. | | +| - **false**: **(Default)** The autocomplete appears immediately after the user types a tilde. | | +| For example, typing ``~`` will show the autocomplete. | | ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + +.. config:setting:: youtube-referrer-policy + :displayname: YouTube referrer policy (Experimental) + :systemconsole: Experimental > Features + :configjson: ExperimentalSettings.YoutubeReferrerPolicy + :environment: MM_EXPERIMENTALSETTINGS_YOUTUBEREFERRERPOLICY + :description: This setting resolves issues where YouTube video previews display as unavailable. -+-------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExperimentalSettings.DelayChannelAutocomplete": false`` with options ``true`` and ``false``. | -+-------------------------------------------------------------------------------------------------------------------------------------------+ + - **true**: The referrer policy for embedded YouTube videos is set to ``strict-origin-when-cross-origin``. + - **false**: **(Default)** The referrer policy is set to ``no-referrer`` which enhances user privacy. YouTube referrer policy -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This setting resolves issues where YouTube video previews display as unavailable. - -**True**: The referrer policy for embedded YouTube videos is set to ``strict-origin-when-cross-origin``. - -**False**: (Default) The referrer policy is set to ``no-referrer`` which enhances user privacy by not disclosing the source URL, but limits the ability to track user engagement and traffic sources in analytics tools. +~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExperimentalSettings.YoutubeReferrerPolicy": false`` with options ``true`` and ``false``. | -+-------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| This setting resolves issues where YouTube video previews display as unavailable. | - System Config path: **Experimental > Features** | +| | - ``config.json`` setting: ``ExperimentalSettings`` > ``YoutubeReferrerPolicy`` > ``false`` | +| - **true**: The referrer policy for embedded YouTube videos is set to | - Environment variable: MM_EXPERIMENTALSETTINGS_YOUTUBEREFERRERPOLICY | +| ``strict-origin-when-cross-origin``. | | +| - **false**: **(Default)** The referrer policy is set to ``no-referrer`` which enhances user privacy | | +| by not disclosing the source URL, but limits the ability to track user engagement and traffic | | +| sources in analytics tools. | | ++----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ ---- @@ -666,8 +752,8 @@ Access the following configuration settings in the System Console by going to ** .. config:setting:: enable-bleve-indexing :displayname: Enable Bleve indexing (Experimental) :systemconsole: Experimental > Bleve - :configjson: EnableIndexing - :environment: N/A + :configjson: BleveSettings.EnableIndexing + :environment: MM_BLEVESETTINGS_ENABLEINDEXING - **true**: The indexing of new posts occurs automatically. - **false**: **(Default)** The indexing of new posts does not occur automatically. @@ -675,34 +761,41 @@ Access the following configuration settings in the System Console by going to ** Enable Bleve indexing ~~~~~~~~~~~~~~~~~~~~~ -**True**: The indexing of new posts occurs automatically. Search queries will not use bleve search until :ref:`Enable Bleve for search queries ` is enabled. ++----------------------------------------------------------+-------------------------------------------------------------------------------+ +| This setting controls whether Bleve indexing is | - System Config path: **Experimental > Bleve** | +| enabled for posts to support search functionality. | - ``config.json`` setting: ``BleveSettings`` > ``EnableIndexing`` > ``false`` | +| | - Environment variable: MM_BLEVESETTINGS_ENABLEINDEXING | +| - **true**: The indexing of new posts occurs | | +| automatically. | | +| | | +| - **false**: **(Default)** The indexing of new posts | | +| does not occur automatically. | | ++----------------------------------------------------------+-------------------------------------------------------------------------------+ -**False**: The indexing of new posts does not occur automatically. +.. note:: -+------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableIndexing": false`` with options ``true`` and ``false``. | -+------------------------------------------------------------------------------------------------------------+ + Search queries won't use bleve search until the :ref:`Enable Bleve for search queries ` setting is enabled. .. config:setting:: index-directory :displayname: Index directory (Experimental) :systemconsole: Experimental > Bleve - :configjson: IndexDir - :environment: N/A + :configjson: BleveSettings.IndexDir + :environment: MM_BLEVESETTINGS_INDEXDIR :description: Directory path to use for storing bleve indexes. Index directory ~~~~~~~~~~~~~~~ -Directory path to use for storing bleve indexes. ++-----------------------------------------------------------+----------------------------------------------------------------------+ +| Directory path to use for storing bleve indexes. | - System Config path: **Experimental > Bleve** | +| | - ``config.json`` setting: ``BleveSettings`` > ``IndexDir`` > ``""`` | +| String input. | - Environment variable: MM_BLEVESETTINGS_INDEXDIR | ++-----------------------------------------------------------+----------------------------------------------------------------------+ .. tip:: The bleve index directory path isn't required to exist within the ``mattermost`` directory. When it exists outside of the ``mattermost`` directory, no additional steps are needed to preserve or reindex these files as part of a Mattermost upgrade. See our :doc:`Upgrading Mattermost Server ` documentation for details. -+-----------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"IndexDir": ""`` with string input. | -+-----------------------------------------------------------------------------------------------------------+ - Bulk index now ~~~~~~~~~~~~~~ @@ -716,8 +809,8 @@ Select **Purge Index** to remove the contents of the Bleve index directory. Sear .. config:setting:: enable-bleve-indexingsearch :displayname: Enable Bleve for search queries (Experimental) :systemconsole: Experimental > Bleve - :configjson: EnableSearching - :environment: N/A + :configjson: BleveSettings.EnableSearching + :environment: MM_BLEVESETTINGS_ENABLESEARCHING - **true**: Search queries will use bleve search. - **false**: **(Default)** Search queries will not use bleve search. @@ -725,19 +818,19 @@ Select **Purge Index** to remove the contents of the Bleve index directory. Sear Enable Bleve for search queries ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**True**: Search queries will use bleve search. - -**False**: Search queries will not use bleve search. - -+--------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableSearching": false`` with options ``true`` and ``false``. | -+--------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| This setting controls whether Bleve search engine is used for search queries instead of the default | - System Config path: **Experimental > Bleve** | +| database search. | - ``config.json`` setting: ``BleveSettings`` > ``EnableSearching`` > ``false`` | +| | - Environment variable: MM_BLEVESETTINGS_ENABLESEARCHING | +| - **true**: Search queries will use bleve search. | | +| - **false**: **(Default)** Search queries will not use bleve search. | | ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ .. config:setting:: enable-bleve-indexingautocomplete :displayname: Enable Bleve for autocomplete queries (Experimental) :systemconsole: Experimental > Bleve - :configjson: EnableAutocomplete - :environment: N/A + :configjson: BleveSettings.EnableAutocomplete + :environment: MM_BLEVESETTINGS_ENABLEAUTOCOMPLETE - **true**: Autocomplete queries will use bleve search. - **false**: **(Default)** Autocomplete queries will not use bleve search. @@ -745,13 +838,13 @@ Enable Bleve for search queries Enable Bleve for autocomplete queries ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**True**: Autocomplete queries will use bleve search. - -**False**: Autocomplete queries will not use bleve search. - -+-----------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableAutocomplete": false`` with options ``true`` and ``false``. | -+-----------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| This setting controls whether Bleve search engine is used for autocomplete queries instead of the | - System Config path: **Experimental > Bleve** | +| default database search. | - ``config.json`` setting: ``BleveSettings`` > ``EnableAutocomplete`` > ``false`` | +| | - Environment variable: MM_BLEVESETTINGS_ENABLEAUTOCOMPLETE | +| - **true**: Autocomplete queries will use bleve search. | | +| - **false**: **(Default)** Autocomplete queries will not use bleve search. | | ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ ---- @@ -768,7 +861,7 @@ Enable the following settings to output audit events in the System Console by go :displayname: Advanced Logging (Audit Logging > Cloud) :systemconsole: Experimental > Features :configjson: AdvancedLoggingJSON - :environment: N/A + :environment: MM_EXPERIMENTALAUDITSETTINGS_ADVANCEDLOGGINGJSON :description: Output log and audit records to any combination of console, local file, syslog, and TCP socket targets for a Mattermost Cloud deployment. Advanced logging @@ -782,8 +875,8 @@ Output log and audit records to any combination of console, local file, syslog, .. config:setting:: enable-audit-logging :displayname: Enable audit logging (Audit Logging > Self-Hosted) :systemconsole: Experimental > Features - :configjson: FileEnabled - :environment: N/A + :configjson: ExperimentalAuditSettings.FileEnabled + :environment: MM_EXPERIMENTALAUDITSETTINGS_FILEENABLED :description: Write audit files locally for a self-hosted deployment. Enable audit logging @@ -792,21 +885,22 @@ Enable audit logging .. include:: ../_static/badges/ent-cloud-selfhosted.rst :start-after: :nosearch: -When audit logging is enabled in a self-hosted instance, you can specify size, backup interval, compression, maximium age to manage file rotation, and timestamps for audit logging, as defined below. You can specify these settings independently for audit events and AD/LDAP events. - -**True**: Audit logging files are enabled, and audit files are written locally to a file for a self-hosted deployment. - -**False**: Audit logging files aren't enabled, and audit logs aren't written locally to a file for a self-hosted deployment. - -+--------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileEnabled": false",`` with options ``true`` and ``false``. | -+--------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| When audit logging is enabled in a self-hosted instance, you can specify size, backup interval, | - System Config path: **Experimental > Features** | +| compression, maximum age to manage file rotation, and timestamps for audit logging, as defined below. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileEnabled`` > ``false`` | +| You can specify these settings independently for audit events and AD/LDAP events. | - Environment variable: MM_EXPERIMENTALAUDITSETTINGS_FILEENABLED | +| | | +| - **true**: Audit logging files are enabled, and audit files are written locally to a file for a | | +| self-hosted deployment. | | +| - **false**: **(Default)** Audit logging files aren't enabled, and audit logs aren't written locally | | +| to a file for a self-hosted deployment. | | ++----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ .. config:setting:: file-name :displayname: File name (Audit Logging > Self-Hosted) :systemconsole: Experimental > Features - :configjson: FileName - :environment: N/A + :configjson: ExperimentalAuditSettings.FileName + :environment: MM_EXPERIMENTALAUDITSETTINGS_FILENAME :description: Specify the path to the audit file for a self-hosted deployment. File name @@ -815,17 +909,17 @@ File name .. include:: ../_static/badges/ent-selfhosted.rst :start-after: :nosearch: -Specify the path to the audit file for a self-hosted deployment. - -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileName": ""`` with string input consisting of a user-defined path (e.g. ``/var/log/mattermost_audit.log``). | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| Specify the path to the audit file for a self-hosted deployment. | - System Config path: **Experimental > Features** | +| | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileName`` > ``""`` | +| String input consisting of a user-defined path (e.g. ``/var/log/mattermost_audit.log``). | - Environment variable: MM_EXPERIMENTALAUDITSETTINGS_FILENAME | ++---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ .. config:setting:: max-file-size :displayname: File max size MB (Audit Logging > Self-Hosted) :systemconsole: Experimental > Features - :configjson: FileMaxSizeMB - :environment: N/A + :configjson: ExperimentalAuditSettings.FileMaxSizeMB + :environment: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXSIZEMB :description: This is the maximum size (measured in megabytes) that the file can grow before triggering rotation for a self-hosted deployment.. Default is **100** MB. Max file size @@ -834,17 +928,18 @@ Max file size .. include:: ../_static/badges/ent-selfhosted.rst :start-after: :nosearch: -This is the maximum size, in megabytes, that the file can grow before triggering rotation for a self-hosted deployment. The default setting is ``100``. - -+---------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileMaxSizeMB": 100`` with numerical input. | -+---------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| This is the maximum size, in megabytes, that the file can grow before | - System Config path: **Experimental > Features** | +| triggering rotation for a self-hosted deployment. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileMaxSizeMB`` > ``100`` | +| | - Environment variable: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXSIZEMB | +| Numerical input. Default is **100** MB. | | ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ .. config:setting:: max-file-age :displayname: File max age days (Audit Logging > Self-Hosted) :systemconsole: Experimental > Features - :configjson: FileMaxAgeDays - :environment: N/A + :configjson: ExperimentalAuditSettings.FileMaxAgeDays + :environment: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXAGEDAYS :description: This is the maximum age in days a file can reach before triggering rotation for a self-hosted deployment.. The default value is **0**, indicating no limit on the age. Max file age @@ -853,17 +948,18 @@ Max file age .. include:: ../_static/badges/ent-selfhosted.rst :start-after: :nosearch: -This is the maximum age, in days, a file can reach before triggering rotation for a self-hosted deployment. The default value is ``0``, indicating no limit on the age. - -+--------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileMaxAgeDays": 0`` with numerical input. | -+--------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +| This is the maximum age, in days, a file can reach before | - System Config path: **Experimental > Features** | +| triggering rotation for a self-hosted deployment. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileMaxAgeDays`` > ``0`` | +| | - Environment variable: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXAGEDAYS | +| Numerical input. Default is **0** days (no limit). | | ++-------------------------------------------------------------------+---------------------------------------------------------------------------------------+ .. config:setting:: maximum-file-backups :displayname: File max backups (Audit Logging > Self-Hosted) :systemconsole: Experimental > Features - :configjson: FileMaxBackups - :environment: N/A + :configjson: ExperimentalAuditSettings.FileMaxBackups + :environment: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXBACKUPS :description: This is the maximum number of rotated files kept for a self-hosted deployment. The oldest is deleted first. The default value is **0**, indicating no limit on the number of backups. Maximum file backups @@ -872,17 +968,18 @@ Maximum file backups .. include:: ../_static/badges/ent-selfhosted.rst :start-after: :nosearch: -This is the maximum number of rotated files kept for a self-hosted deployment. The oldest is deleted first. The default value is ``0``, indicating no limit on the number of backups. - -+--------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileMaxBackups": 0`` with numerical input. | -+--------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| This is the maximum number of rotated files kept for a | - System Config path: **Experimental > Features** | +| self-hosted deployment. The oldest is deleted first. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileMaxBackups`` > ``0`` | +| | - Environment variable: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXBACKUPS | +| Numerical input. Default is **0** (no limit). | | ++--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: file-compression :displayname: File compress (Audit Logging > Self-Hosted) :systemconsole: Experimental > Features - :configjson: FileCompress - :environment: N/A + :configjson: ExperimentalAuditSettings.FileCompress + :environment: MM_EXPERIMENTALAUDITSETTINGS_FILECOMPRESS :description: When ``true``, rotated files are compressed using ``gzip`` in a self-hosted deployment. Default value is **false**. File compression @@ -891,17 +988,19 @@ File compression .. include:: ../_static/badges/ent-selfhosted.rst :start-after: :nosearch: -When ``true``, rotated files are compressed using ``gzip`` in a self-hosted deployment. - -+-------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileCompress": false`` with options ``true`` and ``false``. | -+-------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| When ``true``, rotated files are compressed using | - System Config path: **Experimental > Features** | +| ``gzip`` in a self-hosted deployment. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileCompress`` > ``false`` | +| | - Environment variable: MM_EXPERIMENTALAUDITSETTINGS_FILECOMPRESS | +| - **true**: Rotated files are compressed using ``gzip``. | | +| - **false**: **(Default)** Rotated files are not compressed. | | ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------+ .. config:setting:: maximum-file-queue :displayname: File max queue size (Audit Logging > Self-Hosted) :systemconsole: Experimental > Features - :configjson: FileMaxQueueSize - :environment: N/A + :configjson: ExperimentalAuditSettings.FileMaxQueueSize + :environment: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXQUEUESIZE :description: This setting determines how many audit records can be queued/buffered at any point in time when writing to a file for a self-hosted deployment. Default is **1000** records. Maximum file queue @@ -910,12 +1009,17 @@ Maximum file queue .. include:: ../_static/badges/ent-selfhosted.rst :start-after: :nosearch: -This setting determines how many audit records can be queued/buffered at any point in time when writing to a file for a self-hosted deployment. The default is ``1000`` records. -This setting can be left as default unless you are seeing audit write failures in the server log and need to adjust the number accordingly. ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +| This setting determines how many audit records can be | - System Config path: **Experimental > Features** | +| queued/buffered at any point in time when writing to a file | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileMaxQueueSize`` > ``1000`` | +| for a self-hosted deployment. | - Environment variable: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXQUEUESIZE | +| | | +| Numerical input. Default is **1000** records. | | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------+ -+-------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileMaxQueueSize": 1000`` with numerical input. | -+-------------------------------------------------------------------------------------------------------------------------+ +.. note:: + + This setting can be left as default unless you are seeing audit write failures in the server log and need to adjust the value accordingly. .. config:setting:: audit-logging-certificate :displayname: Audit logging certificate upload (Audit Logging > Cloud Enterprise) @@ -965,7 +1069,7 @@ Access the following self-hosted configuration settings by editing the ``config. :displayname: Allowed themes (Experimental) :systemconsole: N/A :configjson: AllowedThemes - :environment: N/A + :environment: MM_THEMESETTINGS_ALLOWEDTHEMES :description: Select the themes that can be chosen by users when ``EnableThemeSelection`` is set to ``true``. Allowed themes @@ -974,22 +1078,23 @@ Allowed themes .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -This setting isn't available in the System Console and can only be set in ``config.json``. - -Select the themes that can be chosen by users when ``EnableThemeSelection`` is set to ``true``. - -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"AllowedThemes": []`` with string array input consisting of the options ``"default"``, ``"organization"``, ``"mattermostDark"``, and ``"windows10"``, such as ``["mattermostDark", "windows10"]``. | -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| Select the themes that can be chosen by users when ``EnableThemeSelection`` is set to ``true``. | - System Config path: N/A | +| | - ``config.json`` setting: ``ThemeSettings`` > ``AllowedThemes`` > ``[]`` | +| String array input consisting of the options ``"default"``, ``"organization"``, ``"mattermostDark"``, | - Environment variable: MM_THEMESETTINGS_ALLOWEDTHEMES | +| and ``"windows10"``, such as ``["mattermostDark", "windows10"]``. | | ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +.. note:: + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: file-location :displayname: File location (Experimental) :systemconsole: N/A :configjson: FileLocation - :environment: N/A - :description: Set the file location of the compliance exports. Default value is **export**. + :environment: MM_COMPLIANCESETTINGS_DIRECTORY + :description: Set the file location of the compliance exports. By default, they are written to the ``exports`` subdirectory of the configured Local Storage directory. File Location ~~~~~~~~~~~~~ @@ -997,62 +1102,72 @@ File Location .. include:: ../_static/badges/ent-only.rst :start-after: :nosearch: -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| Set the file location of the compliance exports. By default, they are written to the ``exports`` | - System Config path: N/A | +| subdirectory of the configured | - ``config.json`` setting: ``ComplianceSettings`` > ``FileLocation`` > ``""`` | +| :ref:`Local Storage directory `. | - Environment variable: MM_COMPLIANCESETTINGS_DIRECTORY | +| | | +| String input. | | ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ -Set the file location of the compliance exports. By default, they are written to the ``exports`` subdirectory of the configured :ref:`Local Storage directory `. +.. note:: -+-------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"FileLocation": "export"`` with string input. | -+-------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: push-notification-buffer :displayname: Push notification buffer (Experimental) :systemconsole: N/A :configjson: PushNotificationBuffer - :environment: N/A + :environment: MM_EMAILSETTINGS_PUSHNOTIFICATIONBUFFER :description: Used to control the buffer of outstanding Push Notification messages to be sent. Default is **1000** notifications. Push notification buffer ~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - -Used to control the buffer of outstanding Push Notification messages to be sent. If the number of messages exceeds that number, then the request making the Push Notification will be blocked until there's room. ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| Used to control the buffer of outstanding Push Notification messages to be sent. If the number of | - System Config path: N/A | +| messages exceeds that number, then the request making the Push Notification will be blocked until | - ``config.json`` setting: ``EmailSettings`` > ``PushNotificationBuffer`` > ``1000`` | +| there's room. | - Environment variable: MM_EMAILSETTINGS_PUSHNOTIFICATIONBUFFER | +| | | +| Numerical input. Default is **1000** notifications. | | ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ -+---------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature’s ``config.json`` setting is ``"PushNotificationBuffer": 1000"`` with numerical input. | -+---------------------------------------------------------------------------------------------------------------------------------------------+ +.. note:: + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: restrict-system-admin - :displayname: File configuration settings + :displayname: Restrict system admin (Experimental) :systemconsole: N/A - :configjson: FileEnabled - :environment: N/A - :description: Enable this setting to write audit files locally, specifying size, backup interval, compression, maximum age to manage file rotation, and timestamps. Default value is **false**. + :configjson: RestrictSystemAdmin + :environment: MM_EXPERIMENTALSETTINGS_RESTRICTSYSTEMADMIN + :description: Restricts the system admin from viewing and modifying a subset of server configuration settings from the System Console. + + - **true**: **(Default for Cloud deployments)** Restricts the system admin from viewing and modifying a subset of server configuration settings. + - **false**: **(Default for self-hosted deployments)** No restrictions are applied to the system admin role. Restrict system admin ~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - -**True**: **(Default for Cloud deployments)** Restricts the system admin from viewing and modifying a subset of server configuration settings from the System Console. Not recommended for use in on-prem installations. This is intended to support Mattermost Private Cloud in giving the system admin role to users but restricting certain actions only for Cloud Admins. - -**False**: **(Default for self-host deployments)** No restrictions are applied to the system admin role. - -+-------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"RestrictSystemAdmin": "false"`` with options ``true`` and ``false``. | -+-------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| - **true**: **(Default for Cloud deployments)** Restricts the system admin from viewing and modifying | - System Config path: N/A | +| a subset of server configuration settings from the System Console. Not recommended for use in | - ``config.json`` setting: ``ExperimentalSettings`` > ``RestrictSystemAdmin`` > ``false`` | +| on-prem installations. This is intended to support Mattermost Private Cloud in giving the system | - Environment variable: MM_EXPERIMENTALSETTINGS_RESTRICTSYSTEMADMIN | +| admin role to users but restricting certain actions only for Cloud Admins. | | +| - **false**: **(Default for self-host deployments)** No restrictions are applied to the system admin | | +| role. | | ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+ .. note:: - The ability to restrict the system admin from viewing and modifying a subset of server configuration settings is currently in :ref:`Beta `. + - This setting isn't available in the System Console and can only be set in ``config.json``. + - The ability to restrict the system admin from viewing and modifying a subset of server configuration settings is currently in :ref:`Beta `. .. config:setting:: enable-client-side-certification :displayname: Enable client-side certification (Experimental) :systemconsole: N/A :configjson: ClientSideCertEnable - :environment: N/A + :environment: MM_EXPERIMENTALSETTINGS_CLIENTSIDECERTENABLE - **true**: Enables client-side certification for your Mattermost server. - **false**: **(Default)** Client-side certification is disabled. @@ -1063,19 +1178,20 @@ Enable client-side certification .. include:: ../_static/badges/ent-only.rst :start-after: :nosearch: -**True**: Enables client-side certification for your Mattermost server. See :doc:`the documentation ` to learn more. - -**False**: Client-side certification is disabled. - -+------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ClientSideCertEnable": false`` with options ``true`` and ``false``. | -+------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +| This setting controls whether client-side certificate authentication is enabled for your Mattermost | - System Config path: N/A | +| server. | - ``config.json`` setting: ``ExperimentalSettings`` > ``ClientSideCertEnable`` > ``false`` | +| | - Environment variable: MM_EXPERIMENTALSETTINGS_CLIENTSIDECERTENABLE | +| - **true**: Enables client-side certification for your Mattermost server. See :doc:`the documentation | | +| ` to learn more. | | +| - **false**: **(Default)** Client-side certification is disabled. | | ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ .. config:setting:: client-side-certification-login-method :displayname: Client-side certification login method (Experimental) :systemconsole: N/A :configjson: ClientSideCertCheck - :environment: N/A + :environment: MM_EXPERIMENTALSETTINGS_CLIENTSIDECERTCHECK - **primary**: After the client side certificate is verified, user's email is retrieved from the certificate and is used to log in without a password. - **secondary**: **(Default)** After the client side certificate is verified, user's email is retrieved from the certificate and matched against the one supplied by the user. If they match, the user logs in with regular email/password credentials. @@ -1086,117 +1202,137 @@ Client-side certification login method .. include:: ../_static/badges/ent-only.rst :start-after: :nosearch: -Used in combination with the ``ClientSideCertEnable`` configuration setting. - -**Primary**: After the client side certificate is verified, user's email is retrieved from the certificate and is used to log in without a password. - -**Secondary**: After the client side certificate is verified, user's email is retrieved from the certificate and matched against the one supplied by the user. If they match, the user logs in with regular email/password credentials. - -+----------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ClientSideCertCheck": "secondary"`` with options ``"primary"`` and ``"secondary"``. | -+----------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| This setting controls how client-side certificates are used for user authentication. Used in | - System Config path: N/A | +| combination with the ``ClientSideCertEnable`` configuration setting. | - ``config.json`` setting: ``ExperimentalSettings`` > ``ClientSideCertCheck`` > ``"secondary"`` | +| | - Environment variable: ``MM_EXPERIMENTALSETTINGS_CLIENTSIDECERTCHECK`` | +| - **primary**: After the client side certificate is verified, user's email is retrieved from the | | +| certificate and is used to log in without a password. | | +| - **secondary**: **(Default)** After the client side certificate is verified, user's email is | | +| retrieved from the certificate and matched against the one supplied by the user. If they match, | | +| the user logs in with regular email/password credentials. | | ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ .. config:setting:: export-output-directory :displayname: Export output directory (Experimental) :systemconsole: N/A :configjson: .ExportSettings.Directory - :environment: N/A + :environment: MM_EXPORTSETTINGS_DIRECTORY :description: The directory where the exported files are stored. The path is relative to the ``FileSettings`` directory. Default value is **./export**. Export output directory ~~~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - The directory where the exported files are stored. The path is relative to the ``FileSettings`` directory. By default, exports are stored under ``./data/export``. -+---------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting under the ``ExportSettings`` section is ``Directory: ./export`` with string input. | -+---------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| The directory where the exported files are stored. The path is relative to the ``FileSettings`` | - System Config path: N/A | +| directory. By default, exports are stored under ``./data/export``. | - ``config.json`` setting: ``ExportSettings`` > ``Directory`` > ``"./export"`` | +| | - Environment variable: MM_EXPORTSETTINGS_DIRECTORY | +| String input. | | ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ + +.. note:: + + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: export-retention-days :displayname: Export retention days (Experimental) :systemconsole: N/A :configjson: .ExportSettings.RetentionDays - :environment: N/A + :environment: MM_EXPORTSETTINGS_RETENTIONDAYS :description: The number of days to retain the exported files before deleting them. Default value is **30** days. Export retention days ~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - The number of days to retain the exported files before deleting them. -+----------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting under the ``ExportSettings`` section is ``RetentionDays: 30`` with numerical input. | -+----------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| The number of days to retain the exported files before deleting them. | - System Config path: N/A | +| | - ``config.json`` setting: ``ExportSettings`` > ``RetentionDays`` > ``30`` | +| Numerical input. | - Environment variable: MM_EXPORTSETTINGS_RETENTIOND | ++-------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + +.. note:: + + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: maximum-image-resolution :displayname: Maximum image resolution (Experimental) :systemconsole: N/A :configjson: MaxImageResolution - :environment: N/A + :environment: MM_FILESETTINGS_MAXIMAGERESOLUTION :description: Maximum image resolution size for message attachments in pixels. Default value is **33177600** pixels. Maximum image resolution ~~~~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - Maximum image resolution size for message attachments in pixels. -+--------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"MaxImageResolution": 33177600`` with numerical input. | -+--------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| Maximum image resolution size for message attachments in pixels. | - System Config path: N/A | +| | - ``config.json`` setting: ``ExperimentalSettings`` > ``MaxImageResolution`` > ``33177600`` | +| Numerical input. Default value is **33177600** pixels. | - Environment variable: MM_FILESETTINGS_MAXIMAGERESOLUTION | ++----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + +.. note:: + + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: maximum-image-decoder-concurrency :displayname: Maximum image decoder concurrency (Experimental) :systemconsole: N/A :configjson: MaxImageDecoderConcurrency - :environment: N/A + :environment: MM_FILESETTINGS_MAXIMAGEDECODERCONCURRENCY :description: Indicates how many images can be decoded concurrently at once. The default value of **-1** configures Mattermost to automatically use the number of CPUs present. Maximum image decoder concurrency ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - Indicates how many images can be decoded concurrently at once. The default value of ``-1`` configures Mattermost to automatically use the number of CPUs present. ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ +| Indicates how many images can be decoded concurrently at once. The default value of ``-1`` configures | - System Config path: N/A | +| Mattermost to automatically use the number of CPUs present. | - ``config.json`` setting: ``ExperimentalSettings`` > ``MaxImageDecoderConcurrency`` > ``-1`` | +| | - Environment variable: MM_FILESETTINGS_MAXIMAGEDECODERCONCURRENCY | +| Numerical input. | | ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + .. note:: + - This setting isn't available in the System Console and can only be set in ``config.json``. - This configuration setting affects the total memory consumption of the server. The maximum memory of a single image is dictated by ``MaxImageResolution * 24 bytes``, where the default maximum image resolution value is 33MB. - Therefore, a good rule of thumb to follow is that ``33MB * MaxImageDecoderConcurrency * 24`` should be less than the total memory for the server. - For example, if you have a 4-core server, you should leave aside at least ``33 * 4 * 24 = 3168MB`` memory for image processing. Otherwise, adjust the `MaxImageResolution <#maximum-image-resolution>`_ configuration setting to adjust the amount of memory needed for image processing. -+--------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"MaxImageDecoderConcurrency": "-1"`` with numerical input. | -+--------------------------------------------------------------------------------------------------------+ - .. config:setting:: initial-font :displayname: Initial font (Experimental) :systemconsole: N/A :configjson: InitialFont - :environment: N/A + :environment: MM_FILESETTINGS_INITIALFONT :description: Font used in auto-generated profile pics with colored backgrounds. Default value is **luximbi.ttf**. Initial font ~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - Font used in auto-generated profile pics with colored backgrounds. -+-----------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"InitialFont": "luximbi.ttf"`` with string input. | -+-----------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| Font used in auto-generated profile pics with colored backgrounds. | - System Config path: N/A | +| | - ``config.json`` setting: ``ExperimentalSettings`` > ``InitialFont`` > ``"luximbi.ttf"`` | +| String input. Default value is **luximbi.ttf**. | - Environment variable: MM_FILESETTINGS_INITIALFONT | ++-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + +.. note:: + + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: amazon-s3-signature-v2 :displayname: Amazon S3 signature v2 (Experimental) :systemconsole: N/A :configjson: AmazonS3SignV2 - :environment: N/A + :environment: MM_FILESETTINGS_AMAZONS3SIGNV2 - **true**: Use Signature Version 2 Signing Process. - **false**: **(Default)** Use Signature Version 4 Signing Process. @@ -1204,59 +1340,81 @@ Font used in auto-generated profile pics with colored backgrounds. Amazon S3 signature v2 ~~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------------+-------------------------------------------------------------------------------+ +| This setting controls which AWS signature version is | - System Config path: N/A | +| used for signing API calls to Amazon S3. By | - ``config.json`` setting: ``FileSettings`` > ``AmazonS3SignV2`` > ``false`` | +| default, Mattermost uses Signature V4 to sign API calls | - Environment variable: MM_FILESETTINGS_AMAZONS3SIGNV2 | +| to AWS, but under some circumstances, V2 is | | +| required. | | +| | | +| - **true**: Use Signature Version 2 Signing Process. | | +| - **false**: **(Default)** Use Signature Version 4 | | +| Signing Process. | | ++----------------------------------------------------------------+-------------------------------------------------------------------------------+ -By default, Mattermost uses Signature V4 to sign API calls to AWS, but under some circumstances, V2 is required. For more information about when to use V2, see https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html. - -**True**: Use Signature Version 2 Signing Process. - -**False**: Use Signature Version 4 Signing Process. +.. note:: -+------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"AmazonS3SignV2": false`` with options ``true`` and ``false``. | -+------------------------------------------------------------------------------------------------------------+ + - This setting isn't available in the System Console and can only be set in ``config.json``. + - For more information about when to use V2, see https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html. .. config:setting:: amazon-s3-path :displayname: Amazon S3 path (Experimental) :systemconsole: N/A :configjson: AmazonS3PathPrefix - :environment: N/A - :description: Allows using the same S3 bucket for multiple deployments. + :environment: MM_FILESETTINGS_AMAZONS3PATHPREFIX + :description: Specifies a subdirectory prefix within your S3 bucket where Mattermost stores files. Default value is an empty string. Amazon S3 path ~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| The AmazonS3PathPrefix config setting specifies a subdirectory prefix within your S3 bucket where | - System Config path: N/A | +| Mattermost stores files. | - ``config.json`` setting: ``FileSettings`` > ``AmazonS3PathPrefix`` > ``""`` | +| | - Environment variable: ``MM_FILESETTINGS_AMAZONS3PATHPREFIX`` | +| Possible values: Any string representing a valid S3 path prefix (e.g., "subdir1/", "mattermost-files/", | | +| or empty). The setting validates that there's no leading/trailing whitespace. | | +| | | +| String input. Default is empty string **("")**. | | ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -Allows using the same S3 bucket for multiple deployments. +.. note:: -+------------------------------------------------------------------------------------------------------------+ -| This feature’s ``config.json`` setting is ``"AmazonS3PathPrefix: ""`` with string input. | -+------------------------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: gitlab-scope :displayname: GitLab scope (Experimental) :systemconsole: N/A :configjson: Scope - :environment: N/A - :description: Standard setting for OAuth to determine the scope of information shared with OAuth client. Not currently supported by GitLab OAuth. + :environment: MM_GITLABSETTINGS_SCOPE + :description: Controls OAuth scopes for GitLab authentication. Becomes experimental when it contains "openid" to enable OpenID Connect functionality. Default is empty string. GitLab scope ~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ +| The GitLab scope experimental config setting controls OAuth scopes for GitLab authentication. | - System Config path: N/A | +| | - ``config.json`` setting: ``GitLabSettings`` > ``Scope`` > ``""`` | +| Possible values: | - Environment variable: ``MM_GITLABSETTINGS_SCOPE`` | +| | | +| - Empty string **("")** - Standard OAuth 2.0 flow | | +| - **"profile openid email"** - Enables experimental OpenID Connect features | | +| - Any custom OAuth scope string | | +| | | +| The setting becomes "experimental" when it contains "openid", which enables OpenID Connect | | +| functionality with GitLab instead of standard OAuth 2.0. | | +| | | +| String input. Default is empty string **("")**. | | ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -Standard setting for OAuth to determine the scope of information shared with OAuth client. Not currently supported by GitLab OAuth. +.. note:: -+------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"Scope": ""`` with string input. | -+------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: global-relay-smtp-server-timeout :displayname: Global relay SMTP server timeout (Experimental) :systemconsole: N/A :configjson: GlobalRelaySettings.SMTPServerTimeout - :environment: N/A + :environment: MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPSERVERTIMEOUT :description: The number of seconds that can elapse before the connection attempt to the SMTP server is abandoned. Default is **1800** seconds. Global relay SMTP server timeout @@ -1265,19 +1423,22 @@ Global relay SMTP server timeout .. include:: ../_static/badges/ent-only.rst :start-after: :nosearch: -This setting isn't available in the System Console and can only be set in ``config.json``. ++---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| The number of seconds that can elapse before the | - System Config path: N/A | +| connection attempt to the SMTP server is abandoned. | - ``config.json`` setting: ``GlobalRelaySettings`` > ``SMTPServerTimeout`` > ``1800`` | +| | - Environment variable: MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPSERVERTIMEOUT | +| Numerical input. Default is **1800** seconds. | | ++---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -The number of seconds that can elapse before the connection attempt to the SMTP server is abandoned. The default value is 1800 seconds. This setting is currently not available in the System Console and can only be set in ``config.json``. +.. note:: -+-----------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"GlobalRelaySettings.SMTPServerTimeout": "1800"`` with numerical input. | -+-----------------------------------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: google-scope :displayname: Google scope (Experimental) :systemconsole: N/A :configjson: Scope - :environment: N/A + :environment: MM_GOOGLESETTINGS_SCOPE :description: Standard setting for OAuth to determine the scope of information shared with OAuth client. Default value is **profile email**. Google scope @@ -1286,55 +1447,66 @@ Google scope .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -This setting isn't available in the System Console and can only be set in ``config.json``. ++-----------------------------------------------------------+-----------------------------------------------------------------------------------+ +| Standard setting for OAuth to determine the scope of | - System Config path: N/A | +| information shared with OAuth client. Recommended | - ``config.json`` setting: ``GoogleSettings`` > ``Scope`` > ``"profile email"`` | +| setting is ``profile email``. | - Environment variable: MM_GOOGLESETTINGS_SCOPE | +| | | +| String input. Default is **profile email**. | | ++-----------------------------------------------------------+-----------------------------------------------------------------------------------+ -Standard setting for OAuth to determine the scope of information shared with OAuth client. Recommended setting is ``profile email``. +.. note:: -+-------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"Scope": "profile email"`` with string input. | -+-------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: import-input-directory :displayname: Import input directory (Experimental) :systemconsole: N/A :configjson: ImportSettings.Directory - :environment: N/A + :environment: MM_IMPORTSETTINGS_DIRECTORY :description: The directory where the imported files are stored. The path is relative to the ``FileSettings`` directory. Default value is **./import**. Import input directory ~~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------+----------------------------------------------------------------------------------+ +| The directory where the imported files are stored. | - System Config path: N/A | +| The path is relative to the ``FileSettings`` | - ``config.json`` setting: ``ImportSettings`` > ``Directory`` > ``"./import"`` | +| directory. By default, imports are stored | - Environment variable: MM_IMPORTSETTINGS_DIRECTORY | +| under ``./data/import``. | | +| | | +| String input. Default is **./import**. | | ++----------------------------------------------------------+----------------------------------------------------------------------------------+ -The directory where the imported files are stored. The path is relative to the ``FileSettings`` directory. By default, imports are stored under ``./data/import``. +.. note:: -+---------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting under the ``ImportSettings`` section is ``Directory: ./import`` with string input. | -+---------------------------------------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: import-retention-days :displayname: Import retention days (Experimental) :systemconsole: N/A :configjson: ImportSettings.RetentionDays - :environment: N/A + :environment: MM_IMPORTSETTINGS_RETENTIONDAYS :description: The number of days to retain the imported files before deleting them. Default is **30** days. Import retention days ~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| The number of days to retain the imported files before deleting them. | - System Config path: N/A | +| | - ``config.json`` setting: ``ImportSettings`` > ``RetentionDays`` > ``30`` | +| Numerical input. Default is **30** days. | - Environment variable: MM_IMPORTSETTINGS_RETENTIONDAYS | ++---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -The number of days to retain the imported files before deleting them. +.. note:: -+----------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting under the ``ImportSettings`` section is ``RetentionDays: 30`` with numerical input. | -+----------------------------------------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: export-from-timestamp :displayname: Export from timestamp (Experimental) :systemconsole: N/A :configjson: ExportFromTimestamp - :environment: N/A + :environment: MM_MESSAGEEXPORTSETTINGS_EXPORTFROMTIMESTAMP :description: Set the Unix timestamp (seconds since epoch, UTC) to export data from. Default is **0**. Export from timestamp @@ -1343,19 +1515,21 @@ Export from timestamp .. include:: ../_static/badges/ent-only.rst :start-after: :nosearch: -This setting isn't available in the System Console and can only be set in ``config.json``. ++-----------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| Set the Unix timestamp (seconds since epoch, UTC) to export data from. | - System Config path: N/A | +| | - ``config.json`` setting: ``ExportSettings`` > ``ExportFromTimestamp`` > ``0`` | +| Numerical input. Default is **0**. | - Environment variable: MM_MESSAGEEXPORTSETTINGS_EXPORTFROMTIMESTAMP | ++-----------------------------------------------------------------------------+----------------------------------------------------------------------------------+ -Set the Unix timestamp (seconds since epoch, UTC) to export data from. +.. note:: -+----------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExportFromTimestamp": 0`` with numerical input. | -+----------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: block-profile-rate :displayname: Block profile rate (Experimental) :systemconsole: N/A :configjson: BlockProfileRate - :environment: N/A + :environment: MM_METRICSSETTINGS_BLOCKPROFILERATE Value that controls the `fraction of goroutine blocking events reported in the blocking profile `_. To include every blocking event in the profile, set the rate to ``1``. To turn off profiling entirely, set the rate to ``0``. @@ -1364,23 +1538,26 @@ Set the Unix timestamp (seconds since epoch, UTC) to export data from. Block profile rate ~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. Changes to this setting require a server restart before taking effect. - -Value that controls the `fraction of goroutine blocking events reported in the blocking profile `_. ++----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| Value that controls the `fraction of goroutine blocking events reported in the blocking profile | - System Config path: N/A | +| `_. The profiler aims to sample an average of one | - ``config.json`` setting: ``ServiceSettings`` > ``BlockProfileRate`` > ``0`` | +| blocking event per rate nanoseconds spent blocked. | - Environment variable: MM_METRICSSETTINGS_BLOCKPROFILERATE | +| | | +| To include every blocking event in the profile, set the rate to ``1``. To turn off profiling entirely, | | +| set the rate to ``0``. | | +| | | +| Numerical input with options ``0`` and ``1``. Default is **0**. | | ++----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ -The profiler aims to sample an average of one blocking event per rate nanoseconds spent blocked. - -To include every blocking event in the profile, set the rate to ``1``. To turn off profiling entirely, set the rate to ``0``. +.. note:: -+---------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"BlockProfileRate": 0`` with options ``0`` and ``1``. | -+---------------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. Changes to this setting require a server restart before taking effect. .. config:setting:: entra-id-scope :displayname: Entra ID scope (Experimental) :systemconsole: N/A :configjson: Scope - :environment: N/A + :environment: MM_OFFICE365SETTINGS_SCOPE :description: Standard setting for OAuth to determine the scope of information shared with OAuth client. Recommended setting is ``User.Read``. Entra ID Scope @@ -1389,19 +1566,22 @@ Entra ID Scope .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| Standard setting for OAuth to determine the scope of information shared with OAuth client. Recommended | - System Config path: N/A | +| setting is ``User.Read``. | - ``config.json`` setting: ``Office365Settings`` > ``Scope`` > ``"User.Read"`` | +| | - Environment variable: MM_OFFICE365SETTINGS_SCOPE | +| String input. Default is **User.Read**. | | ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ -Standard setting for OAuth to determine the scope of information shared with OAuth client. Recommended setting is ``User.Read``. +.. note:: -+---------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"Scope": "User.Read"`` with string input. | -+---------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: enable-plugin-uploads :displayname: Enable plugin uploads (Experimental) :systemconsole: N/A :configjson: EnableUploads - :environment: N/A + :environment: MM_PLUGINSETTINGS_ENABLEUPLOADS - **true**: Enables plugin uploads by system admins at **Plugins > Management**. - **false**: **(Default)** Disables plugin uploads on your Mattermost server. @@ -1409,21 +1589,25 @@ Standard setting for OAuth to determine the scope of information shared with OAu Enable plugin uploads ~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - -**True**: Enables plugin uploads by system admins at **Plugins > Management**. If you do not plan to upload a plugin, set to ``false`` to control which plugins are installed on your server. See `documentation `__ to learn more. ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| This setting controls whether system administrators can upload plugins through the System Console. | - System Config path: N/A | +| | - ``config.json`` setting: ``PluginSettings`` > ``EnableUploads`` > ``false`` | +| - **true**: Enables plugin uploads by system admins at **Plugins > Management**. If you do not plan | - Environment variable: MM_PLUGINSETTINGS_ENABLEUPLOADS | +| to upload a plugin, set to ``false`` to control which plugins are installed on your server. See | | +| `documentation `__ to | | +| learn more. | | +| - **false**: **(Default)** Disables plugin uploads on your Mattermost server. | | ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -**False**: Disables plugin uploads on your Mattermost server. +.. note:: -+-----------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableUploads": false`` with options ``true`` and ``false``. | -+-----------------------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: allow-insecure-download-url :displayname: Allow insecure download URL (Experimental) :systemconsole: N/A :configjson: AllowInsecureDownloadUrl - :environment: N/A + :environment: MM_PLUGINSETTINGS_ALLOWINSECUREDOWNLOADURL - **true**: Enables downloading and installing a plugin from a remote URL. - **false**: **(Default)** Disables downloading and installing a plugin from a remote URL. @@ -1433,19 +1617,18 @@ Allow insecure download URL This setting isn't available in the System Console and can only be set in ``config.json``. -**True**: Enables downloading and installing a plugin from a remote URL. - -**False**: Disables downloading and installing a plugin from a remote URL. - -+-----------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"AllowInsecureDownloadUrl": false`` with options ``true`` and ``false``. | -+-----------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| This setting controls whether plugins can be downloaded and installed from remote URLs. | - System Config path: N/A | +| | - ``config.json`` setting: ``PluginSettings`` > ``AllowInsecureDownloadUrl`` > ``false`` | +| - **true**: Enables downloading and installing a plugin from a remote URL. | - Environment variable: MM_PLUGINSETTINGS_ALLOWINSECUREDOWNLOADURL | +| - **false**: **(Default)** Disables downloading and installing a plugin from a remote URL. | | ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: enable-plugin-health-check :displayname: Enable plugin health check (Experimental) :systemconsole: N/A :configjson: EnableHealthCheck - :environment: N/A + :environment: MM_PLUGINSETTINGS_ENABLEHEALTHCHECK - **true**: **(Default)** Enables plugin health check to ensure all plugins are periodically monitored, and restarted or deactivated based on their health status. - **false**: Disables plugin health check on your Mattermost server. @@ -1455,55 +1638,61 @@ Enable plugin health check This setting isn't available in the System Console and can only be set in ``config.json``. -**True**: Enables plugin health check to ensure all plugins are periodically monitored, and restarted or deactivated based on their health status. The health check runs every 30 seconds. If the plugin is detected to fail 3 times within an hour, the Mattermost server attempts to restart it. If the restart fails 3 successive times, it's automatically disabled. - -**False**: Disables plugin health check on your Mattermost server. - -+--------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableHealthCheck": true`` with options ``true`` and ``false``. | -+--------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Enables plugin health check to ensure all plugins are periodically monitored, | - System Config path: N/A | +| and restarted or deactivated based on their health status. The health check runs every 30 seconds. | - ``config.json`` setting: ``PluginSettings`` > ``EnableHealthCheck`` > ``true`` | +| If the plugin is detected to fail 3 times within an hour, the Mattermost server attempts to restart | - Environment variable: MM_PLUGINSETTINGS_ENABLEHEALTHCHECK | +| it. If the restart fails 3 successive times, it's automatically disabled. | | +| - **false**: Disables plugin health check on your Mattermost server. | | ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: plugin-directory :displayname: Plugin directory (Experimental) :systemconsole: N/A :configjson: Directory - :environment: N/A + :environment: MM_PLUGINSETTINGS_DIRECTORY :description: The location of the plugin files. If blank, they are stored in the ``./plugins`` directory. Default value is **./plugins**. Plugin directory ~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| The location of the plugin files. If blank, they are stored in the ``./plugins`` directory. The path | - System Config path: N/A | +| that you set must exist and Mattermost must have write permissions in it. | - ``config.json`` setting: ``PluginSettings`` > ``Directory`` > ``"./plugins"`` | +| | - Environment variable: MM_PLUGINSETTINGS_DIRECTORY | +| String input. Default is **./plugins**. | | ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -The location of the plugin files. If blank, they are stored in the ``./plugins`` directory. The path that you set must exist and Mattermost must have write permissions in it. +.. note:: -+-----------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"Directory": "./plugins"`` with string input. | -+-----------------------------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: client-plugin-directory :displayname: Client plugin directory (Experimental) :systemconsole: N/A :configjson: ClientDirectory - :environment: N/A + :environment: MM_PLUGINSETTINGS_CLIENTDIRECTORY :description: The location of client plugin files. If blank, they are stored in the ``./client/plugins`` directory. Default value is **./client/plugins**. Client plugin directory ~~~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| The location of client plugin files. If blank, they are stored in the ``./client/plugins`` directory. | - System Config path: N/A | +| The path that you set must exist and Mattermost must have write permissions in it. | - ``config.json`` setting: ``PluginSettings`` > ``ClientDirectory`` > ``"./client/plugins"`` | +| | - Environment variable: MM_PLUGINSETTINGS_CLIENTDIRECTORY | +| String input. Default is **./client/plugins**. | | ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -The location of client plugin files. If blank, they are stored in the ``./client/plugins`` directory. The path that you set must exist and Mattermost must have write permissions in it. +.. note:: -+-----------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ClientDirectory": "./client/plugins"`` with string input. | -+-----------------------------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: scoping-idp-provider-id :displayname: Scoping IDP provider ID (Experimental) :systemconsole: N/A :configjson: ScopingIDPProviderId - :environment: N/A + :environment: MM_SAMLSETTINGS_SCOPINGIDPPROVIDERID :description: Allows an authenticated user to skip the initial login page of their federated Azure AD server, and only require a password to log in. Scoping IDP provider ID @@ -1512,19 +1701,22 @@ Scoping IDP provider ID .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Allows an authenticated user to skip the initial login page of their federated Azure AD server, and | - System Config path: N/A | +| only require a password to log in. | - ``config.json`` setting: ``SamlSettings`` > ``ScopingIDPProviderId`` > ``""`` | +| | - Environment variable: MM_SAMLSETTINGS_SCOPINGIDPPROVIDERID | +| String input. | | ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -Allows an authenticated user to skip the initial login page of their federated Azure AD server, and only require a password to log in. +.. note:: -+---------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ScopingIDPProviderId": ""`` with string input. | -+---------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: scoping-idp-provider-name :displayname: Scoping IDP provider name (Experimental) :systemconsole: N/A :configjson: ScopingIDPName - :environment: N/A + :environment: MM_SAMLSETTINGS_SCOPINGIDPNAME :description: Adds the name associated with a user's Scoping Identity Provider ID. Scoping IDP provider name @@ -1533,37 +1725,46 @@ Scoping IDP provider name .. include:: ../_static/badges/ent-pro-only.rst :start-after: :nosearch: -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Adds the name associated with a user's Scoping Identity Provider ID. | - System Config path: N/A | +| | - ``config.json`` setting: ``SamlSettings`` > ``ScopingIDPName`` > ``""`` | +| String input. | - Environment variable: MM_SAMLSETTINGS_SCOPINGIDPNAME | ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -Adds the name associated with a user's Scoping Identity Provider ID. +.. note:: -+---------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ScopingIDPName": ""`` with string input. | -+---------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: group-unread-channels :displayname: Group unread channels (Experimental) :systemconsole: N/A :configjson: ExperimentalGroupUnreadChannels - :environment: N/A - - - **default_off**: **(Default)** Disables the unread channels sidebar section for all users by default. Users can enable it in **Settings > Sidebar > Group unread channels separately**. - - **default_on**: Enables the unread channels sidebar section for all users by default. Users can disable it in **Settings > Sidebar > Group unread channels separately**. + :environment: MM_SERVICESETTINGS_EXPERIMENTALGROUPUNREADCHANNELS + :description: Controls whether unread channels are grouped separately in the sidebar. Default is "disabled". Group unread channels ~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - -This setting applies to the new sidebar only. You must disable the :ref:`Enable Legacy Sidebar ` configuration setting to see and enable this functionality in the System Console. ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| The ExperimentalGroupUnreadChannels config setting controls whether unread channels are grouped | - System Config path: N/A | +| separately in the sidebar. | - ``config.json`` setting: ``ServiceSettings`` > ``ExperimentalGroupUnreadChannels`` > ``"disabled"`` | +| | - Environment variable: ``MM_SERVICESETTINGS_EXPERIMENTALGROUPUNREADCHANNELS`` | +| Possible values: | | +| | | +| - **"disabled"** - Unread channels grouping is disabled | | +| - **"default_on"** - Enabled by default for new users | | +| - **"default_off"** - Available but disabled by default for new users | | +| | | +| This setting applies to the new sidebar only. You must disable the :ref:`Enable Legacy Sidebar | | +| ` configuration setting to see and | | +| enable this functionality in the System Console. | | +| | | +| String input. Default is **"disabled"**. | | ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -**Default Off**: Disables the unread channels sidebar section for all users by default. Users can enable it in **Settings > Sidebar > Group unread channels separately**. - -**Default On**: Enables the unread channels sidebar section for all users by default. Users can disable it in **Settings > Sidebar > Group unread channels separately**. +.. note:: -+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExperimentalGroupUnreadChannels": "default_off"`` with options ``"default_off"`` and ``"default_on"``. | -+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: enable-channel-category-sorting :displayname: Enable channel category sorting (Experimental) @@ -1594,7 +1795,7 @@ From Mattermost v10.10, when this :ref:`experimental ``ExperimentalStrictCSRFEnforcement`` > ``false`` | +| | - Environment variable: ``MM_SERVICESETTINGS_EXPERIMENTALSTRICTCSRFENFORCEMENT`` | +| - **true**: Enables CSRF protection tokens for additional hardening compared to the currently used | | +| custom header. When the user logs in, an additional cookie is created with the CSRF token contained. | | +| - **false**: **(Default)** Disables CSRF protection tokens. | | ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. config:setting:: developer-flags :displayname: Developer flags (Experimental) :systemconsole: N/A :configjson: DeveloperFlags - :environment: N/A - :description: This configuration setting specifies a list of strings where each string is a flag used to set the content security policy (CSP) for the Mattermost Web App. + :environment: MM_SERVICESETTINGS_DEVELOPERFLAGS + :description: Controls Content Security Policy (CSP) directives for debugging purposes. Requires developer mode to be enabled. Default is empty string. Developer flags ~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - -This configuration setting specifies a list of strings where each string is a flag used to set the content security policy (CSP) for the Mattermost Web App. Each flag must be in the format ``flag=true`` (e.g. ``unsafe-eval=true,unsafe-inline=true``). Not recommended for production environments. - -The following values are currently supported: ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| The DeveloperFlags config setting controls Content Security Policy (CSP) directives for debugging | - System Config path: N/A | +| purposes. | - ``config.json`` setting: ``ServiceSettings`` > ``DeveloperFlags`` > ``""`` | +| | - Environment variable: ``MM_SERVICESETTINGS_DEVELOPERFLAGS`` | +| Possible values: Comma-separated key-value pairs in format key=value: | | +| | | +| - **"unsafe-eval=true"** - Allows eval() functions for faster source maps | | +| - **"unsafe-inline=true"** - Allows inline scripts/styles for React/Redux DevTools | | +| - **"unsafe-eval=true,unsafe-inline=true"** - Enables both flags | | +| | | +| Only flags set to "true" are honored, and unrecognized flags generate warning logs. | | +| | | +| This configuration setting requires :ref:`developer mode | | +| ` to be enabled. | | +| | | +| String input. Default is empty string **("")**. | | ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ -- ``unsafe-eval``: Adds the ``unsafe-eval`` CSP directive to the root webapp, allowing increased debugging in developer environments. -- ``unsafe-inline``: Adds the ``unsafe-inline`` CSP directive to the root webapp, allowing increased debugging in developer environments. - -This configuration setting is disabled by default and requires :ref:`developer mode ` to be enabled. +.. note:: -+----------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"DeveloperFlags": ""`` with string input. | -+----------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: enable-post-search :displayname: Enable post search (Experimental) :systemconsole: N/A :configjson: EnablePostSearch - :environment: N/A + :environment: MM_SERVICESETTINGS_ENABLEPOSTSEARCH :description: If this setting is enabled, users can search messages. Default is **true**. Enable post search ~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - -If this setting is enabled, users can search for messages in their Mattermost instance. - -+-------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnablePostSearch": true`` with options ``true`` and ``false``. | -+-------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Enables searching for messages in their Mattermost instance. | - System Config path: N/A | +| - **false**: Disables searching for messages in their Mattermost instance. | - ``config.json`` setting: ``ServiceSettings`` > ``EnablePostSearch`` > ``true`` | +| | - Environment variable: MM_SERVICESETTINGS_ENABLEPOSTSEARCH | ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ .. note:: + This setting isn't available in the System Console and can only be set in ``config.json``. + Disabling this experimental configuration setting in larger deployments may improve server performance in the following areas: - - Reduced Database Load: When post search is enabled, every search query adds additional load to the database. Disabling search reduces these queries, leading to better database performance and lower response times for other operations. - - Lower Memory Usage: Search functionality often requires indexing of posts, which consumes memory. By disabling search, the memory required for maintaining these indexes is freed up for other uses, improving overall system performance. - - Faster Write Operations: When post search is enabled, indexing has to be updated with every new post, edit, or deletion. Disabling search avoids this overhead, allowing for faster write operations. - - Performance Consistency: Without the search feature, the application avoids potential performance bottlenecks and can maintain more consistent performance levels, especially under heavy usage scenarios with a high number of posts. - - Simplified System Maintenance: Managing search indexes can be complex and resource-intensive. Disabling search simplifies this aspect of system maintenance, potentially reducing the risk of performance issues related to search index corruption or degradation. - - However, the ability to search messages in Mattermost is a critical feature for many users, and disabling this feature will result in users seeing an error if they attempt to use the Mattermost Search box. It’s important to balance performance improvements with the needs of your organization and users. + - **Reduced Database Load**: When post search is enabled, every search query adds additional load to the database. Disabling search reduces these queries, leading to better database performance and lower response times for other operations. + - **Lower Memory Usage**: Search functionality often requires indexing of posts, which consumes memory. By disabling search, the memory required for maintaining these indexes is freed up for other uses, improving overall system performance. + - **Faster Write Operations**: When post search is enabled, indexing has to be updated with every new post, edit, or deletion. Disabling search avoids this overhead, allowing for faster write operations. + - **Performance Consistency**: Without the search feature, the application avoids potential performance bottlenecks and can maintain more consistent performance levels, especially under heavy usage scenarios with a high number of posts. + - **Simplified System Maintenance**: Managing search indexes can be complex and resource-intensive. Disabling search simplifies this aspect of system maintenance, potentially reducing the risk of performance issues related to search index corruption or degradation. + + However, the ability to search messages in Mattermost is a critical feature for many users, and disabling this feature will result in users seeing an error if they attempt to use the Mattermost Search box. It's important to balance performance improvements with the needs of your organization and users. .. config:setting:: enable-file-search :displayname: Enable file search (Experimental) :systemconsole: N/A :configjson: EnableFileSearch - :environment: N/A + :environment: MM_SERVICESETTINGS_ENABLEFILESEARCH :description: This configuration setting enables users to search documents attached to messages by filename. Default is **true**. Enable file search ~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - -.. important:: - - This experimental configuration setting enables users to search documents attached to messages by filename. To enable users to search documents by their content, you must also enable the ``ExtractContent`` configuration setting. See our :ref:`Enable Document Search by Content ` documentation for details. Document content search is available in Mattermost Server from v5.35, with mobile support coming soon. - -**True**: Supported document types are searchable by their filename. - -**False**: File-based searches are disabled. - -+-------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableFileSearch": true`` with options ``true`` and ``false``. | -+-------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Supported document types are searchable by their filename. | - System Config path: N/A | +| - **false**: File-based searches are disabled. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableFileSearch`` > ``true`` | +| | - Environment variable: MM_SERVICESETTINGS_ENABLEFILESEARCH | ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ .. note:: - Disabling this experimental configuration setting in larger deployments may improve server performance in the following areas: + - This setting isn't available in the System Console and can only be set in ``config.json``. + - This experimental configuration setting enables users to search documents attached to messages by filename. To enable users to search documents by their content, you must also enable the ``ExtractContent`` configuration setting. See our :ref:`Enable Document Search by Content ` documentation for details. Document content search is available in Mattermost Server from v5.35, with mobile support coming soon. + - Disabling this experimental configuration setting in larger deployments may improve server performance in the following areas: + + - Less Data to Index: Indexing files in addition to messages adds to the amount of data that needs to be processed and stored in the search index. + - Fewer Complex Queries: Searching through files can require more complex queries, which can be more resource-intensive and time-consuming as compared to searching through messages alone. + - Lower IO Operations: Searching files can generate more input/output operations, impacting the overall disk performance, especially if the system handles a large volume of file uploads and searches. - - Less Data to Index: Indexing files in addition to messages adds to the amount of data that needs to be processed and stored in the search index. - - Fewer Complex Queries: Searching through files can require more complex queries, which can be more resource-intensive and time-consuming as compared to searching through messages alone. - - Lower IO Operations: Searching files can generate more input/output operations, impacting the overall disk performance, especially if the system handles a large volume of file uploads and searches. - - However, the ability to search for files in Mattermost is a critical feature for many users, and disabling this feature will result in users seeing an error if they attempt to use the Mattermost Search box. It’s important to balance performance improvements with the needs of your organization and users. + However, the ability to search for files in Mattermost is a critical feature for many users, and disabling this feature will result in users seeing an error if they attempt to use the Mattermost Search box. It's important to balance performance improvements with the needs of your organization and users. .. config:setting:: enable-user-status-updates :displayname: Enable user status updates (Experimental) :systemconsole: N/A :configjson: EnableUserStatuses - :environment: N/A + :environment: MM_SERVICESETTINGS_ENABLEUSERSTATUSES :description: Turn status updates off to improve performance. Default is **true**. Enable user status updates ~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Enables user status updates. | - System Config path: N/A | +| - **false**: Turn status updates off to improve performance. When status updates are off, users appear | - ``config.json`` setting: ``ServiceSettings`` > ``EnableUserStatuses`` > ``true`` | +| online only for brief periods when posting a message, and only to members of the channel in which | - Environment variable: MM_SERVICESETTINGS_ENABLEUSERSTATUSES | +| the message is posted. | | ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -Turn status updates off to improve performance. When status updates are off, users appear online only for brief periods when posting a message, and only to members of the channel in which the message is posted. +.. note:: -+---------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableUserStatuses": true`` with options ``true`` and ``false``. | -+---------------------------------------------------------------------------------------------------------------+ + - This setting isn't available in the System Console and can only be set in ``config.json``. + - Turn status updates off to improve performance. When status updates are off, users appear online only for brief periods when posting a message, and only to members of the channel in which the message is posted. .. config:setting:: websocket-secure-port :displayname: Websocket secure port (Experimental) :systemconsole: N/A :configjson: WebsocketSecurePort - :environment: N/A + :environment: MM_SERVICESETTINGS_WEBSOCKETSECUREPORT :description: This setting defines the port on which the secured WebSocket will listen using the ``wss`` protocol. Default is **443**. Websocket secure port ~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. Changes to this setting require a server restart before taking effect. - -(Optional) This setting defines the port on which the secured WebSocket is listening using the ``wss`` protocol. Defaults to ``443``. When the client attempts to make a WebSocket connection it first checks to see if the page is loaded with HTTPS. If so, it will use the secure WebSocket connection. If not, it will use the unsecure WebSocket connection. IT IS HIGHLY RECOMMENDED PRODUCTION DEPLOYMENTS ONLY OPERATE UNDER HTTPS AND WSS. - -+------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"WebsocketSecurePort": 443`` with numerical input. | -+------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ +| (Optional) This setting defines the port on which the secured WebSocket is listening using the ``wss`` | - System Config path: N/A | +| protocol. When the client attempts to make a WebSocket connection it first checks to see if the page | - ``config.json`` setting: ``ServiceSettings`` > ``WebsocketSecurePort`` > ``443`` | +| is loaded with HTTPS. If so, it will use the secure WebSocket connection. If not, it will use the | - Environment variable: MM_SERVICESETTINGS_WEBSOCKETSECUREPORT | +| unsecure WebSocket connection. IT IS HIGHLY RECOMMENDED PRODUCTION DEPLOYMENTS ONLY OPERATE UNDER | | +| HTTPS AND WSS. | | +| | | +| Numerical input. Default is **443**. | | ++----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ .. note:: - This is a client only override that doesn't affect the listening port of the server process which is controlled by the :ref:`Web server listen address ` setting. + + - This setting isn't available in the System Console and can only be set in ``config.json``. Changes to this setting require a server restart before taking effect. + - This is a client only override that doesn't affect the listening port of the server process which is controlled by the :ref:`Web server listen address ` setting. .. config:setting:: websocket-port :displayname: Websocket port (Experimental) :systemconsole: N/A :configjson: WebsocketPort - :environment: N/A + :environment: MM_SERVICESETTINGS_WEBSOCKETPORT :description: This setting defines the port on which the unsecured WebSocket will listen using the ``ws`` protocol. Default is **80**. Websocket port ~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. Changes to this setting require a server restart before taking effect. - -(Optional) This setting defines the port on which the unsecured WebSocket is listening using the ``ws`` protocol. Defaults to ``80``. When the client attempts to make a WebSocket connection it first checks to see if the page is loaded with HTTPS. If so, it will use the secure WebSocket connection. If not, it will use the unsecure WebSocket connection. IT IS HIGHLY RECOMMENDED PRODUCTION DEPLOYMENTS ONLY OPERATE UNDER HTTPS AND WSS. - -+----------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``WebsocketPort": 80`` with numerical input. | -+----------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| (Optional) This setting defines the port on which the unsecured WebSocket is listening using the ``ws`` | - System Config path: N/A | +| protocol. When the client attempts to make a WebSocket connection it first checks to see if the page | - ``config.json`` setting: ``ServiceSettings`` > ``WebsocketPort`` > ``80`` | +| is loaded with HTTPS. If so, it will use the secure WebSocket connection. If not, it will use the | - Environment variable: MM_SERVICESETTINGS_WEBSOCKETPORT | +| unsecure WebSocket connection. IT IS HIGHLY RECOMMENDED PRODUCTION DEPLOYMENTS ONLY OPERATE UNDER | | +| HTTPS AND WSS. | | +| | | +| Numerical input. Default is **80**. | | ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ .. note:: - This is a client only override that doesn't affect the listening port of the server process which is controlled by the :ref:`Web server listen address ` setting. + - This setting isn't available in the System Console and can only be set in ``config.json``. Changes to this setting require a server restart before taking effect. + - This is a client only override that doesn't affect the listening port of the server process which is controlled by the :ref:`Web server listen address ` setting. .. config:setting:: enable-local-mode-for-mmctl :displayname: Enable local mode for mmctl (Experimental) :systemconsole: N/A :configjson: EnableLocalMode - :environment: N/A + :environment: MM_SERVICESETTINGS_ENABLELOCALMODE - **true**: Enables local mode for mmctl. - **false**: **(Default)** Prevents local mode for mmctl. @@ -1774,13 +1990,13 @@ Enable local mode for mmctl This setting isn't available in the System Console and can only be set in ``config.json``. -**True**: Enables local mode for mmctl. - -**False**: Prevents local mode for mmctl. - -+-------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableLocalMode": false`` with options ``true`` and ``false``. | -+-------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| This setting controls whether mmctl can connect to the server | - System Config path: N/A | +| using local mode through a socket connection. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableLocalMode`` > ``false`` | +| | - Environment variable: MM_SERVICESETTINGS_ENABLELOCALMODE | +| - **true**: Enables local mode for mmctl. | | +| - **false**: **(Default)** Prevents local mode for mmctl. | | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------+ .. tip:: @@ -1790,45 +2006,52 @@ This setting isn't available in the System Console and can only be set in ``conf :displayname: Enable local mode socket location (Experimental) :systemconsole: N/A :configjson: LocalModeSocketLocation - :environment: N/A + :environment: MM_SERVICESETTINGS_LOCALMODESOCKETLOCATION :description: The path for the socket that the server will create for mmctl to connect and communicate through local mode. Default value is **/var/tmp/mattermost_local.socket**. Enable local mode socket location ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| The path for the socket that the server will create for mmctl to connect and communicate through local | - System Config path: N/A | +| mode. If the default value for this key is changed, you will need to point mmctl to the new socket | - ``config.json`` setting: ``ServiceSettings`` > ``LocalModeSocketLocation`` > ``"/var/tmp/mattermost_local.socket"`` | +| path when in local mode, using the ``--local-socket-path /new/path/to/socket`` flag in addition to | - Environment variable: MM_SERVICESETTINGS_LOCALMODESOCKETLOCATION | +| the ``--local`` flag. | | +| | | +| If nothing is specified, the default path that both the server and mmctl assumes is | | +| ``/var/tmp/mattermost_local.socket``. | | +| | | +| String input. Default is **/var/tmp/mattermost_local.socket**. | | ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -The path for the socket that the server will create for mmctl to connect and communicate through local mode. If the default value for this key is changed, you will need to point mmctl to the new socket path when in local mode, using the ``--local-socket-path /new/path/to/socket`` flag in addition to the ``--local`` flag. - -If nothing is specified, the default path that both the server and mmctl assumes is ``/var/tmp/mattermost_local.socket``. +.. note:: -+--------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"LocalModeSocketLocation": "/var/tmp/mattermost_local.socket"`` with string input. | -+--------------------------------------------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: default-channels :displayname: Default channels (Experimental) :systemconsole: N/A :configjson: ExperimentalDefaultChannels - :environment: N/A + :environment: MM_TEAMSETTINGS_EXPERIMENTALDEFAULTCHANNELS :description: Default channels every user is added to automatically after joining a new team. Only applies to Public channels, but affects all teams on the server. Default channels ~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. - -Default channels every user is added to automatically after joining a new team. Only applies to Public channels, but affects all teams on the server. - -When not set, every user is added to the ``town-square`` channel by default. ++----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| Default channels every user is added to automatically after joining a new team. Only applies to Public | - System Config path: N/A | +| channels, but affects all teams on the server. | - ``config.json`` setting: ``TeamSettings`` > ``ExperimentalDefaultChannels`` > ``[]`` | +| | - Environment variable: MM_TEAMSETTINGS_EXPERIMENTALDEFAULTCHANNELS | +| When not set, every user is added to the ``town-square`` channel by default. | | +| | | +| String array input consisting of channel names, such as ``["announcement", "developers"]``. | | ++----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ .. note:: - Even if ``town-square`` isn't listed, every user is added to that channels automatically when joining a new team. - -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"ExperimentalDefaultChannels": []`` with string array input consisting of channel names, such as ``["announcement", "developers"]``. | -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. + + Even if ``town-square`` isn't listed, every user is added to that channels automatically when joining a new team. ---- @@ -1848,7 +2071,7 @@ When running Mattermost in High Availability mode, ``RunJobs`` should be enabled :displayname: Run jobs (Experimental) :systemconsole: N/A :configjson: RunJobs - :environment: N/A + :environment: MM_JOBSETTINGS_RUNJOBS :description: Set whether or not this Mattermost server will handle tasks created by the Scheduler. Default is **true**. Run jobs @@ -1860,15 +2083,17 @@ Set whether or not this Mattermost server will handle tasks created by the Sched When running Mattermost in :doc:`High Availablity mode `, one or more servers should have this setting enabled. We recommend that your High Availability cluster-based deployment has one or more dedicated Workers with this setting enabled while the remaining Mattermost app servers have it disabled. -+------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"RunJobs": true`` with options ``true`` and ``false``. | -+------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ +| - **true**: **(Default)** This Mattermost server will handle tasks created by the Scheduler. | - System Config path: N/A | +| - **false**: This Mattermost server will not handle tasks created by the Scheduler. | - ``config.json`` setting: ``JobSettings`` > ``RunJobs`` > ``true`` | +| | - Environment variable: MM_JOBSETTINGS_RUNJOBS | ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: run-scheduler :displayname: Run scheduler (Experimental) :systemconsole: N/A :configjson: RunScheduler - :environment: N/A + :environment: MM_JOBSETTINGS_RUNSCHEDULER :description: Set whether or not this Mattermost server will schedule tasks that will be completed by a Worker. Default is **true**. Run scheduler @@ -1882,44 +2107,51 @@ When running Mattermost in :doc:`High Availablity mode ``RunScheduler`` > ``true`` | +| - **false**: This Mattermost server will not schedule tasks that will be completed by a Worker. | - Environment variable: MM_JOBSETTINGS_RUNSCHEDULER | ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ .. config:setting:: clean-up-old-database-jobs :displayname: Clean up old database jobs (Experimental) :systemconsole: N/A :configjson: .JobSettings.CleanupJobsThresholdDays - :environment: N/A + :environment: MM_JOBSETTINGS_CLEANUPJOBSTHRESHOLDDAYS :description: Defines the threshold in hours beyond which older completed database jobs are removed. Must be set to a value greater than or equal to ``0`` to be enabled. Default value is **-1** Clean up old database jobs ~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| Defines the threshold in days beyond which older completed database jobs are removed. This setting is | - System Config path: N/A | +| disabled by default, and must be set to a value greater than or equal to ``0`` to be enabled. | - ``config.json`` setting: ``JobSettings`` > ``CleanupJobsThresholdDays`` > ``-1`` | +| | - Environment variable: MM_JOBSETTINGS_CLEANUPJOBSTHRESHOLDDAYS | +| Numerical input. Default is **-1** (disabled). | | ++----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -Defines the threshold in days beyond which older completed database jobs are removed. This setting is disabled by default, and must be set to a value greater than or equal to ``0`` to be enabled. +.. note:: -+--------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"JobSettings.CleanupJobsThresholdDays": -1`` with numerical input. | -+--------------------------------------------------------------------------------------------------------------------+ + This setting isn't available in the System Console and can only be set in ``config.json``. .. config:setting:: clean-up-outdated-database-entries :displayname: Clean up outdated database entries (Experimental) :systemconsole: N/A :configjson: .JobSettings.CleanupConfigThresholdDays - :environment: N/A + :environment: MM_JOBSETTINGS_CLEANUPCONFIGTHRESHOLDDAYS :description: Defines the threshold in days beyond which outdated configurations are removed from the database. Default is **30** days. Clean up outdated database entries ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting only applies to configuration in the database. It isn't available in the System Console and can be set via mmctl or changed in the database. ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| Defines the threshold in days beyond which outdated configurations are removed from the database. | - System Config path: N/A | +| | - ``config.json`` setting: ``JobSettings`` > ``CleanupConfigThresholdDays`` > ``30`` | +| Numerical input. Default is **30** days. | - Environment variable: MM_JOBSETTINGS_CLEANUPCONFIGTHRESHOLDDAYS | ++----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ -Defines the threshold in days beyond which outdated configurations are removed from the database. +.. note:: -+--------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"JobSettings.CleanupConfigThresholdDays": 30`` with numerical input. | -+--------------------------------------------------------------------------------------------------------------------+ + This setting only applies to configuration in the database. It isn't available in the System Console and can be set via mmctl.