V11.6 Docs

Makefile

@@ -28,7 +28,7 @@ BUILDDIR        = build
 SPHINXOPTS      ?= -j auto
 SPHINXBUILD     ?= pipenv run sphinx-build
 SPHINXAUTOBUILD ?= pipenv run sphinx-autobuild
-AUTOBUILDOPTS   ?= -D=html_baseurl=http://127.0.0.1:8000 --ignore "*/_generated/*"
+AUTOBUILDOPTS   ?= -D=html_baseurl=http://127.0.0.1:8000
 
 # If we're using Windows, use CMD to run commands in the Makefile.
 ifeq ($(OS),Windows_NT)

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

@@ -2246,6 +2246,24 @@ GitLab OpenID Client secret
 .. note::
   See **Step 2** of the :doc:`GitLab Single Sign-On </administration-guide/onboard/sso-gitlab>` documentation for details.
 
+.. config:setting:: oidc-gitlabusepreferredusername
+  :displayname: Use preferred username (OpenID Connect - GitLab)
+  :systemconsole: Authentication > OpenID Connect
+  :configjson: .GitLabSettings.UsePreferredUsername
+  :environment: MM_GITLABSETTINGS_USEPREFERREDUSERNAME
+
+  - **true**: Mattermost uses the ``preferred_username`` claim from the GitLab OpenID token as the Mattermost username.
+  - **false**: **(Default)** Mattermost does not use the ``preferred_username`` claim for username assignment.
+
+GitLab OpenID use preferred username
+'''''''''''''''''''''''''''''''''''''
+
++-------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
+| - **true**: Mattermost uses the ``preferred_username`` claim from the GitLab OpenID token as the Mattermost      | - System Config path: **Authentication > OpenID Connect**                              |
+|   username.                                                                                                       | - ``config.json`` setting: ``GitLabSettings`` > ``UsePreferredUsername`` > ``false``   |
+| - **false**: **(Default)** Mattermost does not use the ``preferred_username`` claim for username assignment.      | - Environment variable: ``MM_GITLABSETTINGS_USEPREFERREDUSERNAME``                     |
++-------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
+
 Google OpenID settings
 ^^^^^^^^^^^^^^^^^^^^^^
 
@@ -2323,6 +2341,24 @@ Google OpenID Client secret
 | String input.                                                                                                     |                                                           |
 +-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
 
+.. config:setting:: oidc-googleusepreferredusername
+  :displayname: Use preferred username (OpenID Connect - Google)
+  :systemconsole: Authentication > OpenID Connect
+  :configjson: .GoogleSettings.UsePreferredUsername
+  :environment: MM_GOOGLESETTINGS_USEPREFERREDUSERNAME
+
+  - **true**: Mattermost uses the ``preferred_username`` claim from the Google OpenID token as the Mattermost username.
+  - **false**: **(Default)** Mattermost does not use the ``preferred_username`` claim for username assignment.
+
+Google OpenID use preferred username
+'''''''''''''''''''''''''''''''''''''
+
++-------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
+| - **true**: Mattermost uses the ``preferred_username`` claim from the Google OpenID token as the Mattermost      | - System Config path: **Authentication > OpenID Connect**                              |
+|   username.                                                                                                       | - ``config.json`` setting: ``GoogleSettings`` > ``UsePreferredUsername`` > ``false``   |
+| - **false**: **(Default)** Mattermost does not use the ``preferred_username`` claim for username assignment.      | - Environment variable: ``MM_GOOGLESETTINGS_USEPREFERREDUSERNAME``                     |
++-------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
+
 Entra ID OpenID settings
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -2420,6 +2456,27 @@ Entra ID Client secret
 | String input.                                                                                                        |                                                                |
 +----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
 
