diff --git a/docs/main/administration-guide/configure/enabling-chinese-japanese-korean-search.mdx b/docs/main/administration-guide/configure/enabling-chinese-japanese-korean-search.mdx index b731c21c4e7..897f3128575 100644 --- a/docs/main/administration-guide/configure/enabling-chinese-japanese-korean-search.mdx +++ b/docs/main/administration-guide/configure/enabling-chinese-japanese-korean-search.mdx @@ -80,7 +80,7 @@ apt install git postgresql-server-dev-13 ``` sql -- 创建 extension -CREATE EXTENSION zhparser +CREATE EXTENSION zhparser; -- 创建 text search configuration CREATE TEXT SEARCH CONFIGURATION simple_zh_cfg (PARSER = zhparser); -- 配置 token mapping diff --git a/docs/main/administration-guide/configure/environment-configuration-settings.mdx b/docs/main/administration-guide/configure/environment-configuration-settings.mdx index f078c45b6e0..eda1ff8fc53 100644 --- a/docs/main/administration-guide/configure/environment-configuration-settings.mdx +++ b/docs/main/administration-guide/configure/environment-configuration-settings.mdx @@ -2776,33 +2776,18 @@ Enable debug logs by changing the [file log level](#file-log-level) to `DEBUG` t -

Whether or not general diagnostics and error reports are sent to Mattermost, Inc.

- +

Controls whether server errors and crashes are reported to Mattermost via Sentry.

+ -See the [telemetry](/administration-guide/manage/telemetry#error-and-diagnostics-reporting-feature) docummentation for details on the information Mattermost collects. +See the [telemetry](/administration-guide/manage/telemetry#error-and-diagnostics-reporting-feature) documentation for details on the information Mattermost collects. -#### Enable verbose diagnostics - - ---- - - - - - - -

Whether or not verbose general diagnostics information is sent.

  • true: Send verbose diagnostics information.
  • false: (Default) Verbose diagnostics information isn't sent.
  • System Config path: N/A
  • config.json setting: LogSettings > VerboseDiagnostics > false
  • Environment variable: MM_LOGSETTINGS_VERBOSEDIAGNOSTICS
- #### Enable Sentry reporting @@ -3023,85 +3008,10 @@ When `FileEnabled` is set to **true**, then the [audit file name](#audit-file-na -The file name must be set to [enable](#output-audit-logs-to-file) audit logging. +When [output audit logs to file](#output-audit-logs-to-file) is enabled, the file name must be set. To configure file rotation and advanced audit log output, use the [AdvancedLoggingJSON](#output-audit-logs-to-multiple-targets) setting. -#### Maximum file size - -
---- - - - - - - -

The maximum size in megabytes for audit log files before they are rotated.

Numerical input. Default is 100 MB.

  • System Config path: Compliance > Audit Logging
  • config.json setting: ExperimentalAuditSettings > FileMaxSizeMB > 100
  • Environment variable: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXSIZEMB
- -#### Maximum file age - - ---- - - - - - - -

The maximum age in days for audit log files before they are deleted.

Numerical input. Default is 0 (no limit).

  • System Config path: Compliance > Audit Logging
  • config.json setting: ExperimentalAuditSettings > FileMaxAgeDays > 0
  • Environment variable: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXAGEDAYS
- -#### Maximum file backups - - ---- - - - - - - -

The maximum number of audit log file backups to retain.

Numerical input. Default is 0 (no limit).

  • System Config path: Compliance > Audit Logging
  • config.json setting: ExperimentalAuditSettings > FileMaxBackups > 0
  • Environment variable: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXBACKUPS
- -#### Compress audit log files - - ---- - - - - - - -

Whether to compress rotated audit log files.

  • true: Rotated audit log files are compressed.
  • false: (Default) Rotated audit log files aren't compressed.
  • System Config path: Compliance > Audit Logging
  • config.json setting: ExperimentalAuditSettings > FileCompress > false
  • Environment variable: MM_EXPERIMENTALAUDITSETTINGS_FILECOMPRESS
- -#### Audit log queue size - - ---- - - - - - - -

The maximum number of audit log entries that can be queued.

Numerical input. Default is 1000.

  • System Config path: Compliance > Audit Logging
  • config.json setting: ExperimentalAuditSettings > FileMaxQueueSize > 1000
  • Environment variable: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXQUEUESIZE
- #### Audit log certificate @@ -3604,6 +3514,76 @@ Changing this configuration setting takes effect when mobile users restart their +### Mobile ephemeral mode + + + +See [mobile security features](/deployment-guide/mobile/mobile-security-features) for a full description of how the timers and operations interact. + +These settings apply globally to all mobile users. Changes are delivered to connected devices in real time; offline devices continue operating under their last-known configuration until they reconnect. Timer state persists across app and device restarts. + +When a timer expires, active cached content such as posts and file previews is purged, and the app notifies the user that data was removed due to policy enforcement. After a purge, users re-sync from the server on reconnection — server URLs are recoverable from keychain entries so server access is not lost. + +#### Enable Mobile Ephemeral Mode + +
++++ + + + + + + +

Controls whether mobile clients enforce the server-configured ephemeral data policies.

  • true: (Default) Ephemeral data policies are enforced.
  • false: Ephemeral data policies are not enforced on mobile clients.
  • System Config path: Environment > Mobile Security
  • config.json setting: NativeAppSettings > MobileEnableEphemeralMode > true
  • Environment variable: MM_NATIVEAPPSETTINGS_MOBILEENABLEEPHEMERALMODE
+ +#### Disconnection timeout + + ++++ + + + + + + +

Grace period in seconds after the WebSocket drops before the device is considered offline. Once elapsed, the Offline Persistence Timer begins counting down.

Numerical input in seconds. Default is 60. Values below 5 are not recommended.

  • System Config path: Environment > Mobile Security
  • config.json setting: NativeAppSettings > MobileDisconnectionTimeoutSeconds > 60
  • Environment variable: MM_NATIVEAPPSETTINGS_MOBILEDISCONNECTIONTIMEOUTSECONDS
+ +#### Offline persistence timer + + ++++ + + + + + + +

How long cached content is retained after the device is considered offline, in hours.

Numerical input in hours. Default is 2. Set to 0 for immediate purge on disconnect.

  • System Config path: Environment > Mobile Security
  • config.json setting: NativeAppSettings > MobileOfflinePersistenceTimerHours > 2
  • Environment variable: MM_NATIVEAPPSETTINGS_MOBILEOFFLINEPERSISTENCETIMERHOURS
+ +#### Auto cache cleanup + + ++++ + + + + + + +

Maximum age in days for content cached on the device, regardless of connection status.

Numerical input in days. Default is 7. Set to 0 for zero-persistence mode.

  • System Config path: Environment > Mobile Security
  • config.json setting: NativeAppSettings > MobileAutoCacheCleanupDays > 7
  • Environment variable: MM_NATIVEAPPSETTINGS_MOBILEAUTOCACHECLEANUPDAYS
+ ### Enable secure file preview on mobile This setting improves an organization's mobile security posture by restricting file access while still allowing essential file viewing capabilities. diff --git a/docs/main/administration-guide/configure/experimental-configuration-settings.mdx b/docs/main/administration-guide/configure/experimental-configuration-settings.mdx index 8a5bcdb78e1..4ce0e9e0e92 100644 --- a/docs/main/administration-guide/configure/experimental-configuration-settings.mdx +++ b/docs/main/administration-guide/configure/experimental-configuration-settings.mdx @@ -6,7 +6,6 @@ title: "Experimental configuration settings" Review and manage the following [experimental](/administration-guide/manage/feature-labels#experimental) configuration options in the System Console by selecting the **Product** Navigate between Channels, collaborative playbooks, and boards using the product menu icon. menu, selecting **System Console**, and then selecting **Experimental \> Features**: - [Experimental System Console configuration settings](#experimental-system-console-configuration-settings) -- [Experimental audit logging configuration settings](#experimental-audit-logging-configuration-settings) - [Experimental job configuration settings](#experimental-job-configuration-settings) - [Experimental configuration settings for self-hosted deployments only](#experimental-configuration-settings-for-self-hosted-deployments-only) @@ -295,6 +294,33 @@ Changes made when hardened mode is enabled: +### Enable Mobile Watermark + +Available on [Enterprise Advanced](https://mattermost.com/pricing/) from Mattermost v11.7 onward. + +**True**: Authenticated Mattermost mobile sessions display a watermark overlay showing the user's username, the server domain, the current date (YYYY-MM-DD), and the current time (HH:mm). This experimental capability is intended to support data loss prevention (DLP) workflows by helping identify the user, server, and time associated with mobile screenshots or shared screen captures. + +**False**: No watermark overlay is displayed in the Mattermost mobile app. + + + +- This is an experimental setting. Behavior, defaults, and visual presentation may change in future releases. +- This setting only applies to the Mattermost mobile app. It does not add a watermark to the Mattermost web app or desktop apps. +- The watermark overlay is a visual aid and does not, by itself, prevent screenshots, screen recordings, file exports, or other forms of data extraction. Use it in combination with other mobile security controls, such as [screenshot and screen recording prevention](/deployment-guide/mobile/mobile-security-features#screenshot-and-screen-recording-prevention), where appropriate. + + + + +++ + + + + + +
This feature's config.json setting is "ExperimentalSettings.EnableWatermark": false with options true and false.
+ ### Enable theme selection **True**: Enables the **Display \> Theme** tab in **Settings** so users can select their theme. @@ -705,151 +731,6 @@ Select **Purge Index** to remove the contents of the Bleve index directory. Sear ------------------------------------------------------------------------------------------------------------------------ -## Experimental audit logging configuration settings - -Enable the following settings to output audit events in the System Console by going to **Compliance \> Audit Logging**, or in the `config.json` file. - - - -The ability to enable and configure audit logging is currently in [Beta](/administration-guide/manage/feature-labels#beta). - - - -### Advanced logging - - - -Output log and audit records to any combination of console, local file, syslog, and TCP socket targets for a Mattermost Cloud deployment. See the [advanced logging](/administration-guide/manage/logging#advanced-logging) documentation for details about logging options. - -### Enable audit logging - - - -When audit logging is enabled in a self-hosted instance, you can specify size, backup interval, compression, maximium age to manage file rotation, and timestamps for audit logging, as defined below. You can specify these settings independently for audit events and AD/LDAP events. - -**True**: Audit logging files are enabled, and audit files are written locally to a file for a self-hosted deployment. - -**False**: Audit logging files aren't enabled, and audit logs aren't written locally to a file for a self-hosted deployment. - - --- - - - - - -
This feature's config.json setting is ".ExperimentalAuditSettings.FileEnabled": false", with options true and false.
- -### File name - - - -Specify the path to the audit file for a self-hosted deployment. - - --- - - - - - -
This feature's config.json setting is ".ExperimentalAuditSettings.FileName": "" with string input consisting of a user-defined path (e.g. /var/log/mattermost_audit.log).
- -### Max file size - - - -This is the maximum size, in megabytes, that the file can grow before triggering rotation for a self-hosted deployment. The default setting is `100`. - - --- - - - - - -
This feature's config.json setting is ".ExperimentalAuditSettings.FileMaxSizeMB": 100 with numerical input.
- -### Max file age - - - -This is the maximum age, in days, a file can reach before triggering rotation for a self-hosted deployment. The default value is `0`, indicating no limit on the age. - - --- - - - - - -
This feature's config.json setting is ".ExperimentalAuditSettings.FileMaxAgeDays": 0 with numerical input.
- -### Maximum file backups - - - -This is the maximum number of rotated files kept for a self-hosted deployment. The oldest is deleted first. The default value is `0`, indicating no limit on the number of backups. - - --- - - - - - -
This feature's config.json setting is ".ExperimentalAuditSettings.FileMaxBackups": 0 with numerical input.
- -### File compression - - - -When `true`, rotated files are compressed using `gzip` in a self-hosted deployment. - - --- - - - - - -
This feature's config.json setting is ".ExperimentalAuditSettings.FileCompress": false with options true and false.
- -### Maximum file queue - - - -This setting determines how many audit records can be queued/buffered at any point in time when writing to a file for a self-hosted deployment. The default is `1000` records. This setting can be left as default unless you are seeing audit write failures in the server log and need to adjust the number accordingly. - - --- - - - - - -
This feature's config.json setting is ".ExperimentalAuditSettings.FileMaxQueueSize": 1000 with numerical input.
- -### Certificate - -Cloud Enterprise customers can upload and manage a certificate for audit logging encryption on Syslog or TCP logging targets. - -Upload the certificate PEM file in the System Console by going to **System Console \> Audit Log Settings \> Certificate** and selecting **File/Remove Certificate**. The certificate file can be stored in the filestore or stored locally on the filesystem. - ## Experimental configuration settings for self-hosted deployments only Access the following self-hosted configuration settings by editing the `config.json` file as described in the following tables. These configuration settings are not accessible through the System Console. diff --git a/docs/main/administration-guide/configure/integrations-configuration-settings.mdx b/docs/main/administration-guide/configure/integrations-configuration-settings.mdx index cbc180ed658..cf548d55e50 100644 --- a/docs/main/administration-guide/configure/integrations-configuration-settings.mdx +++ b/docs/main/administration-guide/configure/integrations-configuration-settings.mdx @@ -186,7 +186,7 @@ Cloud admins can't modify this configuration setting. ### Integration request timeout -The number of seconds to wait for external integration HTTP requests, before timing out, including [custom slash commands](https://developers.mattermost.com/integrate/slash-commands/custom/), [outgoing webhooks](https://developers.mattermost.com/integrate/webhooks/outgoing/), [interactive messages](https://developers.mattermost.com/integrate/plugins/interactive-messages/), and [interactive dialogs](https://developers.mattermost.com/integrate/plugins/interactive-dialogs/). Increase this value if you have external integrations that can take some time to generate an HTTP response, or experience delayed responses due to latency. +The number of seconds to wait for external integration HTTP requests before timing out, including [custom slash commands](https://developers.mattermost.com/integrate/slash-commands/custom/), [outgoing webhooks](https://developers.mattermost.com/integrate/webhooks/outgoing/), [interactive messages](https://developers.mattermost.com/integrate/plugins/interactive-messages/), and [interactive dialogs](https://developers.mattermost.com/integrate/plugins/interactive-dialogs/). Increase this value if you have external integrations that can take some time to generate an HTTP response, or experience delayed responses due to latency. @@ -194,7 +194,7 @@ The number of seconds to wait for external integration HTTP requests, before tim - +
This feature's config.json setting is "OutgoingIntegrationRequestsDefaultTimeout": 3.This feature's config.json setting is "OutgoingIntegrationRequestsTimeout": 30.
diff --git a/docs/main/administration-guide/configure/plugins-configuration-settings.mdx b/docs/main/administration-guide/configure/plugins-configuration-settings.mdx index 939801eb98d..6cd4db5690d 100644 --- a/docs/main/administration-guide/configure/plugins-configuration-settings.mdx +++ b/docs/main/administration-guide/configure/plugins-configuration-settings.mdx @@ -73,8 +73,8 @@ Disabling this configuration setting in larger deployments may improve server pe -
  • true: (Default) Enables plugin signature validation for managed and unmanaged plugins.
  • false: Disables plugin signature validation for managed and unmanaged plugins.
-
  • System Config path: Plugins > Plugin Management
  • config.json setting: PluginSettings > RequirePluginSignature > true
  • Environment variable: MM_PLUGINSETTINGS_REQUIREPLUGINSIGNATURE
+
  • true: Enables plugin signature validation for managed and unmanaged plugins.
  • false: (Default) Disables plugin signature validation for managed and unmanaged plugins.
+
  • System Config path: Plugins > Plugin Management
  • config.json setting: PluginSettings > RequirePluginSignature > false
  • Environment variable: MM_PLUGINSETTINGS_REQUIREPLUGINSIGNATURE
diff --git a/docs/main/administration-guide/configure/reporting-configuration-settings.mdx b/docs/main/administration-guide/configure/reporting-configuration-settings.mdx index ed54cf4a682..57e9c77e990 100644 --- a/docs/main/administration-guide/configure/reporting-configuration-settings.mdx +++ b/docs/main/administration-guide/configure/reporting-configuration-settings.mdx @@ -5,14 +5,16 @@ title: "Reporting configuration settings" View the following statistics for your overall deployment and specific teams, as well as access server logs, in the System Console by selecting the **Product** Navigate between Channels, collaborative playbooks, and boards using the product menu icon. menu, selecting **System Console**, and then selecting **Reporting**: -- [Site statistics](#site-statistics) +- [System statistics](#system-statistics) - [Team statistics](#team-statistics) - [Server logs](#server-logs) - [Statistics configuration settings](#statistics-configuration-settings) ------------------------------------------------------------------------------------------------------------------------ -## Site statistics + + +## System statistics @@ -23,7 +25,7 @@ View the following statistics for your overall deployment and specific teams, as diff --git a/docs/main/administration-guide/configure/site-configuration-settings.mdx b/docs/main/administration-guide/configure/site-configuration-settings.mdx index b686021f2a1..597f13e5205 100644 --- a/docs/main/administration-guide/configure/site-configuration-settings.mdx +++ b/docs/main/administration-guide/configure/site-configuration-settings.mdx @@ -17,6 +17,7 @@ Review and manage the following site configuration options in the System Console - [Public Links](#public-links) - [Notices](#notices) - [Connected Workspaces](#connected-workspaces) +- [Classification Markings](#classification-markings) @@ -230,7 +231,7 @@ This configuration setting applies to all Mattermost clients, including web, des With self-hosted deployments, you can specify how the **Report a Problem** option behaves in the Mattermost app via the **Help** menu: -- **Default link**: Uses the default Mattermost URL to report a problem. Customers with a Mattermost subscription are directed to the [Mattermost Support Portal](https://support.mattermost.com/hc/en-us/requests/new). Community deployments are directed to [create a new issue on the Mattermost GitHub repository](https://github.com/mattermost/mattermost/issues/new). +- **Default**: Customers with a Mattermost license can open a support case by email with the Mattermost support team. Unlicensed Mattermost deployments are directed to the [troubleshooting forums](https://mattermost.com/pl/report_a_problem_unlicensed). - **Email address**: Enables you to [enter an email address](/administration-guide/configure/site-configuration-settings#report-a-problem-email-address) that users will be prompted to send a message to when they choose **Report a Problem** in Mattermost. - **Custom link**: Enables you to [enter a URL](/administration-guide/configure/site-configuration-settings#report-a-problem-link) that users will be directed to when they choose **Report a Problem** in Mattermost. - **Hide link**: Removes the **Report a Problem** option from Mattermost. @@ -266,7 +267,7 @@ This setting is applicable to self-hosted deployments only. - +
View statistics on a wide variety of activities in Mattermost, including: users, seats, teams, channels, posts, calls, sessions, commands, webhooks, websocket and database connections, and collaborative playbooks.
    -
  • System Config path: Reporting > Site Statistics
    • +
  • System Config path: Reporting > System Statistics
  • config.json setting: N/A
  • Environment variable: N/A

This field sets the email address for the Report a Problem link in the channel header Help menu.

String input. Cannot be left blank.

  • System Config path: Site Configuration > Customization
  • config.json setting: SupportSettings > ReportAProblemMail
  • Environment variable: MM_SUPPORTSETTINGS_REPORTAPROBLMEMAIL
  • System Config path: Site Configuration > Customization
  • config.json setting: SupportSettings > ReportAProblemMail
  • Environment variable: MM_SUPPORTSETTINGS_REPORTAPROBLEMMAIL
@@ -885,6 +886,23 @@ Access the following configuration settings in the System Console by going to ** +### Channel category sorting + +From Mattermost v11.8, channel category sorting is enabled by default. When enabled, channel admins can choose a default sidebar category when creating or editing a channel. Channel admins can select an existing category, type a new category name, or clear the default category from channel settings. Members who join the channel see it under that category in their sidebar. When disabled, the default category selector is hidden. + + ++++ + + + + + + +
  • true: (Default) When creating or editing supported channels, channel admins see a Default category (optional) field. They can select an existing category, enter a new category name, or clear the default category from channel settings. Members who join the channel see it under that category in their sidebar.
  • false: The default category selector is hidden when creating or editing channels.
  • System Config path: Site Configuration > Users and Teams
  • config.json setting: TeamSettings > EnableChannelCategorySorting > true
  • Environment variable: MM_TEAMSETTINGS_ENABLECHANNELCATEGORYSORTING
+ ------------------------------------------------------------------------------------------------------------------------ ## Notifications @@ -2119,6 +2137,35 @@ Enabling these features can increase the load on your Mattermost server’s CPU, ------------------------------------------------------------------------------------------------------------------------ +## Classification Markings + +From Mattermost v11.8, system admins can configure classification markings in the System Console by going to **Site Configuration \> Classification Markings**. + +Classification markings define reusable classification levels that can be displayed as global or channel-level banners in the web and desktop apps. Each classification level includes a name, color, and rank order. You can select a preset, such as US DoD, NATO, UK GSCP, Canada, or Australia PSPF, or define custom classification levels. + + + +Classification markings are informational only and aren't tied to access control decisions at this time. + + + +Configure classification markings: + +1. Go to **System Console \> Site Configuration \> Classification Markings**. +2. Enable **Enable classification markings**. +3. Select a **Classification preset**, or create custom classification levels. +4. Configure classification level names, colors, and rank order. +5. Optionally enable the **Global Classification Banner** under **Global Classification Indicators**. +6. Select the **Banner visibility**: + + - **Top only** + - **Top and bottom** + +7. Select the **Global classification level** to display. +8. Select **Save**. + +------------------------------------------------------------------------------------------------------------------------ + ## config.json-only settings The following self-hosted deployment settings are only configurable in the `config.json` file and are not available in the System Console. diff --git a/docs/main/administration-guide/configure/system-attributes.mdx b/docs/main/administration-guide/configure/system-attributes.mdx index 55e843f2d03..ed4afa67215 100644 --- a/docs/main/administration-guide/configure/system-attributes.mdx +++ b/docs/main/administration-guide/configure/system-attributes.mdx @@ -9,6 +9,6 @@ Review and manage the following system attributes configuration options in the S You can define, manage, and enforce specific attributes, including: -- **Custom attributes for user profiles**: Display details such as job titles, departments, or other metadata, on user profiles that align with your organizational structures and workflows. Learn more about [managing custom user profile attributes](/administration-guide/manage/admin/user-attributes). API responses for custom profile attributes return default visibility and sort order when those values are missing. +- **User attributes**: Display details such as job titles, departments, or other metadata, on user profiles that align with your organizational structures and workflows. Learn more about [managing user attributes](/administration-guide/manage/admin/user-attributes). API responses for user attributes return default visibility and sort order when those values are missing. - **Granular access controls based on user attributes**: Ensure users have access to only the resources and functionality relevant to their roles, bolstering security and compliance across the organization. Learn more about [managing access based on user attributes](/administration-guide/manage/admin/attribute-based-access-control). - **Control user-managed attributes in attribute-based access control (ABAC)**: From Mattermost v10.11 (Enterprise Edition Advanced), user-managed attributes are excluded from ABAC rules by default to prevent unauthorized access. System admins can enable them with a configuration setting. Learn more about enabling user-managed attributes in ABAC rules in the [User Attributes documentation](/administration-guide/manage/admin/user-attributes#before-you-begin).