diff --git a/docs/main/administration-guide/scale/collect-performance-metrics.mdx b/docs/main/administration-guide/scale/collect-performance-metrics.mdx
index eaa84f0abb8a..c4e31f79fa7a 100644
--- a/docs/main/administration-guide/scale/collect-performance-metrics.mdx
+++ b/docs/main/administration-guide/scale/collect-performance-metrics.mdx
@@ -1,6 +1,8 @@
---
title: "Collect performance metrics"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
System admins can collect and store the [same performance monitoring metrics](/administration-guide/scale/performance-monitoring-metrics) as Prometheus, without having to deploy these third-party tools. Data is collected every minute and is stored in a path you configure. The data is synchronized to either a cloud-based or local file store every hour, and retained for 15 days.
@@ -24,7 +26,7 @@ For Mattermost Cloud deployments, no setup is required. See the [usage](#usage)
For a self-hosted Mattermost deployment, a Mattermost system admin must perform the following steps in Mattermost.
1. Log in to your Mattermost [workspace](/end-user-guide/end-user-guide-index) as a system admin.
-2. From Mattermost v10.1, you can install the Metrics plugin from the in-product Mattermost Marketplace by selecting the **Product** 
icon and selecting **App Marketplace**. Search for **Metrics** and select **Install**.
+2. From Mattermost v10.1, you can install the Metrics plugin from the in-product Mattermost Marketplace by selecting the **Product** })
icon and selecting **App Marketplace**. Search for **Metrics** and select **Install**.
3. Go to **System Console \> Plugins \> Plugin Management**. In the **Installed Plugins** section, scroll to **Mattermost Metrics Plugin**, and select **Enable Plugin**.
4. Specify the path of the time-series database, and select **Save**.
5. Go to **System Console \> Environment \> Performance Monitoring**, and set **Enable Performance Monitoring** to **true**. Select **Save**.
@@ -59,7 +61,7 @@ Once you set this up, run `docker-compose` as described in [Dockprom Repository]
You can also use our [Mattermost Performance Monitoring v2](https://grafana.com/grafana/dashboards/15582-mattermost-performance-monitoring-v2/) dashboard by simply importing it into Grafana.
1. Open Grafana (`<localhost>:3000` by default) and then log into it.
-2. Once you log in, go to the **Plus** 
icon on the left sidebar, and then select **Import**.
+2. Once you log in, go to the **Plus** })
icon on the left sidebar, and then select **Import**.
3. Enter the dashboard ID (`15582`) in the **Grafana.com Dashboard** field, and then select **Load** to fetch the dashboard.
## What's collected?
diff --git a/docs/main/administration-guide/scale/high-availability-cluster-based-deployment.mdx b/docs/main/administration-guide/scale/high-availability-cluster-based-deployment.mdx
index c1e8c5d621da..fdfe5429d37b 100644
--- a/docs/main/administration-guide/scale/high-availability-cluster-based-deployment.mdx
+++ b/docs/main/administration-guide/scale/high-availability-cluster-based-deployment.mdx
@@ -1,6 +1,8 @@
---
title: "High availability cluster-based deployment"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
A high availability cluster-based deployment enables a Mattermost system to maintain service during outages and hardware failures through the use of redundant infrastructure.
@@ -1267,7 +1269,7 @@ For example, if you're deploying Mattermost on AWS with Amazon Aurora we recomme
### How to find the hostname of the connected websocket?
-From Mattermost v10.4, Enterprise customers running self-hosted deployments can go to the **Product** menu and select **About Mattermost** to see the hostname of the node in the cluster running Mattermost.
+From Mattermost v10.4, Enterprise customers running self-hosted deployments can go to the **Product** menu and select **About Mattermost** to see the hostname of the node in the cluster running Mattermost.
## Troubleshooting
diff --git a/docs/main/administration-guide/scale/server-architecture.mdx b/docs/main/administration-guide/scale/server-architecture.mdx
index 692ef959d674..7c9cbebaf7dd 100644
--- a/docs/main/administration-guide/scale/server-architecture.mdx
+++ b/docs/main/administration-guide/scale/server-architecture.mdx
@@ -1,6 +1,7 @@
---
title: "Deployment Architecture at Scale"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -32,22 +33,22 @@ Mattermost is designed to be able to handle a large number of concurrent users,
-
+})
-
+})
-
+})
-
+})
@@ -58,22 +59,22 @@ Mattermost is designed to be able to handle a large number of concurrent users,
-
+})
-
+})
-
+})
-
+})
@@ -84,7 +85,7 @@ Mattermost is designed to be able to handle a large number of concurrent users,
-
+})
diff --git a/docs/main/administration-guide/upgrade/important-upgrade-notes.mdx b/docs/main/administration-guide/upgrade/important-upgrade-notes.mdx
index e9339f6845fa..2c3cef926f64 100644
--- a/docs/main/administration-guide/upgrade/important-upgrade-notes.mdx
+++ b/docs/main/administration-guide/upgrade/important-upgrade-notes.mdx
@@ -666,7 +666,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
| v10.6 |
-Support for PostgreSQL v11 and v12 have been removed. The new minimum PostgreSQL version is v13+. | See the | minimum supported PostgreSQL version policy documentation | for details. | |
+Support for PostgreSQL v11 and v12 have been removed. The new minimum PostgreSQL version is v13+. | See the | minimum supported PostgreSQL version policy documentation | for details. | |
System Console statistics now perform faster on PostgreSQL. The MaxUsersForStatistics configuration setting now only disables the User counts with posts chart, while all other stats remain unaffected. The other stats remain unaffected because that configuration value is no longer needed to disable the other queries since they are always fast now. Post and file counts update daily, so they may not always reflect real-time data. Advanced stats, such as line charts and plugin data, are now hidden until clicked, reducing load time. No performance improvements apply to MySQL since it's scheduled for full deprecation in v11. We recommend migrating to PostgreSQL for better performance and long-term support. Migration times: On a system with 12M posts, and 1M fileinfo entries, the migration takes 15s, but could take several minutes depending on the server's table sizes and database specs. This migration is non-locking. Note that there is no migration for MySQL deployments because this optimization is only applicable for PostgreSQL. Below are the SQL queries included in the schema changes: CREATE MATERIALIZED VIEW IF NOT EXISTS posts_by_team_day asSELECT to_timestamp(p.createat/1000)::date as day, COUNT(*) as num, teamidFROM posts p JOIN channels c on p.channelid=c.idGROUP BY day, c.teamid;CREATE MATERIALIZED VIEW IF NOT EXISTS bot_posts_by_team_day asSELECT to_timestamp(p.createat/1000)::date as day, COUNT(*) as num, teamidFROM posts pJOIN Bots b ON p.UserId = b.UseridJOIN channels c on p.channelid=c.idGROUP BY day, c.teamid;CREATE MATERIALIZED VIEW IF NOT EXISTS file_stats asSELECT COUNT(*) as num, COALESCE(SUM(Size), 0) as usageFROM fileinfoWHERE DeleteAt = 0;
|
@@ -685,7 +685,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
Mattermost has stopped official Mattermost server builds for the Microsoft Windows operating system. Administrators should migrate existing Mattermost server installations to use the official Linux builds. See more details in this forum post. |
-| v10.5 introduces updates to the Compliance Export functionality, which will modify how exported data is structured, stored and processed. These changes | primarily affect System Administrators and the main changes are outlined below. See more details in | the Compliance Export documentation. | | Output files and directories have changed - Previously we were exporting a single zip containing all the batch directories. Now we will export a single | directory, and under that directory each batch will be its own zip. | | Compliance exports performance improvements - Compliance exports should now be at least 50% faster, and possibly more. | | Logic improvements - We’ve made improvements and fixed bugs that we found. | | Changes specific to each Export Type - The export output formats have been changed. Some fields’ semantic meaning has been clarified, and there are a number of | new fields. Our goal was to maintain backwards compatibility while fixing the logic bugs. | | See the compliance export product documentation for details. | |
+v10.5 introduces updates to the Compliance Export functionality, which will modify how exported data is structured, stored and processed. These changes | primarily affect System Administrators and the main changes are outlined below. See more details in | the Compliance Export documentation. | | Output files and directories have changed - Previously we were exporting a single zip containing all the batch directories. Now we will export a single | directory, and under that directory each batch will be its own zip. | | Compliance exports performance improvements - Compliance exports should now be at least 50% faster, and possibly more. | | Logic improvements - We’ve made improvements and fixed bugs that we found. | | Changes specific to each Export Type - The export output formats have been changed. Some fields’ semantic meaning has been clarified, and there are a number of | new fields. Our goal was to maintain backwards compatibility while fixing the logic bugs. | | See the compliance export product documentation for details. | |
As part of the Property System Architecture feature, Mattermost v10.5 is going to run a set of migrations to add new tables to the schema. This migration only creates new tables and indexes, so there is no impact on preexisting data. New tables PropertyGroups, PropertyFields and PropertyValues are going to be created. In the case of PostgreSQL, a new enum type property_field_type is going to be created, to be used in the Type column of the PropertyFields table. The PropertyFields and PropertyValues tables have a unique constraint that will generate an index in MySQL, and in the case of PostgreSQL, they directly use a UNIQUE INDEX to enforce this constraint. A new index idx_propertyvalues_targetid_groupid will be created for the PropertyValues table. The migration is only creating new tables with no data. The migration is backwards-compatible, and a previous version of Mattermost can run with the new schema changes. No table locks or existing operations on the table are impacted by this upgrade. Zero downtime is possible when upgrading to this release. Below are the SQL queries included in the schema changes: MySQL: CREATE TABLE IF NOT EXISTS PropertyGroups ( ID varchar(26) PRIMARY KEY, Name varchar(64) NOT NULL, UNIQUE(Name));CREATE TABLE IF NOT EXISTS PropertyFields ( ID varchar(26) PRIMARY KEY, GroupID varchar(26) NOT NULL, Name varchar(255) NOT NULL, Type enum('text', 'select', 'multiselect', 'date', 'user', 'multiuser'), Attrs json, TargetID varchar(255), TargetType varchar(255), CreateAt bigint(20), UpdateAt bigint(20), DeleteAt bigint(20), UNIQUE(GroupID, TargetID, Name, DeleteAt));CREATE TABLE IF NOT EXISTS PropertyValues ( ID varchar(26) PRIMARY KEY, TargetID varchar(255) NOT NULL, TargetType varchar(255) NOT NULL, GroupID varchar(26) NOT NULL, FieldID varchar(26) NOT NULL, Value json, CreateAt bigint(20), UpdateAt bigint(20), DeleteAt bigint(20), UNIQUE(GroupID, TargetID, FieldID, DeleteAt));SET @preparedStatement = (SELECT IF( ( SELECT COUNT(*) FROM INFORMATION_SCHEMA.STATISTICS WHERE table_name = 'PropertyValues' AND table_schema = DATABASE() AND index_name = 'idx_propertyvalues_targetid_groupid' ) > 0, 'SELECT 1', 'CREATE INDEX idx_propertyvalues_targetid_groupid ON PropertyValues (TargetID, GroupID);'));PREPARE createIndexIfNotExists FROM @preparedStatement;EXECUTE createIndexIfNotExists;DEALLOCATE PREPARE createIndexIfNotExists;
PostgreSQL: CREATE TABLE IF NOT EXISTS PropertyGroups ( ID varchar(26) PRIMARY KEY, Name varchar(64) NOT NULL, UNIQUE(Name));DOBEGIN IF NOT EXISTS (SELECT * FROM pg_type typ INNER JOIN pg_namespace nsp ON nsp.oid = typ.typnamespace WHERE nsp.nspname = current_schema() AND typ.typname = 'property_field_type') THEN CREATE TYPE property_field_type AS ENUM ( 'text', 'select', 'multiselect', 'date', 'user', 'multiuser' ); END IF;END;LANGUAGE plpgsql;CREATE TABLE IF NOT EXISTS PropertyFields ( ID varchar(26) PRIMARY KEY, GroupID varchar(26) NOT NULL, Name varchar(255) NOT NULL, Type property_field_type, Attrs jsonb, TargetID varchar(255), TargetType varchar(255), CreateAt bigint NOT NULL, UpdateAt bigint NOT NULL, DeleteAt bigint NOT NULL);CREATE UNIQUE INDEX IF NOT EXISTS idx_propertyfields_unique ON PropertyFields (GroupID, TargetID, Name) WHERE DeleteAt = 0;CREATE TABLE IF NOT EXISTS PropertyValues ( ID varchar(26) PRIMARY KEY, TargetID varchar(255) NOT NULL, TargetType varchar(255) NOT NULL, GroupID varchar(26) NOT NULL, FieldID varchar(26) NOT NULL, Value jsonb NOT NULL, CreateAt bigint NOT NULL, UpdateAt bigint NOT NULL, DeleteAt bigint NOT NULL);CREATE UNIQUE INDEX IF NOT EXISTS idx_propertyvalues_unique ON PropertyValues (GroupID, TargetID, FieldID) WHERE DeleteAt = 0;CREATE INDEX IF NOT EXISTS idx_propertyvalues_targetid_groupid ON PropertyValues (TargetID, GroupID); ``
|
@@ -748,7 +748,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
| v9.11 |
-Added support for Elasticsearch v8. Also added Beta support for OpenSearch v1.x and v2.x. A new config setting ElasticsearchSettings.Backend has been | added to differentiate between Elasticsearch and OpenSearch. The default value is elasticsearch which breaks support for AWS Elasticsearch v7.10.x | since the official v8 client only works from Elasticsearch v7.11+ versions. | | .. note:: | | - For AWS customers on OpenSearch, you must modify Mattermost configuration from elasticsearch to opensearch and disable compatibility mode. | See the OpenSearch documentation for details on upgrading. | - After upgrading the Mattermost server, use mmctl or edit the config manually, | then restart the Mattermost server. | - If you are using OpenSearch, you must set the backend to opensearch. Otherwise Mattermost will not work. | | If you are using Elasticsearch v8, be sure to set action.destructive_requires_name to false in elasticsearch.yml to allow for wildcard operations to | work. | |
+Added support for Elasticsearch v8. Also added Beta support for OpenSearch v1.x and v2.x. A new config setting ElasticsearchSettings.Backend has been | added to differentiate between Elasticsearch and OpenSearch. The default value is elasticsearch which breaks support for AWS Elasticsearch v7.10.x | since the official v8 client only works from Elasticsearch v7.11+ versions. | | .. note:: | | - For AWS customers on OpenSearch, you must modify Mattermost configuration from elasticsearch to opensearch and disable compatibility mode. | See the OpenSearch documentation for details on upgrading. | - After upgrading the Mattermost server, use mmctl or edit the config manually, | then restart the Mattermost server. | - If you are using OpenSearch, you must set the backend to opensearch. Otherwise Mattermost will not work. | | If you are using Elasticsearch v8, be sure to set action.destructive_requires_name to false in elasticsearch.yml to allow for wildcard operations to | work. | |
| v9.10 |
@@ -775,7 +775,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
We have stopped supporting MySQL v5.7 since it's at the end of life. We urge customers to upgrade their MySQL instance at their earliest convenience. |
-| Added safety limit error message in compiled Team Edition and Enterprise Edition deployments when enterprise scale and access control automation features are | unavailable and count of users who are registered and not deactivated exceeds 10,000. | ERROR_SAFETY_LIMITS_EXCEEDED. | |
+Added safety limit error message in compiled Team Edition and Enterprise Edition deployments when enterprise scale and access control automation features are | unavailable and count of users who are registered and not deactivated exceeds 10,000. | ERROR_SAFETY_LIMITS_EXCEEDED. | |
| v9.4 |
@@ -851,7 +851,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
Removed deprecated model.CommandArgs.Session. |
-For servers wanting to allow websockets to connect from origins other than the origin of the site URL, please set the ServiceSettings.AllowCorsFrom | configuration setting. Also ensure that | the siteURL is set correctly. | |
+For servers wanting to allow websockets to connect from origins other than the origin of the site URL, please set the ServiceSettings.AllowCorsFrom | configuration setting. Also ensure that | the siteURL is set correctly. | |
In v8.0 release, the following repositories are merged into one: mattermost-server, mattermost-webapp and mmctl. Developers should read the updated Developer Guide for details. |
@@ -876,7 +876,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
In v7.10.1, fixed an issue where a user would still see threads in the threads view of channels they have left. Migration execution time in MySQL: Query OK, 2766769 rows affected (4 min 47.57 sec). Migration execution time in PostgreSQL: 58.11 sec, DELETE 2766690. |
-In v7.10.3, for servers wanting to allow websockets to connect from origins other than the origin of the site URL, please set the | ServiceSettings.AllowCorsFrom | configuration setting. Also ensure that | the siteURL is set correctly. | |
+In v7.10.3, for servers wanting to allow websockets to connect from origins other than the origin of the site URL, please set the | ServiceSettings.AllowCorsFrom | configuration setting. Also ensure that | the siteURL is set correctly. | |
| v7.9 |
@@ -889,11 +889,11 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
In v7.9.4, backported a fix related Oauth 2. Query times depend on if you have rows to delete or not. With no rows to delete: - MySQL v5.7.12: 9ms
- PostgreSQL v10: 21ms
4 rows: - MySQL v5.7.12: 17.2ms
- PostgreSQL v10: 9.9ms
Those times are based off the following table sizes: - Preferences: 2 million records
oauthaccessdata and sessions: 10 records
You can assess the number of impacted rows by running the following: PostgreSQL: SELECT count(o.*)FROM oauthaccessdata o WHERE NOT EXISTS ( SELECT p.* FROM preferences p WHERE o.clientid = p.name AND o.userid = p. userid AND p.category = 'oauth_app' );
MySQL: SELECT COUNT(o.`Token`)FROM OAuthAccessData oLEFT JOIN Preferences p ON o. clientid = p.name AND o.userid = p.userid AND p.category = 'oauth_app'INNER JOIN Sessions s ON o.token = s .tokenWHERE p.name IS NULL;
Locks on the oauthaccessdata and sessions table will only be acquired if there are rows to delete. |
-In v7.9.5, for servers wanting to allow websockets to connect from origins other than the origin of the site URL, please set the | ServiceSettings.AllowCorsFrom | configuration setting. Also ensure that | the siteURL is set correctly. | |
+In v7.9.5, for servers wanting to allow websockets to connect from origins other than the origin of the site URL, please set the | ServiceSettings.AllowCorsFrom | configuration setting. Also ensure that | the siteURL is set correctly. | |
| v7.8 |
-Message Priority & Acknowledgement is now enabled by default | for all instances. You may disable this feature in the System Console by going to Posts > Message Priority or via the config PostPriority setting. | |
+Message Priority & Acknowledgement is now enabled by default | for all instances. You may disable this feature in the System Console by going to Posts > Message Priority or via the config PostPriority setting. | |
| In v7.8.5, fixed an issue where a user would still see threads in the threads view of channels they have left. Migration execution time in MySQL: Query OK, 2766769 rows affected (4 min 47.57 sec). Migration execution time in PostgreSQL: 58.11 sec, DELETE 2766690. |
@@ -902,7 +902,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
In v7.8.5, backported a fix related Oauth 2. Query times depend on if you have rows to delete or not. With no rows to delete: - MySQL v5.7.12: 9ms
- PostgreSQL v10: 21ms
4 rows: - MySQL v5.7.12: 17.2ms
- PostgreSQL v10: 9.9ms
Those times are based off the following table sizes: - Preferences: 2 million records
oauthaccessdata and sessions: 10 records
You can assess the number of impacted rows by running the following: PostgreSQL: SELECT count(o.*) FROM oauthaccessdata o WHERE NOT EXISTS ( SELECT p.* FROM preferences p WHERE o.clientid = p.name AND o.userid = p. userid AND p.category = 'oauth_app' );
MySQL: SELECT COUNT(o.`Token`)FROM OAuthAccessData oLEFT JOIN Preferences p ON o. clientid = p.name AND o.userid = p.userid AND p.category = 'oauth_app'INNER JOIN Sessions s ON o.token = s .tokenWHERE p.name IS NULL;
Locks on the oauthaccessdata and sessions table will only be acquired if there are rows to delete. |
-In v7.8.7, for servers wanting to allow websockets to connect from origins other than the origin of the site URL, please set the | ServiceSettings.AllowCorsFrom | configuration setting. Also ensure that | the siteURL is set correctly. | |
+In v7.8.7, for servers wanting to allow websockets to connect from origins other than the origin of the site URL, please set the | ServiceSettings.AllowCorsFrom | configuration setting. Also ensure that | the siteURL is set correctly. | |
In v7.8.11, improved performance on data retention DeleteOrphanedRows queries. New migration for a new table: MySQL: CREATE TABLEIF NOT EXISTS RetentionIdsForDeletion(Id VARCHAR(26) NOT NULL, TableName VARCHAR(64), Ids json, PRIMARY KEY (Id ), KEY idx_retentionidsfordeletion_tablename (TableName)) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4; ``
PostgreSQL: CREATE TABLEIF NOT EXISTS retentionidsfordeletion(id VARCHAR(26) PRIMARY KEY, tablename VARCHAR(64), ids VARCHAR(26) []); CREATE INDEXIF NOT EXISTS idx_retentionidsfordeletion_tablename ON retentionidsfordeletion( tablename); ``
Hard deleting a user or a channel will now also clean up associated reactions. Removed feature flag DataRetentionConcurrencyEnabled. Data retention now runs without concurrency in order to avoid any performance degradation. Added a new configuration setting DataRetentionSettings.RetentionIdsBatchSize, which allows admins to configure how many batches of IDs will be fetched at a time when deleting orphaned reactions. The default value is 100. |
@@ -918,7 +918,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
Starting with the Calls version shipping with v7.7, there's now a minimum version requirement when using the external RTCD service. This means that if Calls is configured to use the external service, customers need to upgrade RTCD first to at least version 0.8.0 or the plugin will fail to start. |
-In v7.7.2, Message Priority & Acknowledgement is now enabled by | default for all instances. You may disable this feature in the System Console by going to Posts > Message Priority or via the config PostPriority | setting. | |
+In v7.7.2, Message Priority & Acknowledgement is now enabled by | default for all instances. You may disable this feature in the System Console by going to Posts > Message Priority or via the config PostPriority | setting. | |
| v7.5 |
@@ -953,34 +953,34 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
When a new configuration setting via System Console > Experimental > Features > Enable App Bar is enabled, all channel header icons registered by plugins will be moved to the new Apps Bar, even if they do not explicitly use the new registry function to render a component there. The setting for Apps Bar defaults to false for self-hosted deployments. |
-The value of ServiceSettings.TrustedProxyIPHeader defaults to empty from now on. A previous bug prevented this from happening in certain conditions. | Customers are requested to check for these values in their config and set them to nil if necessary. See more details | here. | |
+The value of ServiceSettings.TrustedProxyIPHeader defaults to empty from now on. A previous bug prevented this from happening in certain conditions. | Customers are requested to check for these values in their config and set them to nil if necessary. See more details | here. | |
-| Collapsed Reply Threads is now generally available and enabled by default for new | Mattermost servers. For servers upgrading to v7.0 and later, please reference | this article for more information | and guidance on enabling the feature. | |
+Collapsed Reply Threads is now generally available and enabled by default for new | Mattermost servers. For servers upgrading to v7.0 and later, please reference | this article for more information | and guidance on enabling the feature. | |
| v6.7 |
New schema changes were introduced in the form of a new index. The following summarizes the test results measuring how long it took for the database queries to run with these schema changes: MySQL 7M Posts - ~17s (Instance: db.r5.xlarge) MySQL 9M Posts - 2min 12s (Instance: db.r5.large) Postgres 7M Posts - ~9s (Instance: db.r5.xlarge) For customers wanting a zero downtime upgrade, they are encouraged to apply this index prior to doing the upgrade. This is fully backwards compatible and will not acquire any table lock or affect any existing operations on the table when run manually. Else, the queries will run during the upgrade process and will lock the table in non-MySQL environments. Run the following to apply this index: For MySQL: CREATE INDEX idx_posts_create_at_id on Posts(CreateAt, Id) LOCK=NONE; For Postgres: CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_posts_create_at_id on posts(createat, id); |
-In v6.7.1, the value of ServiceSettings.TrustedProxyIPHeader defaults to empty from now on. A previous bug prevented this from happening in certain | conditions. Customers are requested to check for these values in their config and set them to nil if necessary. See more details | here. | |
+In v6.7.1, the value of ServiceSettings.TrustedProxyIPHeader defaults to empty from now on. A previous bug prevented this from happening in certain | conditions. Customers are requested to check for these values in their config and set them to nil if necessary. See more details | here. | |
| v6.6 |
The Apps Framework protocol for binding/form submissions has changed, by separating the single call into separate submit, form, refresh and lookup calls. If any users have created their own Apps, they have to be updated to the new system. |
-| Channel admins can now configure certain actions to be executed automatically based on trigger | conditions without writing any code. Users running an older Playbooks release need to upgrade their Playbooks instance to at least v1.26 to take advantage of | the channel actions functionality. | |
+Channel admins can now configure certain actions to be executed automatically based on trigger | conditions without writing any code. Users running an older Playbooks release need to upgrade their Playbooks instance to at least v1.26 to take advantage of | the channel actions functionality. | |
-In v6.6.2, the value of ServiceSettings.TrustedProxyIPHeader defaults to empty from now on. A previous bug prevented this from happening in certain | conditions. Customers are requested to check for these values in their config and set them to nil if necessary. See more details | here. | |
+In v6.6.2, the value of ServiceSettings.TrustedProxyIPHeader defaults to empty from now on. A previous bug prevented this from happening in certain | conditions. Customers are requested to check for these values in their config and set them to nil if necessary. See more details | here. | |
| v6.5 |
-The mattermost version CLI command does not interact with the database anymore. Therefore the database version is not going to be | printed. Also, the database migrations are not going to be applied with the version sub command. | A new db migrate sub command is added to enable administrators | to trigger migrations. | |
+The mattermost version CLI command does not interact with the database anymore. Therefore the database version is not going to be | printed. Also, the database migrations are not going to be applied with the version sub command. | A new db migrate sub command is added to enable administrators | to trigger migrations. | |
-In v6.5.2, the value of ServiceSettings.TrustedProxyIPHeader defaults to empty from now on. A previous bug prevented this from happening in certain | conditions. Customers are requested to check for these values in their config and set them to nil if necessary. See more details | here. | |
+In v6.5.2, the value of ServiceSettings.TrustedProxyIPHeader defaults to empty from now on. A previous bug prevented this from happening in certain | conditions. Customers are requested to check for these values in their config and set them to nil if necessary. See more details | here. | |
| v6.4 |
@@ -994,11 +994,11 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
In v6.3.3, the default for ThreadAutoFollow has been changed to false. This does not affect existing configurations where this value is already set to true. |
-In v6.3.9, the value of ServiceSettings.TrustedProxyIPHeader defaults to empty from now on. A previous bug prevented this from happening in certain | conditions. Customers are requested to check for these values in their config and set them to nil if necessary. See more details | here. | |
+In v6.3.9, the value of ServiceSettings.TrustedProxyIPHeader defaults to empty from now on. A previous bug prevented this from happening in certain | conditions. Customers are requested to check for these values in their config and set them to nil if necessary. See more details | here. | |
| v6.2 |
-Channel results in the channel autocomplete will include private channels. Customers using Bleve or | Elasticsearch for autocomplete will have to reindex their data to get the new results. Since this can | take a long time, we suggest disabling autocomplete and running indexing in the background. When this is complete, re-enable autocomplete. | | .. note:: | Only channel members see private channel names in autocomplete results. | |
+Channel results in the channel autocomplete will include private channels. Customers using Bleve or | Elasticsearch for autocomplete will have to reindex their data to get the new results. Since this can | take a long time, we suggest disabling autocomplete and running indexing in the background. When this is complete, re-enable autocomplete. | | .. note:: | Only channel members see private channel names in autocomplete results. | |
In v6.2.3, the default for ThreadAutoFollow has been changed to false. This does not affect existing configurations where this value is already set to true. |
@@ -1030,16 +1030,16 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
While trying to upgrade to a Mattermost version >= 6.0.x, you might encounter the following error: Failed to alter column type. It is likely you have invalid JSON values in the column. Please fix the values manually and run the migration again. This means that the particular column has some invalid JSON values which need to be fixed manually. A common fix that is known to work is to wipe out all \u0000 characters. Please follow these steps: - Check the affected values by:
SELECT COUNT(*) FROM <table> WHERE <column> LIKE '%\u0000%'; - If you get a count more than 0, check those values manually, and confirm they are okay to be removed.
- Remove them by
UPDATE <table> SET <column> = regexp_replace(<column>, '\\u0000', '', 'g') where <column> like '%\u0000%';
Then try to start Mattermost again. |
-| Please see unsupported legacy releases documentation for a list of deprecations in this release. | |
+Please see unsupported legacy releases documentation for a list of deprecations in this release. | |
| Focalboard plugin has been renamed to Mattermost Boards, and v0.9.1 (released with Mattermost v6.0) is now enabled by default. |
-| The advanced logging configuration schema changed. This is a breaking change relative to 5.x. See updated | documentation. | |
+The advanced logging configuration schema changed. This is a breaking change relative to 5.x. See updated | documentation. | |
-| The existing theme names and colors, including "Mattermost", "Organization", "Mattermost Dark", and "Windows Dark" have been updated to the new "Denim", | "Quartz", "Indigo", and "Onyx" theme names and colors, respectively. Anyone using the existing themes will see slightly modified theme colors after their | server or workspace is upgraded. The theme variables for the existing "Mattermost", "Organization", "Mattermost Dark", and "Windows Dark" themes will still be | accessible in our documentation. A custom theme can be created with these theme variables if desired. | Custom themes are unaffected by this change. | |
+The existing theme names and colors, including "Mattermost", "Organization", "Mattermost Dark", and "Windows Dark" have been updated to the new "Denim", | "Quartz", "Indigo", and "Onyx" theme names and colors, respectively. Anyone using the existing themes will see slightly modified theme colors after their | server or workspace is upgraded. The theme variables for the existing "Mattermost", "Organization", "Mattermost Dark", and "Windows Dark" themes will still be | accessible in our documentation. A custom theme can be created with these theme variables if desired. | Custom themes are unaffected by this change. | |
Some breaking changes to plugins are included: - Support for left-hand side-specific bot icons was dropped.
- Removed a deprecated "Backend" field from the plugin manifest.
- Converted the "Executables" field in the plugin manifest to a map.
|
@@ -1062,7 +1062,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
The platform binary and “--platform” flag have been removed. If you are using the “--platform” flag or are using the platform binary directly to run the Mattermost server application via a systemd file or custom script, you will be required to use only the mattermost binary. |
-| Collapsed Reply Threads are available as Beta in Mattermost Server | v5.37 and later. It’s expected that you may experience bugs as we stabilize the feature. In particular, please be aware of | the known issues documented here. | |
+Collapsed Reply Threads are available as Beta in Mattermost Server | v5.37 and later. It’s expected that you may experience bugs as we stabilize the feature. In particular, please be aware of | the known issues documented here. | |
| v5.37 adds support for emoji standard v13.0. If you have added a custom emoji in the past that uses one of the new system names, then it is going to get overwritten by the system emoji. The workaround is to change the custom emoji name. |
@@ -1088,7 +1088,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
The existing password generation logic used during the bulk user import process was comparatively weak. Hence it's advised for admins to immediately reset the passwords for all the users who were generated during the bulk import process and whose password has not been changed even once. |
-| v5.35.0 introduces a new feature to search for files. Search results for files shared in the past may be incomplete until a | content extraction command is executed to extract | and index the content of files already in the database. Instances running Elasticsearch or Bleve search backends will also need to execute a Bulk Indexing after | the content extraction is complete. Please see more details in this blog post. | |
+v5.35.0 introduces a new feature to search for files. Search results for files shared in the past may be incomplete until a | content extraction command is executed to extract | and index the content of files already in the database. Instances running Elasticsearch or Bleve search backends will also need to execute a Bulk Indexing after | the content extraction is complete. Please see more details in this blog post. | |
| v5.34.1 |
@@ -1120,7 +1120,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
| v5.29.0 |
-A new configuration setting ThreadAutoFollow has been added to support Collapsed Reply Threads releasing in beta in Q1 2021. | This setting is enabled by default and may affect server performance. It is recommended to review our documentation on hardware requirements | to ensure your servers are appropriately scaled for the size of your user base. | |
+A new configuration setting ThreadAutoFollow has been added to support Collapsed Reply Threads releasing in beta in Q1 2021. | This setting is enabled by default and may affect server performance. It is recommended to review our documentation on hardware requirements | to ensure your servers are appropriately scaled for the size of your user base. | |
| Disabled the xmlsec1-based SAML library in favor of the re-enabled and improved SAML library. |
@@ -1130,7 +1130,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
Now when the service crashes, it will generate a coredump instead of just dumping the stack trace to the console. This allows us to preserve the full information of the crash to help with debugging it. For more information about coredumps, please see: https://man7.org/linux/man-pages/man5/core.5.html. |
-| In-product notices have been introduced to keep system admins and end users informed of the latest product enhancements available in new server and desktop | versions. Learn more about in-product notices and how to disable them in our documentation. | |
+In-product notices have been introduced to keep system admins and end users informed of the latest product enhancements available in new server and desktop | versions. Learn more about in-product notices and how to disable them in our documentation. | |
| Disabled the xmlsec1-based SAML library in favor of the re-enabled and improved SAML library. |
@@ -1154,7 +1154,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
| v5.25.0 |
-Some incorrect instructions regarding SAML setup with Active Directory ADFS for setting the “Relying Party Trust Identifier” were corrected. Although the | settings will continue to work, it is encouraged that you | modify those settings. | |
+Some incorrect instructions regarding SAML setup with Active Directory ADFS for setting the “Relying Party Trust Identifier” were corrected. Although the | settings will continue to work, it is encouraged that you | modify those settings. | |
| Disabled the xmlsec1-based SAML library in favor of the re-enabled and improved SAML library. |
@@ -1227,14 +1227,14 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
The Mattermost Desktop v4.3.0 release includes a change to how desktop notifications are sent sent from non-secure URLs http://. Organizations using non-secure Mattermost Servers http:// will need to update to Mattermost Server versions 5.16.0+, 5.15.1, 5.14.4 or 5.9.5 (ESR) to continue receiving desktop notifications when using Mattermost Desktop v4.3.0 or later. |
-| When enabling Guest Accounts, all users who have the ability to invite users will be able to | invite guests by default. System admins will need to remove this permission on each role via System Console > Permissions Schemes. In Mattermost Server | version 5.17, the system admin will be the only role to automatically get the invite guest permission, however the fix will not be applicable in 5.16 due to | database migration processes. | |
+When enabling Guest Accounts, all users who have the ability to invite users will be able to | invite guests by default. System admins will need to remove this permission on each role via System Console > Permissions Schemes. In Mattermost Server | version 5.17, the system admin will be the only role to automatically get the invite guest permission, however the fix will not be applicable in 5.16 due to | database migration processes. | |
| v5.14.0 |
Webhooks are now only displayed if the user is the creator of the webhook or a system administrator. |
-With the update from Google+ to Google People, system admins need to ensure the GoogleSettings.Scope config.json setting is set to profile email and | UserAPIEndpoint setting should be set to https://people.googleapis.com/v1/people/me?personFields=names,emailAddresses,nicknames,metadata per | updated documentation. | |
+With the update from Google+ to Google People, system admins need to ensure the GoogleSettings.Scope config.json setting is set to profile email and | UserAPIEndpoint setting should be set to https://people.googleapis.com/v1/people/me?personFields=names,emailAddresses,nicknames,metadata per | updated documentation. | |
| v5.12.0 |
@@ -1255,18 +1255,18 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
| v5.10.0 |
-SupportedTimezonesPath setting in config.json and changes to timezones in the UI based on the timezones.json file was removed. This was made to support | storing configurations in the database. | |
+SupportedTimezonesPath setting in config.json and changes to timezones in the UI based on the timezones.json file was removed. This was made to support | storing configurations in the database. | |
| v5.9.0 |
-If DisableLegacyMfa setting in config.json is set to true and | multi-factor authentication is enabled, ensure your users have upgraded to mobile app | version 1.17 or later. Otherwise, users who have MFA enabled may not be able to log in successfully. | | If the setting is not defined in the config.json file, the DisableLegacyMfa setting is set to false by default to ensure no breaking changes. | | We recommend setting DisableLegacyMfa to true for additional security hardening. | |
+If DisableLegacyMfa setting in config.json is set to true and | multi-factor authentication is enabled, ensure your users have upgraded to mobile app | version 1.17 or later. Otherwise, users who have MFA enabled may not be able to log in successfully. | | If the setting is not defined in the config.json file, the DisableLegacyMfa setting is set to false by default to ensure no breaking changes. | | We recommend setting DisableLegacyMfa to true for additional security hardening. | |
-| The public IP of the Mattermost application server is considered a reserved IP for additional security hardening in the context of untrusted external requests | such as Open Graph metadata, webhooks, or slash commands. | See documentation for additional information. | |
+The public IP of the Mattermost application server is considered a reserved IP for additional security hardening in the context of untrusted external requests | such as Open Graph metadata, webhooks, or slash commands. | See documentation for additional information. | |
| v5.8.0 |
-The local image proxy has been added, and images displayed within the client are now affected by the AllowUntrustedInternalConnections setting. | See documentation for more details if you have trouble loading images. | |
+The local image proxy has been added, and images displayed within the client are now affected by the AllowUntrustedInternalConnections setting. | See documentation for more details if you have trouble loading images. | |
| v5.6.0 |
@@ -1320,7 +1320,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
This release includes support for post messages longer than the default of 4000 characters, but may require a manual database migration. This migration is entirely optional, and need only be done if you want to enable post messages up to 16383 characters. For many installations, no migration will be required, or the old limit remains sufficient. To check your current post limit after upgrading to 5.0.0, look for a log message on startup: [2018/03/27 09:08:00 EDT] [INFO] Post.Message supports at most 16383 characters (65535 bytes)
As of 5.0.0, the maximum post message size is 16383 (multi-byte) characters. If your logs show a number less than this limit and you want to enable longer post messages, you will need to manually migrate your database as described below. This migration can be slow for larger Posts tables, so it's best to schedule this upgrade during off-peak hours. To migrate a MySQL database, connect to your database and run the following: ALTER TABLE Posts MODIFY COLUMN Message TEXT;
To migrate a PostgreSQL database, connect to your database and run the following: ALTER TABLE Posts ALTER COLUMN Message TYPE VARCHAR(65535);
Restart your Mattermost instances. |
-Deployments on Enterprise E20 will need to enable RunJobs in the config.json and allow the permissions migration to complete before using Team | Override Schemes. | |
+Deployments on Enterprise E20 will need to enable RunJobs in the config.json and allow the permissions migration to complete before using Team | Override Schemes. | |
| v4.10.0 |
@@ -1349,11 +1349,11 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
The behavior of the config.json setting PostEditTimeLimit has been updated to accommodate the migration to a roles based permission system. When post editing is permitted, set "PostEditTimeLimit": -1 to allow editing anytime, or set "PostEditTimeLimit" to a positive integer to restrict editing time in seconds. If post editing is disabled, this setting does not apply. |
-- If using Let's Encrypt without a proxy server, the server will fail to start with an error message unless the Forward80To443 |
config.json setting is set to true.
If forwarding port 80 to 443, the server will fail to start with an error message unless the ListenAddress | config.json setting is set to listen on port 443. | |
+- If using Let's Encrypt without a proxy server, the server will fail to start with an error message unless the Forward80To443 |
config.json setting is set to true.
If forwarding port 80 to 443, the server will fail to start with an error message unless the ListenAddress | config.json setting is set to listen on port 443. | |
| v4.6.2 |
-If using Let's Encrypt without a proxy server, forward port 80 through a firewall, with the Forward80To443 | config.json setting set to true to complete the Let's Encrypt certification. | |
+If using Let's Encrypt without a proxy server, forward port 80 through a firewall, with the Forward80To443 | config.json setting set to true to complete the Let's Encrypt certification. | |
| v4.4.0 |
@@ -1367,7 +1367,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
Mattermost now handles multiple content types for integrations, including plaintext content type. If your integration suddenly prints the JSON payload data instead of rendering the generated message, make sure your integration is returning the application/json content-type to retain previous behavior. |
-| By default, user-supplied URLs such as those used for Open Graph metadata, webhooks, or slash commands will no longer be allowed to connect to reserved IP | addresses including loopback or link-local addresses used for internal networks. | | This change may cause private integrations to break in testing environments, which may point to a URL such as http://127.0.0.1:1021/my-command. | | If you point private integrations to such URLs, you may whitelist such domains, IP addresses, or CIDR notations via the | Allowed Untrusted Internal Connections | configuration setting in your local environment. Although not recommended, you may also whitelist the addresses in your production environments. See | documentation to learn more. | | Push notification, OAuth 2.0 and WebRTC server URLs are trusted and not affected by this setting. | |
+By default, user-supplied URLs such as those used for Open Graph metadata, webhooks, or slash commands will no longer be allowed to connect to reserved IP | addresses including loopback or link-local addresses used for internal networks. | | This change may cause private integrations to break in testing environments, which may point to a URL such as http://127.0.0.1:1021/my-command. | | If you point private integrations to such URLs, you may whitelist such domains, IP addresses, or CIDR notations via the | Allowed Untrusted Internal Connections | configuration setting in your local environment. Although not recommended, you may also whitelist the addresses in your production environments. See | documentation to learn more. | | Push notification, OAuth 2.0 and WebRTC server URLs are trusted and not affected by this setting. | |
Uploaded file attachments are now grouped by day and stored in /data/<date-of-upload-as-YYYYMMDD>/teams/... of your file storage system. |
@@ -1391,7 +1391,7 @@ DELETE FROM threadmemberships WHERE (postid, userid) IN (
You need to verify settings in the System Console due to a security-related change. - Go to the the GENERAL section of the System Console
- Click Logging
- Make sure that the File Log Directory field is either empty or has a directory path only. It must not have a filename as part of the path.
|
-| Backwards compatibility with the old CLI tool was removed. If you have any scripts that rely on the old CLI, they must be revised to use the | new CLI. | |
+Backwards compatibility with the old CLI tool was removed. If you have any scripts that rely on the old CLI, they must be revised to use the | new CLI. | |
| v3.6.0 |
diff --git a/docs/main/administration-guide/upgrade/upgrade-v11.mdx b/docs/main/administration-guide/upgrade/upgrade-v11.mdx
deleted file mode 100644
index ca543e1996d8..000000000000
--- a/docs/main/administration-guide/upgrade/upgrade-v11.mdx
+++ /dev/null
@@ -1,43 +0,0 @@
----
-title: Upgrade Guide v11
-sidebar_position: 20
-description: Operator-facing upgrade procedure for moving a Mattermost cluster to v11.
-slug: /upgrade-guide/upgrade-v11
----
-
-
-
-
-# Upgrade Guide v11
-
-Per-major-version upgrade guides give operators a single canonical procedure for moving a Mattermost cluster to that major version. This page focuses on the operator runbook; see the [v11 Changelog](../../product-overview/mattermost-v11-changelog.mdx) for commit-level release notes.
-
-URL convention: `/upgrade-guide/upgrade-v{X.Y}/` (Grafana pattern). Predictable, deep-linkable, per-version.
-
-:::note Status
-This page is a stub seeded by the IA redesign Phase 1 (see `docs/_redesign/proposed-ia.md` §6 in the repo). Content authored by the release-management + technical-writing team.
-:::
-
-## Before you upgrade
-
-- Confirm the source version is within the supported upgrade matrix. See [Important Upgrade Notes](/administration-guide/upgrade/important-upgrade-notes) for non-sequential upgrade paths.
-- Read [Prepare to Upgrade Mattermost](./prepare-to-upgrade-mattermost.mdx).
-- For air-gapped deployments, stage the v11 release artifacts following [Air-Gapped Quick-Start Runbook](../../deployment-guide/air-gapped-operations/quick-start-runbook) steps 1–3.
-
-## Procedure
-
-*Per-release, version-specific procedure authored by release-management team.*
-
-## Validation
-
-*Post-upgrade verification checklist.*
-
-## Rollback
-
-*Documented rollback procedure for this version, if any. See [Downgrading Mattermost Server](./downgrading-mattermost-server.mdx) for cross-version downgrade guidance.*
-
-## Related
-
-- [v11 Changelog](../../product-overview/mattermost-v11-changelog.mdx) — commit-level release notes.
-- [Important Upgrade Notes](/administration-guide/upgrade/important-upgrade-notes) — version-by-version notes for non-sequential upgrades.
-- [Upgrading Mattermost Server](./upgrading-mattermost-server.mdx) — general upgrade procedure (cross-version).
diff --git a/docs/main/deployment-guide/air-gapped-operations/disable-phone-home-features.mdx b/docs/main/deployment-guide/air-gapped-operations/disable-phone-home-features.mdx
index 3d6fcf8cd013..e71c19b1cb3b 100644
--- a/docs/main/deployment-guide/air-gapped-operations/disable-phone-home-features.mdx
+++ b/docs/main/deployment-guide/air-gapped-operations/disable-phone-home-features.mdx
@@ -1,90 +1,36 @@
---
-title: Disable Phone-Home Features
-sidebar_position: 4
-description: Complete inventory of outbound network calls Mattermost makes, and the settings to disable each one for air-gapped operation.
+title: Configure for Air-Gapped Operation
+sidebar_position: 3
+description: Server settings that depend on internet access and should be disabled or adjusted for an air-gapped deployment.
---
-# Disable Phone-Home Features
+# Configure for Air-Gapped Operation
-Mattermost makes a small set of outbound network calls during normal operation. In an air-gapped enclave these calls fail silently — they do not affect functionality, but they pollute egress logs and may trigger boundary alerts. Disable each one explicitly so the cluster makes **zero** unexpected outbound connections.
+After successful deployment, you'll need to configure Mattermost for air-gapped operation. The following sections describe features that rely on internet access and offer recommendations for settings.
-This page is the **single canonical inventory** of phone-home behavior. Every outbound call Mattermost initiates from the server process is listed below with its purpose, target, and the setting that disables it.
+## Mobile push notifications
-:::important Use this list as a checklist
-Run through every row of the table below as a Day-1 task. After the cluster is up, packet-capture at the enclave boundary should show no outbound connections to any of the targets listed.
-:::
+Mattermost can use mobile push notifications to notify users of new messages and activity. These notifications require a server component to be deployed to send the notifications to mobile devices. By default, Mattermost uses the public push notification service, which isn't available in an air-gapped environment. We recommend disabling push notifications in **System Console > Environment > [Push Notification Server](/administration-guide/configure/environment-configuration-settings#push-notification-server)**.
-## Outbound call inventory
+## Email
-| Feature | Outbound target | Disable in `config.json` |
-|---|---|---|
-| Anonymous diagnostics telemetry | `telemetry.mattermost.com` | `LogSettings.EnableDiagnostics = false` |
-| Security update notifications | `security.mattermost.com` | `ServiceSettings.EnableSecurityFixAlert = false` |
-| Plugin Marketplace catalog | `api.integrations.mattermost.com` | `PluginSettings.EnableMarketplace = false` |
-| Automated license utilization reporting | `customers.mattermost.com` | `ServiceSettings.EnableLicenseReporting = false` *(see [Offline License Activation](./offline-license-activation))* |
-| In-product version check | `releases.mattermost.com` | `ServiceSettings.EnableLatestVersionCheck = false` |
-| In-product notices feed | `notices.mattermost.com` | `AnnouncementSettings.AdminNoticesEnabled = false` and `AnnouncementSettings.UserNoticesEnabled = false` |
-| Image proxy for inline images | varies (per-image origin) | `ImageProxySettings.Enable = false` *(in air-gapped mode, inline images from external URLs are blocked at the network layer anyway)* |
-| Outbound webhooks / slash commands | per-integration URL | Disable individual integrations in **System Console → Integrations** |
-| Apple Push Notification Service (APNs) | `api.push.apple.com` | Use mediated push proxy — *Push Notifications without Direct APNs / FCM Egress* (Phase 2) |
-| Google Firebase Cloud Messaging (FCM) | `fcm.googleapis.com` | Use mediated push proxy — Phase 2 |
-| Bleve search index download (first start) | `releases.mattermost.com` | Pre-stage Bleve index on internal mirror; see [Mirror Package Repositories](./mirror-package-repositories) |
-| Plugin install from URL | per-plugin URL | Plugins must be installed via `mmctl plugin add` from local file system; do not use URL install |
+Unless you've set up an internal air-gapped email service, we recommend disabling email invitations and email verification from **System Console > Authentication > Signup**.
-## Recommended `config.json` snippet
+## Website link previews
-```json
-{
- "ServiceSettings": {
- "EnableSecurityFixAlert": false,
- "EnableLicenseReporting": false,
- "EnableLatestVersionCheck": false
- },
- "LogSettings": {
- "EnableDiagnostics": false
- },
- "PluginSettings": {
- "EnableMarketplace": false
- },
- "AnnouncementSettings": {
- "AdminNoticesEnabled": false,
- "UserNoticesEnabled": false
- },
- "ImageProxySettings": {
- "Enable": false
- }
-}
-```
+Website link previews require a connection to the internet to fetch the content of the links. We recommend [disabling website link previews](/administration-guide/configure/site-configuration-settings#enable-website-link-previews) in **System Console > Site Configuration > Posts**.
-Apply this snippet via configuration management (Ansible, Salt, etc.) rather than editing `config.json` by hand. The Mattermost Operator (Kubernetes) accepts these settings via the `MattermostInstallation` CR's `mattermostConfig` field.
+## GIF picker
-## Cross-cutting concerns
+The GIF picker relies on a third-party service which has a dependency on external internet access. You can disable it in **System Console > Integrations > GIF**.
-### What this does *not* disable
+## Notices
-These settings disable **Mattermost-initiated** outbound calls. They do **not** disable:
+[In-product notices](/administration-guide/manage/in-product-notices) require internet access to periodically inform administrators and end users of new product improvements, features, and releases. You can disable notices in **System Console > Site Configuration > Notices**.
-- **OS-level callbacks** (NTP, DNS, distribution-package updaters). Manage these via your OS hardening profile, not Mattermost configuration.
-- **User-initiated outbound calls** (link unfurling when a user pastes a public URL into a channel). Mattermost respects the enclave's network policy here — link unfurling will simply fail.
-- **Plugin-initiated outbound calls**. Each plugin has its own outbound behavior. Audit each plugin you install. The Mattermost Calls plugin in particular requires careful egress configuration; see [Calls Deployment](/administration-guide/configure/calls-deployment-guide).
+## Telemetry
-### Verification
-
-After applying the snippet and restarting Mattermost:
-
-1. Tail the server log for one hour during steady-state traffic.
-2. Grep the log for any of the disabled targets:
- ```
- grep -E '(telemetry|security|releases|notices|customers|api.integrations)\.mattermost\.com' mattermost.log
- ```
- Expected output: **none**.
-3. Run a packet capture at the enclave boundary for one hour. Confirm zero connections to any row of the table above.
-
-If any outbound call is observed despite the settings being applied, file a security issue at `security@mattermost.com`. In an air-gapped enclave, you may need to send this out-of-band via your security liaison.
-
-## Reference
-
-This page consolidates phone-home behavior previously scattered across multiple admin configuration pages. The canonical home for this inventory is here under Air-Gapped Operations because the Air-Gapped Operator persona (`docs/_redesign/personas.md` §4 in the repo) is the primary consumer.
+To avoid log errors, we recommend disabling [telemetry-related features](/administration-guide/manage/telemetry), including the security update check, and error and diagnostics reporting features.
diff --git a/docs/main/deployment-guide/air-gapped-operations/index.mdx b/docs/main/deployment-guide/air-gapped-operations/index.mdx
index 48128ee9db07..03b19b4c49b5 100644
--- a/docs/main/deployment-guide/air-gapped-operations/index.mdx
+++ b/docs/main/deployment-guide/air-gapped-operations/index.mdx
@@ -1,34 +1,26 @@
---
title: Air-Gapped Operations
sidebar_position: 5
-description: Deploy and operate Mattermost in network-isolated enclaves — air-gapped, sovereign-cloud, and tactical-edge environments.
+description: Deploy and operate Mattermost in a self-hosted air-gapped environment with no direct internet access.
---
-
-
+
+
# Air-Gapped Operations
-This section is for operators deploying Mattermost in **network-isolated enclaves** — environments with no egress to public networks, no DNS to public resolvers, no upstream package mirrors, and no telemetry. Typical contexts: DoD SIPRNet / JWICS, IL4 / IL5 enclaves, sovereign-cloud (AWS GovCloud, Azure Government), and forward-deployed tactical edges with DDIL (Disconnected, Intermittent, Limited bandwidth) connectivity.
+An air-gapped environment is one that's isolated from the public internet, requiring all necessary components to be available locally. This section outlines what you'll need to deploy and operate Mattermost in a self-hosted air-gapped environment — preparation, deployment guidance, and the configuration changes required for a successful deployment.
-Mattermost runs fully in air-gapped mode. The procedure differs from a connected install in five ways: package mirroring, offline license activation, disabling phone-home features, push-notification mediation, and audit-log export topology. Each is documented below.
+Deploying Mattermost in an air-gapped environment requires preparing all necessary software, container images, and configuration resources in advance, since the target system has no direct internet access; transferring these artifacts to the isolated network using secure media; and then installing, configuring, and validating the deployment within the air-gapped environment.
-:::note Persona scope
-This sub-tree is the canonical home for the **Air-Gapped Operator** persona (see `docs/_redesign/personas.md` §4 in the repo). Companion pages for **Security Architects** live under Security & Compliance; compliance machinery for **Compliance Officers** lives under Administration Guide → Comply.
-:::
+
-## In this section
-
-- [Quick-Start Runbook](/deployment-guide/air-gapped-operations/quick-start-runbook) — 12-step procedure to stand up a working air-gapped Mattermost cluster from scratch.
-- [Mirror Package Repositories](/deployment-guide/air-gapped-operations/mirror-package-repositories) — internal Linux package + container registry topology and trust setup.
-- [Offline License Activation](/deployment-guide/air-gapped-operations/offline-license-activation) — activate Enterprise / Enterprise Advanced licenses without phoning home to `mattermost.com`.
-- [Disable Phone-Home Features](/deployment-guide/air-gapped-operations/disable-phone-home-features) — inventory of every outbound network call Mattermost makes and how to disable it in air-gapped mode.
+Consider [talking to a Mattermost expert](https://mattermost.com/contact-sales/) if your organization needs support deploying Mattermost and supporting services in an air-gapped environment.
-## Roadmap (Phase 2)
+
-Phase 2 of the IA redesign (see `docs/_redesign/proposed-ia.md` §6 in the repo) adds four more pages:
+## In this section
-- Push Notifications without Direct APNs / FCM Egress
-- Air-Gapped Upgrade Procedure
-- Audit Log Export to Air-Gapped SIEM
-- Tactical Edge / DDIL Operations
+- [Deployment Overview](/deployment-guide/air-gapped-operations/quick-start-runbook) — the high-level steps to prepare for and complete an air-gapped install.
+- [Bill of Materials and Registry Mirroring](/deployment-guide/air-gapped-operations/mirror-package-repositories) — what to gather before you cross the air gap, and how to set up a private package mirror or container registry.
+- [Configure for Air-Gapped Operation](/deployment-guide/air-gapped-operations/disable-phone-home-features) — server settings that depend on internet access and should be disabled or adjusted.
diff --git a/docs/main/deployment-guide/air-gapped-operations/mirror-package-repositories.mdx b/docs/main/deployment-guide/air-gapped-operations/mirror-package-repositories.mdx
index 2b999ca06fb5..72ec74556a5d 100644
--- a/docs/main/deployment-guide/air-gapped-operations/mirror-package-repositories.mdx
+++ b/docs/main/deployment-guide/air-gapped-operations/mirror-package-repositories.mdx
@@ -1,66 +1,375 @@
---
-title: Mirror Package Repositories
+title: Bill of Materials and Registry Mirroring
sidebar_position: 2
-description: Stand up internal Linux package mirrors and container registries that host Mattermost artifacts inside the enclave.
+description: Gather the packages, images, and certificates you need before crossing the air gap, and set up a private registry or package mirror.
---
+import Tabs from '@theme/Tabs';
+
-# Mirror Package Repositories
+# Bill of Materials and Registry Mirroring
+
+On an internet-connected machine, you must gather all required packages, container images, and dependencies needed for the installation process. The resources you'll need will depend on your deployment method.
+
+## Bill of materials
+
+
+
+
+Using our provided tarball is recommended as the simplest installation method for air-gapped environments. You can install the Mattermost Server in a few minutes on any air-gapped 64-bit Linux system.
+
+**Prerequisites**
+
+- [Mattermost tarball](/product-overview/version-archive). We recommend using the latest [ESR](/product-overview/release-policy#extended-support-releases) for extended support where server upgrades may be infrequent.
+- Database: PostgreSQL [installation packages](https://www.postgresql.org/download/) or container images for your Linux distribution.
+- File Storage: Local filesystem storage is sufficient for deployments under 2,000 users. For larger deployments requiring high availability, we recommend using an S3-compatible object storage solution or an NFS (Network File System) server for shared storage needs.
+- Load balancer: If you already have a load balancer running in your air-gapped environment you can skip this resource, otherwise we recommend deploying [NGINX](/deployment-guide/server/setup-nginx-proxy) from these [Linux packages](https://nginx.org/en/linux_packages.html).
+- Desktop app: Download the [required package](https://github.com/mattermost/desktop/releases) based on your deployment method.
+
+**(Optional) Supporting services**
+
+Consider downloading these additional resources if you plan to enable these optional components:
+
+- [Mattermost Calls](/administration-guide/configure/calls-deployment-guide): [mattermost-calls-offloader](https://github.com/mattermost/calls-offloader/releases) (required for recording, transcription, and live captions) and [mattermost-rtcd](https://github.com/mattermost/rtcd/releases) (required for performance and scalability).
+- [Elasticsearch](https://www.elastic.co/downloads/elasticsearch) can be [deployed](https://www.elastic.co/docs/deploy-manage/deploy/self-managed/installing-elasticsearch) for enhanced search performance at scale.
+- [Prometheus](https://prometheus.io/download/) and [Grafana](https://grafana.com/grafana/download) for monitoring and observability.
+
+
+
+
+Kubernetes is recommended for a highly scalable and robust deployment if your organization is already running a Kubernetes cluster in the air-gapped environment.
+
+**Prerequisites**
+
+- [Mattermost Operator](https://github.com/mattermost/mattermost-helm/tree/master/charts/mattermost-operator) and [values](https://github.com/mattermost/mattermost-helm/blob/master/charts/mattermost-operator/values.yaml).
+- Database: We recommend options such as the [Postgres Operator](https://access.crunchydata.com/documentation/postgres-operator/latest/quickstart) from Crunchy Data, [CloudNativePG](https://cloudnative-pg.io/documentation/1.27/installation_upgrade/), or [pgEdge](https://github.com/pgEdge/pgedge-helm).
+- File Storage: We recommend using an S3-compatible storage service or a mounted NFS volume for shared storage needs.
+- Load balancer: If you already have a load balancer running in your air-gapped environment you can skip this resource, otherwise we recommend deploying [NGINX](/deployment-guide/server/setup-nginx-proxy), using the [NGINX Ingress Controller operator](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-operator/).
+- Desktop app: Download the [required package](https://github.com/mattermost/desktop/releases) based on your deployment method.
+
+**(Optional) Supporting services**
+
+Consider downloading these additional resources if you plan to enable these optional components:
+
+- [Mattermost Calls](/administration-guide/configure/calls-deployment-guide) helm charts: [mattermost-calls-offloader](https://github.com/mattermost/mattermost-helm/tree/master/charts/mattermost-calls-offloader) and [values](https://github.com/mattermost/mattermost-helm/blob/master/charts/mattermost-calls-offloader/values.yaml) (required for recording, transcription, and live captions), [mattermost-rtcd](https://github.com/mattermost/mattermost-helm/tree/master/charts/mattermost-rtcd) and [values](https://github.com/mattermost/mattermost-helm/blob/master/charts/mattermost-rtcd/values.yaml) (required for performance and scalability).
+- [Elasticsearch](https://www.elastic.co/docs/deploy-manage/deploy/cloud-on-k8s) can be [deployed in air-gapped k8s environments](https://www.elastic.co/guide/en/cloud-on-k8s/2.8/k8s-air-gapped.html) for enhanced search performance at scale.
+- [Prometheus](https://github.com/prometheus-operator/prometheus-operator) and [Grafana](https://github.com/grafana/grafana-operator) operators for monitoring and observability.
+
+
+
+
+Docker can be used if you don't have a running Kubernetes cluster in the air-gapped environment, but want to use containers for simplified installation and dependency management. Docker is not recommended for production environments at high scale, as it doesn't support clustered deployments or High Availability (HA) configurations out-of-the-box.
+
+**Prerequisites**
+
+- [Mattermost Enterprise Edition](https://hub.docker.com/r/mattermost/mattermost-enterprise-edition) image.
+- Database: [PostgreSQL](https://hub.docker.com/_/postgres) image.
+- Load balancer: If you already have a load balancer running in your air-gapped environment you can skip this resource, otherwise we recommend deploying [NGINX](/deployment-guide/server/setup-nginx-proxy) from these [images](https://hub.docker.com/_/nginx).
+- Desktop app: Download the [required package](https://github.com/mattermost/desktop/releases) based on your deployment method.
+
+**(Optional) Supporting services**
+
+Consider downloading these additional resources if you plan to enable these optional components:
+
+- [Mattermost Calls](/administration-guide/configure/calls-deployment-guide) images: [calls-offloader](https://hub.docker.com/r/mattermost/calls-offloader) (required for recording, transcription, and live captions) and [rtcd](https://hub.docker.com/r/mattermost/rtcd) (required for performance and scalability).
+- [Elasticsearch](https://hub.docker.com/_/elasticsearch) image for enhanced search performance at scale.
+- [Prometheus](https://hub.docker.com/r/prom/prometheus) and [Grafana](https://hub.docker.com/r/grafana/grafana) images for monitoring and observability.
+
+
+
+
+## Mattermost plugins
+
+Mattermost includes a number of [pre-built integrations](/integrations-guide/popular-integrations) for mission-critical tools. If you'd like to use any plugins beyond those that are pre-built in the Mattermost package, you'll need to download the plugin binaries from the [Mattermost Marketplace](https://mattermost.com/marketplace/). Once you have Mattermost deployed, these plugin binaries can be uploaded directly in the System Console.
+
+## SSL/TLS certificates and keys
+
+If your deployment requires SSL, ensure you have the necessary certificates. This includes certificates and keys for enabling HTTPS with Mattermost, as well as any CA files or certificates needed to access internal services such as LDAP or SAML. See [Setup TLS](/deployment-guide/server/setup-tls) for configuration details.
+
+## Set up a private registry or mirror
+
+A private container registry securely stores the Docker images necessary for air-gapped deployments, ensuring compliance with data isolation requirements. Similarly, a private package mirror stores operating system packages necessary for air-gapped deployments in Ubuntu or RHEL/CentOS Linux environments. Setting up a local registry or mirror is a critical step in deploying Mattermost to ensure all images, dependencies, and packages are available to you in the air-gapped environment. The steps below outline the process required to set up a local registry or mirror, depending on the deployment method you are using. These steps are a rough guide, and can be supplemented with online resources depending on your specific deployment needs.
+
+
+
+
+**(Ubuntu) Set up a private Debian package mirror**
+
+We will use Aptly to create a local mirror, although you can also use other options such as debmirror.
+
+1. **Install Aptly** (on an internet-connected machine):
+
+ ```bash
+ apt-get update
+ apt-get install aptly gnupg
+ ```
+
+2. **Create a GPG key for signing packages**:
+
+ ```bash
+ gpg --gen-key
+ ```
+
+3. **Create a mirror configuration**:
+
+ ```bash
+ aptly mirror create -architectures=amd64 debian-bullseye http://deb.debian.org/debian bullseye main contrib non-free
+ ```
+
+4. **Update the mirror to download packages**:
+
+ ```bash
+ aptly mirror update debian-bullseye
+ ```
+
+5. **Create and publish a snapshot**:
+
+ ```bash
+ aptly snapshot create debian-bullseye-$(date +%Y%m%d) from mirror debian-bullseye
+ aptly publish snapshot debian-bullseye-$(date +%Y%m%d)
+ ```
+
+6. **Serve the repository**:
+
+ ```bash
+ aptly serve
+ ```
+
+7. **Client configuration:** Configure apt to use your local mirror:
+
+ ```bash
+ cat > /etc/apt/sources.list << EOF
+ deb http://mirror.example.com/debian bullseye main contrib non-free
+ EOF
+ ```
+
+**(RHEL/CentOS) Set up a private RHEL package mirror**
+
+We will use reposync for a local mirror.
+
+1. **Install required tools** (on an internet-connected RHEL system):
+
+ ```bash
+ yum install yum-utils createrepo
+ ```
+
+2. **Download packages**:
+
+ ```bash
+ mkdir -p /var/www/html/repos/rhel8
+ reposync -p /var/www/html/repos/rhel8 --download-metadata --repo=rhel-8-for-x86_64-baseos-rpms
+ reposync -p /var/www/html/repos/rhel8 --download-metadata --repo=rhel-8-for-x86_64-appstream-rpms
+ ```
+
+3. **Create repository metadata**:
+
+ ```bash
+ createrepo /var/www/html/repos/rhel8/rhel-8-for-x86_64-baseos-rpms
+ createrepo /var/www/html/repos/rhel8/rhel-8-for-x86_64-appstream-rpms
+ ```
+
+4. **Set up a web server**:
+
+ ```bash
+ yum install httpd
+ systemctl enable httpd
+ systemctl start httpd
+ ```
+
+5. **Client configuration:** Disable existing repositories:
+
+ ```bash
+ cd /etc/yum.repos.d/
+ mkdir backup
+ mv *.repo backup/
+ ```
+
+6. **Client configuration:** Create new repository files:
+
+ ```bash
+ cat > /etc/yum.repos.d/local-baseos.repo << EOF
+ [local-baseos]
+ name=Red Hat Enterprise Linux 8 BaseOS
+ baseurl=http://mirror.example.com/repos/rhel8/rhel-8-for-x86_64-baseos-rpms
+ enabled=1
+ gpgcheck=0
+ EOF
+
+ cat > /etc/yum.repos.d/local-appstream.repo << EOF
+ [local-appstream]
+ name=Red Hat Enterprise Linux 8 AppStream
+ baseurl=http://mirror.example.com/repos/rhel8/rhel-8-for-x86_64-appstream-rpms
+ enabled=1
+ gpgcheck=0
+ EOF
+ ```
+
+7. **Client configuration:** Clear cache and test:
+
+ ```bash
+ yum clean all
+ yum repolist
+ ```
+
+
+
+
+**Set up a self-hosted private container registry**
+
+1. **Install Docker Registry**:
+
+ ```bash
+ docker run -d -p 5000:5000 --restart=always --name registry registry:2
+ ```
+
+2. **Configure persistent storage**:
+
+ ```bash
+ docker run -d -p 5000:5000 --restart=always --name registry \
+ -v /mnt/registry:/var/lib/registry \
+ registry:2
+ ```
+
+3. **Add TLS security** (recommended):
+
+ a. Generate self-signed certificates:
+
+ ```bash
+ mkdir -p certs
+ openssl req -newkey rsa:4096 -nodes -sha256 -keyout certs/domain.key \
+ -x509 -days 365 -out certs/domain.crt
+ ```
+
+ b. Run the registry with TLS:
+
+ ```bash
+ docker run -d -p 5000:5000 --restart=always --name registry \
+ -v /mnt/registry:/var/lib/registry \
+ -v $(pwd)/certs:/certs \
+ -e REGISTRY_HTTP_TLS_CERTIFICATE=/certs/domain.crt \
+ -e REGISTRY_HTTP_TLS_KEY=/certs/domain.key \
+ registry:2
+ ```
+
+**Configure Kubernetes to use private image registries**
+
+When using Kubernetes in an air-gapped environment, you need to configure it to use your private registry.
+
+1. **Create a Kubernetes secret for registry authentication**:
+
+ ```bash
+ kubectl create secret docker-registry regcred \
+ --docker-server=registry.example.com:5000 \
+ --docker-username=your_username \
+ --docker-password=your_password \
+ --docker-email=your_email@example.com
+ ```
+
+2. **Reference the secret in pod specifications**:
+
+ ```yaml
+ apiVersion: v1
+ kind: Pod
+ metadata:
+ name: mattermost-pod
+ spec:
+ containers:
+ - name: mattermost
+ image: registry.example.com:5000/mattermost/mattermost-enterprise-edition:latest
+ imagePullSecrets:
+ - name: regcred
+ ```
+
+3. **For Helm deployments**, specify the registry in `values.yaml`:
+
+ ```yaml
+ image:
+ repository: registry.example.com:5000/mattermost/mattermost-enterprise-edition
+ tag: latest
+ pullPolicy: IfNotPresent
+
+ imagePullSecrets:
+ - name: regcred
+ ```
+
+
+
+
+**Set up a self-hosted private container registry**
+
+1. **Install Docker Registry**:
-In an air-gapped enclave, every package and container image Mattermost depends on must come from a mirror inside the enclave. There is no fall-through to upstream registries. This page enumerates the artifacts that need mirroring and the trust topology that ties them together.
+ ```bash
+ docker run -d -p 5000:5000 --restart=always --name registry registry:2
+ ```
-## What needs mirroring
+2. **Configure persistent storage**:
-### Linux distribution packages
+ ```bash
+ docker run -d -p 5000:5000 --restart=always --name registry \
+ -v /mnt/registry:/var/lib/registry \
+ registry:2
+ ```
-Mirror the upstream Linux package repositories for the OS image you run Mattermost on. Mattermost requires recent versions of `glibc`, `ca-certificates`, and (for plugins) `ImageMagick` and `xpdf-utils`. PostgreSQL is the only supported database for new installs.
+3. **Add TLS security** (recommended):
-- **Ubuntu / Debian**: mirror the upstream `apt` repos for the release you use (e.g., `noble`, `jammy`). Tools: `apt-mirror`, `aptly`, internal Pulp 3.
-- **RHEL / Rocky / Alma / SUSE**: mirror upstream `dnf` / `zypper` repos. Tools: `reposync`, Red Hat Satellite, Pulp.
+ a. Generate self-signed certificates:
-### Mattermost release artifacts
+ ```bash
+ mkdir -p certs
+ openssl req -newkey rsa:4096 -nodes -sha256 -keyout certs/domain.key \
+ -x509 -days 365 -out certs/domain.crt
+ ```
-Mattermost publishes three artifact families. Stage all three on your operator workstation, verify checksums and signatures, then transfer across the air gap.
+ b. Run the registry with TLS:
-| Artifact | Source | Verification |
-|---|---|---|
-| Server tarball (`mattermost-VERSION-linux-amd64.tar.gz`) | `releases.mattermost.com` | SHA-256 + PGP signature |
-| Container images (`mattermost/mattermost-enterprise-edition:VERSION`, `mattermost/mattermost-mobile-push-proxy:VERSION`) | Docker Hub | Image digest (`sha256:…`) |
-| Mattermost Operator Helm chart | `chartmuseum.mattermost.com` | SHA-256 of `.tgz` |
+ ```bash
+ docker run -d -p 5000:5000 --restart=always --name registry \
+ -v /mnt/registry:/var/lib/registry \
+ -v $(pwd)/certs:/certs \
+ -e REGISTRY_HTTP_TLS_CERTIFICATE=/certs/domain.crt \
+ -e REGISTRY_HTTP_TLS_KEY=/certs/domain.key \
+ registry:2
+ ```
-### Plugin and integration artifacts
+**Populate your private registry**
-Pre-built plugins ship as signed `.tar.gz` files from the Mattermost Marketplace. Stage the bundle of plugins you intend to install (e.g., Channel Export, Legal Hold, Calls, AI Agents) before the air-gap transfer.
+Ensure the required images from the [Bill of Materials](#bill-of-materials) are downloaded and pushed to the private registry.
-:::important
-The Mattermost Marketplace itself **cannot reach your enclave**. After air-gapped install, the Marketplace UI surface is disabled (see [Disable Phone-Home Features](./disable-phone-home-features)). Plugins are installed via `mmctl plugin add` from the local file system.
-:::
+**Configure Docker to use private image registries**
-## Internal container registry
+Configure Docker on all hosts to trust and use your private registry.
-For Kubernetes / container deployments, push the Mattermost container images to your internal registry (Harbor, Artifactory, Quay, GitLab Container Registry, AWS ECR inside GovCloud). Tag images with the same version strings you pulled upstream.
+1. **Add your registry to Docker's trusted registries**:
-Configure your Kubernetes cluster's `imagePullSecrets` to authenticate to the internal registry, and configure the Mattermost Operator Helm chart's `image.repository` value to point at the internal path (e.g., `registry.enclave.example/mattermost/mattermost-enterprise-edition`).
+ Edit or create `/etc/docker/daemon.json`:
-## Trust topology
+ ```json
+ {
+ "insecure-registries": ["registry.example.com:5000"]
+ }
+ ```
-The artifact-trust chain inside the enclave depends on:
+ For registries using self-signed certificates:
-1. **Your internal CA** signing the TLS certificate served by the internal package mirror and container registry.
-2. **The enclave OS trust store** including your internal CA. Without this, `apt update` / `dnf install` will fail with TLS errors.
-3. **A verified signature chain** for the Mattermost artifacts themselves. The enclave operator should verify checksums and PGP signatures *before* publishing to the internal mirror.
+ ```bash
+ mkdir -p /etc/docker/certs.d/registry.example.com:5000
+ cp domain.crt /etc/docker/certs.d/registry.example.com:5000/ca.crt
+ ```
-## Validation
+2. **Restart Docker daemon**:
-After mirroring is complete:
+ ```bash
+ systemctl restart docker
+ ```
-- `apt update` (or distribution equivalent) succeeds against only the internal mirror.
-- `docker pull registry.enclave.example/mattermost/mattermost-enterprise-edition:VERSION` succeeds.
-- `helm pull oci://registry.enclave.example/charts/mattermost-operator --version VERSION` succeeds.
-- Outbound traffic capture at the enclave boundary shows **no connections to `releases.mattermost.com`, `chartmuseum.mattermost.com`, or Docker Hub** during install.
+3. **Test the configuration**:
-## Reference
+ ```bash
+ docker pull registry.example.com:5000/mattermost/mattermost-enterprise-edition:latest
+ ```
-This page is a stub — Phase 2 will add per-distribution `apt-mirror` / `reposync` configuration examples and a Harbor + GovCloud ECR worked example. Tracked in `docs/_redesign/proposed-ia.md` §6 in the repo.
+
+
diff --git a/docs/main/deployment-guide/air-gapped-operations/offline-license-activation.mdx b/docs/main/deployment-guide/air-gapped-operations/offline-license-activation.mdx
deleted file mode 100644
index 528ec288e6b7..000000000000
--- a/docs/main/deployment-guide/air-gapped-operations/offline-license-activation.mdx
+++ /dev/null
@@ -1,64 +0,0 @@
----
-title: Offline License Activation
-sidebar_position: 3
-description: Activate Mattermost Enterprise or Enterprise Advanced licenses inside an enclave without phoning home.
----
-
-
-
-
-# Offline License Activation
-
-In a connected install, Mattermost activates Enterprise licenses by contacting `customers.mattermost.com` and validating the license signature against Mattermost's signing key. In an air-gapped enclave, that callback is impossible.
-
-Offline activation produces a **license file** that is signed by Mattermost's customer-success team and validated locally by the Mattermost server using a pre-installed public key. No network access is required at activation time.
-
-## Procedure
-
-1. **Open a license request with Mattermost Customer Success** through your standard support channel. Provide:
- - The Mattermost server version you'll install (e.g., `v10.5.0`).
- - The expected user count (must match your purchased seat count).
- - Your enclave's clock authority (so the license `IssuedAt` is sensible relative to your NTP source).
- - Whether the deployment requires the **FIPS-compliant container image** (see [FIPS / STIG container builds](../server/containers/fips-stig)).
-2. **Receive a signed `mattermost.license` file** out-of-band (typically encrypted email, customer portal download, or shipped on physical media for sovereign-cloud deployments).
-3. **Transfer the license across the air gap** using your approved transfer mechanism. Verify the file SHA-256 hash on both sides.
-4. **Install the license** on the running Mattermost server:
- ```
- mmctl license upload /path/to/mattermost.license
- ```
- Or via the System Console: **System Console → Edition and License → Upload Mattermost License File**.
-5. **Verify activation**:
- ```
- mmctl license status
- ```
- The output should list the licensee, expiration, and active feature set.
-
-## License lifecycle in air-gapped mode
-
-| Event | Connected install | Air-gapped install |
-|---|---|---|
-| Initial activation | Online callback to `customers.mattermost.com` | Local validation of pre-signed `.license` file |
-| Renewal | Automatic prompt 60 days before expiry | Manual: customer-success issues new file; operator re-uploads |
-| Automated utilization reporting | Daily POST to `customers.mattermost.com` | **Disabled** — Mattermost does not contact `customers.mattermost.com` from inside the enclave. Reporting is done manually at renewal. |
-
-:::important Automated license utilization reporting must be disabled
-The `EnableLicenseReporting` server setting must be set to `false` in `config.json`. Otherwise, Mattermost attempts (and silently fails) a daily POST to `customers.mattermost.com`. The failure does not affect functionality, but it pollutes egress logs and triggers boundary alerts. See [Disable Phone-Home Features](./disable-phone-home-features).
-:::
-
-## License signature verification
-
-Mattermost server ships with the public key used to verify license signatures embedded in the binary. There is no need to import or trust an additional key.
-
-If license validation fails after upload, the server logs an explicit error message. Common causes:
-
-- **Clock skew**: enclave clock is more than 5 minutes off from the license `IssuedAt`. Fix your NTP source.
-- **Version mismatch**: the license was issued for a different Mattermost major version than the one installed. Re-request from customer success.
-- **Tampering**: SHA-256 hash of the license file changed during air-gap transfer. Re-transfer.
-
-## Renewal cadence
-
-Mattermost Enterprise licenses are typically 12-month terms. In air-gapped mode, plan for license renewal **60 days before expiry** to allow time for customer-success issuance + air-gap transfer. Expired licenses degrade Mattermost to free-tier features; they do not lock the server.
-
-## Reference
-
-This page is a stub — Phase 2 will add a worked example for sovereign-cloud (GovCloud) deployments where the license file is delivered via the customer portal rather than out-of-band. Tracked in `docs/_redesign/proposed-ia.md` §6 in the repo.
diff --git a/docs/main/deployment-guide/air-gapped-operations/quick-start-runbook.mdx b/docs/main/deployment-guide/air-gapped-operations/quick-start-runbook.mdx
index ca37ddd4631f..a4c08d5f2031 100644
--- a/docs/main/deployment-guide/air-gapped-operations/quick-start-runbook.mdx
+++ b/docs/main/deployment-guide/air-gapped-operations/quick-start-runbook.mdx
@@ -1,53 +1,32 @@
---
-title: Quick-Start Runbook
+title: Deployment Overview
sidebar_position: 1
-description: 12-step procedure to stand up a working Mattermost cluster in an air-gapped enclave from scratch.
+description: The high-level steps to prepare for and complete a self-hosted air-gapped Mattermost deployment.
---
-
+
-# Air-Gapped Quick-Start Runbook
+# Air-Gapped Deployment Overview
-This runbook brings a Mattermost cluster online inside a network-isolated enclave. It assumes you are the **deploying operator** with administrative access to the enclave's package mirror, container registry, certificate authority, and DNS.
+This is a summary of the steps involved in deploying Mattermost in an air-gapped environment.
-:::important Prerequisites
-- An enclave with internal-only DNS, an internal package mirror (Linux distro repos), and an internal container registry (Harbor / Artifactory / equivalent).
-- An offline-activatable Enterprise or Enterprise Advanced license — see [Offline License Activation](./offline-license-activation).
-- A staged Mattermost Server release tarball + checksums verified out-of-band, and a Mattermost Operator Helm chart (Kubernetes) or Linux package (`.deb` / `.rpm`).
-- A PostgreSQL database reachable from the Mattermost host(s) inside the enclave.
-- An NTP source reachable from inside the enclave.
-:::
+1. **Select your preferred Mattermost deployment option.** This step is often dictated by the infrastructure already running in your air-gapped environment. If you're deploying from scratch, review our [server deployment documentation](/deployment-guide/server/server-deployment-planning#deployment-options) to select the optimal option given your organization's needs.
-## The 12 steps
+2. **Set up a private container registry or package mirror.** Ideally the air-gapped environment already has a private container registry or package mirror available. If not, see [Bill of Materials and Registry Mirroring](./mirror-package-repositories) for setup guidance.
-1. **Stage the release artifacts on the operator workstation.** Download the Mattermost Server tarball, container images, Helm chart, and Vale + plugin assets from `releases.mattermost.com` on an internet-connected workstation. Verify SHA-256 checksums and PGP signatures against the published list. *Never* let a non-verified artifact cross the air gap.
-2. **Transfer artifacts across the air gap.** Use the enclave's approved transfer mechanism (one-way diode, manual media, or cross-domain solution). Re-verify checksums on the enclave side before staging in the internal mirror.
-3. **Publish artifacts to the internal package mirror and container registry.** Mirror the Linux package repos (Ubuntu, RHEL, SLES — whichever your hosts use) and push container images (e.g., `mattermost/mattermost-enterprise-edition`, `mattermost/mattermost-mobile-push-proxy`) to the internal registry. Tag images with the same version strings published upstream.
-4. **Provision PostgreSQL.** Provision the database inside the enclave per [Reference Architecture](/deployment-guide/reference-architecture/reference-architecture-index). Set `max_connections`, `shared_buffers`, and `effective_cache_size` per the [scale tier](/deployment-guide/reference-architecture/reference-architecture-index) you're targeting.
-5. **Configure DNS and TLS inside the enclave.** Create an internal DNS A record for the Mattermost host (e.g., `mattermost.enclave.example`). Issue a TLS certificate from your internal CA. Configure NGINX or your reverse proxy with [TLS](../server/setup-tls.mdx).
-6. **Install the Mattermost binary.** Install on Linux ([deploy-linux](../server/deploy-linux.mdx)), Kubernetes via the Mattermost Operator ([deploy-kubernetes](../server/deploy-kubernetes.mdx)), or containers ([deploy-containers](../server/deploy-containers.mdx)). Point image references at your internal registry, not Docker Hub.
-7. **Apply the air-gapped configuration profile.** See [Disable Phone-Home Features](./disable-phone-home-features) for the complete list. At minimum, disable: `EnableDiagnostics`, `EnableSecurityFixAlert`, `EnableMarketplace`, automated license utilization reporting, image proxy, and the in-product version check.
-8. **Activate the license.** Apply the offline license file produced by the Customer Account team — see [Offline License Activation](./offline-license-activation).
-9. **Mediate push notifications.** Apple APNs and Google FCM are reachable only from internet-connected networks. Deploy a mediated push proxy at your enclave boundary; see *Push Notifications without Direct APNs / FCM Egress* (Phase 2).
-10. **Configure NTP.** Mattermost relies on accurate clocks for token validation, audit-log timestamps, and rate-limiting. Point hosts at the enclave's internal NTP source.
-12. **Verify and run smoke tests.** Confirm the cluster passes the [post-install verification checklist](../server/server-deployment-planning.mdx). Run a manual smoke: log in as system admin, create a team, send a message, install one bundled plugin, trigger an audit-log export.
+3. **Prepare your Bill of Materials.** Depending on your deployment method, you'll need to download, tag, and push required materials into your private registry or mirror.
-## Validation
+4. **Transfer materials into the air-gapped environment.** If the private registry cannot access the public internet, you can prepare an archive of the registry data on your internet-connected machine and securely transfer it using approved data transfer methods — for example, burning to a disk.
-After completing all 12 steps, your air-gapped cluster should:
+5. **Install Mattermost Server.** Once you have all the necessary resources in your air-gapped environment, you can move forward with deployment following the instructions for [Linux](/deployment-guide/server/deploy-linux), [Kubernetes](/deployment-guide/server/deploy-kubernetes), or [Docker](/deployment-guide/server/deploy-containers).
-- Reach the in-product login page over TLS from inside the enclave.
-- Authenticate users against your internal directory (AD/LDAP, SAML, OIDC) — no public IdP.
-- Make **no outbound DNS queries to public resolvers** during steady-state operation. Verify with packet capture at the enclave boundary.
-- Show no "Mattermost installation telemetry" or "Marketplace pings" in egress logs.
+6. **Install Mattermost Desktop Apps.** Since air-gapped devices cannot access the publicly available app stores, you'll need to install the apps directly from the latest [packages available on our GitHub release page](https://github.com/mattermost/desktop/releases). You'll find [installation instructions](/deployment-guide/desktop/desktop-app-deployment) in our documentation based on your desired deployment method.
-## What this runbook does *not* cover
+7. **Configure Mattermost for air-gapped operation.** See [Configure for Air-Gapped Operation](./disable-phone-home-features) for the settings that accommodate the lack of internet access.
-- **Hardening beyond the install procedure** — see [Security & Compliance → Hardening Guides](../../security-guide/security-guide-index.mdx).
-- **Upgrade procedure for an already-installed air-gapped cluster** — see *Air-Gapped Upgrade Procedure* (Phase 2).
-- **Tactical edge / DDIL operation** — for forward-deployed nodes that sync intermittently to a parent enclave, see *Tactical Edge / DDIL Operations* (Phase 2).
+
-## Reference
+Consider [talking to a Mattermost expert](https://mattermost.com/contact-sales/) if your organization needs support deploying Mattermost and supporting services in an air-gapped environment.
-This runbook is modelled on GitLab's [Offline GitLab Quick Start Guide](https://docs.gitlab.com/topics/offline/quick_start_guide/) and Red Hat OpenShift's [Disconnected installation chapter](https://docs.okd.io/4.18/installing/disconnected_install/index.html). Both treat air-gapped deployment as a first-class, runbook-shaped operation rather than a "contact sales" stub.
+
diff --git a/docs/main/deployment-guide/deployment-architecture.mdx b/docs/main/deployment-guide/deployment-architecture.mdx
index 72bb59307da5..604cb06fb761 100644
--- a/docs/main/deployment-guide/deployment-architecture.mdx
+++ b/docs/main/deployment-guide/deployment-architecture.mdx
@@ -20,8 +20,8 @@ Pick your scale tier, deployment type, and hosting provider. The builder below r
Once you've sized the architecture:
-- For **air-gapped, sovereign-cloud, or DDIL** environments, also work through [Air-Gapped Operations](/deployment-guide/air-gapped-operations/quick-start-runbook). The architecture is the same; the install procedure and dependency-staging are different.
-- For **regulated workloads** (FedRAMP, DoD IL, DISA STIG), see [Security & Compliance → Compliance Frameworks](/security-guide/compliance-frameworks) for the configuration overlay that goes on top of the architecture choices above.
+- For **air-gapped** environments, also work through [Air-Gapped Operations](/deployment-guide/air-gapped-operations/quick-start-runbook). The architecture is the same; the install procedure and dependency-staging are different.
+- For **regulated workloads** (DoD IL, DISA STIG), see [Security & Compliance → Compliance Frameworks](/security-guide/compliance-frameworks) for the configuration overlay that goes on top of the architecture choices above.
- For **HA tuning** (clustering, Redis configuration, multi-AZ database topology), see [High Availability cluster-based deployment](/administration-guide/scale/high-availability-cluster-based-deployment).
- For **specific install paths**, jump to [Install on Linux](/deployment-guide/server/deploy-linux), [Install on Kubernetes](/deployment-guide/server/deploy-kubernetes), or [Install with Containers](/deployment-guide/server/deploy-containers).
diff --git a/docs/main/deployment-guide/desktop/desktop-custom-dictionaries.mdx b/docs/main/deployment-guide/desktop/desktop-custom-dictionaries.mdx
index daf7d536bf88..5d84591843d0 100644
--- a/docs/main/deployment-guide/desktop/desktop-custom-dictionaries.mdx
+++ b/docs/main/deployment-guide/desktop/desktop-custom-dictionaries.mdx
@@ -1,6 +1,8 @@
---
title: "Desktop App custom dictionaries"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
From Mattermost desktop app v4.7.1, custom dictionary definitions can be served through a URL on Windows and Linux. If custom dictionaries aren't specified, default dictionary definitions are obtained automatically from Chromium's CDNs (content delivery networks). On macOS, the Mattermost desktop app uses dictionary definitions provided by Apple that can't be customized.
@@ -18,7 +20,7 @@ To access a copy of these dictionary definitions:
## Configure the Desktop App
-1. In the Mattermost Desktop App, go to Settings by selecting 
**\> File \> Settings**.
+1. In the Mattermost Desktop App, go to Settings by selecting })
**\> File \> Settings**.
2. Under **App Options**, ensure that the **Check spelling** option is enabled.
3. Select **Use an alternative dictionary URL** to specify the URL to the root folder of your custom dictionaries, then select **Save**.
diff --git a/docs/main/deployment-guide/desktop/linux-desktop-install.mdx b/docs/main/deployment-guide/desktop/linux-desktop-install.mdx
index 6a49f872dc76..a2fd552e06c7 100644
--- a/docs/main/deployment-guide/desktop/linux-desktop-install.mdx
+++ b/docs/main/deployment-guide/desktop/linux-desktop-install.mdx
@@ -1,6 +1,7 @@
---
title: "Install desktop app on Linux"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -51,7 +52,7 @@ A snap is available for systems that have Snapcraft installed. Snapcraft is inst
-You can review the current version of your desktop app by selecting the **More** icon located in the top left corner of the desktop app, then selecting **Help \> Version...**.
+You can review the current version of your desktop app by selecting the **More** icon located in the top left corner of the desktop app, then selecting **Help \> Version...**.
@@ -79,7 +80,7 @@ To manually update the desktop app, run the following command:
-You can review the current version of your desktop app by selecting the **More** icon located in the top left corner of the desktop app, then selecting **Help \> Version...**.
+You can review the current version of your desktop app by selecting the **More** icon located in the top left corner of the desktop app, then selecting **Help \> Version...**.
@@ -129,7 +130,7 @@ Flatpak packages are available for:
-You can review the current version of your desktop app by selecting the **More** icon located in the top left corner of the desktop app, then selecting **Help \> Version...**.
+You can review the current version of your desktop app by selecting the **More** icon located in the top left corner of the desktop app, then selecting **Help \> Version...**.
diff --git a/docs/main/deployment-guide/mobile/deploy-mobile-apps-using-emm-provider.mdx b/docs/main/deployment-guide/mobile/deploy-mobile-apps-using-emm-provider.mdx
index 1e17d914f1c6..d6000ea0f99a 100644
--- a/docs/main/deployment-guide/mobile/deploy-mobile-apps-using-emm-provider.mdx
+++ b/docs/main/deployment-guide/mobile/deploy-mobile-apps-using-emm-provider.mdx
@@ -1,6 +1,8 @@
---
title: "Deploy using an EMM provider"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
You can enhance mobile security by deploying the Mattermost mobile app with [Enterprise Mobility Management (EMM)](https://en.wikipedia.org/wiki/Enterprise_mobility_management) and Mattermost AppConfig compatibility to secure mobile endpoints with management application configuration.
@@ -67,85 +69,85 @@ The following table shows all the configuration options that can be sent from th
inAppPinCode
String |
Require users to authenticate as the device owner before using the app. Prompts for fingerprint or passcode when the app first opens and when the app has been in the background for more than five minutes. |
Default: false
Valid: true | false |
-  |
- |
+ }) |
+ |
blurApplicationScreen
String |
Blur the app when it's set to background to protect any confidential on-screen information. On Android, it also prevents taking screenshots of the app. |
Default: false
Valid: true | false |
- |
- |
+ |
+ |
jailbreakDetection
String |
Disable app launch on jailbroken or rooted devices. |
Default: false
Valid: true | false |
- |
- |
+ |
+ |
copyAndPasteProtection
String |
Disable the ability to copy from or paste into any text inputs in the app. |
Default: false
Valid: true | false |
- |
- (since v1.24.0) |
+ |
+ (since v1.24.0) |
serverUrl
String |
Set a default Mattermost server URL. Supports a single server only while v2.0 of the mobile app supports multiple server connections. |
Valid: URL |
- |
- |
+ |
+ |
serverName
String |
Automatically populates the server display name for the URL specified in serverURL. |
Valid: alphanumeric or empty |
- |
- |
+ |
+ |
allowOtherServers
String |
Allow the user to change the above server URL. If set to true, users can connect to multiple servers that aren't specified in the server URL setting. If set to false, users can only connect to a single defined server. |
Default: true
Valid: true | false |
- |
- |
+ |
+ |
username
String |
Set the username or email address to use to authenticate against the Mattermost Server. |
|
- |
- |
+ |
+ |
useVPN
String |
Enable connection to the Mattermost Server to use a per-app VPN or VPN on-demand. |
Default: false
Valid: true | false |
- |
+ |
|
timeoutVPN
String |
Set how long the request waits (in milliseconds) for an initial VPN connection to establish before timeout. |
Default: 30000 |
- |
+ |
|
vendor
String |
Name of the EMM vendor or company deploying the app. Used in help text when prompting for passcodes so users are aware why the app is being protected. |
Default: Mattermost |
- |
- |
+ |
+ |
inAppSessionAuth
String |
Use the app's internal browser for SSO instead of an external browser. From Mattermost v10.2 and mobile v2.2.1, deprecated in favor of the mobile external browser server configuration setting. |
Default: false
Valid: true | false |
- |
- |
+ |
+ |
diff --git a/docs/main/deployment-guide/mobile/mobile-troubleshooting.mdx b/docs/main/deployment-guide/mobile/mobile-troubleshooting.mdx
index 359fd58d5a66..cb20bfb6b3b4 100644
--- a/docs/main/deployment-guide/mobile/mobile-troubleshooting.mdx
+++ b/docs/main/deployment-guide/mobile/mobile-troubleshooting.mdx
@@ -1,6 +1,8 @@
---
title: "Mobile deployment troubleshooting"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
## I keep getting a message "Cannot connect to the server. Please check your server URL and internet connection."
@@ -103,19 +105,19 @@ Then use the following instructions to confirm push notifications are working pr
1. Log in to your mobile app with an account on your Mattermost Server, which we’ll refer to as “Account A”.
2. (iOS) When the app asks whether you wish to receive notifications, **confirm you want to receive notifications**.
-> 
+ })
3. Confirm push notifications are enabled for “Account A”.
-> 1. Go to the notification settings menu in the mobile app.
->
-> 
->
-> 2. Check that the mobile push notifications are set to send.
->
-> 
->
-> 
+ 1. Go to the notification settings menu in the mobile app.
+
+ })
+
+ 2. Check that the mobile push notifications are set to send.
+
+ })
+
+ })
4. Have “Account A” put the app to background or close the app.
5. Using a browser, log in to “Account B” on the same Mattermost Server.
diff --git a/docs/main/deployment-guide/reference-architecture/application-architecture.mdx b/docs/main/deployment-guide/reference-architecture/application-architecture.mdx
index 6ef6564de376..3975c01d6b96 100644
--- a/docs/main/deployment-guide/reference-architecture/application-architecture.mdx
+++ b/docs/main/deployment-guide/reference-architecture/application-architecture.mdx
@@ -1,9 +1,11 @@
---
title: "Application architecture"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
Mattermost is an open-source collaboration platform that offers secure messaging, file sharing, and integrations for team communication. It's self-hosted, providing IT admins full control over data, security, integrations, and customization. The platform is built with modular components to ensure scalability, flexibility, and extensibility.
-
+})
## Workflow overview
@@ -31,7 +33,7 @@ The Access Layer plays a critical role in ensuring that users are always connect
The Mattermost Server is the heart of the platform and responsible for processing all user and system operations. It's composed of multiple modular elements as follows:
-
+})
**RESTful JSON Web Service**: Handles all incoming API requests (from web clients, apps, and integrations) and ensures that responses are formatted in JSON. Acts as the communication bridge between the clients (Access Layer) and backend systems. To ensure high availability, this layer can be distributed across multiple servers and load-balanced, preventing service disruptions due to high traffic or server failure.
@@ -109,7 +111,7 @@ If a WSS connection is not available and HTTPS is substituted, the system will a
High availability for WSS connections can be achieved through clustering Mattermost servers and load balancing WebSocket connections across those cluster nodes. Proxy servers and WebSocket-specific configurations (such as sticky sessions or connection persistence) are essential to maintain real-time interactivity during server or network failures.
-
+})
By incorporating high availability strategies into communication protocols, the platform ensures secure, scalable, and reliable connections for both regular user interactions (via HTTPS) and real-time updates (via WSS). These measures are critical for mission-critical environments and distributed deployments where continuous communication is necessary.
diff --git a/docs/main/deployment-guide/reference-architecture/deployment-scenarios/deploy-oob.mdx b/docs/main/deployment-guide/reference-architecture/deployment-scenarios/deploy-oob.mdx
index 53d1a119bd22..c9439008fa3e 100644
--- a/docs/main/deployment-guide/reference-architecture/deployment-scenarios/deploy-oob.mdx
+++ b/docs/main/deployment-guide/reference-architecture/deployment-scenarios/deploy-oob.mdx
@@ -1,6 +1,8 @@
---
title: "Deploy for Out-of-Band (OOB) Communications"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
When a critical incident disrupts an organization’s primary infrastructure—due to a cyberattack, cloud outage, or internal failure—a secure, independent communication channel becomes essential. Mattermost can serve as that channel by operating in an Out-of-Band (OOB) environment: isolated, pre-provisioned, and ready to support incident response and business continuity teams.
This document outlines architectural guidance for deploying Mattermost in an OOB scenario across [generic](#generic-oob-architecture), [AWS](#aws-based-oob-deployment), and [Azure](#azure-based-oob-deployment) environments.
@@ -9,7 +11,7 @@ This document outlines architectural guidance for deploying Mattermost in an OOB
This platform-agnostic design establishes a fallback communication system, decoupled from primary networks and identity providers.
-
+})
### Architecture components
@@ -30,7 +32,7 @@ This platform-agnostic design establishes a fallback communication system, decou
Deploying Mattermost in AWS leverages managed services and strong isolation capabilities.
-
+})
### AWS components
@@ -52,7 +54,7 @@ Deploying Mattermost in AWS leverages managed services and strong isolation capa
For Azure customers, AKS and related services provide a robust OOB platform for Mattermost.
-
+})
### Azure components
diff --git a/docs/main/deployment-guide/server/deploy-linux.mdx b/docs/main/deployment-guide/server/deploy-linux.mdx
index de0fad8eabd9..f65bd8206ac4 100644
--- a/docs/main/deployment-guide/server/deploy-linux.mdx
+++ b/docs/main/deployment-guide/server/deploy-linux.mdx
@@ -49,9 +49,9 @@ Once Mattermost is running, complete these steps before exposing it to users:
- Review the [post-install configuration checklist](/deployment-guide/server/server-deployment-planning) under Server deployment planning.
:::tip Air-gapped environments
-If you're deploying into a network-isolated enclave, use the [Air-Gapped Quick-Start Runbook](/deployment-guide/air-gapped-operations/quick-start-runbook) instead of the connected install paths above. The runbook adds package mirroring, offline license activation, and the phone-home-disable inventory on top of the standard install.
+If you're deploying into a network-isolated enclave, see [Air-Gapped Operations](/deployment-guide/air-gapped-operations/quick-start-runbook) instead of the connected install paths above. It covers package mirroring and the configuration changes needed on top of the standard install.
:::
-:::note Troubleshooting
+:::note[Troubleshooting]
See [Deployment Troubleshooting](/deployment-guide/deployment-troubleshooting) for common install failures.
:::
diff --git a/docs/main/deployment-guide/server/linux/deploy-tar.mdx b/docs/main/deployment-guide/server/linux/deploy-tar.mdx
index df753bad81e7..33e320700e50 100644
--- a/docs/main/deployment-guide/server/linux/deploy-tar.mdx
+++ b/docs/main/deployment-guide/server/linux/deploy-tar.mdx
@@ -68,7 +68,7 @@ Enterprise and Team Edition releases are listed in the [version archive](/produc
-In an air-gapped environment, stage the tarball on your operator workstation, verify the SHA-256 and PGP signature, then transfer it across the boundary. See [Air-Gapped Operations → Quick-Start Runbook](/deployment-guide/air-gapped-operations/quick-start-runbook) for the full procedure.
+In an air-gapped environment, stage the tarball on your operator workstation, verify the SHA-256 and PGP signature, then transfer it across the boundary. See [Air-Gapped Operations → Deployment Overview](/deployment-guide/air-gapped-operations/quick-start-runbook) for the full procedure.
@@ -191,4 +191,4 @@ sudo userdel mattermost
- [Set up an NGINX reverse proxy](/deployment-guide/server/setup-nginx-proxy)
- [Set up TLS](/deployment-guide/server/setup-tls)
-- For air-gapped deployments: [Air-Gapped Quick-Start Runbook](/deployment-guide/air-gapped-operations/quick-start-runbook), [Disable Phone-Home Features](/deployment-guide/air-gapped-operations/disable-phone-home-features)
+- For air-gapped deployments: [Air-Gapped Deployment Overview](/deployment-guide/air-gapped-operations/quick-start-runbook), [Configure for Air-Gapped Operation](/deployment-guide/air-gapped-operations/disable-phone-home-features)
diff --git a/docs/main/deployment-guide/server/linux/deploy-ubuntu.mdx b/docs/main/deployment-guide/server/linux/deploy-ubuntu.mdx
index ecaba4d155d8..068bf0133b45 100644
--- a/docs/main/deployment-guide/server/linux/deploy-ubuntu.mdx
+++ b/docs/main/deployment-guide/server/linux/deploy-ubuntu.mdx
@@ -8,7 +8,7 @@ sidebar_label: "Ubuntu / Debian"
Install Mattermost Server on Ubuntu or Debian from the signed Mattermost APT repository. The same `.deb` packages cover single-host installs and clustered deployments via tools like Packer.
-:::info Minimum requirements
+:::info[Minimum requirements]
- **Operating system**: Ubuntu 20.04 / 22.04 / 24.04 LTS, or Debian (current stable). Other Debian-family distributions usually work but aren't tested by Mattermost.
- **Hardware**: 1 vCPU and 2 GB RAM (supports up to ~1,000 users).
- **Database**: [PostgreSQL 14+](/deployment-guide/postgres-migration).
@@ -29,7 +29,7 @@ Follow the [database preparation](/deployment-guide/server/preparations#database
## Step 3: Add the Mattermost APT repository
-:::important GPG key change
+:::important[GPG key change]
The GPG public key has changed. Either [import the new public key](https://deb.packages.mattermost.com/pubkey.gpg) or run the repository setup script in the next step (recommended). Existing installations should remove the old key before adding the new one:
For Ubuntu 22.04 LTS and 24.04 LTS:
@@ -66,7 +66,7 @@ sudo apt install mattermost -y
Mattermost installs to `/opt/mattermost`. The package creates a `mattermost` user and group and a systemd unit file. The service is **not** enabled or started at this point.
-:::note systemd dependencies
+:::note[systemd dependencies]
The Mattermost package doesn't declare a database dependency in its systemd unit (the package is used for both single-host and external-database installs). If you installed PostgreSQL on the same host, add the following to the `[Unit]` section of `/lib/systemd/system/mattermost.service`:
```ini
@@ -92,7 +92,7 @@ Edit `/opt/mattermost/config/config.json` and set:
- `ServiceSettings.SiteURL`: the public URL of your deployment (e.g., `https://mattermost.example.com`).
- (Recommended) [`SupportSettings.SupportEmail`](/administration-guide/configure/site-configuration-settings#support-email-address): the email address users contact for help.
-:::note TLS mode for `DataSource`
+:::note[TLS mode for `DataSource`]
The `sslmode` value depends on your database environment. The two relevant options are `disable` and `require`. Managed services such as AWS Lightsail require `sslmode=require`. Check your provider's documentation.
:::
@@ -124,7 +124,7 @@ sudo apt update && sudo apt upgrade
sudo systemctl start mattermost
```
-:::important Stop the server before upgrading
+:::important[Stop the server before upgrading]
`apt upgrade` will replace the Mattermost binary while it's running. Stop the systemd service first to avoid corrupt state.
:::
diff --git a/docs/main/deployment-guide/server/prepare-mattermost-mysql-database.mdx b/docs/main/deployment-guide/server/prepare-mattermost-mysql-database.mdx
index e046580d3805..774daac15886 100644
--- a/docs/main/deployment-guide/server/prepare-mattermost-mysql-database.mdx
+++ b/docs/main/deployment-guide/server/prepare-mattermost-mysql-database.mdx
@@ -1,6 +1,7 @@
---
title: "Set up the Mattermost MySQL database"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -244,7 +245,7 @@ WantedBy=mysql.service
# Technical notes about searching
-By default, Mattermost uses full text search support included in MySQL. Select the **product menu** then select **About Mattermost** to see which database you’re using.
+By default, Mattermost uses full text search support included in MySQL. Select the **product menu** then select **About Mattermost** to see which database you’re using.
- Stop words are filtered out of search results. See [MySQL](https://dev.mysql.com/doc/refman/5.7/en/fulltext-stopwords.html) database documentation for a full list of applicable stop words.
- Hashtags or recent mentions of usernames containing a dot don't return results.
diff --git a/docs/main/deployment-guide/server/server-deployment-planning.mdx b/docs/main/deployment-guide/server/server-deployment-planning.mdx
index 1dbd20c03951..42c013c48638 100644
--- a/docs/main/deployment-guide/server/server-deployment-planning.mdx
+++ b/docs/main/deployment-guide/server/server-deployment-planning.mdx
@@ -95,38 +95,40 @@ When a PostgreSQL version reaches its end of life (EOL), Mattermost will require
-
-
+
+
+
+| Mattermost Version |
+Release Date |
+Minimum PostgreSQL Version |
+
+
-
-Mattermost Version | Release Date | Minimum PostgreSQL Version |
-
-
-- ===========================================================+==================+================================+
--
-
v9.11 ESR | 2024-8-15 | 11.x
-
- |
+v9.11 ESR |
+2024-8-15 |
+11.x |
-| v10.5 ESR | 2025-2-15 | 11.x |
+v10.5 ESR |
+2025-2-15 |
+11.x |
-| v10.6 | 2025-3-15 | 13.x |
+v10.6 |
+2025-3-15 |
+13.x |
| v10.11 ESR |
2025-8-15 |
13.x |
- |
v11.5 ESR * |
2026-2-15 |
14.x (EOL 2026-11-12) |
- |
diff --git a/docs/main/end-user-guide/access/client-availability.mdx b/docs/main/end-user-guide/access/client-availability.mdx
index af2b6c0f9600..64936baee0c5 100644
--- a/docs/main/end-user-guide/access/client-availability.mdx
+++ b/docs/main/end-user-guide/access/client-availability.mdx
@@ -30,49 +30,49 @@ The following tables highlight the end user features of Mattermost and their sup
|
-| Threaded discussions | checkmark | checkmark | checkmark | |
+Threaded discussions | checkmark | checkmark | checkmark | |
-| Format messages with Markdown | checkmark | checkmark | Partial Support | |
+Format messages with Markdown | checkmark | checkmark | Partial Support | |
-| Emojis | checkmark | checkmark | checkmark | |
+Emojis | checkmark | checkmark | checkmark | |
-| Emoji reactions |
+Emoji reactions |
_ | checkmark | checkmark | checkmark | |
-| File sharing | checkmark | checkmark | checkmark | |
+File sharing | checkmark | checkmark | checkmark | |
-| @mentions | checkmark | checkmark | checkmark | |
+@mentions | checkmark | checkmark | checkmark | |
-| Search hashtags | checkmark | checkmark | checkmark | |
+Search hashtags | checkmark | checkmark | checkmark | |
-| Search modifiers | checkmark | checkmark | checkmark | |
+Search modifiers | checkmark | checkmark | checkmark | |
| Search highlighting |
checkmark | checkmark | checkmark | |
-| Pin and save messages | checkmark | checkmark | checkmark | |
+Pin and save messages | checkmark | checkmark | checkmark | |
-| Preview image links |
-ments>`__ | checkmark | checkmark | checkmark | |
+Preview image links |
+checkmark | checkmark | checkmark | |
-| Preview websites | | | | | checkmark | checkmark | checkmark |
+Preview websites | checkmark | checkmark | checkmark |
-| Notifications | checkmark | checkmark | checkmark | |
+Notifications | checkmark | checkmark | checkmark | |
-| Bookmark channels | checkmark | checkmark | checkmark | |
+Bookmark channels | checkmark | checkmark | checkmark | |
@@ -102,37 +102,37 @@ The following tables highlight the end user features of Mattermost and their sup
|
-| Create a new channel | checkmark | checkmark | checkmark | |
+Create a new channel | checkmark | checkmark | checkmark | |
-| Join a channel |
+Join a channel |
|
-| Leave a channel |
+Leave a channel |
|
-| Favorite a channel | checkmark | checkmark | checkmark | |
+Favorite a channel | checkmark | checkmark | checkmark | |
-| Mute a channel | | | | | checkmark | checkmark | checkmark | |
+Mute a channel | checkmark | checkmark | checkmark | |
-| Manage members | checkmark | checkmark | checkmark | |
+Manage members | checkmark | checkmark | checkmark | |
-| Add members | checkmark | checkmark | checkmark |
+Add members | checkmark | checkmark | checkmark |
-| Rename channels | checkmark | checkmark | checkmark | |
+Rename channels | checkmark | checkmark | checkmark | |
-| Deactivate members | | | | | checkmark | checkmark | | |
+Deactivate members | checkmark | checkmark | | |
@@ -162,36 +162,36 @@ The following tables highlight the end user features of Mattermost and their sup
|
-| Multi-team support for notifications | | | | | checkmark | checkmark | checkmark |
+Multi-team support for notifications | checkmark | checkmark | checkmark |
-| Team switching | checkmark | checkmark | checkmark | |
+Team switching | checkmark | checkmark | checkmark | |
-| Team-based theming | checkmark | checkmark | checkmark | |
+Team-based theming | checkmark | checkmark | checkmark | |
-| Team settings | checkmark | checkmark | | |
+Team settings | checkmark | checkmark | | |
-| Join existing team |
-eam>`__ | checkmark | checkmark | checkmark | |
+Join existing team |
+checkmark | checkmark | checkmark | |
-| Create a new team |
-team>`__ | checkmark | checkmark | | |
+Create a new team |
+checkmark | checkmark | | |
-| Share an invite link | checkmark | checkmark | checkmark | |
+Share an invite link | checkmark | checkmark | checkmark | |
-| Invite people | checkmark | checkmark | checkmark | |
+Invite people | checkmark | checkmark | checkmark | |
-| Manage team members | checkmark | checkmark | | |
+Manage team members | checkmark | checkmark | | |
-| Leave team |
+Leave team |
|
@@ -223,7 +223,7 @@ The following tables highlight the end user features of Mattermost and their sup
|
-| Collaborative playbooks | | | | | checkmark | checkmark | |
+Collaborative playbooks | checkmark | checkmark | |
@@ -253,19 +253,19 @@ The following tables highlight the end user features of Mattermost and their sup
|
-| Join call | | | | | checkmark | checkmark | checkmark | |
+Join call | checkmark | checkmark | checkmark | |
-| Share screen | | | | | checkmark | checkmark | | |
+Share screen | checkmark | checkmark | | |
-| Chat in thread | | | | | checkmark | checkmark | checkmark |
+Chat in thread | checkmark | checkmark | checkmark |
-| React with emoji | | | | | checkmark | checkmark | checkmark | |
+React with emoji | checkmark | checkmark | checkmark | |
-| Record a call | | | | | checkmark | checkmark | checkmark | |
+Record a call | checkmark | checkmark | checkmark | |
@@ -295,10 +295,10 @@ The following tables highlight the end user features of Mattermost and their sup
|
-| Slash commands | checkmark | checkmark | Partial Support | |
+Slash commands | checkmark | checkmark | Partial Support | |
-| Server-side plugins | checkmark | checkmark | checkmark |
+Server-side plugins | checkmark | checkmark | checkmark |
| Interactive dialogs |
@@ -364,22 +364,22 @@ The following tables highlight the end user features of Mattermost and their sup
|
-| Email password login | | | | | checkmark | checkmark | checkmark |
+Email password login | checkmark | checkmark | checkmark |
-| AD/LDAP | checkmark | checkmark | checkmark | |
+AD/LDAP | checkmark | checkmark | checkmark | |
-| SAML SSO | checkmark | checkmark | checkmark | |
+SAML SSO | checkmark | checkmark | checkmark | |
-| GitLab SSO | checkmark | checkmark | checkmark | |
+GitLab SSO | checkmark | checkmark | checkmark | |
-| Entra ID SSO | checkmark | checkmark | checkmark | |
+Entra ID SSO | checkmark | checkmark | checkmark | |
-| Google SSO | checkmark | checkmark | checkmark | |
+Google SSO | checkmark | checkmark | checkmark | |
@@ -409,16 +409,16 @@ The following tables highlight the end user features of Mattermost and their sup
|
-| Localization for 22 languages | | | | | checkmark | checkmark | checkmark | |
+Localization for 22 languages | checkmark | checkmark | checkmark | |
-| Custom user interface themes | | | | | checkmark | checkmark | checkmark |
+Custom user interface themes | checkmark | checkmark | checkmark |
-| User profile settings | | | | | checkmark | checkmark | checkmark |
+User profile settings | checkmark | checkmark | checkmark |
-| Channel notification settings | | | | | checkmark | checkmark | checkmark | |
+Channel notification settings | checkmark | checkmark | checkmark | |
diff --git a/docs/main/end-user-guide/access/log-out.mdx b/docs/main/end-user-guide/access/log-out.mdx
index d494edb53409..6b7457b4ecc3 100644
--- a/docs/main/end-user-guide/access/log-out.mdx
+++ b/docs/main/end-user-guide/access/log-out.mdx
@@ -1,6 +1,7 @@
---
title: "Log out of Mattermost"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -16,7 +17,7 @@ You can log out of Mattermost from your profile picture. Select **Log Out** to l
icon to change the name of the Legal Hold, add or remove users, change the end date, as well as include or exclude public channels.
+Select the **Edit** })
icon to change the name of the Legal Hold, add or remove users, change the end date, as well as include or exclude public channels.
##### Access a Legal Hold secret
A Legal Hold secret enables you to verify the authenticity of the data for a Legal Hold in Mattermost.
-Select the **Show** 
icon to display the Legal Hold secret key. Keep a copy of this key in a secure location.
+Select the **Show** })
icon to display the Legal Hold secret key. Keep a copy of this key in a secure location.
@@ -104,7 +106,7 @@ Secret key was provided, verifying legal holds...
##### Download Legal Hold data
-Select the **Download** 
icon to download a copy of the preserved data to a location on your local machine. Note, no data will be available to download until at least one scheduled job is completed. This may take up to 24 hours.
+Select the **Download** })
icon to download a copy of the preserved data to a location on your local machine. Note, no data will be available to download until at least one scheduled job is completed. This may take up to 24 hours.
### Step 5: Release a Legal Hold
@@ -179,7 +181,7 @@ $ ./processor --legal-hold-data ./legalholddata.zip --output-path ./path/to/wher
- `--legal-hold-data`: Path to the Legal Hold zip file downloaded from Mattermost
- `--output-path`: Directory where the HTML output will be generated
-- `--legal-hold-secret`: (Optional) Used as a security measure for an operator to ensure the authenticity of a downloaded zip file. The operator can copy the key corresponding to a particular "hold" from the Legal Hold Plugin settings page in the System Console by selecting the **Show** 
+})
+})
**When to use it**
- You are evaluating Calls for the first time.
@@ -189,7 +190,7 @@ The **Recording** service (`calls-offloader`) can optionally be added to an **In
Reference architecture when using the Recording service with Integrated Calls:
-
+})
**Components**
- **Mattermost server**: Calls plugin is pre-installed.
@@ -204,7 +205,7 @@ Reference architecture when using the Recording service with Integrated Calls:
An **RTCD Server** is added as a dedicated media service that processes all call audio and screen sharing media.
-
+})
The Mattermost server is still responsible for signaling (setting up, managing, and ending calls) and channel state (who is joining or leaving, who has muted, and overall call status), but the call media itself flows directly between clients and the RTCD server, completely bypassing the Mattermost server.
**When to use it**
@@ -231,7 +232,7 @@ The **Recording** service (`calls-offloader`) can optionally be added to an **RT
Reference architecture when using the Recording service with RTCD:
-
+})
**Components**
- **Mattermost server**: Calls plugin is pre-installed.
diff --git a/docs/main/administration-guide/configure/cloud-billing-account-settings.mdx b/docs/main/administration-guide/configure/cloud-billing-account-settings.mdx
index 03f48ccf788c..a6c92739b74a 100644
--- a/docs/main/administration-guide/configure/cloud-billing-account-settings.mdx
+++ b/docs/main/administration-guide/configure/cloud-billing-account-settings.mdx
@@ -1,7 +1,9 @@
---
title: "Cloud workspace subscription, billing, and account settings"
---
-Review and manage the following aspects of your Mattermost cloud-based deployment by selecting the **Product** 
+})
next to the team name, and select **Remove from team**.
+4. To remove the user from a specific team, select **More** })
next to the team name, and select **Remove from team**.
@@ -323,7 +325,7 @@ View user profile details using the System Console. Gather information including
})
})
})
})
icon to distinguish them from channels and channel members of the local server.
+Shared channels and members of those shared channels display a shared })
icon to distinguish them from channels and channel members of the local server.
+})
displays next to archived channels. From Mattermost v11.5, archived private channels display a distinct **Archive Lock** icon to differentiate them from other archived channels.
+- When a Mattermost user is deactivated in the system, your [direct message channel](/end-user-guide/collaborate/channel-types#direct-message-channels) with that user are archived and marked as read-only. An **Archived** icon })
displays next to archived channels. From Mattermost v11.5, archived private channels display a distinct **Archive Lock** icon to differentiate them from other archived channels.
- [Group message channels](/end-user-guide/collaborate/channel-types#group-message-channels) can't be archived, but they can be closed to hide them from the channel sidebar.
- The default **Town Square** channel can't be archived.
- System admins can archive channels without needing to be a channel member by using the System Console.
@@ -80,7 +81,7 @@ To unarchive a channel:
-2. Tap the **More** 
icon for the channel. Any member of a channel can change a channel's purpose description, unless the system admin has [disabled the ability to do so](/administration-guide/onboard/advanced-permissions).
+A channel's purpose is visible in the right pane when you select the **View Info** })
icon for the channel. Any member of a channel can change a channel's purpose description, unless the system admin has [disabled the ability to do so](/administration-guide/onboard/advanced-permissions).
icon. New team members are automatically added to the **Town Square** channel.
+Public channels are open to everyone on a team and are identified with a **Globe** })
icon. New team members are automatically added to the **Town Square** channel.
See the [Join and leave channels](/end-user-guide/collaborate/join-leave-channels) documentation for details on discovering, joining, and leaving other channels.
## Private channels
-Private channels are channels for sensitive topics and are only visible to selected team members. Private channels are identified with a **Lock** 
icon. Channel members can choose to leave private channels at any time.
+Private channels are channels for sensitive topics and are only visible to selected team members. Private channels are identified with a **Lock** })
icon. Channel members can choose to leave private channels at any time.
+> })
2. Enter a channel name.
3. Choose whether this is a public or private channel. See the [channel types](/end-user-guide/collaborate/channel-types) documentation to learn more about public and private channels.
@@ -24,7 +25,7 @@ Anyone can create public channels, private channels, direct messages, and group
## Start a direct or group message
-1. Select the 
icon next to the channel name.
+At the top of the page, select the })
icon next to the channel name.
-To remove a channel from your **Favorites** list, select the 
icon. Select the icon again to show the formatting options.
+- Hide the formatting options by selecting the **Show/Hide Formatting** })
icon. Select the icon again to show the formatting options.
- You can control whether post formatting is rendered within the message formatting editor. When disabled, raw text is shown. See the [Channels customization](/end-user-guide/preferences/manage-advanced-options) documentation for details.
-- `~~strikethrough~~` renders as 
+- `***bold-italic***` renders as })
+- `~~strikethrough~~` renders as })
### Links
@@ -562,7 +563,7 @@ Example: An in-line image that's 50 pixels wide and 76 pixels high.
Renders as:
-> 
+> }){kind=icon}
#### In-line image displayed with fixed width
@@ -574,7 +575,7 @@ Example: An in-line image that's 50 pixels wide where the system adjusts the hei
Renders as:
-> 
+> }){kind=icon}
### Horizontal lines
diff --git a/docs/main/end-user-guide/collaborate/forward-messages.mdx b/docs/main/end-user-guide/collaborate/forward-messages.mdx
index a7ce14f379b4..8f59b4293e07 100644
--- a/docs/main/end-user-guide/collaborate/forward-messages.mdx
+++ b/docs/main/end-user-guide/collaborate/forward-messages.mdx
@@ -1,6 +1,8 @@
---
title: "Forward messages"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
icon, then select **Show chat thread**. Alternatively, expand the call window using the arrows in the top-right of the call widget. From there, select the chat icon to access the chat thread.
+Open the chat thread in the widget by selecting the **Gear** })
icon, then select **Show chat thread**. Alternatively, expand the call window using the arrows in the top-right of the call widget. From there, select the chat icon to access the chat thread.
icon.
+2. Tap on })
icon.
@@ -96,7 +97,7 @@ Select the channel name at the top of the center pane to access the drop-down me
+})
To set the priority of a new root message:
-1. Select the **Message Priority** 
icon in the message formatting toolbar. Select from Standard, Important, or Urgent.
+1. Select the **Message Priority** })
icon in the message formatting toolbar. Select from Standard, Important, or Urgent.
2. Select the priority for the message. Messages have a standard priority by default.
3. Select **Apply**
@@ -22,7 +24,7 @@ From Mattermost v8.0, messages marked as urgent with a priority label and contai
To enable persistent notifications for a message:
1. Compose a root message with at least one @mention.
-2. Select the **Message Priority** 
button is added below the sent message. You can mark message as acknowledged by selecting the button, and you can hover over the **Acknowledged** })
button is added below the sent message. You can mark the message as acknowledged by selecting the button, and you can hover over the **Acknowledged** 
icon in the thread header. This allows you to view and participate in multiple threads simultaneously without losing context.
+From Mattermost v11.2, when using Mattermost in a web browser, you can open threads in separate browser windows by selecting the **New Window** })
icon in the thread header. This allows you to view and participate in multiple threads simultaneously without losing context.
## Follow threads and messages
@@ -34,13 +35,14 @@ You'll automatically follow every thread you participate or are mentioned in. Yo
inside the Mattermost message input box to open the emoji and GIF picker.
+Select the **Smile** icon })
inside the Mattermost message input box to open the emoji and GIF picker.
Select an emoji from the **Emojis** tab, or switch to the **GIFs** tab to search for a GIF.
@@ -52,7 +53,7 @@ You can also specify emojis based on their name. Type `:` followed by at least t
icon next to the message text.
+Reply to messages by selecting the **Reply** })
icon next to the message text.
diff --git a/docs/main/end-user-guide/collaborate/save-pin-messages.mdx b/docs/main/end-user-guide/collaborate/save-pin-messages.mdx
index 275efe97ca89..96f34db63249 100644
--- a/docs/main/end-user-guide/collaborate/save-pin-messages.mdx
+++ b/docs/main/end-user-guide/collaborate/save-pin-messages.mdx
@@ -1,6 +1,7 @@
---
title: "Save and pin messages"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -16,7 +17,7 @@ You have two ways to mark a post to make it easy to find later:
icon next to a message.
+Save messages for later follow up by selecting the **Save** })
icon next to a message.
@@ -33,7 +34,7 @@ Long press a message, and then select **Save**.
-To see all of your saved messages, tap the **Save** 
icon below it to unsave.
+Alternatively, you can also tap on the saved message in a channel and then tap the })
icon below it to unsave.
@@ -51,12 +52,12 @@ Alternatively, you can also tap on the saved message in a channel and then tap t
## Pin messages
-All members of a channel can pin important or useful messages to that channel. The list of pinned messages is visible to all channel members. There is no limit to the number of pinned posts in a channel. From Mattermost v10.2, the **Pinned** 
icon is hidden when no messages are pinned.
+All members of a channel can pin important or useful messages to that channel. The list of pinned messages is visible to all channel members. There is no limit to the number of pinned posts in a channel. From Mattermost v10.2, the **Pinned** })
icon is hidden when no messages are pinned.
+})
-- An alert banner dislays on the **Scheduled** tab
+- A red badge displays a total scheduled post count in the left pane next to **Drafts**. }){kind=icon}
+- An alert banner displays on the **Scheduled** tab
-
+})
icon at the bottom of the app to search for messages or files attached to messages.
+1. Tap the **Search** })
icon at the bottom of the app to search for messages or files attached to messages.
> 
@@ -116,11 +117,11 @@ You can access files recently shared in a channel:
icon to the right of the channel name to access files recently shared in that channel.
+Select the })
icon to the right of the channel name to access files recently shared in that channel.
-Alternatively, you can select the channel name, select the **View Info** 
to send the message.
+Enter a message in the text field, then select **Send** })
to send the message.
menu, alongside any custom prompts your system admin has made available.
+From Mattermost v11.7, Rewrite is accessed through the **AI Actions** })
menu, alongside any custom prompts your system admin has made available.
On Web/Desktop or Mobile:
> 1. Type your message in the message compose field.
-> 2. Open the **AI Actions** 
icon in the message toolbar.
-3. Select **Send** })
icon in the message toolbar.
+3. Select **Send** 
+})
displays next to the channel name.
+When composing a message, you can simply choose to complete it later. The partially composed message is kept in the text field and an **Edit** option })
displays next to the channel name.
From Mattermost v10.5, you'll find local draft messages under **Drafts**. Drafts synchronized to the Mattermost server will be listed under **Drafts** in a future mobile app release.
@@ -144,7 +145,7 @@ All users can edit their own sent messages, unless the system admin has [restric
icon next to the version you want to restore.
+3. Select the **Restore** })
icon next to the version you want to restore.
4. Select **Confirm**.
@@ -203,7 +204,7 @@ Restoring a previous version of the message is available in the Mattermost deskt
All users can delete their own sent messages, unless the system admin has [restricted the ability to do so](/administration-guide/onboard/advanced-permissions).
-1. Using Mattermost in a web browser or the desktop app, select the **More** 
icon in the message input box.
+- Selecting the **Attachment** })
icon in the message input box.
- Pasting from the clipboard.
## Share public links
@@ -29,22 +30,22 @@ If **Get Public Link** is not visible in the file previewer, ask your system adm
## Download files
-You can download an attached file by selecting the **Download** 
option located in the top-right corner of the desktop app window.
+From Mattermost desktop app v5.2, you can review download status, access downloads, and clear the list of downloads from a new **Downloads** }){kind=icon}
option located in the top-right corner of the desktop app window.
-Sharing message links displays a preview of the message in the post. To share links to messages in Mattermost, select the **More** 
icon in the top right corner.
+- You can also hover over an image and select the })
icon in the top right corner.
- The timestamp next to the username of any message is also a permanent link to that conversation.
icon located in the top left corner of the window to access all available servers and to add new servers.
+Tap the **Servers** })
icon located in the top left corner of the window to access all available servers and to add new servers.
1. Tap **Add a server**.
2. Enter the server URL. Server URLs must begin with either `http://` or `https://`.
@@ -60,7 +61,7 @@ Can't find your Mattermost server URL? Ask your company’s IT department or you
3. Enter the server's Display Name.
4. Optionally toggle the **Advanced Options** section to enter an **Authentication secret**. This is an additional security measure that some organizations use. Your system admin can provide you with the secret if required.
-> 
+> })
5. Tap **Done**.
@@ -86,11 +87,11 @@ Can't find your Mattermost server URL? Ask your company’s IT department or you
1. Swipe left on an existing server entry to reveal additional options. Tap **Edit**.
-> 
+> })
2. Modify the server's display name or authentication secret, and then tap **Save**.
-> 
+> })
>
> To view or update the authentication secret, expand the **Advanced Options** section. If a secret is currently configured, it will be pre-filled in the field.
@@ -114,11 +115,11 @@ Removing a server from your desktop app doesn't delete its data. You can add the
-- A dot badge for unread activity. 
+- A numbered badge for unread [direct](/end-user-guide/collaborate/channel-types#direct-message-channels) [group](/end-user-guide/collaborate/channel-types#group-message-channels) messages, [@mentions](/end-user-guide/preferences/manage-your-mentions-keywords-notifications), and [keywords](/end-user-guide/preferences/manage-your-mentions-keywords-notifications) you're actively watching. }){kind=icon}
+- A dot badge for unread activity. }){kind=icon}
## Banner alerts
diff --git a/docs/main/end-user-guide/preferences/manage-your-display-options.mdx b/docs/main/end-user-guide/preferences/manage-your-display-options.mdx
index abb2cb35d64e..12ee89d5bda2 100644
--- a/docs/main/end-user-guide/preferences/manage-your-display-options.mdx
+++ b/docs/main/end-user-guide/preferences/manage-your-display-options.mdx
@@ -1,6 +1,7 @@
---
title: "Manage your display options"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -8,7 +9,7 @@ import TabItem from '@theme/TabItem';
You can customize Mattermost display options based on your preferences.
-- Using Mattermost in a web browser or the desktop app, select the gear icon })
})
+})
### What determines if an email notification should be triggered?
Email notifications are triggered under to following conditions. Click to expand the flow chart.
-
+})
### What determines if a mobile push notification should be triggered?
Mobile push notifications are triggered under to following conditions. Click to expand the flow chart.
-
+})
### Are mobile push notifications free?
diff --git a/docs/main/end-user-guide/project-management/boards-settings.mdx b/docs/main/end-user-guide/project-management/boards-settings.mdx
index 64b45a1463ce..77254cb4e2c8 100644
--- a/docs/main/end-user-guide/project-management/boards-settings.mdx
+++ b/docs/main/end-user-guide/project-management/boards-settings.mdx
@@ -1,16 +1,18 @@
---
title: "Settings"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+})
-
+})
-
+})
-
+})
-
+})
## Parameters
@@ -94,7 +96,7 @@ The JSON payload can contain the following parameters:
+})
### Example with Card Prop
diff --git a/docs/main/integrations-guide/integrations-guide-index.mdx b/docs/main/integrations-guide/integrations-guide-index.mdx
index a3d055ba8c03..8878d54a073f 100644
--- a/docs/main/integrations-guide/integrations-guide-index.mdx
+++ b/docs/main/integrations-guide/integrations-guide-index.mdx
@@ -1,6 +1,8 @@
---
title: "Integrations Guide"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
Mattermost provides a variety of methods to integrate with your favorite tools, automate critical workflows, and extend the capabilities of the platform. This guide provides a high-level overview of integration options and the level of technical skills required [(no-code, low-code, or pro-code)](/integrations-guide/faq#what-is-meant-by-no-code-low-code-and-pro-code), and links to detailed documentation for each.
## Choose Your Path
@@ -20,7 +22,7 @@ Mattermost provides a variety of methods to integrate with your favorite tools,
+})
#### Custom-Built Plugins
diff --git a/docs/main/integrations-guide/jira.mdx b/docs/main/integrations-guide/jira.mdx
index b88b5f9affc5..4aa5c522534d 100644
--- a/docs/main/integrations-guide/jira.mdx
+++ b/docs/main/integrations-guide/jira.mdx
@@ -1,6 +1,8 @@
---
title: "Connect Jira to Mattermost"
---
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+})
You can also include [message attachments](https://developers.mattermost.com/integrate/reference/message-attachments/) and [interactive messages](https://developers.mattermost.com/integrate/plugins/interactive-messages/) in your response to create more advanced workflows.
diff --git a/docs/main/integrations-guide/popular-integrations.mdx b/docs/main/integrations-guide/popular-integrations.mdx
index da671371a1c6..5680180b5c90 100644
--- a/docs/main/integrations-guide/popular-integrations.mdx
+++ b/docs/main/integrations-guide/popular-integrations.mdx
@@ -19,18 +19,18 @@ Designed for teams that need reliability, auditability, and ownership of their c