+.. config:setting:: oidc-entraidusepreferredusername
+  :displayname: Use preferred username (OpenID Connect - Entra ID)
+  :systemconsole: Authentication > OpenID Connect
+  :configjson: .Office365Settings.UsePreferredUsername
+  :environment: MM_OFFICE365SETTINGS_USEPREFERREDUSERNAME
+
+  - **true**: Mattermost uses the ``preferred_username`` claim from the Entra ID OpenID token as the Mattermost username.
+  - **false**: **(Default)** Mattermost does not use the ``preferred_username`` claim for username assignment.
+
+Entra ID use preferred username
+''''''''''''''''''''''''''''''''
+
++----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+| - **true**: Mattermost uses the ``preferred_username`` claim from the Entra ID OpenID token as the Mattermost username.   | - System Config path: **Authentication > OpenID Connect**                                  |
+| - **false**: **(Default)** Mattermost does not use the ``preferred_username`` claim for username assignment.               | - ``config.json`` setting: ``Office365Settings`` > ``UsePreferredUsername`` > ``false``    |
+|                                                                                                                            | - Environment variable: ``MM_OFFICE365SETTINGS_USEPREFERREDUSERNAME``                      |
++----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
+
+.. note::
+  To make the ``preferred_username`` claim available, add it as an optional claim in the Azure Portal under **App registrations > Token configuration**. See :doc:`Entra ID Single Sign-On </administration-guide/onboard/sso-entraid>` for setup details.
+
 OpenID Connect (other) settings
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -2536,6 +2593,26 @@ OpenID Connect (other) Client secret
 | String input.                                                                                                                   |                                                           |
 +---------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
 
+.. config:setting:: oidc-usepreferredusername
+  :displayname: Use preferred username (OpenID Connect)
+  :systemconsole: Authentication > OpenID Connect
+  :configjson: .OpenIdSettings.UsePreferredUsername
+  :environment: MM_OPENIDSETTINGS_USEPREFERREDUSERNAME
+
+  - **true**: Mattermost uses the ``preferred_username`` claim from the OpenID token as the Mattermost username.
+  - **false**: **(Default)** Mattermost does not use the ``preferred_username`` claim for username assignment.
+
+OpenID Connect (other) use preferred username
+''''''''''''''''''''''''''''''''''''''''''''''
+
++---------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
+| - **true**: Mattermost uses the ``preferred_username`` claim from the provider's OpenID token as the Mattermost username.       | - System Config path: **Authentication > OpenID Connect** |
+| - **false**: **(Default)** Mattermost does not use the ``preferred_username`` claim for username assignment.                    | - ``config.json`` setting: ``OpenIdSettings`` >           |
+|                                                                                                                                 |   ``UsePreferredUsername`` > ``false``                    |
+|                                                                                                                                 | - Environment variable:                                   |
+|                                                                                                                                 |   ``MM_OPENIDSETTINGS_USEPREFERREDUSERNAME``               |
++---------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
+
 ----
 
 Guest access

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

@@ -2082,6 +2082,7 @@ Enable searching content of documents within ZIP files
 
   - You can search for document content within ZIP files when using Mattermost in a web browser or the desktop app.
   - Searching document contents adds load to your server.
+  - This setting applies only to standard ZIP files. 7zip (``.7z``) files are blocked for security reasons and are not searchable.
   - For large deployments, or teams that share many large, text-heavy documents, we recommend you review our :ref:`hardware requirements <deployment-guide/software-hardware-requirements:hardware requirements>`, and test enabling this feature in a staging environment before enabling it in a production environment.
 
 .. config:setting:: amazon-s3-bucket

source/administration-guide/configure/user-management-configuration-settings.rst

@@ -18,7 +18,7 @@ Review and manage the following in the System Console by selecting the **Product
 Users
 -----
 
-Mattermost system admins can provision and manage user accounts, team membership, roles and permissions, and update user email addresses.
+Mattermost system admins can provision and manage user accounts, team membership, roles and permissions, and update user email addresses, usernames, and authentication data.
 
 Provision users
 ~~~~~~~~~~~~~~~
@@ -274,6 +274,25 @@ Update the emails of users using the System Console.
 .. tip::
   You can also update the email from the **Actions** column on the **Users** page. Select **Update email**, enter the new email for the user, and then select **Save**.
 
+Update user's username
+~~~~~~~~~~~~~~~~~~~~~~
+
+From Mattermost 11.6: Update the username of a user using the System Console.
+
+1. Go to **System Console > User Management > Users** to access all user accounts.
+2. Select the user, and enter a new username in the **Username** field.
+3. Select **Save**.
+
+Update user's authentication data
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+From Mattermost 11.6: System admins can view and update the authentication data (AuthData) for a user directly in the System Console. AuthData is the external identifier associated with the user's authentication method, such as an LDAP Distinguished Name (DN), SAML NameID, or OAuth ID. Updating this field is useful when a user's external authentication identifier changes, for example after an identity provider migration.
+
+1. Go to **System Console > User Management > Users** to access all user accounts.
+2. Select the user to open their User Configuration page.
+3. In the **Authentication** section, view or update the user's authentication data value.
+4. Select **Save**.
+
 Reset user's password
 ~~~~~~~~~~~~~~~~~~~~~~