V11.0 documentation

source/administration-guide/configure/authentication-configuration-settings.rst

@@ -245,6 +245,10 @@ Password
 
 Access the following configuration settings in the System Console by going to **Authentication > Password**.
 
+.. note::
+
+  From Mattermost v11.0, password hashing uses PBKDF2 for enhanced security. User passwords are automatically migrated when they log in after upgrading to v11.0 or later. This migration is progressive and happens transparently when users authenticate.
+
 .. config:setting:: minimum-password-length
   :displayname: Minimum password length (Password)
   :systemconsole: Authentication > Password
@@ -1499,7 +1503,7 @@ Sign request
   :systemconsole: Authentication > SAML 2.0
   :configjson: .SamlSettings.SignatureAlgorithm
   :environment: MM_SAMLSETTINGS_SIGNATUREALGORITHM
-  :description: This setting determines the signature algorithm used to sign the SAML request. Options are: ``RSAwithSHA1``, ``RSAwithSHA256``, ``RSAwithSHA512``.
+  :description: This setting determines the signature algorithm used to sign the SAML request. Options are: ``RSAwithSHA1``, ``RSAwithSHA256``, ``RSAwithSHA512``. From v11, default is ``RSAwithSHA256``. Previously ``RSAwithSHA1``.
 
 Signature algorithm
 ~~~~~~~~~~~~~~~~~~~
@@ -1511,6 +1515,11 @@ Signature algorithm
 | This setting determines the signature algorithm used to sign the SAML request. Options are: ``RSAwithSHA1``, ``RSAwithSHA256``, ``RSAwithSHA512``. | - System Config path: **Authentication > SAML 2.0**                      |
 |                                                                                                                                                    | - ``config.json`` setting: ``SamlSettings`` > ``SignatureAlgorithm``     |
 | String input.                                                                                                                                      | - Environment variable: ``MM_SAMLSETTINGS_SIGNATUREALGORITHM``           |
+|                                                                                                                                                    |                                                                          |
+| .. note::                                                                                                                                          |                                                                          |
+|                                                                                                                                                    |                                                                          |
+|   From Mattermost v11, the default signature algorithm has been updated from ``RSAwithSHA1`` to ``RSAwithSHA256`` for improved security.           |                                                                          |
+|   Existing configurations will continue to work, but new installations will default to ``RSAwithSHA256``.                                          |                                                                          |
 +----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
 
 .. config:setting:: canonical-algorithm

source/administration-guide/configure/bleve-search.rst

@@ -1,27 +1,34 @@
-Bleve search (experimental)
-===========================
+Bleve search
+=============
 
 .. include:: ../../_static/badges/allplans-selfhosted.rst
   :start-after: :nosearch:
 
-Bleve is a search engine that uses Lucene-style full-text search and indexing. This style of search and indexing helps overcome limitations of the default database search such as challenges with characters and advanced search capabilities.
+.. important::
+  **From Mattermost v11, Bleve search has been deprecated.** 
+
+  - **For v11.0 and later**: Use :doc:`Elasticsearch </administration-guide/scale/elasticsearch-setup>` or :doc:`OpenSearch <administration-guide/scale/opensearch-setup>` for :doc:`enterprise search </administration-guide/scale/enterprise-search>` capabilities
+  - **For pre-v11.0 deployments**: This documentation remains relevant for existing installations that continue using Bleve.
 
-The Bleve search engine works as a library integrated into the Mattermost codebase. As it generates indexes in the filesystem of the server that it is running on, it doesn’t require an external server to function. Because of this, Bleve should not be enabled in High Availability deployments.
+Bleve is a search engine that uses Lucene-style full-text search and indexing. This style of search and indexing helps overcome limitations of the default database search such as challenges with characters and advanced search capabilities.
 
 .. note::
 
-  Bleve search uses the scorch index type on newly-created indexes. This new index type features efficiency improvements and indexes that use significantly less disk space. Go to **System Console > Experimental > Bleve** and select **Purge Index** to run a purge operation. When that's complete, select **Index Now** to reindex. Bleve remains compatible with existing indexes, so currently indexed data will continue to work if a purge and reindex isn't run.
+  Experimental Bleve search uses the scorch index type on newly-created indexes. This new index type features efficiency improvements and indexes that use significantly less disk space. Go to **System Console > Experimental > Bleve** and select **Purge Index** to run a purge operation. When that's complete, select **Index Now** to reindex. Bleve remains compatible with existing indexes, so currently indexed data will continue to work if a purge and reindex isn't run.
 
 Configuring Bleve in Mattermost
--------------------------------
+--------------------------------
+
+.. note::
+  The following steps are only valid for Mattermost versions prior to v11.0. For v11.0 and later, consider using Elasticsearch or OpenSearch instead.
 
 Follow these steps to configure the Mattermost server to use Bleve and generate required indexes. Once the configuration is saved, new posts made to the database will be automatically indexed with Bleve.
 
 **Note:** During indexing, search results may be incomplete until the indexing job is complete.
 
 1. Open **System Console > Experimental > Bleve**.
 2. Set **Enable Bleve Indexing** to **true** to enable the other settings on the page.
