From 917816556c319a769752cd75799ca341cb1a2555 Mon Sep 17 00:00:00 2001 From: "claude[bot]" <209825114+claude[bot]@users.noreply.github.com> Date: Mon, 7 Jul 2025 20:19:17 +0000 Subject: [PATCH 1/4] Migrate compliance config settings to standard format - Updated all configuration settings to use standardized two-column table format - Replaced old single-column tables with new format matching other config files - Maintained all existing config:setting directives - Ensures consistent documentation structure across all configuration pages Fixes #8155 Co-authored-by: Carrie Warner (Mattermost) --- .../compliance-configuration-settings.rst | 218 +++++++++--------- 1 file changed, 113 insertions(+), 105 deletions(-) diff --git a/source/configure/compliance-configuration-settings.rst b/source/configure/compliance-configuration-settings.rst index 869279d0f4b..00f3bad6904 100644 --- a/source/configure/compliance-configuration-settings.rst +++ b/source/configure/compliance-configuration-settings.rst @@ -45,13 +45,11 @@ Access the following configuration settings in the System Console by going to ** Global retention policy for messages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Set how long Mattermost keeps messages across all teams and channels. Doesn't apply to custom retention policies. Requires the :ref:`global retention policy for messages ` configuration setting to be set to ``true``. - -By default, messages are kept forever. If **Hours**, **Days**, or **Years** is chosen, set how many hours, days, or years messages are kept in Mattermost. Messages older than the duration you set will be deleted nightly. The minimum message retention time is one hour. - -+--------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"MessageRetentionHours": 1`` or ``"MessageRetentionDays"`` with numerical input. | -+--------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| Set how long Mattermost keeps messages across all teams and channels. Doesn't apply to custom retention policies. | - System Config path: **Compliance > Data Retention Policies** | +| | - ``config.json`` setting: ``DataRetentionSettings`` > ``MessageRetentionDays`` or ``MessageRetentionHours`` | +| By default, messages are kept forever. If **Hours**, **Days**, or **Years** is chosen, set how many hours, days, or years messages are kept in Mattermost. Messages older than the duration you set will be deleted nightly. The minimum message retention time is one hour. | - Environment variable: ``MM_DATARETENTIONSETTINGS_MESSAGERETENTIONDAYS`` or ``MM_DATARETENTIONSETTINGS_MESSAGERETENTIONHOURS`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. note:: @@ -67,13 +65,11 @@ By default, messages are kept forever. If **Hours**, **Days**, or **Years** is c Global retention policy for files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Set how long Mattermost keeps files across all teams and channels. Doesn't apply to custom retention policies. Requires the :ref:`global retention policy for files ` configuration setting to be set to ``true``. - -By default, files are kept forever. If **Hours**, **Days**, or **Years** is chosen, set how many hours, days, or years files are kept in Mattermost. Files older than the duration you set will be deleted nightly. The minimum file retention time is one hour. - -+--------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"FileRetentionHours": ``1`` or ``"FileRetentionDays"`` with numerical input. | -+--------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| Set how long Mattermost keeps files across all teams and channels. Doesn't apply to custom retention policies. | - System Config path: **Compliance > Data Retention Policies** | +| | - ``config.json`` setting: ``DataRetentionSettings`` > ``FileRetentionDays`` or ``FileRetentionHours`` | +| By default, files are kept forever. If **Hours**, **Days**, or **Years** is chosen, set how many hours, days, or years files are kept in Mattermost. Files older than the duration you set will be deleted nightly. The minimum file retention time is one hour. | - Environment variable: ``MM_DATARETENTIONSETTINGS_FILERETENTIONDAYS`` or ``MM_DATARETENTIONSETTINGS_FILERETENTIONHOURS`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. note:: @@ -89,7 +85,11 @@ By default, files are kept forever. If **Hours**, **Days**, or **Years** is chos Custom retention policy ~~~~~~~~~~~~~~~~~~~~~~~ -Set how long Mattermost keeps messages and files across specific teams and channels by specifying a name for the custom retention policy, setting a duration value in days or years, and specifying the teams and channels that will follow this policy. ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| Set how long Mattermost keeps messages and files across specific teams and channels by specifying a name for the custom retention policy, setting a duration value in days or years, and specifying the teams and channels that will follow this policy. | - System Config path: **Compliance > Data Retention Policies** | +| | - ``config.json`` setting: N/A | +| | - Environment variable: N/A | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: data-deletion-time :displayname: Data deletion time (Data Retention) @@ -101,18 +101,20 @@ Set how long Mattermost keeps messages and files across specific teams and chann Data deletion time ~~~~~~~~~~~~~~~~~~ -Set the start time of the daily scheduled data retention job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form ``HH:MM``. - -This setting is based on the local time of the server. - -+-------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"DeletionJobStartTime": "02:00"`` with 24-hour timestamp input in the form ``"HH:MM"``. | -+-------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| Set the start time of the daily scheduled data retention job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form ``HH:MM``. | - System Config path: **Compliance > Data Retention Policies** | +| | - ``config.json`` setting: ``DataRetentionSettings`` > ``DeletionJobStartTime`` | +| This setting is based on the local time of the server. | - Environment variable: ``MM_DATARETENTIONSETTINGS_DELETIONJOBSTARTTIME`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ Run deletion job now ~~~~~~~~~~~~~~~~~~~~~ -Start a Data Retention deletion job immediately. You can monitor the status of the job in the data deletion job table within the Policy Log section. ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| Start a Data Retention deletion job immediately. You can monitor the status of the job in the data deletion job table within the Policy Log section. | - System Config path: **Compliance > Data Retention Policies** | +| | - ``config.json`` setting: N/A | +| | - Environment variable: N/A | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ---- @@ -136,13 +138,11 @@ Access the following configuration settings in the System Console by going to ** Enable compliance export ~~~~~~~~~~~~~~~~~~~~~~~~ -**True**: Mattermost will generate a compliance export file that contains all messages that were posted in the last 24 hours. The export task is scheduled to run once per day. See the :doc:`documentation to learn more `. - -**False**: Mattermost doesn't generate a compliance export file. - -+----------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableExport": false`` with options ``true`` and ``false``. | -+----------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| - **True**: Mattermost will generate a compliance export file that contains all messages that were posted in the last 24 hours. The export task is scheduled to run once per day. See the :doc:`documentation to learn more `. | - System Config path: **Compliance > Compliance Export** | +| - **False**: **(Default)** Mattermost doesn't generate a compliance export file. | - ``config.json`` setting: ``MessageExportSettings`` > ``EnableExport`` | +| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_ENABLEEXPORT`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: compliance-export-time :displayname: Compliance export time (Compliance Export) @@ -154,13 +154,11 @@ Enable compliance export Compliance export time ~~~~~~~~~~~~~~~~~~~~~~~ -Set the start time of the daily scheduled compliance export job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form ``HH:MM``. - -This setting is based on the local time of the server. - -+---------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"DailyRunTime": 01:00`` with 24-hour timestamp input in the form ``"HH:MM"``. | -+---------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| Set the start time of the daily scheduled compliance export job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form ``HH:MM``. | - System Config path: **Compliance > Compliance Export** | +| | - ``config.json`` setting: ``MessageExportSettings`` > ``DailyRunTime`` | +| This setting is based on the local time of the server. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_DAILYRUNTIME`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: export-file-format :displayname: Export file format (Compliance Export) @@ -172,11 +170,13 @@ This setting is based on the local time of the server. Export file format ~~~~~~~~~~~~~~~~~~~ -File format of the compliance export. Corresponds to the system that you want to import the data into. - -Currently supported formats are CSV, Actiance XML, and Global Relay EML. - -If Global Relay is chosen, the following options will be presented: ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| File format of the compliance export. Corresponds to the system that you want to import the data into. | - System Config path: **Compliance > Compliance Export** | +| | - ``config.json`` setting: ``MessageExportSettings`` > ``ExportFormat`` | +| Currently supported formats are CSV, Actiance XML, and Global Relay EML. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_EXPORTFORMAT`` | +| | | +| If Global Relay is chosen, the following options will be presented: | | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: global-relay-customer-account :displayname: Global Relay customer account (Compliance Export - Global Relay EML) @@ -188,11 +188,11 @@ If Global Relay is chosen, the following options will be presented: Global Relay customer account ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Type of Global Relay customer account your organization has. Can be one of: ``A9/Type 9``, ``A10/Type 10``, or ``Custom``. - -+---------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"CustomerType": "A9"`` with options ``"A9``, ``"A10"``, and ``CUSTOM``. | -+---------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| Type of Global Relay customer account your organization has. Can be one of: ``A9/Type 9``, ``A10/Type 10``, or ``Custom``. | - System Config path: **Compliance > Compliance Export** | +| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``CustomerType`` | +| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMERTYPE`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: global-relay-smtp-username :displayname: Global Relay SMTP username (Compliance Export - Global Relay EML) @@ -204,11 +204,11 @@ Type of Global Relay customer account your organization has. Can be one of: ``A9 Global Relay SMTP username ~~~~~~~~~~~~~~~~~~~~~~~~~~ -The username for authenticating to the Global Relay SMTP server. - -+-------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"SmtpUsername": ""`` with string input. | -+-------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| The username for authenticating to the Global Relay SMTP server. | - System Config path: **Compliance > Compliance Export** | +| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``SmtpUsername`` | +| String input. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPUSERNAME`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: global-relay-smtp-password :displayname: Global Relay SMTP password (Compliance Export - Global Relay EML) @@ -220,11 +220,11 @@ The username for authenticating to the Global Relay SMTP server. Global Relay SMTP password ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The password associated with the Global Relay SMTP username. - -+-------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"SmtpPassword": ""`` with string input. | -+-------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| The password associated with the Global Relay SMTP username. | - System Config path: **Compliance > Compliance Export** | +| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``SMTPPassword`` | +| String input. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPPASSWORD`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: global-relay-email-address :displayname: Global Relay email address (Compliance Export - Global Relay EML) @@ -236,11 +236,11 @@ The password associated with the Global Relay SMTP username. Global Relay email address ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The email address your Global Relay server monitors for incoming compliance exports. - -+-------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EmailAddress": ""`` with string input. | -+-------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| The email address your Global Relay server monitors for incoming compliance exports. | - System Config path: **Compliance > Compliance Export** | +| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``EmailAddress`` | +| String input. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_EMAILADDRESS`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: smtp-server-name :displayname: SMTP server name (Compliance Export - Global Relay EML) @@ -252,11 +252,11 @@ The email address your Global Relay server monitors for incoming compliance expo SMTP server name ~~~~~~~~~~~~~~~~ -The SMTP server name URL that will receive your Global Relay EML file when a `custom customer account type <#global-relay-customer-account>`__ is configured. - -+----------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".MessageExportSettings.GlobalRelaySettings.CustomSMTPServerName": ""`` with string input. | -+----------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| The SMTP server name URL that will receive your Global Relay EML file when a `custom customer account type <#global-relay-customer-account>`__ is configured. | - System Config path: **Compliance > Compliance Export** | +| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``CustomSMTPServerName`` | +| String input. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMSMTPSERVERNAME`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: smtp-server-port :displayname: SMTP server port (Compliance Export - Global Relay EML) @@ -268,16 +268,20 @@ The SMTP server name URL that will receive your Global Relay EML file when a `cu SMTP server port ~~~~~~~~~~~~~~~~ -The SMTP server port that will receive your Global Relay EML file when a `custom customer account type <#global-relay-customer-account>`__ is configured. Default is 25. - -+----------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".MessageExportSettings.GlobalRelaySettings.CustomSMTPPort": 25`` with string input. | -+----------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| The SMTP server port that will receive your Global Relay EML file when a `custom customer account type <#global-relay-customer-account>`__ is configured. Default is 25. | - System Config path: **Compliance > Compliance Export** | +| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``CustomSMTPPort`` | +| Numerical input. Default is 25. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMSMPTPORT`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ Run compliance export job now ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This button initiates a compliance export job immediately. You can monitor the status of the job in the compliance export job table. ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| This button initiates a compliance export job immediately. You can monitor the status of the job in the compliance export job table. | - System Config path: **Compliance > Compliance Export** | +| | - ``config.json`` setting: N/A | +| | - Environment variable: N/A | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ---- @@ -303,13 +307,11 @@ Access the following configuration settings in the System Console by going to ** Enable compliance reporting ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**True**: Compliance reporting is enabled in Mattermost. - -**False**: Compliance reporting is disabled. - -+----------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"Enable": false`` with options ``true`` and ``false``. | -+----------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| - **True**: Compliance reporting is enabled in Mattermost. | - System Config path: **Compliance > Compliance Monitoring** | +| - **False**: **(Default)** Compliance reporting is disabled. | - ``config.json`` setting: ``ComplianceSettings`` > ``Enable`` | +| | - Environment variable: ``MM_COMPLIANCESETTINGS_ENABLE`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: compliance-report-directory :displayname: Compliance report directory (Compliance Monitoring) @@ -321,11 +323,11 @@ Enable compliance reporting Compliance report directory ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Sets the directory where compliance reports are written. - -+-----------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"Directory": "./data/"`` with string input. | -+-----------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| Sets the directory where compliance reports are written. | - System Config path: **Compliance > Compliance Monitoring** | +| | - ``config.json`` setting: ``ComplianceSettings`` > ``Directory`` | +| String input. Default is ``./data/``. | - Environment variable: ``MM_COMPLIANCESETTINGS_DIRECTORY`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: enable-compliance-reportingdaily :displayname: Enable daily report (Compliance Monitoring) @@ -339,13 +341,11 @@ Sets the directory where compliance reports are written. Enable daily report ~~~~~~~~~~~~~~~~~~~~ -**True**: Mattermost generates a daily compliance report. - -**False**: Daily reports are not generated. - -+---------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableDaily": false`` with options ``true`` and ``false``. | -+---------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| - **True**: Mattermost generates a daily compliance report. | - System Config path: **Compliance > Compliance Monitoring** | +| - **False**: **(Default)** Daily reports are not generated. | - ``config.json`` setting: ``ComplianceSettings`` > ``EnableDaily`` | +| | - Environment variable: ``MM_COMPLIANCESETTINGS_ENABLEDAILY`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: batch-size :displayname: Batch size (Compliance Monitoring) @@ -357,11 +357,11 @@ Enable daily report Batch size ~~~~~~~~~~ -Set the size of the batches in which posts will be read from the database to generate the compliance report. This setting is currently not available in the System Console and can only be set in ``config.json``. - -+------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"BatchSize": 30000`` with default value ``30000``. | -+------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| Set the size of the batches in which posts will be read from the database to generate the compliance report. This setting is currently not available in the System Console and can only be set in ``config.json``. | - System Config path: **Compliance > Compliance Monitoring** | +| | - ``config.json`` setting: ``ComplianceSettings`` > ``BatchSize`` | +| Numerical input. Default is ``30000``. | - Environment variable: ``MM_COMPLIANCESETTINGS_BATCHSIZE`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ---- @@ -385,13 +385,15 @@ Access the following configuration settings in the System Console by going to ** Enable custom terms of service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| - **True**: New users must accept the Terms of Service before accessing any Mattermost teams on desktop, web, or mobile. Existing users must accept them after login or a page refresh. To update the Terms of Service link displayed in account creation and login pages, go to **System Console > Legal and Support > Terms of Service Link**. | - System Config path: **Compliance > Custom Terms of Service** | +| - **False**: During account creation or login, users can review Terms of Service by accessing the link configured via **System Console > Legal and Support > Terms of Service link**. | - ``config.json`` setting: ``SupportSettings`` > ``CustomTermsOfServiceEnabled`` | +| | - Environment variable: ``MM_SUPPORTSETTINGS_CUSTOMTERMSOFSERVICEENABLED`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + .. note:: This configuration setting can only be modified using the System Console user interface. -**True**: New users must accept the Terms of Service before accessing any Mattermost teams on desktop, web, or mobile. Existing users must accept them after login or a page refresh. To update the Terms of Service link displayed in account creation and login pages, go to **System Console > Legal and Support > Terms of Service Link**. - -**False**: During account creation or login, users can review Terms of Service by accessing the link configured via **System Console > Legal and Support > Terms of Service link**. - .. config:setting:: custom-terms-of-service-text :displayname: Custom terms of service text (Custom Terms of Service) :systemconsole: Compliance > Custom Terms of Service @@ -402,7 +404,11 @@ Enable custom terms of service Custom terms of service text ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Text that will appear in your custom Terms of Service. Supports Markdown-formatted text. ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| Text that will appear in your custom Terms of Service. Supports Markdown-formatted text. | - System Config path: **Compliance > Custom Terms of Service** | +| | - ``config.json`` setting: N/A | +| Text input. | - Environment variable: N/A | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: re-acceptance-period :displayname: Re-acceptance period (Custom Terms of Service) @@ -414,6 +420,8 @@ Text that will appear in your custom Terms of Service. Supports Markdown-formatt Re-acceptance period ~~~~~~~~~~~~~~~~~~~~ -The number of days before Terms of Service acceptance expires, and the terms must be re-accepted. - -Defaults to 365 days. 0 indicates the terms do not expire. ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| The number of days before Terms of Service acceptance expires, and the terms must be re-accepted. | - System Config path: **Compliance > Custom Terms of Service** | +| | - ``config.json`` setting: ``SupportSettings`` > ``CustomTermsOfServiceReAcceptancePeriod`` | +| Numerical input. Default is 365 days. 0 indicates the terms do not expire. | - Environment variable: ``MM_SUPPORTSETTINGS_CUSTOMTERMSOFSERVICEREACCEPTANCEPERIOD`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ From ca924c5f2239991f57285e3b4379853018477941 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Tue, 8 Jul 2025 13:12:21 -0400 Subject: [PATCH 2/4] Editorial review --- .../compliance-configuration-settings.rst | 280 ++++++++++-------- 1 file changed, 163 insertions(+), 117 deletions(-) diff --git a/source/configure/compliance-configuration-settings.rst b/source/configure/compliance-configuration-settings.rst index 1717d7de187..436477ce7e7 100644 --- a/source/configure/compliance-configuration-settings.rst +++ b/source/configure/compliance-configuration-settings.rst @@ -45,11 +45,16 @@ Access the following configuration settings in the System Console by going to ** Global retention policy for messages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| Set how long Mattermost keeps messages across all teams and channels. Doesn't apply to custom retention policies. | - System Config path: **Compliance > Data Retention Policies** | -| | - ``config.json`` setting: ``DataRetentionSettings`` > ``MessageRetentionDays`` or ``MessageRetentionHours`` | -| By default, messages are kept forever. If **Hours**, **Days**, or **Years** is chosen, set how many hours, days, or years messages are kept in Mattermost. Messages older than the duration you set will be deleted nightly. The minimum message retention time is one hour. | - Environment variable: ``MM_DATARETENTIONSETTINGS_MESSAGERETENTIONDAYS`` or ``MM_DATARETENTIONSETTINGS_MESSAGERETENTIONHOURS`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++----------------------------------------------------------------+--------------------------------------------------------------------------------+ +| Set how long Mattermost keeps messages across all teams and | - System Config path: **Compliance > Data Retention Policies** | +| channels. Doesn't apply to custom retention policies. | - ``config.json`` setting: ``".DataRetentionSettings.MessageRetentionHours"`` | +| | - Environment variable: ``MM_DATARETENTIONSETTINGS_MESSAGERETENTIONHOURS`` | +| By default, messages are kept forever. If **Hours**, **Days**, | | +| or **Years** is chosen, set how many hours, days, or years | | +| messages are kept in Mattermost. Messages older than the | | +| duration you set will be deleted nightly. The minimum message | | +| retention time is one hour. | | ++----------------------------------------------------------------+--------------------------------------------------------------------------------+ .. note:: @@ -65,11 +70,16 @@ Global retention policy for messages Global retention policy for files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| Set how long Mattermost keeps files across all teams and channels. Doesn't apply to custom retention policies. | - System Config path: **Compliance > Data Retention Policies** | -| | - ``config.json`` setting: ``DataRetentionSettings`` > ``FileRetentionDays`` or ``FileRetentionHours`` | -| By default, files are kept forever. If **Hours**, **Days**, or **Years** is chosen, set how many hours, days, or years files are kept in Mattermost. Files older than the duration you set will be deleted nightly. The minimum file retention time is one hour. | - Environment variable: ``MM_DATARETENTIONSETTINGS_FILERETENTIONDAYS`` or ``MM_DATARETENTIONSETTINGS_FILERETENTIONHOURS`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+-----------------------------------------------------------------------------+ +| Set how long Mattermost keeps files across all teams and | - System Config path: **Compliance > Data Retention Policies** | +| channels. Doesn't apply to custom retention policies. | - ``config.json`` setting: ``".DataRetentionSettings.FileRetentionHours"`` | +| | - Environment variable: ``MM_DATARETENTIONSETTINGS_FILERETENTIONHOURS`` | +| By default, files are kept forever. If **Hours**, **Days**, | | +| or **Years** is chosen, set how many hours, days, or years | | +| files are kept in Mattermost. Files older than the duration | | +| you set will be deleted nightly. The minimum file retention | | +| time is 1 hour. | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------+ .. note:: @@ -85,11 +95,13 @@ Global retention policy for files Custom retention policy ~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| Set how long Mattermost keeps messages and files across specific teams and channels by specifying a name for the custom retention policy, setting a duration value in days or years, and specifying the teams and channels that will follow this policy. | - System Config path: **Compliance > Data Retention Policies** | -| | - ``config.json`` setting: N/A | -| | - Environment variable: N/A | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| Set how long Mattermost keeps messages and files across | - System Config path: **Compliance > Data Retention Policies** | +| specific teams and channels by specifying a name for the | - ``config.json`` setting: N/A | +| custom retention policy, setting a duration value in days | - Environment variable: N/A | +| or years, and specifying the teams and channels that will | | +| follow this policy. | | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: data-deletion-time :displayname: Data deletion time (Data Retention) @@ -101,20 +113,22 @@ Custom retention policy Data deletion time ~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| Set the start time of the daily scheduled data retention job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form ``HH:MM``. | - System Config path: **Compliance > Data Retention Policies** | -| | - ``config.json`` setting: ``DataRetentionSettings`` > ``DeletionJobStartTime`` | -| This setting is based on the local time of the server. | - Environment variable: ``MM_DATARETENTIONSETTINGS_DELETIONJOBSTARTTIME`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+------------------------------------------------------------------------------+ +| Set the start time of the daily scheduled data retention job. | - System Config path: **Compliance > Data Retention Policies** | +| Choose a time when fewer people are using your system. Must | - ``config.json`` setting: ``".DataRetentionSettings.DeletionJobStartTime"`` | +| be a 24-hour time stamp in the form ``HH:MM``. | - Environment variable: ``MM_DATARETENTIONSETTINGS_DELETIONJOBSTARTTIME`` | +| | | +| This setting is based on the local time of the server. | | ++---------------------------------------------------------------+------------------------------------------------------------------------------+ Run deletion job now ~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| Start a Data Retention deletion job immediately. You can monitor the status of the job in the data deletion job table within the Policy Log section. | - System Config path: **Compliance > Data Retention Policies** | -| | - ``config.json`` setting: N/A | -| | - Environment variable: N/A | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| Start a Data Retention deletion job immediately. You can | - System Config path: **Compliance > Data Retention Policies** | +| monitor the status of the job in the data deletion job table | - ``config.json`` setting: N/A | +| within the Policy Log section. | - Environment variable: N/A | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ ---- @@ -138,11 +152,16 @@ Access the following configuration settings in the System Console by going to ** Enable compliance export ~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| - **True**: Mattermost will generate a compliance export file that contains all messages that were posted in the last 24 hours. The export task is scheduled to run once per day. See the :doc:`documentation to learn more `. | - System Config path: **Compliance > Compliance Export** | -| - **False**: **(Default)** Mattermost doesn't generate a compliance export file. | - ``config.json`` setting: ``MessageExportSettings`` > ``EnableExport`` | -| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_ENABLEEXPORT`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++-----------------------------------------------------------------+--------------------------------------------------------------------------+ +| - **True**: Mattermost will generate a compliance export file | - System Config path: **Compliance > Compliance Export** | +| that contains all messages that were posted in the last 24 | - ``config.json`` setting: ``".MessageExportSettings.EnableExport"`` | +| hours. The export task is scheduled to run once per day. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_ENABLEEXPORT`` | +| See the :doc:`compliance export documentation | | +| to learn more `. | | +| | | +| - **False**: **(Default)** Mattermost doesn't generate a | | +| compliance export file. | | ++-----------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: compliance-export-time :displayname: Compliance export time (Compliance Export) @@ -154,11 +173,13 @@ Enable compliance export Compliance export time ~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| Set the start time of the daily scheduled compliance export job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form ``HH:MM``. | - System Config path: **Compliance > Compliance Export** | -| | - ``config.json`` setting: ``MessageExportSettings`` > ``DailyRunTime`` | -| This setting is based on the local time of the server. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_DAILYRUNTIME`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| Set the start time of the daily scheduled compliance export | - System Config path: **Compliance > Compliance Export** | +| job. Choose a time when fewer people are using your system. | - ``config.json`` setting: ``".MessageExportSettings.DailyRunTime"`` | +| Must be a 24-hour time stamp in the form ``HH:MM``. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_DAILYRUNTIME`` | +| | | +| This setting is based on the local time of the server. | | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: export-file-format :displayname: Export file format (Compliance Export) @@ -170,13 +191,16 @@ Compliance export time Export file format ~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| File format of the compliance export. Corresponds to the system that you want to import the data into. | - System Config path: **Compliance > Compliance Export** | -| | - ``config.json`` setting: ``MessageExportSettings`` > ``ExportFormat`` | -| Currently supported formats are CSV, Actiance XML, and Global Relay EML. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_EXPORTFORMAT`` | -| | | -| If Global Relay is chosen, the following options will be presented: | | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| File format of the compliance export. Corresponds to the | - System Config path: **Compliance > Compliance Export** | +| system that you want to import the data into. | - ``config.json`` setting: ``".MessageExportSettings.ExportFormat"`` | +| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_EXPORTFORMAT`` | +| Currently supported formats are CSV, Actiance XML, and | | +| Global Relay EML. | | +| | | +| If Global Relay is chosen, the following options will be | | +| presented: | | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: global-relay-customer-account :displayname: Global Relay customer account (Compliance Export - Global Relay EML) @@ -188,11 +212,11 @@ Export file format Global Relay customer account ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| Type of Global Relay customer account your organization has. Can be one of: ``A9/Type 9``, ``A10/Type 10``, or ``Custom``. | - System Config path: **Compliance > Compliance Export** | -| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``CustomerType`` | -| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMERTYPE`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| Type of Global Relay customer account your organization has. | - System Config path: **Compliance > Compliance Export** | +| Can be one of: ``A9/Type 9``, ``A10/Type 10``, or ``Custom``. | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.CustomerType"`` | +| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMERTYPE`` | ++---------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. config:setting:: global-relay-smtp-username :displayname: Global Relay SMTP username (Compliance Export - Global Relay EML) @@ -204,11 +228,12 @@ Global Relay customer account Global Relay SMTP username ~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| The username for authenticating to the Global Relay SMTP server. | - System Config path: **Compliance > Compliance Export** | -| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``SmtpUsername`` | -| String input. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPUSERNAME`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| The username for authenticating to the Global Relay SMTP | - System Config path: **Compliance > Compliance Export** | +| server. | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.SmtpUsername"`` | +| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPUSERNAME`` | +| String input. | | ++---------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. config:setting:: global-relay-smtp-password :displayname: Global Relay SMTP password (Compliance Export - Global Relay EML) @@ -220,11 +245,11 @@ Global Relay SMTP username Global Relay SMTP password ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| The password associated with the Global Relay SMTP username. | - System Config path: **Compliance > Compliance Export** | -| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``SMTPPassword`` | -| String input. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPPASSWORD`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| The password associated with the Global Relay SMTP username. | - System Config path: **Compliance > Compliance Export** | +| | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.SMTPPassword"`` | +| String input. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPPASSWORD`` | ++---------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. config:setting:: global-relay-email-address :displayname: Global Relay email address (Compliance Export - Global Relay EML) @@ -236,11 +261,12 @@ Global Relay SMTP password Global Relay email address ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| The email address your Global Relay server monitors for incoming compliance exports. | - System Config path: **Compliance > Compliance Export** | -| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``EmailAddress`` | -| String input. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_EMAILADDRESS`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| The email address your Global Relay server monitors for | - System Config path: **Compliance > Compliance Export** | +| incoming compliance exports. | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.EmailAddress"`` | +| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_EMAILADDRESS`` | +| String input. | | ++---------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. config:setting:: smtp-server-name :displayname: SMTP server name (Compliance Export - Global Relay EML) @@ -252,11 +278,14 @@ Global Relay email address SMTP server name ~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| The SMTP server name URL that will receive your Global Relay EML file when a `custom customer account type <#global-relay-customer-account>`__ is configured. | - System Config path: **Compliance > Compliance Export** | -| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``CustomSMTPServerName`` | -| String input. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMSMTPSERVERNAME`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| The SMTP server name URL that will receive your Global Relay | - System Config path: **Compliance > Compliance Export** | +| EML file when a | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.CustomSMTPServerName"`` | +| `custom customer account type <#global-relay-customer-account>`__ | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMSMTPSERVERNAME`` | +| is configured. | | +| | | +| String input. | | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ .. config:setting:: smtp-server-port :displayname: SMTP server port (Compliance Export - Global Relay EML) @@ -268,11 +297,14 @@ SMTP server name SMTP server port ~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| The SMTP server port that will receive your Global Relay EML file when a `custom customer account type <#global-relay-customer-account>`__ is configured. Default is 25. | - System Config path: **Compliance > Compliance Export** | -| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``CustomSMTPPort`` | -| Numerical input. Default is 25. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMSMPTPORT`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +| The SMTP server port that will receive your Global Relay EML | - System Config path: **Compliance > Compliance Export** | +| file when a | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.CustomSMTPPort"`` | +| `custom customer account type <#global-relay-customer-account>`__ | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMSMPTPORT`` | +| is configured. | | +| | | +| Numerical input. Default is 25. | | ++---------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ .. config:setting:: message-export-batch-size :displayname: Message export batch size (Compliance Export) @@ -289,20 +321,21 @@ Message export batch size This setting isn't available in the System Console and can only be set in ``config.json``. -Determines how many new posts are batched together to a compliance export file. - -+---------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"BatchSize": 10000`` with numerical input. | -+---------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| Determines how many new posts are batched together to a | - System Config path: N/A | +| compliance export file. | - ``config.json`` setting: ``".MessageExportSettings.BatchSize": 10000`` | +| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_BATCHSIZE`` | +| Numerical input. Default is **10000** posts. | | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ Run compliance export job now ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| This button initiates a compliance export job immediately. You can monitor the status of the job in the compliance export job table. | - System Config path: **Compliance > Compliance Export** | -| | - ``config.json`` setting: N/A | -| | - Environment variable: N/A | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| This button initiates a compliance export job immediately. | - System Config path: **Compliance > Compliance Export** | +| You can monitor the status of the job in the compliance | - ``config.json`` setting: N/A | +| export job table. | - Environment variable: N/A | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ ---- @@ -328,11 +361,11 @@ Access the following configuration settings in the System Console by going to ** Enable compliance reporting ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| - **True**: Compliance reporting is enabled in Mattermost. | - System Config path: **Compliance > Compliance Monitoring** | -| - **False**: **(Default)** Compliance reporting is disabled. | - ``config.json`` setting: ``ComplianceSettings`` > ``Enable`` | -| | - Environment variable: ``MM_COMPLIANCESETTINGS_ENABLE`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| **True**: Compliance reporting is enabled in Mattermost. | - System Config path: **Compliance > Compliance Monitoring** | +| | - ``config.json`` setting: ``".ComplianceSettings.Enable"`` | +| **False**: **(Default)** Compliance reporting is disabled. | - Environment variable: ``MM_COMPLIANCESETTINGS_ENABLE`` | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: compliance-report-directory :displayname: Compliance report directory (Compliance Monitoring) @@ -344,11 +377,11 @@ Enable compliance reporting Compliance report directory ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| Sets the directory where compliance reports are written. | - System Config path: **Compliance > Compliance Monitoring** | -| | - ``config.json`` setting: ``ComplianceSettings`` > ``Directory`` | -| String input. Default is ``./data/``. | - Environment variable: ``MM_COMPLIANCESETTINGS_DIRECTORY`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| Sets the directory where compliance reports are written. | - System Config path: **Compliance > Compliance Monitoring** | +| | - ``config.json`` setting: ``".ComplianceSettings.Directory"`` | +| String input. Default is ``./data/``. | - Environment variable: ``MM_COMPLIANCESETTINGS_DIRECTORY`` | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: enable-compliance-reportingdaily :displayname: Enable daily report (Compliance Monitoring) @@ -362,11 +395,11 @@ Compliance report directory Enable daily report ~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| - **True**: Mattermost generates a daily compliance report. | - System Config path: **Compliance > Compliance Monitoring** | -| - **False**: **(Default)** Daily reports are not generated. | - ``config.json`` setting: ``ComplianceSettings`` > ``EnableDaily`` | -| | - Environment variable: ``MM_COMPLIANCESETTINGS_ENABLEDAILY`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| **True**: Mattermost generates a daily compliance report. | - System Config path: **Compliance > Compliance Monitoring** | +| | - ``config.json`` setting: ``".ComplianceSettings.EnableDaily"`` | +| **False**: **(Default)** Daily reports are not generated. | - Environment variable: ``MM_COMPLIANCESETTINGS_ENABLEDAILY`` | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: batch-size :displayname: Batch size (Compliance Monitoring) @@ -378,11 +411,14 @@ Enable daily report Batch size ~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| Set the size of the batches in which posts will be read from the database to generate the compliance report. This setting is currently not available in the System Console and can only be set in ``config.json``. | - System Config path: **Compliance > Compliance Monitoring** | -| | - ``config.json`` setting: ``ComplianceSettings`` > ``BatchSize`` | -| Numerical input. Default is ``30000``. | - Environment variable: ``MM_COMPLIANCESETTINGS_BATCHSIZE`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| Set the size of the batches in which posts will be read from | - System Config path: **Compliance > Compliance Monitoring** | +| the database to generate the compliance report. This setting | - ``config.json`` setting: ``".ComplianceSettings.BatchSize"`` | +| is currently not available in the System Console and can only | - Environment variable: ``MM_COMPLIANCESETTINGS_BATCHSIZE`` | +| be set in ``config.json``. | | +| | | +| Numerical input. Default is **30000**. | | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ ---- @@ -406,11 +442,18 @@ Access the following configuration settings in the System Console by going to ** Enable custom terms of service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| - **True**: New users must accept the Terms of Service before accessing any Mattermost teams on desktop, web, or mobile. Existing users must accept them after login or a page refresh. To update the Terms of Service link displayed in account creation and login pages, go to **System Console > Legal and Support > Terms of Service Link**. | - System Config path: **Compliance > Custom Terms of Service** | -| - **False**: During account creation or login, users can review Terms of Service by accessing the link configured via **System Console > Legal and Support > Terms of Service link**. | - ``config.json`` setting: ``SupportSettings`` > ``CustomTermsOfServiceEnabled`` | -| | - Environment variable: ``MM_SUPPORTSETTINGS_CUSTOMTERMSOFSERVICEENABLED`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++-----------------------------------------------------------------+-------------------------------------------------------------------------------+ +| **True**: New users must accept the Terms of Service before | - System Config path: **Compliance > Custom Terms of Service** | +| accessing any Mattermost teams on desktop, web, or mobile. | - ``config.json`` setting: ``".SupportSettings.CustomTermsOfServiceEnabled"`` | +| Existing users must accept them after login or a page refresh. | - Environment variable: ``MM_SUPPORTSETTINGS_CUSTOMTERMSOFSERVICEENABLED`` | +| To update the Terms of Service link displayed in account | | +| creation and login pages, go to **System Console > Legal and | | +| Support > Terms of Service Link**. | | +| | | +| **False**: During account creation or login, users can review | | +| Terms of Service by accessing the link configured via | | +| **System Console > Legal and Support > Terms of Service link**. | | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------+ .. note:: This configuration setting can only be modified using the System Console user interface. @@ -425,11 +468,12 @@ Enable custom terms of service Custom terms of service text ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| Text that will appear in your custom Terms of Service. Supports Markdown-formatted text. | - System Config path: **Compliance > Custom Terms of Service** | -| | - ``config.json`` setting: N/A | -| Text input. | - Environment variable: N/A | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| Text that will appear in your custom Terms of Service. | - System Config path: **Compliance > Custom Terms of Service** | +| Supports Markdown-formatted text. | - ``config.json`` setting: N/A | +| | - Environment variable: N/A | +| Text input. | | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: re-acceptance-period :displayname: Re-acceptance period (Custom Terms of Service) @@ -441,8 +485,10 @@ Custom terms of service text Re-acceptance period ~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| The number of days before Terms of Service acceptance expires, and the terms must be re-accepted. | - System Config path: **Compliance > Custom Terms of Service** | -| | - ``config.json`` setting: ``SupportSettings`` > ``CustomTermsOfServiceReAcceptancePeriod`` | -| Numerical input. Default is 365 days. 0 indicates the terms do not expire. | - Environment variable: ``MM_SUPPORTSETTINGS_CUSTOMTERMSOFSERVICEREACCEPTANCEPERIOD`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| The number of days before Terms of Service acceptance expires, | - System Config path: **Compliance > Custom Terms of Service** | +| and the terms must be re-accepted. | - ``config.json`` setting: ``".SupportSettings.CustomTermsOfServiceReAcceptancePeriod"`` | +| | - Environment variable: ``MM_SUPPORTSETTINGS_CUSTOMTERMSOFSERVICEREACCEPTANCEPERIOD`` | +| Numerical input. Default is 365 days. 0 indicates the terms | | +| do not expire. | | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------+ From e9c5a8ff9da8f642654976b669d193e11b138507 Mon Sep 17 00:00:00 2001 From: "claude[bot]" <209825114+claude[bot]@users.noreply.github.com> Date: Thu, 10 Jul 2025 18:48:11 +0000 Subject: [PATCH 3/4] Add default values and constraints to compliance configuration settings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Enhanced all configuration settings in the compliance section with: - Default values for each setting - Constraints and validation rules where applicable - Possible values/options for enum-type settings - Format specifications for structured inputs This improves documentation clarity and helps users understand expected values and formats. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Claude Co-authored-by: Carrie Warner (Mattermost) --- .../compliance-configuration-settings.rst | 60 ++++++++++++++++--- 1 file changed, 53 insertions(+), 7 deletions(-) diff --git a/source/configure/compliance-configuration-settings.rst b/source/configure/compliance-configuration-settings.rst index 436477ce7e7..c2f6da8dac7 100644 --- a/source/configure/compliance-configuration-settings.rst +++ b/source/configure/compliance-configuration-settings.rst @@ -54,6 +54,9 @@ Global retention policy for messages | messages are kept in Mattermost. Messages older than the | | | duration you set will be deleted nightly. The minimum message | | | retention time is one hour. | | +| | | +| **Default**: ``0`` (messages kept forever) | | +| **Constraints**: Must be ≥ 0 | | +----------------------------------------------------------------+--------------------------------------------------------------------------------+ .. note:: @@ -79,6 +82,9 @@ Global retention policy for files | files are kept in Mattermost. Files older than the duration | | | you set will be deleted nightly. The minimum file retention | | | time is 1 hour. | | +| | | +| **Default**: ``0`` (files kept forever) | | +| **Constraints**: Must be ≥ 0 | | +---------------------------------------------------------------+-----------------------------------------------------------------------------+ .. note:: @@ -119,6 +125,9 @@ Data deletion time | be a 24-hour time stamp in the form ``HH:MM``. | - Environment variable: ``MM_DATARETENTIONSETTINGS_DELETIONJOBSTARTTIME`` | | | | | This setting is based on the local time of the server. | | +| | | +| **Default**: ``"02:00"`` | | +| **Format**: ``"HH:MM"`` (24-hour time) | | +---------------------------------------------------------------+------------------------------------------------------------------------------+ Run deletion job now @@ -161,6 +170,8 @@ Enable compliance export | | | | - **False**: **(Default)** Mattermost doesn't generate a | | | compliance export file. | | +| | | +| **Default**: ``false`` | | +-----------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: compliance-export-time @@ -179,6 +190,9 @@ Compliance export time | Must be a 24-hour time stamp in the form ``HH:MM``. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_DAILYRUNTIME`` | | | | | This setting is based on the local time of the server. | | +| | | +| **Default**: ``"01:00"`` | | +| **Format**: ``"HH:MM"`` (24-hour time) | | +---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: export-file-format @@ -200,6 +214,10 @@ Export file format | | | | If Global Relay is chosen, the following options will be | | | presented: | | +| | | +| **Default**: ``"actiance"`` | | +| **Options**: ``"actiance"``, ``"globalrelay"``, | | +| ``"globalrelay-zip"``, ``"csv"`` | | +---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: global-relay-customer-account @@ -216,6 +234,8 @@ Global Relay customer account | Type of Global Relay customer account your organization has. | - System Config path: **Compliance > Compliance Export** | | Can be one of: ``A9/Type 9``, ``A10/Type 10``, or ``Custom``. | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.CustomerType"`` | | | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMERTYPE`` | +| **Default**: ``"A9"`` | | +| **Options**: ``"A9"``, ``"A10"``, ``"CUSTOM"`` | | +---------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. config:setting:: global-relay-smtp-username @@ -233,6 +253,8 @@ Global Relay SMTP username | server. | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.SmtpUsername"`` | | | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPUSERNAME`` | | String input. | | +| | | +| **Default**: ``""`` (empty string) | | +---------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. config:setting:: global-relay-smtp-password @@ -249,6 +271,8 @@ Global Relay SMTP password | The password associated with the Global Relay SMTP username. | - System Config path: **Compliance > Compliance Export** | | | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.SMTPPassword"`` | | String input. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPPASSWORD`` | +| | | +| **Default**: ``""`` (empty string) | | +---------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. config:setting:: global-relay-email-address @@ -266,6 +290,9 @@ Global Relay email address | incoming compliance exports. | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.EmailAddress"`` | | | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_EMAILADDRESS`` | | String input. | | +| | | +| **Default**: ``""`` (empty string) | | +| **Constraints**: Must contain "@" | | +---------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. config:setting:: smtp-server-name @@ -285,6 +312,9 @@ SMTP server name | is configured. | | | | | | String input. | | +| | | +| **Default**: ``""`` (empty string) | | +| **Required**: When CustomerType is "CUSTOM" | | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ .. config:setting:: smtp-server-port @@ -303,7 +333,10 @@ SMTP server port | `custom customer account type <#global-relay-customer-account>`__ | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMSMPTPORT`` | | is configured. | | | | | -| Numerical input. Default is 25. | | +| Numerical input. | | +| | | +| **Default**: ``"25"`` | | +| **Required**: When CustomerType is "CUSTOM" | | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ .. config:setting:: message-export-batch-size @@ -323,9 +356,11 @@ This setting isn't available in the System Console and can only be set in ``conf +---------------------------------------------------------------+--------------------------------------------------------------------------+ | Determines how many new posts are batched together to a | - System Config path: N/A | -| compliance export file. | - ``config.json`` setting: ``".MessageExportSettings.BatchSize": 10000`` | +| compliance export file. | - ``config.json`` setting: ``".MessageExportSettings.BatchSize"`` | | | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_BATCHSIZE`` | -| Numerical input. Default is **10000** posts. | | +| Numerical input. | | +| | | +| **Default**: ``10000`` posts | | +---------------------------------------------------------------+--------------------------------------------------------------------------+ Run compliance export job now @@ -365,6 +400,8 @@ Enable compliance reporting | **True**: Compliance reporting is enabled in Mattermost. | - System Config path: **Compliance > Compliance Monitoring** | | | - ``config.json`` setting: ``".ComplianceSettings.Enable"`` | | **False**: **(Default)** Compliance reporting is disabled. | - Environment variable: ``MM_COMPLIANCESETTINGS_ENABLE`` | +| | | +| **Default**: ``false`` | | +---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: compliance-report-directory @@ -380,7 +417,9 @@ Compliance report directory +---------------------------------------------------------------+--------------------------------------------------------------------------+ | Sets the directory where compliance reports are written. | - System Config path: **Compliance > Compliance Monitoring** | | | - ``config.json`` setting: ``".ComplianceSettings.Directory"`` | -| String input. Default is ``./data/``. | - Environment variable: ``MM_COMPLIANCESETTINGS_DIRECTORY`` | +| String input. | - Environment variable: ``MM_COMPLIANCESETTINGS_DIRECTORY`` | +| | | +| **Default**: ``"./data/"`` | | +---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: enable-compliance-reportingdaily @@ -399,6 +438,8 @@ Enable daily report | **True**: Mattermost generates a daily compliance report. | - System Config path: **Compliance > Compliance Monitoring** | | | - ``config.json`` setting: ``".ComplianceSettings.EnableDaily"`` | | **False**: **(Default)** Daily reports are not generated. | - Environment variable: ``MM_COMPLIANCESETTINGS_ENABLEDAILY`` | +| | | +| **Default**: ``false`` | | +---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: batch-size @@ -417,7 +458,9 @@ Batch size | is currently not available in the System Console and can only | - Environment variable: ``MM_COMPLIANCESETTINGS_BATCHSIZE`` | | be set in ``config.json``. | | | | | -| Numerical input. Default is **30000**. | | +| Numerical input. | | +| | | +| **Default**: ``30000`` | | +---------------------------------------------------------------+--------------------------------------------------------------------------+ ---- @@ -453,6 +496,8 @@ Enable custom terms of service | **False**: During account creation or login, users can review | | | Terms of Service by accessing the link configured via | | | **System Console > Legal and Support > Terms of Service link**. | | +| | | +| **Default**: ``false`` | | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+ .. note:: @@ -489,6 +534,7 @@ Re-acceptance period | The number of days before Terms of Service acceptance expires, | - System Config path: **Compliance > Custom Terms of Service** | | and the terms must be re-accepted. | - ``config.json`` setting: ``".SupportSettings.CustomTermsOfServiceReAcceptancePeriod"`` | | | - Environment variable: ``MM_SUPPORTSETTINGS_CUSTOMTERMSOFSERVICEREACCEPTANCEPERIOD`` | -| Numerical input. Default is 365 days. 0 indicates the terms | | -| do not expire. | | +| Numerical input. 0 indicates the terms do not expire. | | +| | | +| **Default**: ``365`` days | | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------+ From 77fe4f1ad6b46659197c496a4632ba3cc799874c Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Fri, 11 Jul 2025 11:57:28 -0400 Subject: [PATCH 4/4] Editorial review --- .../compliance-configuration-settings.rst | 407 ++++++++---------- .../deprecated-configuration-settings.rst | 8 +- 2 files changed, 189 insertions(+), 226 deletions(-) diff --git a/source/configure/compliance-configuration-settings.rst b/source/configure/compliance-configuration-settings.rst index c2f6da8dac7..07e349119fd 100644 --- a/source/configure/compliance-configuration-settings.rst +++ b/source/configure/compliance-configuration-settings.rst @@ -30,7 +30,7 @@ Changes to properties in this section require a server restart before taking eff .. warning:: - - Once a message or a file is deleted, the action is irreversible. Please be careful when setting up a custom data retention policy. + - Once a message or a file is deleted, the action is irreversible. Please set up a custom data retention policy with care. - From Mattermost v9.5, data retention removes Elasticsearch indexes based on the day of the retention cut-off time. Access the following configuration settings in the System Console by going to **Compliance > Data Retention Policies**. @@ -40,104 +40,100 @@ Access the following configuration settings in the System Console by going to ** :systemconsole: Compliance > Data Retention Policies :configjson: .DataRetentionSettings.MessageRetentionHours :environment: MM_DATARETENTIONSETTINGS_MESSAGERETENTIONHOURS - :description: Set how long Mattermost keeps messages across all teams and channels. Doesn't apply to custom retention policies. The minimum time is 1 hour. + :description: Set how long Mattermost keeps messages across all teams and channels. Doesn't apply to custom retention policies. Default is **O** and the minimum time is 1 hour. Global retention policy for messages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+----------------------------------------------------------------+--------------------------------------------------------------------------------+ -| Set how long Mattermost keeps messages across all teams and | - System Config path: **Compliance > Data Retention Policies** | -| channels. Doesn't apply to custom retention policies. | - ``config.json`` setting: ``".DataRetentionSettings.MessageRetentionHours"`` | -| | - Environment variable: ``MM_DATARETENTIONSETTINGS_MESSAGERETENTIONHOURS`` | -| By default, messages are kept forever. If **Hours**, **Days**, | | -| or **Years** is chosen, set how many hours, days, or years | | -| messages are kept in Mattermost. Messages older than the | | -| duration you set will be deleted nightly. The minimum message | | -| retention time is one hour. | | -| | | -| **Default**: ``0`` (messages kept forever) | | -| **Constraints**: Must be ≥ 0 | | -+----------------------------------------------------------------+--------------------------------------------------------------------------------+ ++----------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| Set how long Mattermost keeps messages across all teams and | - System Config path: **Compliance > Data Retention Policies** | +| channels. This setting doesn't apply to custom retention | - ``config.json`` setting: ``DataRetentionSettings`` > ``MessageRetentionHours`` > ``0`` | +| policies. | - Environment variable: ``MM_DATARETENTIONSETTINGS_MESSAGERETENTIONHOURS`` | +| | | +| By default, messages are kept forever. If **Hours**, **Days**, | | +| or **Years** is chosen, set how many hours, days, or years | | +| messages are kept in Mattermost. Messages older than the | | +| duration you set will be deleted nightly. | | +| | | +| The default is **0** (messages are kept forever). | | +| The minimum message retention is 1 hour. | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. note:: - From Mattermost v9.5, ``MessageRetentionDays`` has been deprecated in favor of ``MessageRetentionHours``. See :doc:`deprecated configuration settings ` for details. + From Mattermost v9.5, ``MessageRetentionDays`` has been deprecated in favor of ``MessageRetentionHours``. See :ref:`deprecated configuration settings ` for details. .. config:setting:: global-retention-policy-for-files :displayname: Global retention policy for files (Data Retention) :systemconsole: Compliance > Data Retention Policies :configjson: .DataRetentionSettings.FileRetentionHours :environment: MM_DATARETENTIONSETTINGS_FILERETENTIONHOURS - :description: Set how long Mattermost keeps files across all teams and channels. Doesn't apply to custom retention policies. The minimum time is 1 hour. + :description: Set how long Mattermost keeps files across all teams and channels. Doesn't apply to custom retention policies. Default is **0** and the minimum time is 1 hour. Global retention policy for files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+-----------------------------------------------------------------------------+ -| Set how long Mattermost keeps files across all teams and | - System Config path: **Compliance > Data Retention Policies** | -| channels. Doesn't apply to custom retention policies. | - ``config.json`` setting: ``".DataRetentionSettings.FileRetentionHours"`` | -| | - Environment variable: ``MM_DATARETENTIONSETTINGS_FILERETENTIONHOURS`` | -| By default, files are kept forever. If **Hours**, **Days**, | | -| or **Years** is chosen, set how many hours, days, or years | | -| files are kept in Mattermost. Files older than the duration | | -| you set will be deleted nightly. The minimum file retention | | -| time is 1 hour. | | -| | | -| **Default**: ``0`` (files kept forever) | | -| **Constraints**: Must be ≥ 0 | | -+---------------------------------------------------------------+-----------------------------------------------------------------------------+ ++---------------------------------------------------------------+---------------------------------------------------------------------------------------+ +| Set how long Mattermost keeps files across all teams and | - System Config path: **Compliance > Data Retention Policies** | +| channels. This setting doesn't apply to custom retention | - ``config.json`` setting: ``DataRetentionSettings`` > ``FileRetentionHours`` > ``0`` | +| policies. | - Environment variable: ``MM_DATARETENTIONSETTINGS_FILERETENTIONHOURS`` | +| | | +| By default, files are kept forever. If **Hours**, **Days**, | | +| or **Years** is chosen, set how many hours, days, or years | | +| files are kept in Mattermost. Files older than the duration | | +| you set will be deleted nightly. | | +| | | +| The default is **0** (files kept forever). | | +| The minimum file retention time is 1 hour. | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------+ .. note:: - From Mattermost v9.5, ``FileRetentionDays`` has been deprecated in favor of ``FileRetentionHours``. See :doc:`deprecated configuration settings ` for details. + From Mattermost v9.5, ``FileRetentionDays`` has been deprecated in favor of ``FileRetentionHours``. See :ref:`deprecated configuration settings ` for details. .. config:setting:: custom-retention-policy :displayname: Custom retention policy (Data Retention) :systemconsole: Compliance > Data Retention Policies - :configjson: .DataRetentionSettings.DeletionJobStartTime - :environment: MM_DATARETENTIONSETTINGS_DELETIONJOBSTARTTIME - :description: Set the start time of the daily scheduled data retention job. Must be a 24-hour time stamp in the form ``HH:MM``. This setting is based on the local time of the server. + :configjson: N/A + :environment: N/A + :description: Define a custom retention policy to override the global retention policy for messages and files. Custom policies can be set for specific teams, channels, or users. Custom retention policy ~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| Set how long Mattermost keeps messages and files across | - System Config path: **Compliance > Data Retention Policies** | -| specific teams and channels by specifying a name for the | - ``config.json`` setting: N/A | -| custom retention policy, setting a duration value in days | - Environment variable: N/A | -| or years, and specifying the teams and channels that will | | -| follow this policy. | | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ +Select **Add Policy** to define a custom retention policy. See the :doc:`custom data retention policy ` documentation for details. .. config:setting:: data-deletion-time :displayname: Data deletion time (Data Retention) :systemconsole: Compliance > Data Retention Policies :configjson: .DataRetentionSettings.DeletionJobStartTime :environment: MM_DATARETENTIONSETTINGS_DELETIONJOBSTARTTIME - :description: Set the start time of the daily scheduled data retention job. Must be a 24-hour time stamp in the form ``HH:MM``. This setting is based on the local time of the server. + :description: Set the start time of the daily scheduled data retention job. Must be a 24-hour time stamp in the form ``HH:MM``. Default is **02:00** and this setting is based on the local time of the server. Data deletion time ~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+------------------------------------------------------------------------------+ -| Set the start time of the daily scheduled data retention job. | - System Config path: **Compliance > Data Retention Policies** | -| Choose a time when fewer people are using your system. Must | - ``config.json`` setting: ``".DataRetentionSettings.DeletionJobStartTime"`` | -| be a 24-hour time stamp in the form ``HH:MM``. | - Environment variable: ``MM_DATARETENTIONSETTINGS_DELETIONJOBSTARTTIME`` | -| | | -| This setting is based on the local time of the server. | | -| | | -| **Default**: ``"02:00"`` | | -| **Format**: ``"HH:MM"`` (24-hour time) | | -+---------------------------------------------------------------+------------------------------------------------------------------------------+ ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ +| Set the start time of the daily scheduled data retention job. | - System Config path: **Compliance > Data Retention Policies** | +| Choose a time when fewer people are using your system. Must | - ``config.json`` setting: ``DataRetentionSettings`` > ``DeletionJobStartTime`` > ``"02:00"`` | +| be a 24-hour time stamp in the form ``HH:MM``. | - Environment variable: ``MM_DATARETENTIONSETTINGS_DELETIONJOBSTARTTIME`` | +| | | +| This setting is based on the local time of the server. | | +| | | +| Default is **02:00**. | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + +.. config:setting:: run-deletion-job-now + :displayname: Run deletion job now (Data Retention) + :systemconsole: Compliance > Data Retention Policies + :configjson: N/A + :environment: N/A + :description: Start a data retention deletion job immediately. Monitor the status of the job in the data deletion job table within the Policy Log section. Run deletion job now ~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| Start a Data Retention deletion job immediately. You can | - System Config path: **Compliance > Data Retention Policies** | -| monitor the status of the job in the data deletion job table | - ``config.json`` setting: N/A | -| within the Policy Log section. | - Environment variable: N/A | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ +Select **Run Deletion Job Now** to start a Data Retention deletion job immediately. Monitor the status of the job in the data deletion job table within the Policy Log section. ---- @@ -161,39 +157,36 @@ Access the following configuration settings in the System Console by going to ** Enable compliance export ~~~~~~~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------+--------------------------------------------------------------------------+ -| - **True**: Mattermost will generate a compliance export file | - System Config path: **Compliance > Compliance Export** | -| that contains all messages that were posted in the last 24 | - ``config.json`` setting: ``".MessageExportSettings.EnableExport"`` | -| hours. The export task is scheduled to run once per day. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_ENABLEEXPORT`` | -| See the :doc:`compliance export documentation | | -| to learn more `. | | -| | | -| - **False**: **(Default)** Mattermost doesn't generate a | | -| compliance export file. | | -| | | -| **Default**: ``false`` | | -+-----------------------------------------------------------------+--------------------------------------------------------------------------+ ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| - **True**: Mattermost will generate a compliance export file | - System Config path: **Compliance > Compliance Export** | +| that contains all messages that were posted in the last 24 | - ``config.json`` setting: ``MessageExportSettings`` > ``EnableExport`` > ``false`` | +| hours. The export task is scheduled to run once per day. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_ENABLEEXPORT`` | +| See the :doc:`compliance export documentation | | +| ` to learn more. | | +| | | +| - **False**: **(Default)** Mattermost doesn't generate a | | +| compliance export file. | | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------+ .. config:setting:: compliance-export-time :displayname: Compliance export time (Compliance Export) :systemconsole: Compliance > Compliance Export :configjson: .MessageExportSettings.DailyRunTime :environment: MM_MESSAGEEXPORTSETTINGS_DAILYRUNTIME - :description: Set the start time of the daily scheduled compliance export job. Must be a 24-hour time stamp in the form ``HH:MM``. This setting is based on the local time of the server. + :description: Set the start time of the daily scheduled compliance export job. Must be a 24-hour time stamp in the form ``HH:MM``. Default is **01:00** and this setting is based on the local time of the server. Compliance export time ~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| Set the start time of the daily scheduled compliance export | - System Config path: **Compliance > Compliance Export** | -| job. Choose a time when fewer people are using your system. | - ``config.json`` setting: ``".MessageExportSettings.DailyRunTime"`` | -| Must be a 24-hour time stamp in the form ``HH:MM``. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_DAILYRUNTIME`` | -| | | -| This setting is based on the local time of the server. | | -| | | -| **Default**: ``"01:00"`` | | -| **Format**: ``"HH:MM"`` (24-hour time) | | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ ++---------------------------------------------------------------+---------------------------------------------------------------------------------------+ +| Set the start time of the daily scheduled compliance export | - System Config path: **Compliance > Compliance Export** | +| job. Choose a time when fewer people are using your system. | - ``config.json`` setting: ``MessageExportSettings`` > ``DailyRunTime`` > ``"01:00"`` | +| Must be a 24-hour time stamp in the form ``HH:MM``. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_DAILYRUNTIME`` | +| | | +| This setting is based on the local time of the server. | | +| | | +| Default is **01:00**. | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------+ .. config:setting:: export-file-format :displayname: Export file format (Compliance Export) @@ -205,20 +198,13 @@ Compliance export time Export file format ~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| File format of the compliance export. Corresponds to the | - System Config path: **Compliance > Compliance Export** | -| system that you want to import the data into. | - ``config.json`` setting: ``".MessageExportSettings.ExportFormat"`` | -| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_EXPORTFORMAT`` | -| Currently supported formats are CSV, Actiance XML, and | | -| Global Relay EML. | | -| | | -| If Global Relay is chosen, the following options will be | | -| presented: | | -| | | -| **Default**: ``"actiance"`` | | -| **Options**: ``"actiance"``, ``"globalrelay"``, | | -| ``"globalrelay-zip"``, ``"csv"`` | | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| File format of the compliance export. Corresponds to the | - System Config path: **Compliance > Compliance Export** | +| system that you want to import the data into. | - ``config.json`` setting: ``MessageExportSettings`` > ``ExportFormat`` > ``"csv"`` | +| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_EXPORTFORMAT`` | +| Currently supported formats are **CSV**, **Actiance XML**, | | +| and **Global Relay EML**. | | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ .. config:setting:: global-relay-customer-account :displayname: Global Relay customer account (Compliance Export - Global Relay EML) @@ -230,13 +216,12 @@ Export file format Global Relay customer account ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| Type of Global Relay customer account your organization has. | - System Config path: **Compliance > Compliance Export** | -| Can be one of: ``A9/Type 9``, ``A10/Type 10``, or ``Custom``. | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.CustomerType"`` | -| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMERTYPE`` | -| **Default**: ``"A9"`` | | -| **Options**: ``"A9"``, ``"A10"``, ``"CUSTOM"`` | | -+---------------------------------------------------------------+------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| Type of Global Relay customer account your organization has. | - System Config path: **Compliance > Compliance Export** | +| Can be one of: **A9/Type 9**, **A10/Type 10**, or **Custom**. | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``CustomerType`` > ``"A9"`` | +| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMERTYPE`` | +| Default is **A9**. | | ++---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ .. config:setting:: global-relay-smtp-username :displayname: Global Relay SMTP username (Compliance Export - Global Relay EML) @@ -248,14 +233,12 @@ Global Relay customer account Global Relay SMTP username ~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| The username for authenticating to the Global Relay SMTP | - System Config path: **Compliance > Compliance Export** | -| server. | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.SmtpUsername"`` | -| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPUSERNAME`` | -| String input. | | -| | | -| **Default**: ``""`` (empty string) | | -+---------------------------------------------------------------+------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| The username for authenticating to the Global Relay SMTP | - System Config path: **Compliance > Compliance Export** | +| server. | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``SmtpUsername`` > ``""`` | +| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPUSERNAME`` | +| String input. Default is an empty string. | | ++---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. config:setting:: global-relay-smtp-password :displayname: Global Relay SMTP password (Compliance Export - Global Relay EML) @@ -267,13 +250,11 @@ Global Relay SMTP username Global Relay SMTP password ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| The password associated with the Global Relay SMTP username. | - System Config path: **Compliance > Compliance Export** | -| | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.SMTPPassword"`` | -| String input. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPPASSWORD`` | -| | | -| **Default**: ``""`` (empty string) | | -+---------------------------------------------------------------+------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| The password associated with the Global Relay SMTP username. | - System Config path: **Compliance > Compliance Export** | +| | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``SMTPPassword`` > ``""`` | +| String input. Default is an empty string. | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPPASSWORD`` | ++---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. config:setting:: global-relay-email-address :displayname: Global Relay email address (Compliance Export - Global Relay EML) @@ -285,15 +266,12 @@ Global Relay SMTP password Global Relay email address ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| The email address your Global Relay server monitors for | - System Config path: **Compliance > Compliance Export** | -| incoming compliance exports. | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.EmailAddress"`` | -| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_EMAILADDRESS`` | -| String input. | | -| | | -| **Default**: ``""`` (empty string) | | -| **Constraints**: Must contain "@" | | -+---------------------------------------------------------------+------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| The email address your Global Relay server monitors for | - System Config path: **Compliance > Compliance Export** | +| incoming compliance exports. | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``EmailAddress`` > ``""`` | +| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_EMAILADDRESS`` | +| String input. Default is an empty string. | | ++---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. config:setting:: smtp-server-name :displayname: SMTP server name (Compliance Export - Global Relay EML) @@ -305,17 +283,14 @@ Global Relay email address SMTP server name ~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| The SMTP server name URL that will receive your Global Relay | - System Config path: **Compliance > Compliance Export** | -| EML file when a | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.CustomSMTPServerName"`` | -| `custom customer account type <#global-relay-customer-account>`__ | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMSMTPSERVERNAME`` | -| is configured. | | -| | | -| String input. | | -| | | -| **Default**: ``""`` (empty string) | | -| **Required**: When CustomerType is "CUSTOM" | | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| The SMTP server name URL that will receive your Global Relay | - System Config path: **Compliance > Compliance Export** | +| EML file when a | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``CustomSMTPServerName`` > ``""`` | +| `custom account type <#global-relay-customer-account>`__ | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMSMTPSERVERNAME`` | +| is configured. | | +| | | +| String input. Default is an empty string. | | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ .. config:setting:: smtp-server-port :displayname: SMTP server port (Compliance Export - Global Relay EML) @@ -327,24 +302,21 @@ SMTP server name SMTP server port ~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ -| The SMTP server port that will receive your Global Relay EML | - System Config path: **Compliance > Compliance Export** | -| file when a | - ``config.json`` setting: ``".MessageExportSettings.GlobalRelaySettings.CustomSMTPPort"`` | -| `custom customer account type <#global-relay-customer-account>`__ | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMSMPTPORT`` | -| is configured. | | -| | | -| Numerical input. | | -| | | -| **Default**: ``"25"`` | | -| **Required**: When CustomerType is "CUSTOM" | | -+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| The SMTP server port that will receive your Global Relay EML | - System Config path: **Compliance > Compliance Export** | +| file when a | - ``config.json`` setting: ``MessageExportSettings`` > ``GlobalRelaySettings`` > ``CustomSMTPPort`` > ``25`` | +| `custom account type <#global-relay-customer-account>`__ | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_CUSTOMSMPTPORT`` | +| is configured. | | +| | | +| Numerical input. Default is **25**. | | ++---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ .. config:setting:: message-export-batch-size :displayname: Message export batch size (Compliance Export) :systemconsole: N/A :configjson: .MessageExportSettings.BatchSize :environment: MM_MESSAGEEXPORTSETTINGS_BATCHSIZE - :description: Determines how many new posts are batched together to a compliance export file. Default is **10000** posts. + :description: Determines how many new messages are batched together to a compliance export file. Default is **10000** messages. Message export batch size ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -352,25 +324,27 @@ Message export batch size .. 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``. ++---------------------------------------------------------------+----------------------------------------------------------------------------------+ +| Determines how many new messages are batched together to a | - System Config path: N/A | +| compliance export file. | - ``config.json`` setting: ``MessageExportSettings`` > ``BatchSize`` > ``10000`` | +| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_BATCHSIZE`` | +| Numerical input. Default is **10000** messages. | | ++---------------------------------------------------------------+----------------------------------------------------------------------------------+ -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| Determines how many new posts are batched together to a | - System Config path: N/A | -| compliance export file. | - ``config.json`` setting: ``".MessageExportSettings.BatchSize"`` | -| | - Environment variable: ``MM_MESSAGEEXPORTSETTINGS_BATCHSIZE`` | -| Numerical input. | | -| | | -| **Default**: ``10000`` posts | | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ +.. note:: + This setting isn't available in the System Console and can only be set in ``config.json``. + +.. config:setting:: run-compliance-export-job-now + :displayname: Run compliance export job now (Compliance Export) + :systemconsole: Compliance > Compliance Export + :configjson: N/A + :environment: N/A + :description: Start a compliance export job immediately. Monitor the status of the job in the compliance export job table. Run compliance export job now ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| This button initiates a compliance export job immediately. | - System Config path: **Compliance > Compliance Export** | -| You can monitor the status of the job in the compliance | - ``config.json`` setting: N/A | -| export job table. | - Environment variable: N/A | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ +Select **Run Compliance Export Job Now** to start a compliance export job immediately. Monitor the status of the job in the compliance export job table. ---- @@ -380,9 +354,7 @@ Compliance monitoring .. include:: ../_static/badges/ent-cloud-selfhosted.rst :start-after: :nosearch: -Settings used to enable and configure Mattermost compliance reports. - -Access the following configuration settings in the System Console by going to **Compliance > Compliance Monitoring**. +Settings to enable and configure Mattermost compliance reports. Access the following configuration settings in the System Console by going to **Compliance > Compliance Monitoring**. .. config:setting:: enable-compliance-reporting :displayname: Enable compliance reporting (Compliance Monitoring) @@ -396,13 +368,11 @@ Access the following configuration settings in the System Console by going to ** Enable compliance reporting ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| **True**: Compliance reporting is enabled in Mattermost. | - System Config path: **Compliance > Compliance Monitoring** | -| | - ``config.json`` setting: ``".ComplianceSettings.Enable"`` | -| **False**: **(Default)** Compliance reporting is disabled. | - Environment variable: ``MM_COMPLIANCESETTINGS_ENABLE`` | -| | | -| **Default**: ``false`` | | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ ++-----------------------------------------------------------------+----------------------------------------------------------------------------+ +| - **True**: Compliance reporting is enabled in Mattermost. | - System Config path: **Compliance > Compliance Monitoring** | +| | - ``config.json`` setting: ``ComplianceSettings`` > ``Enable`` > ``false`` | +| - **False**: **(Default)** Compliance reporting is disabled. | - Environment variable: ``MM_COMPLIANCESETTINGS_ENABLE`` | ++-----------------------------------------------------------------+----------------------------------------------------------------------------+ .. config:setting:: compliance-report-directory :displayname: Compliance report directory (Compliance Monitoring) @@ -414,13 +384,11 @@ Enable compliance reporting Compliance report directory ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| Sets the directory where compliance reports are written. | - System Config path: **Compliance > Compliance Monitoring** | -| | - ``config.json`` setting: ``".ComplianceSettings.Directory"`` | -| String input. | - Environment variable: ``MM_COMPLIANCESETTINGS_DIRECTORY`` | -| | | -| **Default**: ``"./data/"`` | | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| Sets the directory where compliance reports are written. | - System Config path: **Compliance > Compliance Monitoring** | +| | - ``config.json`` setting: ``ComplianceSettings`` > ``Directory`` > ``"./data/"`` | +| String input. Default is **./data/** | - Environment variable: ``MM_COMPLIANCESETTINGS_DIRECTORY`` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ .. config:setting:: enable-compliance-reportingdaily :displayname: Enable daily report (Compliance Monitoring) @@ -429,39 +397,37 @@ Compliance report directory :environment: MM_COMPLIANCESETTINGS_ENABLEDAILY - **true**: Mattermost generates a daily compliance report. - - **false**: **(Default)** Daily reports are not generated. + - **false**: **(Default)** Daily reports aren't generated. Enable daily report ~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| **True**: Mattermost generates a daily compliance report. | - System Config path: **Compliance > Compliance Monitoring** | -| | - ``config.json`` setting: ``".ComplianceSettings.EnableDaily"`` | -| **False**: **(Default)** Daily reports are not generated. | - Environment variable: ``MM_COMPLIANCESETTINGS_ENABLEDAILY`` | -| | | -| **Default**: ``false`` | | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ ++-----------------------------------------------------------------+---------------------------------------------------------------------------------+ +| - **True**: Mattermost generates a daily compliance report. | - System Config path: **Compliance > Compliance Monitoring** | +| | - ``config.json`` setting: ``ComplianceSettings`` > ``EnableDaily`` > ``false`` | +| - **False**: **(Default)** Daily reports aren't generated. | - Environment variable: ``MM_COMPLIANCESETTINGS_ENABLEDAILY`` | ++-----------------------------------------------------------------+---------------------------------------------------------------------------------+ .. config:setting:: batch-size :displayname: Batch size (Compliance Monitoring) :systemconsole: Compliance > Compliance Monitoring :configjson: .ComplianceSettings.BatchSize :environment: MM_COMPLIANCESETTINGS_BATCHSIZE - :description: Set the size of the batches in which posts will be read from the database to generate the compliance report. The default value is **30000**. + :description: Set the size of the batches in which messages will be read from the database to generate the compliance report. The default value is **30000**. Batch size ~~~~~~~~~~ -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| Set the size of the batches in which posts will be read from | - System Config path: **Compliance > Compliance Monitoring** | -| the database to generate the compliance report. This setting | - ``config.json`` setting: ``".ComplianceSettings.BatchSize"`` | -| is currently not available in the System Console and can only | - Environment variable: ``MM_COMPLIANCESETTINGS_BATCHSIZE`` | -| be set in ``config.json``. | | -| | | -| Numerical input. | | -| | | -| **Default**: ``30000`` | | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ ++---------------------------------------------------------------+-------------------------------------------------------------------------------+ +| Set the size of the batches in which messages will be read | - System Config path: **Compliance > Compliance Monitoring** | +| from the database to generate the compliance report. | - ``config.json`` setting: ``ComplianceSettings`` > ``BatchSize`` > ``30000`` | +| | - Environment variable: ``MM_COMPLIANCESETTINGS_BATCHSIZE`` | +| Numerical input. Default is **30000** messages. | | ++---------------------------------------------------------------+-------------------------------------------------------------------------------+ + +.. note:: + + This setting isn't available in the System Console and can only be set in ``config.json``. ---- @@ -480,28 +446,26 @@ Access the following configuration settings in the System Console by going to ** :environment: MM_SUPPORTSETTINGS_CUSTOMTERMSOFSERVICEENABLED - **True**: New users must accept the Terms of Service before accessing any Mattermost teams on desktop, web, or mobile. Existing users must accept them after login or a page refresh. - - **False**: During account creation or login, users can review Terms of Service by accessing the link configured via **System Console > Legal and Support > Terms of Service link**. + - **False**: **(Default)** During account creation or login, users can review Terms of Service by accessing the link configured via **System Console > Legal and Support > Terms of Service link**. Enable custom terms of service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------+-------------------------------------------------------------------------------+ -| **True**: New users must accept the Terms of Service before | - System Config path: **Compliance > Custom Terms of Service** | -| accessing any Mattermost teams on desktop, web, or mobile. | - ``config.json`` setting: ``".SupportSettings.CustomTermsOfServiceEnabled"`` | -| Existing users must accept them after login or a page refresh. | - Environment variable: ``MM_SUPPORTSETTINGS_CUSTOMTERMSOFSERVICEENABLED`` | -| To update the Terms of Service link displayed in account | | -| creation and login pages, go to **System Console > Legal and | | -| Support > Terms of Service Link**. | | -| | | -| **False**: During account creation or login, users can review | | -| Terms of Service by accessing the link configured via | | -| **System Console > Legal and Support > Terms of Service link**. | | -| | | -| **Default**: ``false`` | | -+-----------------------------------------------------------------+-------------------------------------------------------------------------------+ ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| - **True**: New users must accept the Terms of Service before | - System Config path: **Compliance > Custom Terms of Service** | +| accessing any Mattermost teams on desktop, web, or mobile. | - ``config.json`` setting: ``SupportSettings`` > ``CustomTermsOfServiceEnabled`` > ``false`` | +| | - Environment variable: ``MM_SUPPORTSETTINGS_CUSTOMTERMSOFSERVICEENABLED`` | +| - **False**: **(Default)** During account creation or login, | | +| users can review Terms of Service by accessing the link | | +| configured via **System Console > Legal and Support > | | +| Terms of Service link**. | | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ .. note:: - This configuration setting can only be modified using the System Console user interface. + + - This configuration setting can only be managed using the System Console user interface. It can't be set in ``config.json`` or through environment variables. + - When custom terms of service are enabled, users must accept the terms before they can access Mattermost teams after login or page refresh. + - To update the Terms of Service link displayed in account creation and login pages, go to **System Console > Legal and Support > Terms of Service Link**. .. config:setting:: custom-terms-of-service-text :displayname: Custom terms of service text (Custom Terms of Service) @@ -530,11 +494,10 @@ Custom terms of service text Re-acceptance period ~~~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| The number of days before Terms of Service acceptance expires, | - System Config path: **Compliance > Custom Terms of Service** | -| and the terms must be re-accepted. | - ``config.json`` setting: ``".SupportSettings.CustomTermsOfServiceReAcceptancePeriod"`` | -| | - Environment variable: ``MM_SUPPORTSETTINGS_CUSTOMTERMSOFSERVICEREACCEPTANCEPERIOD`` | -| Numerical input. 0 indicates the terms do not expire. | | -| | | -| **Default**: ``365`` days | | -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| The number of days before Terms of Service acceptance expires, | - System Config path: **Compliance > Custom Terms of Service** | +| and the terms must be re-accepted. | - ``config.json`` setting: ``SupportSettings`` > ``CustomTermsOfServiceReAcceptancePeriod`` > ``365`` | +| | - Environment variable: ``MM_SUPPORTSETTINGS_CUSTOMTERMSOFSERVICEREACCEPTANCEPERIOD`` | +| Numerical input. Default is **365** days, and **0** indicates | | +| that the terms don't expire. | | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ diff --git a/source/configure/deprecated-configuration-settings.rst b/source/configure/deprecated-configuration-settings.rst index 46370207f4e..b479d13ded7 100644 --- a/source/configure/deprecated-configuration-settings.rst +++ b/source/configure/deprecated-configuration-settings.rst @@ -180,8 +180,8 @@ Amazon S3 lowercase bucket Data retention settings ----------------------- -MessageRetentionDays -~~~~~~~~~~~~~~~~~~~~ +Message Retention (Days) +~~~~~~~~~~~~~~~~~~~~~~~~ *Deprecated in Mattermost v9.5 release in favor of MessageRetentionHours* @@ -193,8 +193,8 @@ From Mattermost v9.5, this setting has been replaced by :ref:`MessageRetentionHo | This feature's ``config.json`` setting is ``"MessageRetentionDays": 365`` with numerical input. | +-------------------------------------------------------------------------------------------------------------------------------------+ -FileRetentionDays -~~~~~~~~~~~~~~~~~ +File Retention (Days) +~~~~~~~~~~~~~~~~~~~~~ *Deprecated in Mattermost v9.5 release in favor of FileRetentionHours*