Compliance configuration settings#

plans-img Available on Enterprise plans

deployment-img Cloud and self-hosted deployments

Both self-hosted and Cloud admins can access the following configuration settings in System Console > Compliance. Self-hosted admins can also edit the config.json file as described in the following tables.

Data retention policies#

plans-img Available on Enterprise plans

deployment-img Cloud and self-hosted deployments

Changes to properties in this section require a server restart before taking effect.

Warning

  • Once a message or a file is deleted, the action is irreversible. Please be careful when setting up a custom data retention policy.

  • 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.

Global retention policy for messages#

Also available in legacy Mattermost Enterprise Edition E20

Set how long Mattermost keeps messages across all teams and channels. Doesn’t apply to custom retention policies. Requires the 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.

Note

From Mattermost v9.5, when a MessageRetentionHours value is configured, the MessageRetentionDays value must be 0 in the config.json file. Conversely, when a MessageRetentionDays value is configured, the MessageRetentionHours value must be 0.

Global retention policy for files#

Also available in legacy Mattermost Enterprise Edition E20

Set how long Mattermost keeps files across all teams and channels. Doesn’t apply to custom retention policies. Requires the 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.

Note

From Mattermost v9.5, when a FileRetentionHours value is configured, the FileRetentionDays value must be 0 in the config.json file. Conversely, when a FileRetentionDays value is configured, the FileRetentionHours value must be 0.

Custom retention policy#

Also available in legacy Mattermost Enterprise Edition E20

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.

Data deletion time#

Also available in legacy Mattermost Enterprise Edition E20

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".

Run deletion job now#

Also available in legacy Mattermost Enterprise Edition E20

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.

Compliance export#

plans-img Available on Enterprise plans

deployment-img Cloud and self-hosted deployments

Access the following configuration settings in the System Console by going to Compliance > Compliance Export.

Enable compliance export#

Available as an add-on to legacy Enterprise Edition E20

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 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.

Compliance export time#

Available as an add-on to legacy Enterprise Edition E20

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".

Export file format#

Available as an add-on to legacy Enterprise Edition E20

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:

Global Relay customer account#

Available as an add-on to legacy Enterprise Edition E20

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.

Global Relay SMTP username#

Available as an add-on to legacy Enterprise Edition E20

The username for authenticating to the Global Relay SMTP server.

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

Global Relay SMTP password#

Available as an add-on to legacy Enterprise Edition E20

The password associated with the Global Relay SMTP username.

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

Global Relay email address#

Available as an add-on to legacy Enterprise Edition E20

The email address your Global Relay server monitors for incoming compliance exports.

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

SMTP server name#

The SMTP server name URL that will receive your Global Relay EML file when a custom customer account type is configured.

This feature’s config.json setting is ".MessageExportSettings.GlobalRelaySettings.CustomSMTPServerName": "" with string input.

SMTP server port#

The SMTP server port that will receive your Global Relay EML file when a custom customer account type is configured. Default is 25.

This feature’s config.json setting is ".MessageExportSettings.GlobalRelaySettings.CustomSMTPPort": 25 with string input.

Run compliance export job now#

Available as an add-on to legacy Enterprise Edition E20

This button initiates a compliance export job immediately. You can monitor the status of the job in the compliance export job table.

Compliance monitoring#

plans-img Available on Enterprise plans

deployment-img Cloud and self-hosted deployments

Settings used to enable and configure Mattermost compliance reports.

Access the following configuration settings in the System Console by going to Compliance > Compliance Monitoring.

Enable compliance reporting#

Available as an add-on to legacy Enterprise Edition E20

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.

Compliance report directory#

Available as an add-on to legacy Enterprise Edition E20

Sets the directory where compliance reports are written.

This feature’s config.json setting is "Directory": "./data/" with string input.

Enable daily report#

Available as an add-on to legacy Enterprise Edition E20

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.

Batch size#

Available as an add-on to legacy Enterprise Edition E20

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.

Custom terms of service#

plans-img Available on Enterprise plans

deployment-img Cloud and self-hosted deployments

Access the following configuration settings in the System Console by going to Compliance > Custom Terms of Service.

Enable custom terms of service#

Available as an add-on to legacy Enterprise Edition E20

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.

Custom terms of service text#

Available as an add-on to legacy Enterprise Edition E20

Text that will appear in your custom Terms of Service. Supports Markdown-formatted text.

Re-acceptance period#

Available as an add-on to legacy Enterprise Edition E20

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.