-3. Set the directory path to use for storing Bleve indexes (e.g.: ``/var/opt/mattermost/bleveindexes``). The user running Mattermost should have permissions to access the directory. See our :ref:`configuration settings <administration-guide/configure/experimental-configuration-settings:experimental bleve configuration settings>`  documentation for details.
+3. Set the directory path to use for storing Bleve indexes (e.g.: ``/var/opt/mattermost/bleveindexes``). The user running Mattermost should have permissions to access the directory. See our :ref:`configuration settings <administration-guide/configure/deprecated-configuration-settings:bleve settings>`  documentation for details.
 4. Save the configuration.
 5. Select **Index Now**. All users, channels, and posts in the database will be indexed oldest to newest.
 6. Set **Enable Bleve for search queries** to **true**.
@@ -32,7 +39,10 @@ Follow these steps to configure the Mattermost server to use Bleve and generate
   Search results for files shared before upgrading to Mattermost Server v5.35 may be incomplete until an extraction command is run using the :ref:`mmctl <administration-guide/manage/mmctl-command-line-tool:mmctl extract>`. After running this command, the search index must be rebuilt. Go to **System Console > Experimental > Bleve > Bulk Indexing**, then select **Index Now** to rebuild the search index to include older file contents.
 
 Using Bleve search
-------------------
+-------------------
+
+.. note::
+  This section applies only to Mattermost versions prior to v11.0.
 
 The following conditions are applied when using Bleve search:
 
@@ -42,4 +52,4 @@ The following conditions are applied when using Bleve search:
 How does search work with Bleve disabled?
 -------------------------------------------
 
-Mattermost performs full text searches against the database unless you have an :ref:`Enterprise license <product-overview/editions-and-offerings:mattermost enterprise edition>` and :doc:`enterprise search </administration-guide/scale/enterprise-search>` configured.
+Mattermost performs full text searches against the database unless you have an :ref:`Enterprise license <product-overview/editions-and-offerings:mattermost enterprise>` and :doc:`enterprise search </administration-guide/scale/enterprise-search>` configured.

source/administration-guide/configure/deprecated-configuration-settings.rst

@@ -30,6 +30,86 @@ The following Mattermost configuration settings are deprecated and are no longer
 Bleve settings
 --------------
 
+*Bleve search has been deprecated from Mattermost v11.0. We recommend using Elasticsearch or OpenSearch for enterprise search capabilities.*
+
+Enable Bleve indexing
+~~~~~~~~~~~~~~~~~~~~~
+
+*Deprecated from Mattermost v11.0*
+
+This setting was available in the System Console by going to **Experimental > Bleve**, or by editing the ``config.json`` file.
+
+**True**: The indexing of new posts occurs automatically.
+
+**False**: The indexing of new posts does not occur automatically.
+
++------------------------------------------------------------------------------------------------------------+
+| This feature's ``config.json`` setting is ``"EnableIndexing": false`` with options ``true`` and ``false``. |
++------------------------------------------------------------------------------------------------------------+
+
+Index directory
+~~~~~~~~~~~~~~~
+
+*Deprecated from Mattermost v11.0*
+
+This setting was available in the System Console by going to **Experimental > Bleve**, or by editing the ``config.json`` file.
+
+Directory path to use for storing bleve indexes.
+
++-----------------------------------------------------------------------------------------------------------+
+| This feature's ``config.json`` setting is ``"IndexDir": ""`` with string input.                           |
++-----------------------------------------------------------------------------------------------------------+
+
+Bulk index now
+~~~~~~~~~~~~~~
+
+Select **Index Now** to index all users, channels, and posts in the database from oldest to newest. Bleve is available during indexing, but search results may be incomplete until the indexing job is complete.
+
+Purge indexes
+~~~~~~~~~~~~~
+
+Select **Purge Index** to remove the contents of the Bleve index directory. Search results may be incomplete until a bulk index of the existing database is rebuilt.
+
+.. config:setting:: enable-bleve-indexingsearch
+  :displayname: Enable Bleve for search queries (Experimental)
+  :systemconsole: Experimental > Bleve
+  :configjson: EnableSearching
+  :environment: N/A
+
+  - **true**: Search queries will use bleve search.
+  - **false**: **(Default)** Search queries will not use bleve search.
+
+
+Enable Bleve for search queries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*Deprecated from Mattermost v11.0*
+
+This setting was available in the System Console by going to **Experimental > Bleve**, or by editing the ``config.json`` file.
+
+**True**: Search queries will use bleve search.
+
+**False**: Search queries will not use bleve search.
+
++--------------------------------------------------------------------------------------------------------------+
+| This feature's ``config.json`` setting is ``"EnableSearching": false`` with options ``true`` and ``false``.  |
++--------------------------------------------------------------------------------------------------------------+
+
+Enable Bleve for autocomplete queries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*Deprecated from Mattermost v11.0*
+
+This setting was available in the System Console by going to **Experimental > Bleve**, or by editing the ``config.json`` file.
+
+**True**: Autocomplete queries will use bleve search.
+
+**False**: Autocomplete queries will not use bleve search.
+
++-----------------------------------------------------------------------------------------------------------------+
+| This feature's ``config.json`` setting is ``"EnableAutocomplete": false`` with options ``true`` and ``false``.  |
++-----------------------------------------------------------------------------------------------------------------+
+
 Bulk Indexing Time Window Seconds
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~