Compliance configuration settings
Available on Enterprise plans
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
Available on Enterprise plans
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.
Access the following configuration settings in the System Console by going to Compliance > Data Retention Policies.
Global retention policy for messages
Available in legacy 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 Days or Years is chosen, set how many days or years messages are kept in Mattermost. Messages older than the duration you set will be deleted nightly. The minimum time is one day.
This feature’s |
Global retention policy for files
Available in legacy 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 Days or Years is chosen, set how many days or years files are kept in Mattermost. Files older than the duration you set will be deleted nightly. The minimum time is one day.
This feature’s |
Custom retention policy
Available in legacy 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, specifying the teams and channels that will follow this policy.
Data deletion time
Available in legacy 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 |
Compliance export
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 |
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 |
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, either A9/Type 9 or A10/Type 10.
This feature’s |
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 |
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 |
Compliance monitoring
Available on Enterprise plans
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 |
Compliance report directory
Available as an add-on to legacy Enterprise Edition E20
Sets the directory where compliance reports are written.
This feature’s |
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 |
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 |
Custom terms of service
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.
