From a97f214ab5ff4b59150ff0098cce674e522652dd Mon Sep 17 00:00:00 2001 From: Guruprasath <138384576+guruprasath-v@users.noreply.github.com> Date: Wed, 13 Nov 2024 03:20:35 +0530 Subject: [PATCH] Refactor config.json settings tables in configuration-settings.rst files to remove horizontal bars (#7549) * Refactor config.json settings tables in configuration-settings.rst files to remove horizontal bars * Fixed build errors --------- Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> --- .../authentication-configuration-settings.rst | 1445 +++++++++-------- .../environment-configuration-settings.rst | 7 +- .../plugins-configuration-settings.rst | 675 ++++---- .../configure/site-configuration-settings.rst | 1075 ++++++------ 4 files changed, 1618 insertions(+), 1584 deletions(-) diff --git a/source/configure/authentication-configuration-settings.rst b/source/configure/authentication-configuration-settings.rst index 2adc13e1bcb..90b199b49fc 100644 --- a/source/configure/authentication-configuration-settings.rst +++ b/source/configure/authentication-configuration-settings.rst @@ -45,18 +45,19 @@ Access the following configuration settings in the System Console by going to ** Enable account creation ~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| - **true**: **(Default)** Anyone can sign up for a user account | - System Config path: **Authentication > Signup** | -| on this server without needing to be invited. | - ``config.json`` setting: ``.TeamSettings.EnableUserCreation: true`` | -| Applies to email-based signups only. | - Environment variable: ``MM_TEAMSETTINGS_ENABLEUSERCREATION`` | -| - **false**: The ability to create accounts is disabled. | | -| Selecting **Create Account** displays an error. | | -| Applies to email, OpenID Connect, and OAuth 2.0 user account authentication. | | -+---------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| **Note**: LDAP and SAML users can always create a Mattermost account by logging in using LDAP or SAML user credentials, regardless of whether this | -| configuration setting is enabled. | -+---------------------------------------------------------------------------------+------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| - **true**: **(Default)** Anyone can sign up for a user account | - System Config path: **Authentication > Signup** | +| on this server without needing to be invited. | - ``config.json`` setting: ``TeamSettings`` > ``EnableUserCreation`` > ``true`` | +| Applies to email-based signups only. | - Environment variable: ``MM_TEAMSETTINGS_ENABLEUSERCREATION`` | +| - **false**: The ability to create accounts is disabled. | | +| Selecting **Create Account** displays an error. | | +| Applies to email, OpenID Connect, and OAuth 2.0 user account authentication. | | ++---------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +.. note:: + LDAP and SAML users can always create a Mattermost account by logging in using LDAP or SAML user credentials, regardless of whether this + configuration setting is enabled. + .. config:setting:: signup-restrictcreationtodomains :displayname: Restrict account creation to specified email domains (Signup) :systemconsole: Authentication > Signup @@ -72,11 +73,11 @@ Enable account creation Restrict account creation to specified email domains ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ -| This setting limits the email address domains that can be used to create a new account or team. You **must** set :ref:`Require Email Verification ` to ``true`` for the restriction to function. This setting only affects email login. | - System Config path: **Authentication > Signup** | -| | - ``config.json`` setting: ``.TeamSettings.RestrictCreationToDomains`` | -| String input of a comma-separated list of domains, i.e. ``corp.mattermost.com, mattermost.com`` | - Environment variable: ``MM_TEAMSETTINGS_RESTRICTCREATIONTODOMAINS`` | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| This setting limits the email address domains that can be used to create a new account or team. You **must** set :ref:`Require Email Verification ` to ``true`` for the restriction to function. This setting only affects email login. | - System Config path: **Authentication > Signup** | +| | - ``config.json`` setting: ``TeamSettings`` > ``RestrictCreationToDomains`` | +| String input of a comma-separated list of domains, i.e. ``corp.mattermost.com, mattermost.com`` | - Environment variable: ``MM_TEAMSETTINGS_RESTRICTCREATIONTODOMAINS`` | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ .. config:setting:: signup-enableopenserver :displayname: Enable open server (Signup) @@ -90,11 +91,11 @@ Restrict account creation to specified email domains Enable open server ~~~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ -| - **true**: Users can create accounts on the server without an invitation. | - System Config path: **Authentication > Signup** | -| - **false**: **(Default)** Users **must** have an invitation to create an account on the server. | - ``config.json`` setting: ``.TeamSettings.EnableOpenServer`` | -| | - Environment variable: ``MM_TEAMSETTINGS_ENABLEOPENSERVER`` | -+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ +| - **true**: Users can create accounts on the server without an invitation. | - System Config path: **Authentication > Signup** | +| - **false**: **(Default)** Users **must** have an invitation to create an account on the server. | - ``config.json`` setting: ``TeamSettings`` > ``EnableOpenServer`` | +| | - Environment variable: ``MM_TEAMSETTINGS_ENABLEOPENSERVER`` | ++--------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: signup-enableemailinvitations :displayname: Enable email invitations (Signup) @@ -108,14 +109,15 @@ Enable open server Enable email invitations ~~~~~~~~~~~~~~~~~~~~~~~~ -+--------------------------------------------------------+-------------------------------------------------------------------------------+ -| - **true**: **(Default for Cloud deployments)** | - System Config path: **Authentication > Signup** | -| Allows users to send email invitations. | - ``config.json`` setting: ``.ServiceSettings.EnableEmailInvitations: false`` | -| - **false**: **(Default for self-hosted deployments)** | - Environment variable: ``MM_SERVICESETTINGS_ENABLEEMAILINVITATIONS`` | -| Disables email invitations. | | -+--------------------------------------------------------+-------------------------------------------------------------------------------+ -| **Note**: Cloud admins can't modify this configuration setting. | -+--------------------------------------------------------+-------------------------------------------------------------------------------+ ++--------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| - **true**: **(Default for Cloud deployments)** | - System Config path: **Authentication > Signup** | +| Allows users to send email invitations. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableEmailInvitations`` > ``false`` | +| - **false**: **(Default for self-hosted deployments)** | - Environment variable: ``MM_SERVICESETTINGS_ENABLEEMAILINVITATIONS`` | +| Disables email invitations. | | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------+ + +.. note:: + Cloud admins can't modify this configuration setting. Invalidate pending email invites ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -148,13 +150,14 @@ Access the following configuration settings in the System Console by going to ** Enable account creation with email ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ -| - **true**: **(Default)** Allows creation of team and user accounts with email and password. | - System Config path: **Authentication > Email** | -| - **false**: Disables creation of team and user accounts with email and password. Requires | - ``config.json`` setting: ``.EmailSettings.EnableSignUpWithEmail`` | -| a single sign-on (SSO) service to create accounts. | - Environment variable: ``MM_EMAILSETTINGS_ENABLESIGNUPWITHEMAIL`` | -+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ -| **Note**: Cloud admins can't modify this configuration setting. | -+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ +| - **true**: **(Default)** Allows creation of team and user accounts with email and password. | - System Config path: **Authentication > Email** | +| - **false**: Disables creation of team and user accounts with email and password. Requires | - ``config.json`` setting: ``EmailSettings`` > ``EnableSignUpWithEmail`` | +| a single sign-on (SSO) service to create accounts. | - Environment variable: ``MM_EMAILSETTINGS_ENABLESIGNUPWITHEMAIL`` | ++-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + +.. note:: + Cloud admins can't modify this configuration setting. .. config:setting:: email-requireverification :displayname: Require email verification (Signup) @@ -168,14 +171,14 @@ Enable account creation with email Require email verification ~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| - **true**: **(Default for Cloud deployments)** | - System Config path: **Authentication > Email** | -| Requires email verification for new accounts | - ``config.json`` setting: ``.EmailSettings.RequireEmailVerification: false`` | -| before allowing the user to sign-in. | - Environment variable: ``MM_EMAILSETTINGS_REQUIREEMAILVERIFICATION`` | -| - **false**: **(Default for self-hosted deployments)** | | -| Disables email verification. can be used to speed development by | | -| skipping the verification process. | | -+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| - **true**: **(Default for Cloud deployments)** | - System Config path: **Authentication > Email** | +| Requires email verification for new accounts | - ``config.json`` setting: ``EmailSettings`` > ``RequireEmailVerification`` > ``false`` | +| before allowing the user to sign-in. | - Environment variable: ``MM_EMAILSETTINGS_REQUIREEMAILVERIFICATION`` | +| - **false**: **(Default for self-hosted deployments)** | | +| Disables email verification. can be used to speed development by | | +| skipping the verification process. | | ++-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ .. config:setting:: email-enablesigninwithemail :displayname: Enable sign-in with email (Signup) @@ -190,14 +193,15 @@ Enable sign-in with email ~~~~~~~~~~~~~~~~~~~~~~~~~ +-----------------------------------------------------------------------------+-------------------------------------------------------------------------+ -| - **true**: **(Default)** Allows users to sign-in with email and password. | - ``config.json`` setting: ``.EmailSettings.EnableSignInWithEmail`` | -| - **false**: Disables authentication with email and password, | - System Config path: **Authentication > Email** | +| - **true**: **(Default)** Allows users to sign-in with email and password. | - System Config path: **Authentication > Email** | +| - **false**: Disables authentication with email and password, | - ``config.json`` setting: ``EmailSettings`` > ``EnableSignInWithEmail``| | and removes the option from the login screen. Use this option to limit | - Environment variable: ``MM_EMAILSETTINGS_ENABLESIGNINWITHEMAIL`` | | authentication to single sign-on services. | | +-----------------------------------------------------------------------------+-------------------------------------------------------------------------+ -| **Note**: To provide users with only a single email sign in option on the login page, ensure that the | -| `enable sign-in with username <#enable-sign-in-with-username>`__ configuration setting is set to **false**. | -+-----------------------------------------------------------------------------+-------------------------------------------------------------------------+ + +.. note:: + To provide users with only a single email sign in option on the login page, ensure that the + `enable sign-in with username <#enable-sign-in-with-username>`__ configuration setting is set to **false**. .. config:setting:: email-enablesigninwithusername :displayname: Enable sign-in with username (Signup) @@ -211,15 +215,16 @@ Enable sign-in with email Enable sign-in with username ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| - **true**: **(Default)** Allows authentication with a username and password for | - System Config path: **Authentication > Email** | -| accounts created with an email address. This setting does not affect AD/LDAP | - ``config.json`` setting: ``.EmailSettings.EnableSignInWithUsername`` | -| sign-in. | - Environment variable: ``MM_EMAILSETTINGS_ENABLESIGNINWITHUSERNAME`` | -| - **false**: Disables authenticaton with a username and removes the sign in option from. | | -| from the login screen. | | -+------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| **Note**: We highly recommended that email-based authentication is only used in small teams on private networks. | -+------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ +| - **true**: **(Default)** Allows authentication with a username and password for | - System Config path: **Authentication > Email** | +| accounts created with an email address. This setting does not affect AD/LDAP | - ``config.json`` setting: ``EmailSettings`` > ``EnableSignInWithUsername`` | +| sign-in. | - Environment variable: ``MM_EMAILSETTINGS_ENABLESIGNINWITHUSERNAME`` | +| - **false**: Disables authenticaton with a username and removes the sign in option from. | | +| from the login screen. | | ++------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ + +.. note:: + We highly recommended that email-based authentication is only used in small teams on private networks. ---- @@ -245,11 +250,11 @@ Minimum password length

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+-----------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ -| This setting determines the minimum number of characters in passwords. It must be a whole number greater than or equal to 5 and less than or equal to 72. | - System Config path: **Authentication > Password** | -| | - ``config.json`` setting: ``.PasswordSettings.MinimumLength`` | -| Numerical input. Default is **5**. | - Environment variable: ``MM_PASSWORDSETTINGS_MINIMUMLENGTH`` | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ +| This setting determines the minimum number of characters in passwords. It must be a whole number greater than or equal to 5 and less than or equal to 72. | - System Config path: **Authentication > Password** | +| | - ``config.json`` setting: ``PasswordSettings`` > ``MinimumLength`` | +| Numerical input. Default is **5**. | - Environment variable: ``MM_PASSWORDSETTINGS_MINIMUMLENGTH`` | ++-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. config:setting:: password-lowercase :displayname: Password requirements - At least one lowercase letter (Password) @@ -286,18 +291,18 @@ Password requirements

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| This setting controls password character requirements. By checking the corresponding box, passwords must contain: | - System Config path: **Authentication > Password** | -| | - ``config.json`` settings: ``.PasswordSettings.Lowercase: false``, ``.PasswordSettings.Uppercase: false``, ``.PasswordSettings.Number: false``, ``.PasswordSettings.Symbol: false`` | -| - **At least one lowercase letter** | - Environment variables: ``MM_PASSWORDSETTINGS_LOWERCASE``, ``MM_PASSWORDSETTINGS_UPPERCASE``, ``MM_PASSWORDSETTINGS_NUMBER``, ``MM_PASSWORDSETTINGS_SYMBOL`` | -| - **At least one uppercase letter** | | -| - **At least one number** | | -| - **At least one symbol** out of these: ``!"#$%&'()*+,-./:;<=>?@[]^_`|~``. | | -| | | -| The error message previewed in the System Console will appear if the user attempts to set an invalid password. | | -| | | -| The default for all boxes is unchecked. The default for all settings in ``config.json`` is ``false``. | | -+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| This setting controls password character requirements. By checking the corresponding box, passwords must contain: | - System Config path: **Authentication > Password** | +| | - ``config.json`` settings: ``PasswordSettings`` > ``Lowercase`` > ``false``, ``PasswordSettings`` > ``Uppercase`` > ``false``, ``PasswordSettings`` > ``Number`` > ``false``, ``PasswordSettings`` > ``Symbol`` > ``false`` | +| - **At least one lowercase letter** | - Environment variables: ``MM_PASSWORDSETTINGS_LOWERCASE``, ``MM_PASSWORDSETTINGS_UPPERCASE``, ``MM_PASSWORDSETTINGS_NUMBER``, ``MM_PASSWORDSETTINGS_SYMBOL`` | +| - **At least one uppercase letter** | | +| - **At least one number** | | +| - **At least one symbol** out of these: ``!"#$%&'()*+,-./:;<=>?@[]^_`|~``. | | +| | | +| The error message previewed in the System Console will appear if the user attempts to set an invalid password. | | +| | | +| The default for all boxes is unchecked. The default for all settings in ``config.json`` is ``false``. | | ++-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: password-maximumloginattempts :displayname: Maximum login attempts (Password) @@ -309,11 +314,11 @@ Password requirements Maximum login attempts ~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -| This setting determines the number of failed sign-in attempts a user can make before being locked out and required to go through a password reset by email. | - System Config path: **Authentication > Password** | -| | - ``config.json`` setting: ``.ServiceSettings.MaximumLoginAttempts: 10`` | -| Numerical input. Default is **10**. | - Environment variable: ``MM_SERVICESETTINGS_MAXIMUMLOGINATTEMPTS`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ +| This setting determines the number of failed sign-in attempts a user can make before being locked out and required to go through a password reset by email. | - System Config path: **Authentication > Password** | +| | - ``config.json`` setting: ``ServiceSettings`` > ``MaximumLoginAttempts`` > ``10`` | +| Numerical input. Default is **10**. | - Environment variable: ``MM_SERVICESETTINGS_MAXIMUMLOGINATTEMPTS`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ .. config:setting:: password-forgotpasswordlink :displayname: Enable forgot password link (Password) @@ -328,14 +333,15 @@ Maximum login attempts Enable forgot password link ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| - **true**: **(Default)** Displays the **Forget Password** link on the | - System Config path: **Authentication > Enable forgot password link** | -| Mattermost login page. | - ``config.json`` setting: ``.LdapSettings.ForgotPasswordLink: true`` | -| - **false**: Hides the **Forgot Password** link from the Mattermost login page. | - Environment variable: ``MM_LDAPSETTINGS_FORGOTPASSWORDLINK`` | -+---------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| **Note**: You can customize the **Forgot Password** link URL by going to **Site Configuration > Customization > Forgot Password Custom Link**. | -| See the :ref:`configuration ` documentation for details. | -+---------------------------------------------------------------------------------+------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| - **true**: **(Default)** Displays the **Forget Password** link on the | - System Config path: **Authentication > Enable forgot password link** | +| Mattermost login page. | - ``config.json`` setting: ``LdapSettings`` > ``ForgotPasswordLink`` > ``true`` | +| - **false**: Hides the **Forgot Password** link from the Mattermost login page. | - Environment variable: ``MM_LDAPSETTINGS_FORGOTPASSWORDLINK`` | ++---------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. note:: + You can customize the **Forgot Password** link URL by going to **Site Configuration > Customization > Forgot Password Custom Link**. + See the :ref:`configuration ` documentation for details. ---- @@ -361,11 +367,11 @@ We recommend deploying Mattermost within your own private network, and using VPN Enable multi-factor authentication ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| - **true**: Users who sign-in with AD/LDAP or an email address have the option to add | - System Config path: **Authentication > MFA** | -| :doc:`multi-factor authentication ` to their accounts. | - ``config.json`` setting: ``.ServiceSettings.EnableMultifactorAuthentication: false`` | -| - **false**: **(Default)** Disables multi-factor authentication. | - Environment variable: ``MM_SERVICESETTINGS_ENABLEMULTIFACTORAUTHENTICATION`` | -+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| - **true**: Users who sign-in with AD/LDAP or an email address have the option to add | - System Config path: **Authentication > MFA** | +| :doc:`multi-factor authentication ` to their accounts. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableMultifactorAuthentication`` > ``false`` | +| - **false**: **(Default)** Disables multi-factor authentication. | - Environment variable: ``MM_SERVICESETTINGS_ENABLEMULTIFACTORAUTHENTICATION`` | ++------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ .. config:setting:: mfa-enforcemfa :displayname: Enforce multi-factor authentication (MFA) @@ -387,17 +393,18 @@ Enforce multi-factor authentication

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| - **true**: Requires `multi-factor authentication (MFA) | - System Config path: **Authentication > MFA** | -| `__ | - ``config.json`` setting: ``.ServiceSettings.EnforceMultifactorAuthentication: false`` | -| for users who sign-in with AD/LDAP or an email address. | - Environment variable: ``MM_SERVICESETTINGS_ENFORCEMULTIFACTORAUTHENTICATION`` | -| New users must set up MFA. Logged in users are redirected to the MFA | | -| setup page until configuration is complete. | | -| - **false**: **(Default)** MFA is optional. | | -+----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| **Note**: If your system has users who authenticate with methods other than AD/LDAP and email, MFA must be enforced with the authentication provider | -| outside of Mattermost. | -+----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ +| - **true**: Requires `multi-factor authentication (MFA) | - System Config path: **Authentication > MFA** | +| `__ | - ``config.json`` setting: ``ServiceSettings`` > ``EnforceMultifactorAuthentication`` > ``false`` | +| for users who sign-in with AD/LDAP or an email address. | - Environment variable: ``MM_SERVICESETTINGS_ENFORCEMULTIFACTORAUTHENTICATION`` | +| New users must set up MFA. Logged in users are redirected to the MFA | | +| setup page until configuration is complete. | | +| - **false**: **(Default)** MFA is optional. | | ++----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ + +.. note:: + If your system has users who authenticate with methods other than AD/LDAP and email, MFA must be enforced with the authentication provider + outside of Mattermost. ---- @@ -425,11 +432,11 @@ Enable sign-in with AD/LDAP

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+-------------------------------------------------------------------------------+-----------------------------------------------------------------+ -| - **true**: Allows sign-in with AD/LDAP. | - System Config path: **Authentication > AD/LDAP** | -| - **false**: **(Default)** Disables sign-in with AD/LDAP. | - ``config.json`` setting: ``.LdapSettings.Enable: false`` | -| | - Environment variable: ``MM_LDAPSETTINGS_ENABLE`` | -+-------------------------------------------------------------------------------+-----------------------------------------------------------------+ ++-------------------------------------------------------------------------------+---------------------------------------------------------------------------+ +| - **true**: Allows sign-in with AD/LDAP. | - System Config path: **Authentication > AD/LDAP** | +| - **false**: **(Default)** Disables sign-in with AD/LDAP. | - ``config.json`` setting: ``LdapSettings`` > ``Enable`` > ``false`` | +| | - Environment variable: ``MM_LDAPSETTINGS_ENABLE`` | ++-------------------------------------------------------------------------------+---------------------------------------------------------------------------+ .. config:setting:: ldap-enablesync :displayname: Enable synchronization with AD/LDAP (AD/LDAP) @@ -447,17 +454,18 @@ Enable synchronization with AD/LDAP

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+---------------------------------------------------------------+----------------------------------------------------------------+ -| - **true**: Mattermost periodically syncs users from AD/LDAP. | - System Config path: **Authentication > AD/LDAP** | -| - **false**: **(Default)** Disables AD/LDAP synchronization. | - ``config.json`` setting: ``.LdapSettings.EnableSync: false`` | -| | - Environment variable: ``MM_LDAPSETTINGS_ENABLESYNC`` | -+---------------------------------------------------------------+----------------------------------------------------------------+ -| **Note**: Synchronization with AD/LDAP settings in the System Console can be used to determine the connectivity and | -| availability of arbitrary hosts. System admins concerned about this can use custom admin roles to limit access to | -| modifying these settings. See the | -| :ref:`delegated granular administration ` | -| documentation for details. | -+---------------------------------------------------------------+----------------------------------------------------------------+ ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| - **true**: Mattermost periodically syncs users from AD/LDAP. | - System Config path: **Authentication > AD/LDAP** | +| - **false**: **(Default)** Disables AD/LDAP synchronization. | - ``config.json`` setting: ``LdapSettings`` > ``EnableSync`` > ``false`` | +| | - Environment variable: ``MM_LDAPSETTINGS_ENABLESYNC`` | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ + +.. note:: + Synchronization with AD/LDAP settings in the System Console can be used to determine the connectivity and + availability of arbitrary hosts. System admins concerned about this can use custom admin roles to limit access to + modifying these settings. See the + :ref:`delegated granular administration ` + documentation for details. .. config:setting:: ldap-loginfieldname :displayname: Login field name (AD/LDAP) @@ -473,11 +481,11 @@ Login field name

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+----------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ -| This setting will display placeholder text in the login field of the sign-in page. This text can remind users to sign-in with their AD/LDAP credentials. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.LoginFieldName`` | -| String input. Default is ``AD/LDAP Username``. | - Environment variable: ``MM_LDAPSETTINGS_LOGINFIELDNAME`` | -+----------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| This setting will display placeholder text in the login field of the sign-in page. This text can remind users to sign-in with their AD/LDAP credentials. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``LoginFieldName`` | +| String input. Default is ``AD/LDAP Username``. | - Environment variable: ``MM_LDAPSETTINGS_LOGINFIELDNAME`` | ++----------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: ldap-server :displayname: AD/LDAP server (AD/LDAP) @@ -493,17 +501,18 @@ AD/LDAP server

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+--------------------------------------------------------------+------------------------------------------------------------------+ -| This is the domain name or IP address of the AD/LDAP server. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.LdapServer`` | -| String input. | - Environment variable: ``MM_LDAPSETTINGS_LDAPSERVER`` | -+--------------------------------------------------------------+------------------------------------------------------------------+ -| **Note**: Synchronization with AD/LDAP settings in the System Console can be used to determine the connectivity and | -| availability of arbitrary hosts. System admins concerned about this can use custom admin roles to limit access to | -| modifying these settings. See the | -| :ref:`delegated granular administration ` | -| documentation for details. | -+--------------------------------------------------------------+------------------------------------------------------------------+ ++--------------------------------------------------------------+-----------------------------------------------------------------------+ +| This is the domain name or IP address of the AD/LDAP server. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``LdapServer`` | +| String input. | - Environment variable: ``MM_LDAPSETTINGS_LDAPSERVER`` | ++--------------------------------------------------------------+-----------------------------------------------------------------------+ + +.. note:: + Synchronization with AD/LDAP settings in the System Console can be used to determine the connectivity and + availability of arbitrary hosts. System admins concerned about this can use custom admin roles to limit access to + modifying these settings. See the + :ref:`delegated granular administration ` + documentation for details. .. config:setting:: ldap-port :displayname: AD/LDAP port (AD/LDAP) @@ -519,11 +528,11 @@ AD/LDAP port

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+--------------------------------------------------------------------+------------------------------------------------------------+ -| This is the port Mattermost uses to connect to the AD/LDAP server. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.LdapPort: 389`` | -| Numerical input. Default is **389**. | - Environment variable: ``MM_LDAPSETTINGS_LDAPPORT`` | -+--------------------------------------------------------------------+------------------------------------------------------------+ ++--------------------------------------------------------------------+----------------------------------------------------------------------+ +| This is the port Mattermost uses to connect to the AD/LDAP server. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``LdapPort`` > ``389`` | +| Numerical input. Default is **389**. | - Environment variable: ``MM_LDAPSETTINGS_LDAPPORT`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------+ .. config:setting:: ldap-connectionsecurity :displayname: Connection security (AD/LDAP) @@ -544,19 +553,19 @@ Connection security

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+------------------------------------------------------------------------------+---------------------------------------------------------------------+ -| This setting controls the type of security Mattermost uses to | - System Config path: **Authentication > AD/LDAP** | -| connect to the AD/LDAP server, with these options: | - ``config.json`` setting: ``.LdapSettings.ConnectionSecurity: ""`` | -| | - Environment variable: ``MM_LDAPSETTINGS_CONNECTIONSECURITY`` | -| - **None**: **(Default for self-hosted deployments)** No encryption. | | -| With this option, it is **highly recommended** that the connection be | | -| secured outside of Mattermost, such as by a stunnel proxy. | | -| ``config.json`` option: ``""`` | | -| - **TLS**: **(Default for Cloud deployments)** Encrypts | | -| communication with TLS. ``config.json`` option: ``"TLS"`` | | -| - **STARTTLS**: Attempts to upgrade an existing insecure connection | | -| to a secure connection with TLS. ``config.json`` option: ``"STARTTLS"`` | | -+------------------------------------------------------------------------------+---------------------------------------------------------------------+ ++------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| This setting controls the type of security Mattermost uses to | - System Config path: **Authentication > AD/LDAP** | +| connect to the AD/LDAP server, with these options: | - ``config.json`` setting: ``LdapSettings`` > ``ConnectionSecurity`` > ``""`` | +| | - Environment variable: ``MM_LDAPSETTINGS_CONNECTIONSECURITY`` | +| - **None**: **(Default for self-hosted deployments)** No encryption. | | +| With this option, it is **highly recommended** that the connection be | | +| secured outside of Mattermost, such as by a stunnel proxy. | | +| ``config.json`` option: ``""`` | | +| - **TLS**: **(Default for Cloud deployments)** Encrypts | | +| communication with TLS. ``config.json`` option: ``"TLS"`` | | +| - **STARTTLS**: Attempts to upgrade an existing insecure connection | | +| to a secure connection with TLS. ``config.json`` option: ``"STARTTLS"`` | | ++------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. config:setting:: ldap-skipcertverification :displayname: Skip certificate verification (AD/LDAP) @@ -574,11 +583,11 @@ Skip certificate verification

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ -| - **true**: Disables the certificate verification step for TLS and STARTTLS connections. Use this option for testing. **Do not use** this option when TLS is required in production. | - System Config path: **Authentication > AD/LDAP** | -| - **false**: **(Default)** Enables certification verification. | - ``config.json`` setting: ``.LdapSettings.SkipCertificateVerification: false`` | -| | - Environment variable: ``MM_LDAPSETTINGS_SKIPCERTIFICATEVERIFICATION`` | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| - **true**: Disables the certificate verification step for TLS and STARTTLS connections. Use this option for testing. **Do not use** this option when TLS is required in production. | - System Config path: **Authentication > AD/LDAP** | +| - **false**: **(Default)** Enables certification verification. | - ``config.json`` setting: ``LdapSettings`` > ``SkipCertificateVerification`` > ``false`` | +| | - Environment variable: ``MM_LDAPSETTINGS_SKIPCERTIFICATEVERIFICATION`` | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+ .. config:setting:: ldap-privatekey :displayname: Private key (AD/LDAP) @@ -594,11 +603,11 @@ Private key

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ -| Use this setting to upload the private key file from your LDAP authentication provider, if TLS client certificates are the primary authentication mechanism.| - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.PrivateKeyFile`` | -| String input. | - Environment variable: ``MM_LDAPSETTINGS_PRIVATEKEYFILE`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| Use this setting to upload the private key file from your LDAP authentication provider, if TLS client certificates are the primary authentication mechanism.| - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``PrivateKeyFile`` | +| String input. | - Environment variable: ``MM_LDAPSETTINGS_PRIVATEKEYFILE`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: ldap-publiccert :displayname: Public certificate (AD/LDAP) @@ -614,11 +623,11 @@ Public certificate

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| Use this setting to upload the public TLS certificate from your LDAP authentication provider, if TLS client certificates are the primary authentication mechanism. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.PublicCertificateFile`` | -| String input. | - Environment variable: ``MM_LDAPSETTINGS_PUBLICCERTIFICATEFILE`` | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ +| Use this setting to upload the public TLS certificate from your LDAP authentication provider, if TLS client certificates are the primary authentication mechanism. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``PublicCertificateFile`` | +| String input. | - Environment variable: ``MM_LDAPSETTINGS_PUBLICCERTIFICATEFILE`` | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ .. config:setting:: ldap-bindusername :displayname: Bind username (AD/LDAP) @@ -639,17 +648,18 @@ Bind username

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ -| This is the username for the account Mattermost utilizes to perform an AD/LDAP search. This should be an account specific to Mattermost. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.BindUsername`` | -| Limit the permissions of the account to read-only access to the portion of the AD/LDAP tree specified in the **Base DN** setting. | - Environment variable: ``MM_LDAPSETTINGS_BINDUSERNAME`` | -| | | -| When using Active Directory, **Bind Username** should specify domain in ``"DOMAIN/username"`` format. | | -| | | -| String input. | | -+------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ -| **Note**: This field is required. Anonymous bind is not currently supported. | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ +| This is the username for the account Mattermost utilizes to perform an AD/LDAP search. This should be an account specific to Mattermost. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``BindUsername`` | +| Limit the permissions of the account to read-only access to the portion of the AD/LDAP tree specified in the **Base DN** setting. | - Environment variable: ``MM_LDAPSETTINGS_BINDUSERNAME`` | +| | | +| When using Active Directory, **Bind Username** should specify domain in ``"DOMAIN/username"`` format. | | +| | | +| String input. | | ++------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + +.. note:: + This field is required. Anonymous bind is not currently supported. .. config:setting:: ldap-bindpassword :displayname: Bind password (AD/LDAP) @@ -665,11 +675,11 @@ Bind password

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+-------------------------------------------------------------------------------+-----------------------------------------------------------+ -| This is the password for the username given in the **Bind Username** setting. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.BindPassword`` | -| String input. | - Environment variable: ``MM_LDAPSETTINGS_BINDPASSWORD`` | -+-------------------------------------------------------------------------------+-----------------------------------------------------------+ ++-------------------------------------------------------------------------------+----------------------------------------------------------------+ +| This is the password for the username given in the **Bind Username** setting. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``BindPassword`` | +| String input. | - Environment variable: ``MM_LDAPSETTINGS_BINDPASSWORD`` | ++-------------------------------------------------------------------------------+----------------------------------------------------------------+ .. config:setting:: ldap-basedn :displayname: Base DN (AD/LDAP) @@ -685,11 +695,11 @@ Base DN

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| This is the **Base Distinguished Name** of the location in the AD/LDAP tree where Mattermost will start searching for users. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.BaseDN`` | -| String input. | - Environment variable: ``MM_LDAPSETTINGS_BASEDN`` | -+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ +| This is the **Base Distinguished Name** of the location in the AD/LDAP tree where Mattermost will start searching for users. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``BaseDN`` | +| String input. | - Environment variable: ``MM_LDAPSETTINGS_BASEDN`` | ++------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ .. config:setting:: ldap-userfilter :displayname: User filter (AD/LDAP) @@ -705,15 +715,16 @@ User filter

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ -| This setting accepts a `general syntax `__ AD/LDAP filter that is applied when searching for user objects. Only the users selected by the query can access Mattermost. For example, to filter out disabled users, the filter is: ``(&(objectCategory=Person)(!(UserAccountControl:1.2.840.113556.1.4.803:=2)))``. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.UserFilter`` | -| To filter by group membership, determine the ``distinguishedName`` of the group, then use group membership general syntax to format the filter. For example, if the security group ``distinguishedName`` is ``CN=group1,OU=groups,DC=example,DC=com``, then the filter is: ``(memberOf=CN=group1,OU=groups,DC=example,DC=com)``. The user must explicitly belong to this group for the filter to apply. | - Environment variable: ``MM_LDAPSETTINGS_USERFILTER`` | -| | | -| String input. | | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ -| **Note**: This filter uses the permissions of the **Bind Username** account to execute the search. This account should be specific to Mattermost and have read-only access to the portion of the AD/LDAP tree specified in the **Base DN** field. | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ +| This setting accepts a `general syntax `__ AD/LDAP filter that is applied when searching for user objects. Only the users selected by the query can access Mattermost. For example, to filter out disabled users, the filter is: ``(&(objectCategory=Person)(!(UserAccountControl:1.2.840.113556.1.4.803:=2)))``. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``UserFilter`` | +| To filter by group membership, determine the ``distinguishedName`` of the group, then use group membership general syntax to format the filter. For example, if the security group ``distinguishedName`` is ``CN=group1,OU=groups,DC=example,DC=com``, then the filter is: ``(memberOf=CN=group1,OU=groups,DC=example,DC=com)``. The user must explicitly belong to this group for the filter to apply. | - Environment variable: ``MM_LDAPSETTINGS_USERFILTER`` | +| | | +| String input. | | ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ + +.. note:: + This filter uses the permissions of the **Bind Username** account to execute the search. This account should be specific to Mattermost and have read-only access to the portion of the AD/LDAP tree specified in the **Base DN** field. .. config:setting:: ldap-groupfilter :displayname: Group filter (AD/LDAP) @@ -732,13 +743,14 @@ Group filter

Also available in legacy Mattermost Enterprise Edition E20

-+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ -| This setting accepts a `general syntax `__ AD/LDAP filter that is applied when searching for group objects. Only the groups selected by the query can access Mattermost.| - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.GroupFilter`` | -| String input. Default is ``(|(objectClass=group)(objectClass=groupOfNames)(objectClass=groupOfUniqueNames))``. | - Environment variable: ``MM_LDAPSETTINGS_GROUPFILTER`` | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ -| **Note**: This filter is only used when AD/LDAP Group Sync is enabled. See :doc:`AD/LDAP Group Sync ` for more information. | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ +| This setting accepts a `general syntax `__ AD/LDAP filter that is applied when searching for group objects. Only the groups selected by the query can access Mattermost.| - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``GroupFilter`` | +| String input. Default is ``(|(objectClass=group)(objectClass=groupOfNames)(objectClass=groupOfUniqueNames))``. | - Environment variable: ``MM_LDAPSETTINGS_GROUPFILTER`` | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ + +.. note:: + This filter is only used when AD/LDAP Group Sync is enabled. See :doc:`AD/LDAP Group Sync ` for more information. .. config:setting:: ldap-enableadminfilter :displayname: Enable admin filter (AD/LDAP) @@ -756,13 +768,14 @@ Enable admin filter

Also available in legacy Mattermost Enterprise Edition E20

-+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| - **true**: Enables the **Admin Filter** setting that designates system admins using an AD/LDAP filter. | - System Config path: **Authentication > AD/LDAP** | -| - **false**: **(Default)** Disables the **Admin Filter** setting. | - ``config.json`` setting: ``.LdapSettings.EnableAdminFilter: false`` | -| | - Environment variable: ``MM_LDAPSETTINGS_ENABLEADMINFILTER`` | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| **Note**: If this setting is ``false``, no additional users are designated as system admins by the filter. Users that were previously designated as system admins retain this role unless the filter is changed or removed. | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| - **true**: Enables the **Admin Filter** setting that designates system admins using an AD/LDAP filter. | - System Config path: **Authentication > AD/LDAP** | +| - **false**: **(Default)** Disables the **Admin Filter** setting. | - ``config.json`` setting: ``LdapSettings`` > ``EnableAdminFilter`` > ``false`` | +| | - Environment variable: ``MM_LDAPSETTINGS_ENABLEADMINFILTER`` | ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ + +.. note:: + If this setting is ``false``, no additional users are designated as system admins by the filter. Users that were previously designated as system admins retain this role unless the filter is changed or removed. .. config:setting:: ldap-adminfilter :displayname: Admin filter (AD/LDAP) @@ -778,13 +791,13 @@ Admin filter

Also available in legacy Mattermost Enterprise Edition E20

-+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ -| This setting accepts an AD/LDAP filter that designates the selected users as system admins. Users are promoted to this role on their next sign-in or on the next scheduled AD/LDAP sync. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.AdminFilter`` | -| If the Admin Filter is removed, users who are currently logged in retain their Admin role until their next sign-in. | - Environment variable: ``MM_LDAPSETTINGS_ADMINFILTER`` | -| | | -| String input. | | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ +| This setting accepts an AD/LDAP filter that designates the selected users as system admins. Users are promoted to this role on their next sign-in or on the next scheduled AD/LDAP sync. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``AdminFilter`` | +| If the Admin Filter is removed, users who are currently logged in retain their Admin role until their next sign-in. | - Environment variable: ``MM_LDAPSETTINGS_ADMINFILTER`` | +| | | +| String input. | | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ .. config:setting:: ldap-guestfilter :displayname: Guest filter (AD/LDAP) @@ -800,13 +813,13 @@ Guest filter

Also available in legacy Mattermost Enterprise Edition E20

-+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ -| This setting accepts an AD/LDAP filter to apply when searching for external users with Guest Access to Mattermost. Only users selected by the query can access Mattermost as Guests. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.GuestFilter`` | -| See :doc:`Guest Accounts ` for more information. | - Environment variable: ``MM_LDAPSETTINGS_GUESTFILTER`` | -| | | -| String input. | | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ +| This setting accepts an AD/LDAP filter to apply when searching for external users with Guest Access to Mattermost. Only users selected by the query can access Mattermost as Guests. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``GuestFilter`` | +| See :doc:`Guest Accounts ` for more information. | - Environment variable: ``MM_LDAPSETTINGS_GUESTFILTER`` | +| | | +| String input. | | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ .. config:setting:: ldap-idattribute :displayname: ID attribute (AD/LDAP) @@ -824,13 +837,14 @@ ID attribute +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | This is the attribute in the AD/LDAP server that is serves as a unique user identifier in Mattermost. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.IdAttribute`` | +| | - ``config.json`` setting: ``LdapSettings`` > ``IdAttribute`` | | The attribute should have a unique value that does not change, such as ``objectGUID`` or ``entryUUID``. Confirm that these attributes are available in your environment before making any changes. | - Environment variable: ``MM_LDAPSETTINGS_IDATTRIBUTE`` | | | | | String input. | | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| **Note**: If a user's ID Attribute changes, a new Mattermost account is created that is not associated with the previous account. If you need to change this field after users have signed-in, use the :ref:`mmctl ldap idmigrate ` command. | -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + If a user's ID Attribute changes, a new Mattermost account is created that is not associated with the previous account. If you need to change this field after users have signed-in, use the :ref:`mmctl ldap idmigrate ` command. .. config:setting:: ldap-loginidattribute :displayname: Login ID attribute (AD/LDAP) @@ -846,13 +860,13 @@ Login ID attribute

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ -| This is the attribute in the AD/LDAP server that is used for signing-in to Mattermost. This is normally the same as the **Username Attribute**. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.LoginIdAttribute`` | -| If your team uses ``domain\username`` to sign-in to other services with AD/LDAP, you may enter ``domain\username`` in this field to maintain consistency between sites. | - Environment variable: ``MM_LDAPSETTINGS_LOGINIDATTRIBUTE`` | -| | | -| String input. | | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ +| This is the attribute in the AD/LDAP server that is used for signing-in to Mattermost. This is normally the same as the **Username Attribute**. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``LoginIdAttribute`` | +| If your team uses ``domain\username`` to sign-in to other services with AD/LDAP, you may enter ``domain\username`` in this field to maintain consistency between sites. | - Environment variable: ``MM_LDAPSETTINGS_LOGINIDATTRIBUTE`` | +| | | +| String input. | | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ .. config:setting:: ldap-usernameattribute :displayname: Username attribute (AD/LDAP) @@ -868,15 +882,15 @@ Username attribute

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ -| This is the attribute in the AD/LDAP server that populates the username field in Mattermost. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.UsernameAttribute`` | -| This attribute identifies users in the UI. For example, if a Username Attribute is set to ``john.smith``, typing ``@john`` will show ``@john.smith`` as an auto-complete option, and posting a message with ``@john.smith`` will send a notification to that user. | - Environment variable: ``MM_LDAPSETTINGS_USERNAMEATTRIBUTE`` | -| | | -| This is normally the same as the **Login ID Attribute**, but it can be mapped to a different attribute. | | -| | | -| String input. | | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ +| This is the attribute in the AD/LDAP server that populates the username field in Mattermost. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``UsernameAttribute`` | +| This attribute identifies users in the UI. For example, if a Username Attribute is set to ``john.smith``, typing ``@john`` will show ``@john.smith`` as an auto-complete option, and posting a message with ``@john.smith`` will send a notification to that user. | - Environment variable: ``MM_LDAPSETTINGS_USERNAMEATTRIBUTE`` | +| | | +| This is normally the same as the **Login ID Attribute**, but it can be mapped to a different attribute. | | +| | | +| String input. | | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. config:setting:: ldap-emailattribute :displayname: Email attribute (AD/LDAP) @@ -892,13 +906,13 @@ Email attribute

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ -| This is the attribute in AD/LDAP server that populates the email address field in Mattermost. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting ``.LdapSettings.EmailAttribute`` | -| Email notifications are sent to this address. The address may be seen by other Mattermost users depending on privacy settings. | - Environment variable: ``MM_LDAPSETTINGS_EMAILATTRIBUTE`` | -| | | -| String input. | | -+--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ +| This is the attribute in AD/LDAP server that populates the email address field in Mattermost. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting ``LdapSettings`` > ``EmailAttribute`` | +| Email notifications are sent to this address. The address may be seen by other Mattermost users depending on privacy settings. | - Environment variable: ``MM_LDAPSETTINGS_EMAILATTRIBUTE`` | +| | | +| String input. | | ++--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ .. config:setting:: ldap-firstnameattribute :displayname: First name attribute (AD/LDAP) @@ -914,15 +928,15 @@ First name attribute

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ -| This is the attribute in the AD/LDAP server that populates the first name field in Mattermost. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.FirstNameAttribute`` | -| When set, users cannot edit their first name. | - Environment variable: ``MM_LDAPSETTINGS_FIRSTNAMEATTRIBUTE`` | -| | | -| When not set, users can edit their first name in their :doc:`profile settings `. | | -| | | -| String input. | | -+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| This is the attribute in the AD/LDAP server that populates the first name field in Mattermost. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``FirstNameAttribute`` | +| When set, users cannot edit their first name. | - Environment variable: ``MM_LDAPSETTINGS_FIRSTNAMEATTRIBUTE`` | +| | | +| When not set, users can edit their first name in their :doc:`profile settings `. | | +| | | +| String input. | | ++--------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ .. config:setting:: ldap-lastnameattribute :displayname: Last name attribute (AD/LDAP) @@ -938,15 +952,15 @@ Last name attribute

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ -| This is the attribute in the AD/LDAP server that populates the last name field in Mattermost. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.LastNameAttribute`` | -| When set, users cannot edit their last name. | - Environment variable: ``MM_LDAPSETTINGS_LASTNAMEATTRIBUTE`` | -| | | -| When not set, users can edit their last name as part of their :doc:`profile settings `. | | -| | | -| String input. | | -+---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ +| This is the attribute in the AD/LDAP server that populates the last name field in Mattermost. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``LastNameAttribute`` | +| When set, users cannot edit their last name. | - Environment variable: ``MM_LDAPSETTINGS_LASTNAMEATTRIBUTE`` | +| | | +| When not set, users can edit their last name as part of their :doc:`profile settings `. | | +| | | +| String input. | | ++---------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. config:setting:: ldap-nicknameattribute :displayname: Nickname attribute (AD/LDAP) @@ -962,15 +976,15 @@ Nickname attribute

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ -| This is the attribute in the AD/LDAP server that populates the nickname field in Mattermost. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.NicknameAttribute`` | -| When set, users cannot edit their nickname. | - Environment variable: ``MM_LDAPSETTINGS_NICKNAMEATTRIBUTE`` | -| | | -| When not set, users can edit their nickname as part of their :doc:`profile settings `. | | -| | | -| String input. | | -+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ +| This is the attribute in the AD/LDAP server that populates the nickname field in Mattermost. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``NicknameAttribute`` | +| When set, users cannot edit their nickname. | - Environment variable: ``MM_LDAPSETTINGS_NICKNAMEATTRIBUTE`` | +| | | +| When not set, users can edit their nickname as part of their :doc:`profile settings `. | | +| | | +| String input. | | ++--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. config:setting:: ldap-positionattribute :displayname: Position attribute (AD/LDAP) @@ -986,15 +1000,15 @@ Position attribute

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ -| This is the attribute in the AD/LDAP server that populates the position field in Mattermost. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.PositionAttribute`` | -| When set, users cannot edit their position. | - Environment variable: ``MM_LDAPSETTINGS_POSITIONATTRIBUTE`` | -| | | -| When not set, users can edit their position as part of their :doc:`profile settings `. | | -| | | -| String input. | | -+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ +| This is the attribute in the AD/LDAP server that populates the position field in Mattermost. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``PositionAttribute`` | +| When set, users cannot edit their position. | - Environment variable: ``MM_LDAPSETTINGS_POSITIONATTRIBUTE`` | +| | | +| When not set, users can edit their position as part of their :doc:`profile settings `. | | +| | | +| String input. | | ++--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. config:setting:: ldap-profilepictureattribute :displayname: Profile picture attribute (AD/LDAP) @@ -1010,15 +1024,15 @@ Profile picture attribute

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ -| This is the attribute in the AD/LDAP server that syncs and locks the profile picture in Mattermost. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.PictureAttribute`` | -| The image is updated when users sign-in, not when Mattermost syncs with the AD/LDAP server. | - Environment variable: ``MM_LDAPSETTINGS_PICTUREATTRIBUTE`` | -| | | -| The image is not updated if the Mattermost image already matches the AD/LDAP image. | | -| | | -| String input. | | -+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ +| This is the attribute in the AD/LDAP server that syncs and locks the profile picture in Mattermost. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``PictureAttribute`` | +| The image is updated when users sign-in, not when Mattermost syncs with the AD/LDAP server. | - Environment variable: ``MM_LDAPSETTINGS_PICTUREATTRIBUTE`` | +| | | +| The image is not updated if the Mattermost image already matches the AD/LDAP image. | | +| | | +| String input. | | ++-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ .. config:setting:: ldap-groupdisplaynameattribute :displayname: Group display name attribute (AD/LDAP) @@ -1039,11 +1053,12 @@ Group display name attribute +--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | This is the AD/LDAP Group Display name attribute that populates the Mattermost group name field. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.GroupDisplayNameAttribute`` | +| | - ``config.json`` setting: ``LdapSettings`` > ``GroupDisplayNameAttribute`` | | String input. | - Environment variable: ``MM_LDAPSETTINGS_GROUPDISPLAYNAMEATTRIBUTE`` | +--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| **Note**: This attribute is only used when AD/LDAP Group Sync is enabled and it is **required**. See the :doc:`AD/LDAP Group Sync documentation ` for more information. | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This attribute is only used when AD/LDAP Group Sync is enabled and it is **required**. See the :doc:`AD/LDAP Group Sync documentation ` for more information. .. config:setting:: ldap-groupidattribute :displayname: Group ID attribute @@ -1064,13 +1079,14 @@ Group ID attribute +--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | This is an AD/LDAP Group ID attribute that sets a unique identifier for groups. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.GroupIdAttribute`` | +| | - ``config.json`` setting: ``LdapSettings`` > ``GroupIdAttribute`` | | This should be a value that does not change, such as ``entryUUID`` or ``objectGUID``. | - Environment variable: ``MM_LDAPSETTINGS_GROUPIDATTRIBUTE`` | | | | | String input. | | +--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| **Note**: This attribute is only used when AD/LDAP Group Sync is enabled and it is **required**. See the :doc:`AD/LDAP Group Sync documentation ` for more information. | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This attribute is only used when AD/LDAP Group Sync is enabled and it is **required**. See the :doc:`AD/LDAP Group Sync documentation ` for more information. .. config:setting:: ldap-syncinterval :displayname: Synchronization interval (AD/LDAP) @@ -1086,19 +1102,20 @@ Synchronization interval (minutes)

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| This value determines how often Mattermost syncs with the AD/LDAP server by setting the number of minutes between each sync. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.SyncIntervalMinutes: 60`` | -| Syncing with the AD/LDAP server will update Mattermost accounts to match any changes made to AD/LDAP attributes. | - Environment variable: ``MM_LDAPSETTINGS_SYNCINTERVALMINUTES`` | -| | | -| Disabled AD/LDAP accounts become deactivated users in Mattermost, and any active sessions are revoked. | | -| | | -| Use the **AD/LDAP Synchronize Now** button to immediately revoke a session after disabling an AD/LDAP account. | | -| | | -| Numerical input. Default is **60**. | | -+------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| **Note**: LDAP syncs require a large number of database read queries. Monitor database load and adjust the sync interval to minimize performance degradation. | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| This value determines how often Mattermost syncs with the AD/LDAP server by setting the number of minutes between each sync. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``SyncIntervalMinutes`` > ``60`` | +| Syncing with the AD/LDAP server will update Mattermost accounts to match any changes made to AD/LDAP attributes. | - Environment variable: ``MM_LDAPSETTINGS_SYNCINTERVALMINUTES`` | +| | | +| Disabled AD/LDAP accounts become deactivated users in Mattermost, and any active sessions are revoked. | | +| | | +| Use the **AD/LDAP Synchronize Now** button to immediately revoke a session after disabling an AD/LDAP account. | | +| | | +| Numerical input. Default is **60**. | | ++------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + +.. note:: + LDAP syncs require a large number of database read queries. Monitor database load and adjust the sync interval to minimize performance degradation. .. config:setting:: ldap-maxpagesize :displayname: Maximum page size (AD/LDAP) @@ -1114,15 +1131,15 @@ Maximum page size

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ -| This setting paginates the results of AD/LDAP server queries. Use this setting if your AD/LDAP server has a page size limit. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.MaxPageSize: 0`` | -| The recommended setting is **1500**. This is the default AD/LDAP ``MaxPageSize``. | - Environment variable: ``MM_LDAPSETTINGS_MAXPAGESIZE`` | -| | | -| A page size of **0** disables pagination of results. | | -| | | -| Numerical input. Default is **0**. | | -+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| This setting paginates the results of AD/LDAP server queries. Use this setting if your AD/LDAP server has a page size limit. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``MaxPageSize`` > ``0`` | +| The recommended setting is **1500**. This is the default AD/LDAP ``MaxPageSize``. | - Environment variable: ``MM_LDAPSETTINGS_MAXPAGESIZE`` | +| | | +| A page size of **0** disables pagination of results. | | +| | | +| Numerical input. Default is **0**. | | ++------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ .. config:setting:: ldap-querytimeout :displayname: Query timeout (AD/LDAP) @@ -1138,11 +1155,11 @@ Query timeout (seconds)

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+-------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ -| This setting determines the timeout period, in seconds, for AD/LDAP queries. Increase this value to avoid timeout errors when querying a slow server. | - System Config path: **Authentication > AD/LDAP** | -| | - ``config.json`` setting: ``.LdapSettings.QueryTimeout: 60`` | -| Numerical input. Default is **60**. | - Environment variable: ``MM_LDAPSETTINGS_QUERYTIMEOUT`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ +| This setting determines the timeout period, in seconds, for AD/LDAP queries. Increase this value to avoid timeout errors when querying a slow server. | - System Config path: **Authentication > AD/LDAP** | +| | - ``config.json`` setting: ``LdapSettings`` > ``QueryTimeout`` > ``60`` | +| Numerical input. Default is **60**. | - Environment variable: ``MM_LDAPSETTINGS_QUERYTIMEOUT`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ AD/LDAP test ~~~~~~~~~~~~ @@ -1173,9 +1190,10 @@ AD/LDAP synchronize now | | | | Following a manual sync, the next sync will occur after the time set in the **Synchronization Interval**. | | +-----------------------------------------------------------------------------------------------------------+----------------------------------------------------+ -| **Note**: If a sync is ``Pending`` and does not complete, check that **Enable Synchronization with AD/LDAP** is set to ``true``. | -+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +.. note:: + If a sync is ``Pending`` and does not complete, check that **Enable Synchronization with AD/LDAP** is set to ``true``. + .. figure:: ../images/ldap-sync-table.png .. _saml-enterprise: @@ -1213,11 +1231,11 @@ Enable login with SAML

Also available in legacy Mattermost Enterprise Edition E20

-+---------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ -| - **true**: Enables sign-in with SAML. See :doc:`SAML Single Sign-On ` to learn more. | - System Config path: **Authentication > SAML 2.0** | -| - **false**: **(Default)** Disables sign-in with SAML. | - ``config.json`` setting: ``.SamlSettings.Enable: false`` | -| | - Environment variable: ``MM_SAMLSETTINGS_ENABLE`` | -+---------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| - **true**: Enables sign-in with SAML. See :doc:`SAML Single Sign-On ` to learn more. | - System Config path: **Authentication > SAML 2.0** | +| - **false**: **(Default)** Disables sign-in with SAML. | - ``config.json`` setting: ``SamlSettings`` > ``Enable`` > ``false`` | +| | - Environment variable: ``MM_SAMLSETTINGS_ENABLE`` | ++---------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ .. config:setting:: saml-enablesyncwithldap :displayname: Enable synchronizing SAML accounts with AD/LDAP (SAML) @@ -1238,12 +1256,12 @@ Enable synchronizing SAML accounts with AD/LDAP

Also available in legacy Mattermost Enterprise Edition E20

-+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| - **true**: Mattermost updates configured Mattermost user attributes (ex. FirstName, Position, Email) with their values from AD/LDAP. This synchronization may deactivate Mattermost users or remove them from groups, teams, or channels. AD/LDAP synchronization must be enabled and configured through the settings under **Authentication > AD/LDAP**. | - System Config path: **Authentication > SAML 2.0** | -| - **false**: **(Default)** Disables syncing of SAML-authenticated Mattermost users with AD/LDAP. | - ``config.json`` setting: ``.SamlSettings.EnableSyncWithLdap: false`` | -| | - Environment variable: ``MM_SAMLSETTINGS_ENABLESYNCWITHLDAP`` | -| See :doc:`AD/LDAP Setup ` to learn more. | | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| - **true**: Mattermost updates configured Mattermost user attributes (ex. FirstName, Position, Email) with their values from AD/LDAP. This synchronization may deactivate Mattermost users or remove them from groups, teams, or channels. AD/LDAP synchronization must be enabled and configured through the settings under **Authentication > AD/LDAP**. | - System Config path: **Authentication > SAML 2.0** | +| - **false**: **(Default)** Disables syncing of SAML-authenticated Mattermost users with AD/LDAP. | - ``config.json`` setting: ``SamlSettings`` > ``EnableSyncWithLdap`` > ``false`` | +| | - Environment variable: ``MM_SAMLSETTINGS_ENABLESYNCWITHLDAP`` | +| See :doc:`AD/LDAP Setup ` to learn more. | | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ .. config:setting:: saml-ignoreguestsldapsync :displayname: Ignore guest users when synchronizing with AD/LDAP (SAML) @@ -1264,12 +1282,12 @@ Ignore guest users when synchronizing with AD/LDAP

Also available in legacy Mattermost Enterprise Edition E20

-+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -| - **true**: When syncing with the AD/LDAP server, Mattermost does not sync any information about SAML-authenticated Guest Users from the AD/LDAP server. Manage guest deactivation manually via **System Console > Users**. | - System Config path: **Authentication > SAML 2.0** | -| - **false**: **(Default)** Syncing Mattermost with the AD/LDAP server updates Guest User attributes and deactivates and removes SAML-authenticated accounts for Guest Users that are no longer active on the AD/LDAP server. | - ``config.json`` setting: ``.SamlSettings.IgnoreGuestsLdapSync: false`` | -| | - Environment variable: ``MM_SAMLSETTINGS_IGNOREGUESTSLDAPSYNC`` | -| For more information, see :doc:`AD/LDAP Setup ` for details. | | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ +| - **true**: When syncing with the AD/LDAP server, Mattermost does not sync any information about SAML-authenticated Guest Users from the AD/LDAP server. Manage guest deactivation manually via **System Console > Users**. | - System Config path: **Authentication > SAML 2.0** | +| - **false**: **(Default)** Syncing Mattermost with the AD/LDAP server updates Guest User attributes and deactivates and removes SAML-authenticated accounts for Guest Users that are no longer active on the AD/LDAP server. | - ``config.json`` setting: ``SamlSettings`` > ``IgnoreGuestsLdapSync`` > ``false`` | +| | - Environment variable: ``MM_SAMLSETTINGS_IGNOREGUESTSLDAPSYNC`` | +| For more information, see :doc:`AD/LDAP Setup ` for details. | | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ .. config:setting:: saml-overridebindwithldap :displayname: Override SAML bind data with AD/LDAP information (SAML) @@ -1290,17 +1308,16 @@ Override SAML bind data with AD/LDAP information

Also available in legacy Mattermost Enterprise Edition E20

-+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| - **true**: If the SAML ID attribute is configured, Mattermost overrides the SAML ID attribute with the AD/LDAP ID attribute. If the SAML ID attribute is not present, Mattermost overrides the SAML Email attribute with the AD/LDAP Email attribute. | - System Config path: **Authentication > SAML 2.0** | -| - **false**: **(Default)** Mattermost uses the email attribute to bind users to SAML. | - ``config.json`` setting: ``.SamlSettings.EnableSyncWithLdapIncludeAuth: false`` | -| | - Environment variable: ``MM_SAMLSETTINGS_ENABLESYNCWITHLDAPINCLUDEAUTH`` | -| For more information, see :doc:`AD/LDAP Setup ` for details. | | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| **Notes**: | -| - This setting should be **false** unless LDAP sync is enabled. | -| - Changing this setting from **true** to **false** will disable the override. | -| - SAML IDs must match LDAP IDs when the override is enabled. | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| - **true**: If the SAML ID attribute is configured, Mattermost overrides the SAML ID attribute with the AD/LDAP ID attribute. If the SAML ID attribute is not present, Mattermost overrides the SAML Email attribute with the AD/LDAP Email attribute. | - System Config path: **Authentication > SAML 2.0** | +| - **false**: **(Default)** Mattermost uses the email attribute to bind users to SAML. | - ``config.json`` setting: ``SamlSettings`` > ``EnableSyncWithLdapIncludeAuth`` > ``false`` | +| | - Environment variable: ``MM_SAMLSETTINGS_ENABLESYNCWITHLDAPINCLUDEAUTH`` | +| For more information, see :doc:`AD/LDAP Setup ` for details. | | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + +.. note:: + - This setting should be **false** unless LDAP sync is enabled. Changing this setting from **true** to **false** will disable the override. + - SAML IDs must match LDAP IDs when the override is enabled. .. config:setting:: saml-providermetadataurl :displayname: Identity provider metadata URL (SAML) @@ -1319,11 +1336,11 @@ Identity provider metadata URL

Also available in legacy Mattermost Enterprise Edition E20

-+------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ -| This setting is the URL from which Mattermost requests setup metadata from the provider. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.IdpMetadataURL`` | -| String input. | - Environment variable: ``MM_SAMLSETTINGS_IDPMETADATAURL`` | -+------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ ++------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| This setting is the URL from which Mattermost requests setup metadata from the provider. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``IdpMetadataURL`` | +| String input. | - Environment variable: ``MM_SAMLSETTINGS_IDPMETADATAURL`` | ++------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ .. config:setting:: saml-ssourl :displayname: SAML SSO URL (SAML) @@ -1342,11 +1359,11 @@ SAML SSO URL

Also available in legacy Mattermost Enterprise Edition E20

-+--------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| This setting is the URL where Mattermost sends a SAML request to start the login sequence. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.IdpURL`` | -| String input. | - Environment variable: ``MM_SAMLSETTINGS_IDPURL`` | -+--------------------------------------------------------------------------------------------+-----------------------------------------------------+ ++--------------------------------------------------------------------------------------------+----------------------------------------------------------+ +| This setting is the URL where Mattermost sends a SAML request to start the login sequence. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``IdpURL`` | +| String input. | - Environment variable: ``MM_SAMLSETTINGS_IDPURL`` | ++--------------------------------------------------------------------------------------------+----------------------------------------------------------+ .. config:setting:: saml-providerissuerurl :displayname: Identity provider issuer URL (SAML) @@ -1365,11 +1382,11 @@ Identity provider issuer URL

Also available in legacy Mattermost Enterprise Edition E20

-+-----------------------------------------------------------------------------+-------------------------------------------------------------------+ -| This setting is the issuer URL for the Identity Provider for SAML requests. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.IdpDescriptorURL`` | -| String input. | - Environment variable: ``MM_SAMLSETTINGS_IDPDESCRIPTORURL`` | -+-----------------------------------------------------------------------------+-------------------------------------------------------------------+ ++-----------------------------------------------------------------------------+------------------------------------------------------------------------+ +| This setting is the issuer URL for the Identity Provider for SAML requests. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``IdpDescriptorURL`` | +| String input. | - Environment variable: ``MM_SAMLSETTINGS_IDPDESCRIPTORURL`` | ++-----------------------------------------------------------------------------+------------------------------------------------------------------------+ .. config:setting:: saml-providerpubliccert :displayname: Identity provider public certificate (SAML) @@ -1388,11 +1405,11 @@ Identity provider public certificate

Also available in legacy Mattermost Enterprise Edition E20

-+-------------------------------------------------------------------------+---------------------------------------------------------------------+ -| The public authentication certificate issued by your Identity Provider. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.IdpCertificateFile`` | -| String input. | - Environment variable: ``MM_SAMLSETTINGS_IDPCERTIFICATEFILE`` | -+-------------------------------------------------------------------------+---------------------------------------------------------------------+ ++-------------------------------------------------------------------------+--------------------------------------------------------------------------+ +| The public authentication certificate issued by your Identity Provider. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``IdpCertificateFile`` | +| String input. | - Environment variable: ``MM_SAMLSETTINGS_IDPCERTIFICATEFILE`` | ++-------------------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: saml-verifysignature :displayname: Verify signature (SAML) @@ -1413,11 +1430,11 @@ Verify signature

Also available in legacy Mattermost Enterprise Edition E20

-+---------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ -| - **true**: **(Default)** Mattermost checks that the SAML Response signature matches the Service Provider Login URL. | - System Config path: **Authentication > SAML 2.0** | -| - **false**: The signature is not verified. This is **not recommended** for production. Use this option for testing only. | - ``config.json`` setting: ``.SamlSettings.Verify: true`` | -| | - Environment variable: ``MM_SAMLSETTINGS_VERIFY`` | -+---------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ +| - **true**: **(Default)** Mattermost checks that the SAML Response signature matches the Service Provider Login URL. | - System Config path: **Authentication > SAML 2.0** | +| - **false**: The signature is not verified. This is **not recommended** for production. Use this option for testing only. | - ``config.json`` setting: ``SamlSettings`` > ``Verify`` > ``true`` | +| | - Environment variable: ``MM_SAMLSETTINGS_VERIFY`` | ++---------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. config:setting:: saml-providerloginurl :displayname: Service provider login URL (SAML) @@ -1438,13 +1455,13 @@ Service provider login URL

Also available in legacy Mattermost Enterprise Edition E20

-+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ -| Enter the URL of your Mattermost server, followed by ``/login/sso/saml``, i.e. ``https://example.com/login/sso/saml``. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.AssertionConsumerServiceURL`` | -| Use HTTP or HTTPS depending on the configuration of the server. | - Environment variable: ``MM_SAMLSETTINGS_ASSERTIONCONSUMERSERVICEURL`` | -| | | -| This setting is also known as the Assertion Consumer Service URL. | | -+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| Enter the URL of your Mattermost server, followed by ``/login/sso/saml``, i.e. ``https://example.com/login/sso/saml``. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``AssertionConsumerServiceURL`` | +| Use HTTP or HTTPS depending on the configuration of the server. | - Environment variable: ``MM_SAMLSETTINGS_ASSERTIONCONSUMERSERVICEURL`` | +| | | +| This setting is also known as the Assertion Consumer Service URL. | | ++------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ .. config:setting:: saml-provideridentifier :displayname: Service provider identifier (SAML) @@ -1463,11 +1480,11 @@ Service provider identifier

Also available in legacy Mattermost Enterprise Edition E20

-+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ -| This setting is the unique identifier for the Service Provider, which in most cases is the same as the Service Provider Login URL. In ADFS, this must match the Relying Party Identifier. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.ServiceProviderIdentifier`` | -| String input. | - Environment variable: ``MM_SAMLSETTINGS_SERVICEPROVIDERIDENTIFIER`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| This setting is the unique identifier for the Service Provider, which in most cases is the same as the Service Provider Login URL. In ADFS, this must match the Relying Party Identifier. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``ServiceProviderIdentifier`` | +| String input. | - Environment variable: ``MM_SAMLSETTINGS_SERVICEPROVIDERIDENTIFIER`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ .. config:setting:: saml-encryption :displayname: Enable encryption (SAML) @@ -1488,11 +1505,11 @@ Enable encryption

Also available in legacy Mattermost Enterprise Edition E20

-+---------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ -| - **true**: **(Default)** Mattermost will decrypt SAML Assertions that are encrypted with your Service Provider Public Certificate. | - System Config path: **Authentication > SAML 2.0** | -| - **false**: Mattermost does not decrypt SAML Assertions. Use this option for testing only. It is **not recommended** for production. | - ``config.json`` setting: ``.SamlSettings.Encrypt: true`` | -| | - Environment variable: ``MM_SAMLSETTINGS_ENCRYPT`` | -+---------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| - **true**: **(Default)** Mattermost will decrypt SAML Assertions that are encrypted with your Service Provider Public Certificate. | - System Config path: **Authentication > SAML 2.0** | +| - **false**: Mattermost does not decrypt SAML Assertions. Use this option for testing only. It is **not recommended** for production. | - ``config.json`` setting: ``SamlSettings`` > ``Encrypt`` > ``true`` | +| | - Environment variable: ``MM_SAMLSETTINGS_ENCRYPT`` | ++---------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ .. config:setting:: saml-providerprivatekey :displayname: Service provider private key (SAML) @@ -1511,11 +1528,11 @@ Service provider private key

Also available in legacy Mattermost Enterprise Edition E20

-+-------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ -| This setting stores the private key used to decrypt SAML Assertions from the Identity Provider. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.PrivateKeyFile`` | -| String input. | - Environment variable: ``MM_SAMLSETTINGS_PRIVATEKEYFILE`` | -+-------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| This setting stores the private key used to decrypt SAML Assertions from the Identity Provider. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``PrivateKeyFile`` | +| String input. | - Environment variable: ``MM_SAMLSETTINGS_PRIVATEKEYFILE`` | ++-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ .. config:setting:: saml-serviceproviderpubliccert :displayname: Service provider public certificate (SAML) @@ -1534,11 +1551,11 @@ Service provider public certificate

Also available in legacy Mattermost Enterprise Edition E20

-+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| This setting stores the certificate file used to sign a SAML request to the Identity Provider for a SAML login when Mattermost is initiating the login as the Service Provider. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.PublicCertificateFile`` | -| String input. | - Environment variable: ``MM_SAMLSETTINGS_PUBLICCERTIFICATEFILE`` | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ +| This setting stores the certificate file used to sign a SAML request to the Identity Provider for a SAML login when Mattermost is initiating the login as the Service Provider. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``PublicCertificateFile`` | +| String input. | - Environment variable: ``MM_SAMLSETTINGS_PUBLICCERTIFICATEFILE`` | ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ .. config:setting:: saml-signrequest :displayname: Sign request (SAML) @@ -1559,11 +1576,11 @@ Sign request

Also available in legacy Mattermost Enterprise Edition E20

-+--------------------------------------------------------------------------------------+------------------------------------------------------------+ -| - **true**: Mattermost signs the SAML request with the Service Provider Private Key. | - System Config path: **Authentication > SAML 2.0** | -| - **false**: Mattermost does not sign the SAML request. | - ``config.json`` setting: ``.SamlSettings.SignRequest`` | -| | - Environment variable: ``MM_SAMLSETTINGS_SIGNREQUEST`` | -+--------------------------------------------------------------------------------------+------------------------------------------------------------+ ++--------------------------------------------------------------------------------------+-----------------------------------------------------------------+ +| - **true**: Mattermost signs the SAML request with the Service Provider Private Key. | - System Config path: **Authentication > SAML 2.0** | +| - **false**: Mattermost does not sign the SAML request. | - ``config.json`` setting: ``SamlSettings`` > ``SignRequest`` | +| | - Environment variable: ``MM_SAMLSETTINGS_SIGNREQUEST`` | ++--------------------------------------------------------------------------------------+-----------------------------------------------------------------+ .. config:setting:: saml-signaturealgo :displayname: Signature algorithm @@ -1582,11 +1599,11 @@ Signature algorithm

Also available in legacy Mattermost Enterprise Edition E20

-+----------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ -| 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`` | -+----------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ +| 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`` | ++----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: saml-canonicalalgo :displayname: Canonical algorithm (SAML) @@ -1610,7 +1627,7 @@ Canonical algorithm +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | This setting determines the canonicalization algorithm. With these options: | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.CanonicalAlgorithm`` | +| | - ``config.json`` setting: ``SamlSettings`` > ``CanonicalAlgorithm`` | | - **Canonical1.0**: **(Default)** `Exclusive XML Canonicalization 1.0 (omit comments) `__ (``http://www.w3.org/2001/10/xml-exc-c14n#``). ``config.json`` setting: ``Canonical1.0``. | - Environment variable: ``MM_SAMLSETTINGS_CANONICALALGORITHM`` | | - **Canonical1.1**: `Canonical XML 1.1 (omit comments) `__ (``http://www.w3.org/2006/12/xml-c14n11``). ``config.json`` setting: ``Canonical1.1``. | | | | | @@ -1634,13 +1651,13 @@ Email attribute

Also available in legacy Mattermost Enterprise Edition E20

-+------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ -| This setting determines the attribute from the SAML Assertion that populates the user email address field in Mattermost. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.EmailAttribute`` | -| Notifications are sent to this email address. This email address may be visible to other users, depending on how the system admin has set-up user privacy. | - Environment variable: ``MM_SAMLSETTINGS_EMAILATTRIBUTE`` | -| | | -| String input. | | -+------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| This setting determines the attribute from the SAML Assertion that populates the user email address field in Mattermost. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``EmailAttribute`` | +| Notifications are sent to this email address. This email address may be visible to other users, depending on how the system admin has set-up user privacy. | - Environment variable: ``MM_SAMLSETTINGS_EMAILATTRIBUTE`` | +| | | +| String input. | | ++------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ .. config:setting:: saml-usernameattribute :displayname: Username attribute (SAML) @@ -1659,13 +1676,13 @@ Username attribute

Also available in legacy Mattermost Enterprise Edition E20

-+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| This setting determines the SAML Assertion attribute that populates the username field in the Mattermost UI. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.UsernameAttribute`` | -| This attribute identifies users in the UI. For example, if a username is set to ``john.smith``, typing ``@john`` will show ``@john.smith`` as an auto-complete option, and posting a message with ``@john.smith`` will send a notification to that user. | - Environment variable: ``MM_SAMLSETTINGS_USERNAMEATTRIBUTE`` | -| | | -| String input. | | -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ +| This setting determines the SAML Assertion attribute that populates the username field in the Mattermost UI. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``UsernameAttribute`` | +| This attribute identifies users in the UI. For example, if a username is set to ``john.smith``, typing ``@john`` will show ``@john.smith`` as an auto-complete option, and posting a message with ``@john.smith`` will send a notification to that user. | - Environment variable: ``MM_SAMLSETTINGS_USERNAMEATTRIBUTE`` | +| | | +| String input. | | ++----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ .. config:setting:: saml-idattribute :displayname: Id attribute (SAML) @@ -1686,7 +1703,7 @@ Id attribute +----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ | (Optional) This setting determines the SAML Assertion attribute used to bind users from SAML to users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.IdAttribute`` | +| | - ``config.json`` setting: ``SamlSettings`` > ``IdAttribute``| | String input. | - Environment variable: ``MM_SAMLSETTINGS_IDATTRIBUTE`` | +----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ @@ -1709,7 +1726,7 @@ Guest attribute +--------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ | (Optional) This setting determines the SAML Assertion attribute used to apply a Guest role to users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.GuestAttribute`` | +| | - ``config.json`` setting: ``SamlSettings`` > ``GuestAttribute``| | See the :doc:`Guest Accounts documentation ` for more information. | - Environment variable: ``MM_SAMLSETTINGS_GUESTATTRIBUTE`` | | | | | String input. | | @@ -1734,11 +1751,11 @@ Enable admin attribute

Also available in legacy Mattermost Enterprise Edition E20

-+-----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -| - **true**: System admin status is determined by the SAML Assertion attribute set in **Admin attribute**. | - System Config path: **Authentication > SAML 2.0** | -| - **false**: **(Default)** System admin status is **not** determined by the SAML Assertion attribute. | - ``config.json`` setting: ``.SamlSettings.EnableAdminAttribute: false`` | -| | - Environment variable: ``MM_SAMLSETTINGS_ENABLEADMINATTRIBUTE`` | -+-----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ +| - **true**: System admin status is determined by the SAML Assertion attribute set in **Admin attribute**. | - System Config path: **Authentication > SAML 2.0** | +| - **false**: **(Default)** System admin status is **not** determined by the SAML Assertion attribute. | - ``config.json`` setting: ``SamlSettings`` > ``EnableAdminAttribute`` > ``false`` | +| | - Environment variable: ``MM_SAMLSETTINGS_ENABLEADMINATTRIBUTE`` | ++-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ .. config:setting:: saml-adminattribute :displayname: Admin attribute (SAML) @@ -1757,15 +1774,15 @@ Admin attribute

Also available in legacy Mattermost Enterprise Edition E20

-+-------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ -| (Optional) This setting determines the attribute in the SAML Assertion for designating system admins. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.AdminAttribute`` | -| Users are automatically promoted to this role when logging in to Mattermost. | - Environment variable: ``MM_SAMLSETTINGS_ADMINATTRIBUTE`` | -| | | -| If the Admin attribute is removed, users that are logged in retain Admin status. The role is revoked only when users log out. | | -| | | -| String input. | | -+-------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| (Optional) This setting determines the attribute in the SAML Assertion for designating system admins. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``AdminAttribute`` | +| Users are automatically promoted to this role when logging in to Mattermost. | - Environment variable: ``MM_SAMLSETTINGS_ADMINATTRIBUTE`` | +| | | +| If the Admin attribute is removed, users that are logged in retain Admin status. The role is revoked only when users log out. | | +| | | +| String input. | | ++-------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ .. config:setting:: saml-firstnameattribute :displayname: First name attribute (SAML) @@ -1784,12 +1801,12 @@ First name attribute

Also available in legacy Mattermost Enterprise Edition E20

-+-----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ -| (Optional) This setting determines the SAML Assertion attribute that populates the first name of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.FirstNameAttribute`` | -| | - Environment variable: ``MM_SAMLSETTINGS_FIRSTNAMEATTRIBUTE`` | -| String input. | | -+-----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ +| (Optional) This setting determines the SAML Assertion attribute that populates the first name of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``FirstNameAttribute`` | +| | - Environment variable: ``MM_SAMLSETTINGS_FIRSTNAMEATTRIBUTE`` | +| String input. | | ++-----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: saml-lastnameattribute :displayname: Last name attribute (SAML) @@ -1808,12 +1825,12 @@ Last name attribute

Also available in legacy Mattermost Enterprise Edition E20

-+----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| (Optional) This setting determines the SAML Assertion attribute that populates the last name of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.LastNameAttribute`` | -| | - Environment variable: ``MM_SAMLSETTINGS_LASTNAMEATTRIBUTE`` | -| String input. | | -+----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ +| (Optional) This setting determines the SAML Assertion attribute that populates the last name of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``LastNameAttribute`` | +| | - Environment variable: ``MM_SAMLSETTINGS_LASTNAMEATTRIBUTE`` | +| String input. | | ++----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ .. config:setting:: saml-nicknameattribute :displayname: Nickname attribute (SAML) @@ -1832,12 +1849,12 @@ Nickname attribute

Also available in legacy Mattermost Enterprise Edition E20

-+---------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| (Optional) This setting determines the SAML Assertion attribute that populates the nickname of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.NicknameAttribute`` | -| | - Environment variable: ``MM_SAMLSETTINGS_NICKNAMEATTRIBUTE`` | -| String input. | | -+---------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ +| (Optional) This setting determines the SAML Assertion attribute that populates the nickname of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``NicknameAttribute`` | +| | - Environment variable: ``MM_SAMLSETTINGS_NICKNAMEATTRIBUTE`` | +| String input. | | ++---------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ .. config:setting:: saml-positionattribute :displayname: Position atribute (SAML) @@ -1856,12 +1873,12 @@ Position attribute

Also available in legacy Mattermost Enterprise Edition E20

-+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| (Optional) This setting determines the SAML Assertion attribute that populates the position (job title or role at company) of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.PositionAttribute`` | -| | - Environment variable: ``MM_SAMLSETTINGS_POSITIONATTRIBUTE`` | -| String input. | | -+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ +| (Optional) This setting determines the SAML Assertion attribute that populates the position (job title or role at company) of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``PositionAttribute`` | +| | - Environment variable: ``MM_SAMLSETTINGS_POSITIONATTRIBUTE`` | +| String input. | | ++----------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ .. config:setting:: saml-localeattribute :displayname: Preferred language attribute (SAML) @@ -1882,7 +1899,7 @@ Preferred language attribute +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ | (Optional) This setting determines the SAML Assertion attribute that populates the language preference of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.LocaleAttribute`` | +| | - ``config.json`` setting: ``SamlSettings`` > ``LocaleAttribute``| | | - Environment variable: ``MM_SAMLSETTINGS_LOCALEATTRIBUTE`` | | String input. | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ @@ -1904,11 +1921,11 @@ Login button text

Also available in legacy Mattermost Enterprise Edition E20

-+---------------------------------------------------------------------------+--------------------------------------------------------------+ -| (Optional) The text that appears in the login button on the sign-in page. | - System Config path: **Authentication > SAML 2.0** | -| | - ``config.json`` setting: ``.SamlSettings.LoginButtonText`` | -| String input. Default is **SAML**. | - Environment variable: ``MM_SAMLSETTINGS_LOGINBUTTONTEXT`` | -+---------------------------------------------------------------------------+--------------------------------------------------------------+ ++---------------------------------------------------------------------------+-------------------------------------------------------------------+ +| (Optional) The text that appears in the login button on the sign-in page. | - System Config path: **Authentication > SAML 2.0** | +| | - ``config.json`` setting: ``SamlSettings`` > ``LoginButtonText`` | +| String input. Default is **SAML**. | - Environment variable: ``MM_SAMLSETTINGS_LOGINBUTTONTEXT`` | ++---------------------------------------------------------------------------+-------------------------------------------------------------------+ ---- @@ -1966,11 +1983,11 @@ GitLab OAuth 2.0 settings Enable OAuth 2.0 authentication with GitLab ''''''''''''''''''''''''''''''''''''''''''' -+-------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| - **true**: Allows team and account creation using GitLab OAuth authentication. Input the **Secret** and **ID** credentials to configure. | - System Config path: **Authentication > OAuth 2.0 (or GitLab)** | -| - **false**: **(Default)** Disables GitLab OAuth authentication. | - ``config.json`` setting: ``.GitLabSettings.Enable: false`` | -| | - Environment variable: ``MM_GITLABSETTINGS_ENABLE`` | -+-------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ +| - **true**: Allows team and account creation using GitLab OAuth authentication. Input the **Secret** and **ID** credentials to configure. | - System Config path: **Authentication > OAuth 2.0 (or GitLab)** | +| - **false**: **(Default)** Disables GitLab OAuth authentication. | - ``config.json`` setting: ``GitLabSettings`` > ``Enable`` > ``false`` | +| | - Environment variable: ``MM_GITLABSETTINGS_ENABLE`` | ++-------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ .. config:setting:: oauth-gitlabappid :displayname: GitLab OAuth 2.0 Application ID (OAuth - GitLab) @@ -1984,7 +2001,7 @@ GitLab OAuth 2.0 Application ID +------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ | This setting holds the OAuth Application ID from GitLab. Generate the ID by these steps: | - System Config path: **Authentication > OAuth 2.0 (or GitLab)** | -| | - ``config.json`` setting: ``.GitLabSettings.Id`` | +| | - ``config.json`` setting: ``GitLabSettings`` > ``Id`` | | 1. Login to your GitLab account. | - Environment variable: ``MM_GITLABSETTINGS_ID`` | | 2. Go to **Profile Settings > Applications > New Application** and enter a name. | | | 3. Enter the Redirect URLs: ``https:///login/gitlab/complete`` and ``https:///signup/gitlab/complete``. | | @@ -1992,8 +2009,9 @@ GitLab OAuth 2.0 Application ID | | | | String input. | | +------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| Note: GitLab provides the `Application Secret Key <#gitlab-oauth-2-0-application-secret-key>`__ along with the the ID. | -+------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + +.. note:: + GitLab provides the `Application Secret Key <#gitlab-oauth-2-0-application-secret-key>`__ along with the the ID. .. config:setting:: oauth-gitlabappsecretkey :displayname: GitLab OAuth 2.0 Application secret key (OAuth - GitLab) @@ -2007,7 +2025,7 @@ GitLab OAuth 2.0 Application secret key +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ | This setting holds the OAuth Application Secret Key from GitLab. The key is generated at the same time as the **Application ID** (see `GitLab OAuth 2.0 Application ID <#gitlab-oauth-2-0-application-id>`__). | - System Config path: **Authentication > OAuth 2.0 (or GitLab)** | -| | - ``config.json`` setting: ``.GitLabSettings.Secret`` | +| | - ``config.json`` setting: ``GitLabSettings`` > ``Secret`` | | Enter the key provided by GitLab in the Mattermost System Console field, ``config.json`` setting, or Environment variable. | - Environment variable: ``MM_GITLABSETTINGS_SECRET`` | | | | | String input. | | @@ -2039,13 +2057,13 @@ GitLab OAuth 2.0 site URL GitLab OAuth 2.0 User API endpoint '''''''''''''''''''''''''''''''''' -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| This setting holds the URL of your GitLab User API endpoint, e.g. ``https:///api/v3/user``. Use ``http://`` if SSL is not enabled on your GitLab instance. | - System Config path: **Authentication > OAuth 2.0 (or GitLab)** | -| | - ``config.json`` setting: ``.GitLabSettings.UserAPIEndpoint`` | -| Enter the URL in the Mattermost System Console field, ``config.json`` setting, or Environment variable. | - Environment variable: ``MM_GITLABSETTINGS_USERAPIENDPOINT`` | -| | | -| String input. | | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| This setting holds the URL of your GitLab User API endpoint, e.g. ``https:///api/v3/user``. Use ``http://`` if SSL is not enabled on your GitLab instance. | - System Config path: **Authentication > OAuth 2.0 (or GitLab)** | +| | - ``config.json`` setting: ``GitLabSettings`` > ``UserAPIEndpoint`` | +| Enter the URL in the Mattermost System Console field, ``config.json`` setting, or Environment variable. | - Environment variable: ``MM_GITLABSETTINGS_USERAPIENDPOINT`` | +| | | +| String input. | | ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ .. config:setting:: oauth-gitlabauthendpoint :displayname: GitLab OAuth 2.0 Auth endpoint (OAuth - GitLab) @@ -2059,7 +2077,7 @@ GitLab OAuth 2.0 Auth endpoint +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ | This setting holds the URL of your GitLab Auth endpoint, e.g. ``https:///oauth/authorize``. Use ``http://`` if SSL is not enabled on your GitLab instance. | - System Config path: **Authentication > OAuth 2.0 (or GitLab)** | -| | - ``config.json`` setting: ``.GitLabSettings.AuthEndpoint`` | +| | - ``config.json`` setting: ``GitLabSettings`` > ``AuthEndpoint`` | | Enter the URL in the Mattermost System Console field, ``config.json`` setting, or Environment variable. | - Environment variable: ``MM_GITLABSETTINGS_AUTHENDPOINT`` | | | | | String input. | | @@ -2077,7 +2095,7 @@ GitLab OAuth 2.0 Token endpoint +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ | This setting holds the URL of your GitLab OAuth Token endpoint, e.g. ``https:///oauth/token``. Use ``http://`` if SSL is not enabled on your GitLab instance. | - System Config path: **Authentication > OAuth 2.0 (or GitLab)** | -| | - ``config.json`` setting: ``.GitLabSettings.TokenEndpoint`` | +| | - ``config.json`` setting: ``GitLabSettings`` > ``TokenEndpoint``| | Enter the URL in the Mattermost System Console field, ``config.json`` setting, or Environment variable. | - Environment variable: ``MM_GITLABSETTINGS_TOKENENDPOINT`` | | | | | String input. | | @@ -2101,12 +2119,12 @@ Google OAuth 2.0 settings Enable OAuth 2.0 authentication with Google ''''''''''''''''''''''''''''''''''''''''''' -+---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ -| - **true**: Allows team and account creation using Google OAuth authentication. Input the **Client ID** and **Client Secret** credentials to configure. | - System Config path: **Authentication > OAuth 2.0** | -| - **false**: **(Default)** Disables Google OAuth authentication. | - ``config.json`` setting: ``.GoogleSettings.Enable: false`` | -| | - Environment variable: ``MM_GOOGLESETTINGS_ENABLE`` | -| See :doc:`Google Single Sign-On ` implementation instructions. | | -+---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| - **true**: Allows team and account creation using Google OAuth authentication. Input the **Client ID** and **Client Secret** credentials to configure. | - System Config path: **Authentication > OAuth 2.0** | +| - **false**: **(Default)** Disables Google OAuth authentication. | - ``config.json`` setting: ``GoogleSettings`` > ``Enable`` > ``false``| +| | - Environment variable: ``MM_GOOGLESETTINGS_ENABLE`` | +| See :doc:`Google Single Sign-On ` implementation instructions. | | ++---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ .. config:setting:: oauth-googleclientid :displayname: Google OAuth 2.0 Client ID (OAuth - Google) @@ -2122,13 +2140,13 @@ Google OAuth 2.0 Client ID

Also available in legacy Mattermost Enterprise Edition E20

-+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ -| This setting stores the OAuth Client ID from Google. Generate the ID by going to the **Credentials** section of the Google Cloud Platform APIs & Services menu and selecting **Create Credentials > OAuth client ID**. | - System Config path: **Authentication > OAuth 2.0** | -| | - ``config.json`` setting: ``.GoogleSettings.Id`` | -| See :doc:`Google Single Sign-On ` for instructions that can be used to implement Google OAuth or OpenID authentication. | - Environment variable: ``MM_GOOGLESETTINGS_ID`` | -| | | -| String input. | | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ +| This setting stores the OAuth Client ID from Google. Generate the ID by going to the **Credentials** section of the Google Cloud Platform APIs & Services menu and selecting **Create Credentials > OAuth client ID**. | - System Config path: **Authentication > OAuth 2.0** | +| | - ``config.json`` setting: ``GoogleSettings`` > ``Id``| +| See :doc:`Google Single Sign-On ` for instructions that can be used to implement Google OAuth or OpenID authentication. | - Environment variable: ``MM_GOOGLESETTINGS_ID`` | +| | | +| String input. | | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ .. config:setting:: oauth-googleclientsecret :displayname: Google OAuth 2.0 Client secret (OAuth - Google) @@ -2144,11 +2162,11 @@ Google OAuth 2.0 Client secret

Also available in legacy Mattermost Enterprise Edition E20

-+---------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ -| This setting stores the OAuth Client Secret from Google. The Secret is generated at the same time as the Client ID. | - System Config path: **Authentication > OAuth 2.0** | -| | - ``config.json`` setting: ``.GoogleSettings.Secret`` | -| String input. | - Environment variable: ``MM_GOOGLESETTINGS_SECRET`` | -+---------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ +| This setting stores the OAuth Client Secret from Google. The Secret is generated at the same time as the Client ID. | - System Config path: **Authentication > OAuth 2.0** | +| | - ``config.json`` setting: ``GoogleSettings`` > ``Secret`` | +| String input. | - Environment variable: ``MM_GOOGLESETTINGS_SECRET`` | ++---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ .. config:setting:: oauth-googleuserapiendpoint :displayname: Google OAuth 2.0 User API endpoint (OAuth - Google) @@ -2164,11 +2182,11 @@ Google OAuth 2.0 User API endpoint

Also available in legacy Mattermost Enterprise Edition E20

-+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ -| We recommend ``https://people.googleapis.com/v1/people/me?personFields=names,emailAddresses,nicknames,metadata`` as the User API Endpoint. Otherwise, enter a custom endpoint in ``config.json`` with HTTP, or HTTPS, if available on the API server. | - System Config path: **Authentication > OAuth 2.0** | -| | - ``config.json`` setting: ``.GoogleSettings.UserAPIEndpoint`` | -| String input. | - Environment variable: ``MM_GOOGLESETTINGS_USERAPIENDPOINT`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ +| We recommend ``https://people.googleapis.com/v1/people/me?personFields=names,emailAddresses,nicknames,metadata`` as the User API Endpoint. Otherwise, enter a custom endpoint in ``config.json`` with HTTP, or HTTPS, if available on the API server. | - System Config path: **Authentication > OAuth 2.0** | +| | - ``config.json`` setting: ``GoogleSettings`` > ``UserAPIEndpoint`` | +| String input. | - Environment variable: ``MM_GOOGLESETTINGS_USERAPIENDPOINT`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. config:setting:: oauth-googleauthendpoint :displayname: Google OAuth 2.0 Auth endpoint (OAuth - Google) @@ -2184,11 +2202,11 @@ Google OAuth 2.0 Auth endpoint

Also available in legacy Mattermost Enterprise Edition E20

-+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ -| We recommend ``https://accounts.google.com/o/oauth2/v2/auth`` as the Auth Endpoint. Otherwise, enter a custom endpoint in ``config.json`` with HTTP, or HTTPS, if available on the server. | - System Config path: **Authentication > OAuth 2.0** | -| | - ``config.json`` setting: ``.GoogleSettings.AuthEndpoint`` | -| String input. | - Environment variable: ``MM_GOOGLESETTINGS_AUTHENDPOINT`` | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| We recommend ``https://accounts.google.com/o/oauth2/v2/auth`` as the Auth Endpoint. Otherwise, enter a custom endpoint in ``config.json`` with HTTP, or HTTPS, if available on the server. | - System Config path: **Authentication > OAuth 2.0** | +| | - ``config.json`` setting: ``GoogleSettings`` > ``AuthEndpoint`` | +| String input. | - Environment variable: ``MM_GOOGLESETTINGS_AUTHENDPOINT`` | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: oauth-googletokenendpoint :displayname: Google OAuth 2.0 Token endpoint (OAuth - Google) @@ -2204,11 +2222,11 @@ Google OAuth 2.0 Token endpoint

Also available in legacy Mattermost Enterprise Edition E20

-+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ -| We recommend ``https://www.googleapis.com/oauth2/v4/token`` as the Token Endpoint. Otherwise, enter a custom endpoint in ``config.json`` with HTTP, or HTTPS, if available on the server. | - System Config path: **Authentication > OAuth 2.0** | -| | - ``config.json`` setting: ``.GoogleSettings.TokenEndpoint`` | -| String input. | - Environment variable: ``MM_GOOGLESETTINGS_TOKENENDPOINT`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ +| We recommend ``https://www.googleapis.com/oauth2/v4/token`` as the Token Endpoint. Otherwise, enter a custom endpoint in ``config.json`` with HTTP, or HTTPS, if available on the server. | - System Config path: **Authentication > OAuth 2.0** | +| | - ``config.json`` setting: ``GoogleSettings`` > ``TokenEndpoint`` | +| String input. | - Environment variable: ``MM_GOOGLESETTINGS_TOKENENDPOINT`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ Entra ID OAuth 2.0 settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -2231,13 +2249,14 @@ Entra ID OAuth 2.0 settings Enable OAuth 2.0 Authentication with Entra ID ''''''''''''''''''''''''''''''''''''''''''''''' -+-------------------------------------------------------------------------------------+----------------------------------------------------------------+ -| - **true**: Allows team and account creation using Entra ID OAuth authentication. | - System Config path: **Authentication > OAuth 2.0** | -| - **false**: **(Default)** Disables Entra ID OAuth authentication. | - ``config.json`` setting: ``.Office365Settings.Enable: false``| -| | - Environment variable: ``MM_OFFICE365SETTINGS_ENABLE`` | -+-------------------------------------------------------------------------------------+----------------------------------------------------------------+ -| **Note**: See the :doc:`Entra ID Single Sign-On ` documentation for details. | -+-------------------------------------------------------------------------------------+----------------------------------------------------------------+ ++-------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ +| - **true**: Allows team and account creation using Entra ID OAuth authentication. | - System Config path: **Authentication > OAuth 2.0** | +| - **false**: **(Default)** Disables Entra ID OAuth authentication. | - ``config.json`` setting: ``Office365Settings`` > ``Enable`` > ``false``| +| | - Environment variable: ``MM_OFFICE365SETTINGS_ENABLE`` | ++-------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + +.. note:: + See the :doc:`Entra ID Single Sign-On ` documentation for details. .. config:setting:: oauth-entra-id-appid :displayname: Application ID (OAuth - Entra ID) @@ -2253,13 +2272,14 @@ Entra ID OAuth 2.0 Application ID

Also available in legacy Mattermost Enterprise Edition E20

-+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ -| This setting holds the **Application ID** generated when configuring Entra ID as a Single Sign-On service through the Microsoft Azure Portal. | - System Config path: **Authentication > OAuth 2.0** | -| | - ``config.json`` setting: ``.Office365Settings.Id`` | -| String input. | - Environment variable: ``MM_OFFICE365SETTINGS_ID`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ -| **Note**: See the :doc:`Entra ID Single Sign-On ` documentation for details. | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ +| This setting holds the **Application ID** generated when configuring Entra ID as a Single Sign-On service through the Microsoft Azure Portal. | - System Config path: **Authentication > OAuth 2.0** | +| | - ``config.json`` setting: ``Office365Settings`` > ``Id`` | +| String input. | - Environment variable: ``MM_OFFICE365SETTINGS_ID`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ + +.. note:: + See the :doc:`Entra ID Single Sign-On ` documentation for details. .. config:setting:: oauth-entra-id-appsecret :displayname: Application secret password (OAuth - Entra ID) @@ -2275,13 +2295,14 @@ Entra ID OAuth 2.0 Application secret password

Also available in legacy Mattermost Enterprise Edition E20

-+--------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ -| This setting holds the **Application Secret Password** generated when configuring Entra ID as a Single Sign-On service through the Microsoft Azure Portal. | - System Config path: **Authentication > OAuth 2.0** | -| | - ``config.json`` setting: ``.Office365Settings.Secret`` | -| String input. | - Environment variable: ``MM_OFFICE365SETTINGS_SECRET`` | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ -| **Note**: See the :doc:`Entra ID Single Sign-On ` documentation for details. | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ +| This setting holds the **Application Secret Password** generated when configuring Entra ID as a Single Sign-On service through the Microsoft Azure Portal. | - System Config path: **Authentication > OAuth 2.0** | +| | - ``config.json`` setting: ``Office365Settings`` > ``Secret`` | +| String input. | - Environment variable: ``MM_OFFICE365SETTINGS_SECRET`` | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ + +.. note:: + See the :doc:`Entra ID Single Sign-On ` documentation for details. .. config:setting:: oauth-entra-id-directoryid :displayname: Directory ID (OAuth - Entra ID) @@ -2297,13 +2318,14 @@ Entra ID OAuth 2.0 Directory (tenant) ID

Also available in legacy Mattermost Enterprise Edition E20

-+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------+ -| This setting holds the **Directory (tenant) ID** set for Mattermost through the Azure Portal. | - System Config path: **Authentication > OAuth 2.0** | -| | - ``config.json`` setting: ``.Office365Settings.DirectoryId`` | -| String input. | - Environment variable: ``MM_OFFICE365SETTINGS_DIRECTORYID`` | -+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------+ -| **Note**: See the :doc:`Entra ID Single Sign-On ` documentation for details. | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ +| This setting holds the **Directory (tenant) ID** set for Mattermost through the Azure Portal. | - System Config path: **Authentication > OAuth 2.0** | +| | - ``config.json`` setting: ``Office365Settings`` > ``DirectoryId`` | +| String input. | - Environment variable: ``MM_OFFICE365SETTINGS_DIRECTORYID`` | ++-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ + +.. note:: + See the :doc:`Entra ID Single Sign-On ` documentation for details. .. config:setting:: oauth-entra-id-userapiendpoint :displayname: User API endpoint (OAuth - Entra ID) @@ -2319,11 +2341,11 @@ Entra ID OAuth 2.0 User API endpoint

Also available in legacy Mattermost Enterprise Edition E20

-+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ -| We recommend ``https://graph.microsoft.com/v1.0/me`` as the User API Endpoint. Otherwise, enter a custom endpoint in ``config.json`` with ``http``, or ``https``, if available on the server. | - System Config path: **Authentication > OAuth 2.0** | -| | - ``config.json`` setting: ``.Office365Settings.UserAPIEndpoint`` | -| String input. | - Environment variable: ``MM_OFFICE365SETTINGS_USERAPIENDPOINT`` | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| We recommend ``https://graph.microsoft.com/v1.0/me`` as the User API Endpoint. Otherwise, enter a custom endpoint in ``config.json`` with ``http``, or ``https``, if available on the server. | - System Config path: **Authentication > OAuth 2.0** | +| | - ``config.json`` setting: ``Office365Settings`` > ``UserAPIEndpoint`` | +| String input. | - Environment variable: ``MM_OFFICE365SETTINGS_USERAPIENDPOINT`` | ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ .. config:setting:: oauth-entra-id-authendpoint :displayname: Auth endpoint (OAuth - Entra ID) @@ -2339,11 +2361,11 @@ Entra ID OAuth 2.0 Auth endpoint

Also available in legacy Mattermost Enterprise Edition E20

-+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ -| We recommend ``https://login.microsoftonline.com/common/oauth2/v2.0/authorize`` as the Auth Endpoint. Otherwise, enter a custom endpoint in ``config.json`` with ``http``, or ``https``, if available on the server. | - System Config path: **Authentication > OAuth 2.0** | -| | - ``config.json`` setting: ``.Office365Settings.AuthEndpoint`` | -| String input. | - Environment variable: ``MM_OFFICE365SETTINGS_AUTHENDPOINT`` | -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ +| We recommend ``https://login.microsoftonline.com/common/oauth2/v2.0/authorize`` as the Auth Endpoint. Otherwise, enter a custom endpoint in ``config.json`` with ``http``, or ``https``, if available on the server. | - System Config path: **Authentication > OAuth 2.0** | +| | - ``config.json`` setting: ``Office365Settings`` > ``AuthEndpoint`` | +| String input. | - Environment variable: ``MM_OFFICE365SETTINGS_AUTHENDPOINT`` | ++----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. config:setting:: oauth-entra-id-tokenendpoint :displayname: Token endpoint (OAuth - Entra ID) @@ -2359,11 +2381,11 @@ Entra ID OAuth 2.0 Token endpoint

Also available in legacy Mattermost Enterprise Edition E20

-+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ -| We recommend ``https://login.microsoftonline.com/common/oauth2/v2.0/token`` as the Token Endpoint. Otherwise, enter a custom endpoint in ``config.json`` with ``http``, or ``https``, if available on the server. | - System Config path: **Authentication > OAuth 2.0** | -| | - ``config.json`` setting: ``.Office365Settings.TokenEndpoint`` | -| String input. | - Environment variable: ``MM_OFFICE365SETTINGS_TOKENENDPOINT`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| We recommend ``https://login.microsoftonline.com/common/oauth2/v2.0/token`` as the Token Endpoint. Otherwise, enter a custom endpoint in ``config.json`` with ``http``, or ``https``, if available on the server. | - System Config path: **Authentication > OAuth 2.0** | +| | - ``config.json`` setting: ``Office365Settings`` > ``TokenEndpoint`` | +| String input. | - Environment variable: ``MM_OFFICE365SETTINGS_TOKENENDPOINT`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ ---- @@ -2398,8 +2420,9 @@ Select OpenID Connect service provider | - **Entra ID** (`see settings <#entra-id-openid-settings>`__) | | | - **OpenID Connect (Other)** (`see settings <#openid-connect-other-settings>`__) | | +----------------------------------------------------------------------------------+-----------------------------------------------------------+ -| **Note**: **GitLab** OpenID is available in all plans. All other providers require Mattermost Enterprise or Professional. | -+----------------------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + **GitLab** OpenID is available in all plans. All other providers require Mattermost Enterprise or Professional. GitLab OpenID settings ^^^^^^^^^^^^^^^^^^^^^^ @@ -2423,13 +2446,14 @@ Enable OpenID Connect authentication with GitLab

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+------------------------------------------------------------------------------------------+--------------------------------------------------------------+ -| - **true**: Allows team and account creation using GitLab OpenID Connect authentication. | - System Config path: **Authentication > OpenID Connect** | -| - **false**: **(Default)** Disables GitLab OpenID Connect authentication. | - ``config.json`` setting: ``.GitLabSettings.Enable: false`` | -| | - Environment variable: ``MM_GITLABSETTINGS_ENABLE`` | -+------------------------------------------------------------------------------------------+--------------------------------------------------------------+ -| **Note**: See the :doc:`GitLab Single Sign-On ` documentation for details. | -+---------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| - **true**: Allows team and account creation using GitLab OpenID Connect authentication. | - System Config path: **Authentication > OpenID Connect** | +| - **false**: **(Default)** Disables GitLab OpenID Connect authentication. | - ``config.json`` setting: ``GitLabSettings`` > ``Enable`` > ``false`` | +| | - Environment variable: ``MM_GITLABSETTINGS_ENABLE`` | ++------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ + +.. note:: + See the :doc:`GitLab Single Sign-On ` documentation for details. .. config:setting:: oidc-gitlabsiteurl :displayname: GitLab site URL (OpenID Connect - GitLab) @@ -2451,8 +2475,9 @@ GitLab OpenID site URL | | - Environment variable: N/A | | String input. | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------+ -| **Note**: See **Step 2** of the :doc:`GitLab Single Sign-On ` documentation for details. | -+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + See **Step 2** of the :doc:`GitLab Single Sign-On ` documentation for details. .. config:setting:: oidc-gitlabdiscoveryendpoint :displayname: Discovery endpoint (OpenID Connect - GitLab) @@ -2468,14 +2493,15 @@ GitLab OpenID Discovery endpoint

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+-------------------------------------------------------------------------------------+-----------------------------------------------------------------+ -| This setting is prepopulated with the Discovery Endpoint for GitLab OpenID Connect. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.GitLabSettings.DiscoveryEndpoint``| -| | - Environment variable: ``MM_GITLABSETTINGS_DISCOVERYENDPOINT`` | -| String input. Default is ``https://gitlab.com/.well-known/openid-configuration`` | | -+-------------------------------------------------------------------------------------+-----------------------------------------------------------------+ -| **Note**: See **Step 2** of the :doc:`GitLab Single Sign-On ` documentation for details. | -+-------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| This setting is prepopulated with the Discovery Endpoint for GitLab OpenID Connect. | - System Config path: **Authentication > OpenID Connect** | +| | - ``config.json`` setting: ``GitLabSettings`` > ``DiscoveryEndpoint``| +| | - Environment variable: ``MM_GITLABSETTINGS_DISCOVERYENDPOINT`` | +| String input. Default is ``https://gitlab.com/.well-known/openid-configuration`` | | ++-------------------------------------------------------------------------------------+----------------------------------------------------------------------+ + +.. note:: + See **Step 2** of the :doc:`GitLab Single Sign-On ` documentation for details. .. config:setting:: oidc-gitlabclientid :displayname: Client ID (OpenID Connect - GitLab) @@ -2493,12 +2519,13 @@ GitLab OpenID Client ID +-----------------------------------------------------------------+--------------------------------------------------------------------------+ | This setting stores the **Application ID** generated by GitLab. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.GitLabSettings.Id`` | +| | - ``config.json`` setting: ``GitLabSettings`` > ``Id`` | | | - Environment variable: ``MM_GITLABSETTINGS_ID`` | | String input. | | +-----------------------------------------------------------------+--------------------------------------------------------------------------+ -| **Note**: See **Step 2** of the :doc:`GitLab Single Sign-On ` documentation for details. | -+--------------------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + See **Step 2** of the :doc:`GitLab Single Sign-On ` documentation for details. .. config:setting:: oidc-gitlabclientsecret :displayname: Client secret (OpenID Connect - GitLab) @@ -2516,12 +2543,13 @@ GitLab OpenID Client secret +-------------------------------------------------------------------------+------------------------------------------------------------------+ | This setting stores the **Application Secret Key** generated by GitLab. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.GitLabSettings.Secret`` | +| | - ``config.json`` setting: ``GitLabSettings`` > ``Secret`` | | | - Environment variable: ``MM_GITLABSETTINGS_SECRET`` | | String input. | | +-------------------------------------------------------------------------+------------------------------------------------------------------+ -| **Note**: See **Step 2** of the :doc:`GitLab Single Sign-On ` documentation for details. | -+--------------------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + See **Step 2** of the :doc:`GitLab Single Sign-On ` documentation for details. Google OpenID settings ^^^^^^^^^^^^^^^^^^^^^^ @@ -2546,12 +2574,12 @@ Enable OpenID Connect authentication with Google

Also available in legacy Mattermost Enterprise Edition E20

-+------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ -| - **true**: Allows team and account creation using Google OpenID authentication. | - System Config path: **Authentication > OpenID Connect** | -| - **false**: **(Default)** Disables Google OpenID authentication. | - ``config.json`` setting: ``.GoogleSettings.Enable: false`` | -| | - Environment variable: ``MM_GOOGLESETTINGS_ENABLE`` | -| See :doc:`Google Single Sign-On ` implementation instructions. | | -+------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| - **true**: Allows team and account creation using Google OpenID authentication. | - System Config path: **Authentication > OpenID Connect** | +| - **false**: **(Default)** Disables Google OpenID authentication. | - ``config.json`` setting: ``GoogleSettings`` > ``Enable`` > ``false`` | +| | - Environment variable: ``MM_GOOGLESETTINGS_ENABLE`` | +| See :doc:`Google Single Sign-On ` implementation instructions. | | ++------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ .. config:setting:: oidc-googlediscoveryendpoint :displayname: Discovery endpoint (OpenID Connect - Google) @@ -2567,13 +2595,13 @@ Google OpenID Discovery endpoint

Also available in legacy Mattermost Enterprise Edition E20

-+---------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| This setting is prepopulated with the Discovery Endpoint for Google OpenID Connect. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.GoogleSettings.DiscoveryEndpoint`` | -| See :ref:`Configure Mattermost for Google Apps SSO `. | - Environment variable: ``MM_GOOGLESETTINGS_DISCOVERYENDPOINT`` | -| | | -| String input. Default is ``https://accounts.google.com/.well-known/openid-configuration`` | | -+---------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| This setting is prepopulated with the Discovery Endpoint for Google OpenID Connect. | - System Config path: **Authentication > OpenID Connect** | +| | - ``config.json`` setting: ``GoogleSettings`` > ``DiscoveryEndpoint`` | +| See :ref:`Configure Mattermost for Google Apps SSO `. | - Environment variable: ``MM_GOOGLESETTINGS_DISCOVERYENDPOINT`` | +| | | +| String input. Default is ``https://accounts.google.com/.well-known/openid-configuration`` | | ++---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ .. config:setting:: oidc-googleclientid :displayname: Client ID (OpenID Connect - Google) @@ -2591,7 +2619,7 @@ Google OpenID Client ID +------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ | This setting stores the Client ID generated by Google. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.GoogleSettings.Id`` | +| | - ``config.json`` setting: ``GoogleSettings`` > ``Id`` | | See :doc:`Google Single Sign-On ` implementation instructions. | - Environment variable: ``MM_GOOGLESETTINGS_ID`` | | | | | String input. | | @@ -2613,7 +2641,7 @@ Google OpenID Client secret +-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ | This setting stores the Client Secret generated by Google. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.GoogleSettings.Secret`` | +| | - ``config.json`` setting: ``GoogleSettings`` > ``Secret``| | See :doc:`Google Single Sign-On ` implementation instructions. | - Environment variable: ``MM_GOOGLESETTINGS_SECRET`` | | | | | String input. | | @@ -2644,12 +2672,12 @@ Enable OpenID Connect authentication with Entra ID

Also available in legacy Mattermost Enterprise Edition E20

-+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ -| - **true**: Allows team and account creation using Entra ID OpenID Connect authentication. | - System Config path: **Authentication > OpenID Connect** | -| - **false**: **(Default)** Disables Entra ID OpenID Connect authentication. | - ``config.json`` setting: ``.Office365Settings.Enable: false`` | -| | - Environment variable: ``MM_OFFICE365SETTINGS_ENABLE`` | -| See :doc:`Entra ID Single Sign-On ` implementation instructions. | | -+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ +| - **true**: Allows team and account creation using Entra ID OpenID Connect authentication. | - System Config path: **Authentication > OpenID Connect** | +| - **false**: **(Default)** Disables Entra ID OpenID Connect authentication. | - ``config.json`` setting: ``Office365Settings`` > ``Enable`` > ``false`` | +| | - Environment variable: ``MM_OFFICE365SETTINGS_ENABLE`` | +| See :doc:`Entra ID Single Sign-On ` implementation instructions. | | ++----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ .. config:setting:: oidc-o365directoryid :displayname: Directory ID (OpenID Connect - Entra ID) @@ -2665,13 +2693,13 @@ Entra ID OpenID Directory (tenant) ID

Also available in legacy Mattermost Enterprise Edition E20

-+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ -| This setting holds the Directory (tenant) ID set for Mattermost through the Microsoft Azure Portal. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.Office365Settings.DirectoryId`` | -| See :doc:`Entra ID Single Sign-On ` implementation instructions. | - Environment variable: ``MM_OFFICE365SETTINGS_DIRECTORYID`` | -| | | -| String input. | | -+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ +| This setting holds the Directory (tenant) ID set for Mattermost through the Microsoft Azure Portal. | - System Config path: **Authentication > OpenID Connect** | +| | - ``config.json`` setting: ``Office365Settings`` > ``DirectoryId`` | +| See :doc:`Entra ID Single Sign-On ` implementation instructions. | - Environment variable: ``MM_OFFICE365SETTINGS_DIRECTORYID`` | +| | | +| String input. | | ++----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ .. config:setting:: oidc-o365discoveryendpoint :displayname: Discovery endpoint (OpenID Connect - Entra ID) @@ -2687,13 +2715,13 @@ Entra ID OpenID Discovery endpoint

Also available in legacy Mattermost Enterprise Edition E20

-+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ -| This setting is prepopulated with the Discovery Endpoint for Entra ID OpenID Connect. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.Office365Settings.DiscoveryEndpoint`` | -| See :doc:`Entra ID Single Sign-On ` implementation instructions. | - Environment variable: ``MM_OFFICE365SETTINGS_DISCOVERYENDPOINT`` | -| | | -| String input. Default is ``https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration`` | | -+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| This setting is prepopulated with the Discovery Endpoint for Entra ID OpenID Connect. | - System Config path: **Authentication > OpenID Connect** | +| | - ``config.json`` setting: ``Office365Settings`` > ``DiscoveryEndpoint`` | +| See :doc:`Entra ID Single Sign-On ` implementation instructions. | - Environment variable: ``MM_OFFICE365SETTINGS_DISCOVERYENDPOINT`` | +| | | +| String input. Default is ``https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration`` | | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ .. config:setting:: oidc-o365clientid :displayname: Client ID (OpenID Connect - Entra ID) @@ -2711,7 +2739,7 @@ Entra ID Client ID +----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ | This setting stores the **Application (client) ID** generated through the Microsoft Azure Portal. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.Office365Settings.Id`` | +| | - ``config.json`` setting: ``Office365Settings`` > ``Id`` | | See :doc:`Entra ID Single Sign-On ` implementation instructions. | - Environment variable: ``MM_OFFICE365SETTINGS_ID`` | | | | | String input. | | @@ -2731,13 +2759,13 @@ Entra ID Client secret

Also available in legacy Mattermost Enterprise Edition E20

-+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ -| This setting stores the **Client Secret** generated through the Microsoft Azure Portal. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.Office365Settings.Secret`` | -| See :doc:`Entra ID Single Sign-On ` implementation instructions. | - Environment variable: ``MM_OFFICE365SETTINGS_SECRET`` | -| | | -| String input. | | -+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ +| This setting stores the **Client Secret** generated through the Microsoft Azure Portal. | - System Config path: **Authentication > OpenID Connect** | +| | - ``config.json`` setting: ``Office365Settings`` > ``Secret`` | +| See :doc:`Entra ID Single Sign-On ` implementation instructions. | - Environment variable: ``MM_OFFICE365SETTINGS_SECRET`` | +| | | +| String input. | | ++----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ OpenID Connect (other) settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -2764,12 +2792,12 @@ Enable OpenID Connect authentication with other service providers

Also available in legacy Mattermost Enterprise Edition E20

-+---------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ -| - **true**: Allows team and account creation using other OpenID Connect service providers. | - System Config path: **Authentication > OpenID Connect** | -| - **false**: **(Default)** Disables OpenID Connect authentication with other service providers. | - ``config.json`` setting: ``.OpenIdSettings.Enable: false`` | -| | - Environment variable: ``MM_OPENIDSETTINGS_ENABLE`` | -| See :doc:`OpenID Connect Single Sign-On ` implementation instructions. | | -+---------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| - **true**: Allows team and account creation using other OpenID Connect service providers. | - System Config path: **Authentication > OpenID Connect** | +| - **false**: **(Default)** Disables OpenID Connect authentication with other service providers. | - ``config.json`` setting: ``OpenIdSettings`` > ``Enable`` > ``false`` | +| | - Environment variable: ``MM_OPENIDSETTINGS_ENABLE`` | +| See :doc:`OpenID Connect Single Sign-On ` implementation instructions. | | ++---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ .. config:setting:: oidc-buttonname :displayname: Button name (OpenID Connect) @@ -2785,11 +2813,11 @@ OpenID Connect (other) Button name

Also available in legacy Mattermost Enterprise Edition E20

-+-------------------------------------------------------+-----------------------------------------------------------+ -| This setting is the text for the OpenID login button. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.OpenIdSettings.ButtonText`` | -| String input. | - Environment variable: ``MM_OPENIDSETTINGS_BUTTONTEXT`` | -+-------------------------------------------------------+-----------------------------------------------------------+ ++-------------------------------------------------------+----------------------------------------------------------------+ +| This setting is the text for the OpenID login button. | - System Config path: **Authentication > OpenID Connect** | +| | - ``config.json`` setting: ``OpenIdSettings`` > ``ButtonText`` | +| String input. | - Environment variable: ``MM_OPENIDSETTINGS_BUTTONTEXT`` | ++-------------------------------------------------------+----------------------------------------------------------------+ .. config:setting:: oidc-buttoncolor :displayname: Button color @@ -2805,11 +2833,11 @@ OpenID Connect (other) Button color

Also available in legacy Mattermost Enterprise Edition E20

-+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ -| This setting is the color of the OpenID login button. Use a hex code with a #-sign before the code, for example ``#145DBF``. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.OpenIdSettings.ButtonColor`` | -| String input. | - Environment variable: ``MM_OPENIDSETTINGS_BUTTONCOLOR`` | -+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ +| This setting is the color of the OpenID login button. Use a hex code with a #-sign before the code, for example ``#145DBF``. | - System Config path: **Authentication > OpenID Connect** | +| | - ``config.json`` setting: ``OpenIdSettings`` > ``ButtonColor`` | +| String input. | - Environment variable: ``MM_OPENIDSETTINGS_BUTTONCOLOR`` | ++------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ .. config:setting:: oidc-discoveryendpoint :displayname: Discovery endpoint (OpenID Connect) @@ -2825,20 +2853,21 @@ OpenID Connect (other) Discovery endpoint

Also available in legacy Mattermost Enterprise Edition E20

-+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| This setting stores the Discovery Endpoint URL from the OpenID provider. | - System Config path: **Authentication > OpenID Connect** | -| The URL should be in the format of ``https://myopenid.provider.com/{my_organization}/ | - ``config.json`` setting: ``.OpenIdSettings.DiscoveryEndpoint`` | -| .well-known/openid-configuration``. | - Environment variable: ``MM_OPENIDSETTINGS_DISCOVERYENDPOINT`` | -| | | -| See :doc:`OpenID Connect Single Sign-On ` | | -| implementation instructions. | | -| | | -| String input. | | -+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ -| **Note**: The **Discovery Endpoint** setting can be used to determine the connectivity and availability of arbitrary hosts. System admins concerned about this can use | -| custom admin roles to limit access to modifying these settings. See the | -| :ref:`delegated granular administration ` documentation for details. | -+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| This setting stores the Discovery Endpoint URL from the OpenID provider. | - System Config path: **Authentication > OpenID Connect** | +| The URL should be in the format of ``https://myopenid.provider.com/{my_organization}/ | - ``config.json`` setting: ``OpenIdSettings`` > ``DiscoveryEndpoint`` | +| .well-known/openid-configuration``. | - Environment variable: ``MM_OPENIDSETTINGS_DISCOVERYENDPOINT`` | +| | | +| See :doc:`OpenID Connect Single Sign-On ` | | +| implementation instructions. | | +| | | +| String input. | | ++--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + +.. note:: + The **Discovery Endpoint** setting can be used to determine the connectivity and availability of arbitrary hosts. System admins concerned about this can use + custom admin roles to limit access to modifying these settings. See the + :ref:`delegated granular administration ` documentation for details. .. config:setting:: oidc-clientid :displayname: Client ID (OpenID Connect) @@ -2856,7 +2885,7 @@ OpenID Connect (other) Client ID +---------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ | This setting stores the Client ID from the OpenID provider. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.OpenIdSettings.Id`` | +| | - ``config.json`` setting: ``OpenIdSettings`` > ``Id`` | | See :doc:`OpenID Connect Single Sign-On ` implementation instructions. | - Environment variable: ``MM_OPENIDSETTINGS_ID`` | | | | | String input. | | @@ -2878,7 +2907,7 @@ OpenID Connect (other) Client secret +---------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ | This setting stores the Client Secret from the OpenID provider. | - System Config path: **Authentication > OpenID Connect** | -| | - ``config.json`` setting: ``.OpenIdSettings.Secret`` | +| | - ``config.json`` setting: ``OpenIdSettings`` > ``Secret``| | See :doc:`OpenID Connect Single Sign-On ` implementation instructions. | - Environment variable: ``MM_OPENIDSETTINGS_SECRET`` | | | | | String input. | | @@ -2910,14 +2939,15 @@ Enable guest access

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+----------------------------------------------------------------+---------------------------------------------------------------------+ -| - **true**: Enables the guest account feature. | - System Config path: **Authentication > Guest Access** | -| - **false**: **(Default)** Disables the guest account feature. | - ``config.json`` setting: ``.GuestAccountsSettings.Enable: false`` | -| | - Environment variable: ``MM_GUESTACCOUNTSSETTINGS_ENABLE`` | -+----------------------------------------------------------------+---------------------------------------------------------------------+ -| **Note**: For billing purposes, activated guest accounts do consume a licensed seat, which is returned when the guest account is | -| deactivated.This means that guest accounts count as a paid user in your Mattermost :doc:`workspace `. | -+--------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------+-------------------------------------------------------------------------------+ +| - **true**: Enables the guest account feature. | - System Config path: **Authentication > Guest Access** | +| - **false**: **(Default)** Disables the guest account feature. | - ``config.json`` setting: ``GuestAccountsSettings`` > ``Enable`` > ``false`` | +| | - Environment variable: ``MM_GUESTACCOUNTSSETTINGS_ENABLE`` | ++----------------------------------------------------------------+-------------------------------------------------------------------------------+ + +.. note:: + For billing purposes, activated guest accounts do consume a licensed seat, which is returned when the guest account is + deactivated.This means that guest accounts count as a paid user in your Mattermost :doc:`workspace `. .. config:setting:: guest-whitelistdomains :displayname: Whitelisted guest domains (Guest Access) @@ -2933,11 +2963,11 @@ Whitelisted guest domains

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+--------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ -| Use this setting to restrict the creation of guest accounts. When set, guest accounts require a verified email address from one of the listed domains. | - System Config path: **Authentication > Guest Access** | -| | - ``config.json`` setting: ``.GuestAccountsSettings.RestrictCreationToDomains`` | -| String input of one or more domains, separated by commas. | - Environment variable: ``MM_GUESTACCOUNTSSETTINGS_RESTRICTCREATIONTODOMAINS`` | -+--------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| Use this setting to restrict the creation of guest accounts. When set, guest accounts require a verified email address from one of the listed domains. | - System Config path: **Authentication > Guest Access** | +| | - ``config.json`` setting: ``GuestAccountsSettings`` > ``RestrictCreationToDomains`` | +| String input of one or more domains, separated by commas. | - Environment variable: ``MM_GUESTACCOUNTSSETTINGS_RESTRICTCREATIONTODOMAINS`` | ++--------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ .. config:setting:: guest-enforcemultifactorauth :displayname: Enforce multi-factor authentication (Guest Access) @@ -2955,13 +2985,14 @@ Enforce multi-factor authentication

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ -| - **true**: Guests must use MFA. Guests without MFA are redirected to the setup page until MFA is configured. | - System Config path: **Authentication > Guest Access** | -| - **false**: **(Default)** MFA is not required for guests. | - ``config.json`` setting: ``.GuestAccountsSettings.EnforceMultifactorAuthentication: false`` | -| | - Environment variable: ``MM_GUESTACCOUNTSSETTINGS_ENFORCEMULTIFACTORAUTHENTICATION`` | -+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ -| **Note**: This setting defaults to false and cannot be changed if MFA isn't enforced for non-guest users. | -+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ +| - **true**: Guests must use MFA. Guests without MFA are redirected to the setup page until MFA is configured. | - System Config path: **Authentication > Guest Access** | +| - **false**: **(Default)** MFA is not required for guests. | - ``config.json`` setting: ``GuestAccountsSettings`` > ``EnforceMultifactorAuthentication`` > ``false`` | +| | - Environment variable: ``MM_GUESTACCOUNTSSETTINGS_ENFORCEMULTIFACTORAUTHENTICATION`` | ++---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting defaults to false and cannot be changed if MFA isn't enforced for non-guest users. .. config:setting:: guest-showtag :displayname: Show guest tag (Guest Access) @@ -2975,13 +3006,11 @@ Enforce multi-factor authentication Show guest tag ~~~~~~~~~~~~~~ -+-----------------------------------------------------------------+----------------------------------------------------------------------+ -| - **true**: **(Default)** Guest tags are visible in Mattermost. | - System Config path: **Authentication > Guest Access** | -| - **false**: Guest tags aren't visible in Mattermost. | - ``config.json`` setting: ``.GuestAccountsSettings.HideTags: true`` | -| | - Environment variable: ``MM_GUESTACCOUNTSSETTINGS_HIDETAGS`` | -+-----------------------------------------------------------------+----------------------------------------------------------------------+ -| **Notes**: | -| | -| - See the :doc:`guest accounts ` documentation for details. | -| - This configuration setting applies to all Mattermost clients, including web, desktop app, and mobile app. | -+----------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+--------------------------------------------------------------------------------+ +| - **true**: **(Default)** Guest tags are visible in Mattermost. | - System Config path: **Authentication > Guest Access** | +| - **false**: Guest tags aren't visible in Mattermost. | - ``config.json`` setting: ``GuestAccountsSettings`` > ``HideTags`` > ``true`` | +| | - Environment variable: ``MM_GUESTACCOUNTSSETTINGS_HIDETAGS`` | ++-----------------------------------------------------------------+--------------------------------------------------------------------------------+ + +.. note:: + This configuration setting applies to all Mattermost clients, including web, desktop app, and mobile app. See the :doc:`guest accounts ` documentation for details. diff --git a/source/configure/environment-configuration-settings.rst b/source/configure/environment-configuration-settings.rst index 7e5449be889..683486bfbd1 100644 --- a/source/configure/environment-configuration-settings.rst +++ b/source/configure/environment-configuration-settings.rst @@ -4082,7 +4082,7 @@ Disable Customer Portal requests +-----------------------------------------------+---------------------------------------------------------------------------+ | Enable or disable customer portal requests. | - System Config path: **N/A** | -| | - ``config.json setting``: ``".CloudSettings.Disable": false",`` | +| | - ``config.json setting``: ``CloudSettings`` > ``Disable`` > ``false,`` | | | - Environment variable: ``MM_CLOUDSETTINGS_DISABLE`` | | - **true**: **(Default)** Server-side | | | requests made to the customer portal are | | @@ -4092,8 +4092,9 @@ Disable Customer Portal requests | but will always fail in air-gapped and | | | restricted deployment environments. | | +-----------------------------------------------+---------------------------------------------------------------------------+ -| **Note**: Cloud admins can’t modify this configuration setting. | -+-----------------------------------------------+---------------------------------------------------------------------------+ + +.. note:: + Cloud admins can’t modify this configuration setting. .. config:setting:: exp-enableapiteamdeletion :displayname: Enable API team deletion (ServiceSettings) diff --git a/source/configure/plugins-configuration-settings.rst b/source/configure/plugins-configuration-settings.rst index 28c252f4073..11835a475ef 100644 --- a/source/configure/plugins-configuration-settings.rst +++ b/source/configure/plugins-configuration-settings.rst @@ -25,11 +25,11 @@ Access the following configuration settings in the System Console by going to ** Enable plugins ~~~~~~~~~~~~~~ -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ -| - **true**: **(Default)** Enables plugins on your Mattermost server. See the `Use plugins with Mattermost `__ documentation for details. | - System Config path: **Plugins > Plugin Management** | -| - **false**: Disables plugins on your Mattermost server. | - ``config.json`` setting: ``.PluginSettings.Enable: true`` | -| | - Environment variable: ``MM_PLUGINSETTINGS_ENABLE`` | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| - **true**: **(Default)** Enables plugins on your Mattermost server. See the `Use plugins with Mattermost `__ documentation for details. | - System Config path: **Plugins > Plugin Management** | +| - **false**: Disables plugins on your Mattermost server. | - ``config.json`` setting: ``PluginSettings`` > ``Enable`` > ``true`` | +| | - Environment variable: ``MM_PLUGINSETTINGS_ENABLE`` | ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ .. config:setting:: plugins-requiresignature :displayname: Require plugin signature (Plugins - Management) @@ -46,16 +46,15 @@ Require plugin signature .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ -| - **true**: **(Default)** Enables plugin signature validation for managed and unmanaged plugins. | - System Config path: **Plugins > Plugin Management** | -| - **false**: Disables plugin signature validation for managed and unmanaged plugins. | - ``config.json`` setting: ``.PluginSettings.RequirePluginSignature: true`` | -| | - Environment variable: ``MM_PLUGINSETTINGS_REQUIREPLUGINSIGNATURE`` | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ -| **Notes**: | -| | -| - Pre-packaged plugins are not subject to signature validation. Plugins installed through the Marketplace are always subject to signature validation at the time of download. | -| - Enabling this configuration will result in `plugin file uploads <#upload-plugin>`__ being disabled in the System Console. | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Enables plugin signature validation for managed and unmanaged plugins. | - System Config path: **Plugins > Plugin Management** | +| - **false**: Disables plugin signature validation for managed and unmanaged plugins. | - ``config.json`` setting: ``PluginSettings`` > ``RequirePluginSignature`` > ``true`` | +| | - Environment variable: ``MM_PLUGINSETTINGS_REQUIREPLUGINSIGNATURE`` | ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ + +.. note:: + - Pre-packaged plugins are not subject to signature validation. Plugins installed through the Marketplace are always subject to signature validation at the time of download. + - Enabling this configuration will result in `plugin file uploads <#upload-plugin>`__ being disabled in the System Console. .. config:setting:: plugins-automaticprepackagedplugins :displayname: Automatic prepackaged plugins (Plugins - Management) @@ -69,11 +68,11 @@ Require plugin signature Automatic prepackaged plugins ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ -| - **true**: **(Default)** Mattermost automatically installs and upgrades any enabled pre-packaged plugins. If a newer version is installed, no changes are made. | - System Config path: **Plugins > Plugin Management** | -| - **false**: Mattermost does not automatically install or upgrade pre-packaged plugins. Pre-packaged plugins may be installed manually from the Marketplace, even when offline. | - ``config.json`` setting: ``.PluginSettings.AutomaticPrepackagedPlugins: true`` | -| | - Environment variable: ``MM_PLUGINSETTINGS_AUTOMATICPREPACKAGEDPLUGINS`` | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Mattermost automatically installs and upgrades any enabled pre-packaged plugins. If a newer version is installed, no changes are made. | - System Config path: **Plugins > Plugin Management** | +| - **false**: Mattermost does not automatically install or upgrade pre-packaged plugins. Pre-packaged plugins may be installed manually from the Marketplace, even when offline. | - ``config.json`` setting: ``PluginSettings`` > ``AutomaticPrepackagedPlugins`` > ``true`` | +| | - Environment variable: ``MM_PLUGINSETTINGS_AUTOMATICPREPACKAGEDPLUGINS`` | ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ .. config:setting:: plugins-upload :displayname: Upload Plugin (Plugins - Management) @@ -90,18 +89,17 @@ Upload Plugin .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| - **true**: Enables you to upload plugins from the local computer to the Mattermost server. | - System Config path: **Plugins > Plugin Management** | -| - **false**: **(Default)** Disables uploading of plugins from the local computer to the Mattermost server. | - ``config.json`` setting: ``.PluginSettings.EnableUploads: false`` | -| | - Environment variable: ``MM_PLUGINSETTINGS_ENABLEUPLOADS`` | -+------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| **Notes**: | -| | -| - When plugin uploads are enabled, the error ``Received invlaid response from the server`` when uploading a plugin file typically indicates that the | -| :ref:`MaxFileSize ` configuration setting isn't large enough to support the plugin file upload. Additional proxy setting updateds | -| may also be required. | -| - The ability to upload plugin files is disabled when the `Require plugin signature <#require-plugin-signature>`__ configuration setting is enabled. | -+------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| - **true**: Enables you to upload plugins from the local computer to the Mattermost server. | - System Config path: **Plugins > Plugin Management** | +| - **false**: **(Default)** Disables uploading of plugins from the local computer to the Mattermost server. | - ``config.json`` setting: ``PluginSettings`` > ``EnableUploads`` > ``false`` | +| | - Environment variable: ``MM_PLUGINSETTINGS_ENABLEUPLOADS`` | ++------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. note:: + - When plugin uploads are enabled, the error ``Received invlaid response from the server`` when uploading a plugin file typically indicates that the + :ref:`MaxFileSize ` configuration setting isn't large enough to support the plugin file upload. Additional proxy setting updateds + may also be required. + - The ability to upload plugin files is disabled when the `Require plugin signature <#require-plugin-signature>`__ configuration setting is enabled. .. config:setting:: plugins-enablemarketplace :displayname: Enable marketplace (Plugins - Management) @@ -115,11 +113,11 @@ Upload Plugin Enable Marketplace ~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| - **true**: **(Default)** Enables the plugin Marketplace on your Mattermost server for all system admins. | - System Config path: **Plugins > Plugin Management** | -| - **false**: Disables the plugin Marketplace on your Mattermost server for all system admins. | - ``config.json`` setting: ``.PluginSettings.EnableMarketplace: true`` | -| | - Environment variable: ``MM_PLUGINSETTINGS_ENABLEMARKETPLACE`` | -+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| - **true**: **(Default)** Enables the plugin Marketplace on your Mattermost server for all system admins. | - System Config path: **Plugins > Plugin Management** | +| - **false**: Disables the plugin Marketplace on your Mattermost server for all system admins. | - ``config.json`` setting: ``PluginSettings`` > ``EnableMarketplace`` > ``true`` | +| | - Environment variable: ``MM_PLUGINSETTINGS_ENABLEMARKETPLACE`` | ++-----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ .. config:setting:: plugins-enableremotemarketplace :displayname: Enable remote marketplace (Plugins - Management) @@ -133,18 +131,17 @@ Enable Marketplace Enable remote Marketplace ~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ -| - **true**: **(Default)** Mattermost attempts to connect to the endpoint set in **Marketplace URL**. | - System Config path: **Plugins > Plugin Management** | -| If the connection fails, an error is displayed, and the Marketplace only shows pre-packaged and installed plugins. | - ``config.json`` setting: ``.PluginSettings.EnableRemoteMarketplace: true`` | -| - **false**: Mattermost does not attempt to connect to a remote Marketplace. | - Environment variable: ``MM_PLUGINSETTINGS_ENABLEREMOTEMARKETPLACE`` | -| The Marketplace shows only pre-packaged and installed plugins. Use this setting if your Mattermost server cannot connect to the Internet. | | -+-------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ -| **Notes**: | -| | -| - From Mattermost v9.1, set this configuration setting value to ``true`` to access a configured remote marketplace URL. | -| - For Mattermost v9.0, the ``MM_FEATUREFLAGS_STREAMLINEDMARKETPLACE`` feature flag must be set to ``false``, and this configuration setting must be set to ``true`` to access a configured remote marketplace URL. | -| - Each Mattermost host must have network access to the endpoint set in MarketplaceURL. | -+-------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Mattermost attempts to connect to the endpoint set in **Marketplace URL**. | - System Config path: **Plugins > Plugin Management** | +| If the connection fails, an error is displayed, and the Marketplace only shows pre-packaged and installed plugins. | - ``config.json`` setting: ``PluginSettings`` > ``EnableRemoteMarketplace`` > ``true`` | +| - **false**: Mattermost does not attempt to connect to a remote Marketplace. | - Environment variable: ``MM_PLUGINSETTINGS_ENABLEREMOTEMARKETPLACE`` | +| The Marketplace shows only pre-packaged and installed plugins. Use this setting if your Mattermost server cannot connect to the Internet. | | ++-------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+ + +.. note:: + - From Mattermost v9.1, set this configuration setting value to ``true`` to access a configured remote marketplace URL. + - For Mattermost v9.0, the ``MM_FEATUREFLAGS_STREAMLINEDMARKETPLACE`` feature flag must be set to ``false``, and this configuration setting must be set to ``true`` to access a configured remote marketplace URL. + - Each Mattermost host must have network access to the endpoint set in MarketplaceURL. .. config:setting:: plugins-marketplaceurl :displayname: Marketplace URL (Plugins - Management) @@ -156,11 +153,11 @@ Enable remote Marketplace Marketplace URL ~~~~~~~~~~~~~~~ -+----------------------------------------------------------------------+---------------------------------------------------------------+ -| This setting stores the URL for the remote Markeplace. | - System Config path: **Plugins > Plugin Management** | -| | - ``config.json`` setting: ``.PluginSettings.MarketplaceURL`` | -| String input. Default is **https://api.integrations.mattermost.com** | - Environment variable: ``MM_PLUGINSETTINGS_MARKETPLACEURL`` | -+----------------------------------------------------------------------+---------------------------------------------------------------+ ++----------------------------------------------------------------------+--------------------------------------------------------------------+ +| This setting stores the URL for the remote Markeplace. | - System Config path: **Plugins > Plugin Management** | +| | - ``config.json`` setting: ``PluginSettings`` > ``MarketplaceURL`` | +| String input. Default is **https://api.integrations.mattermost.com** | - Environment variable: ``MM_PLUGINSETTINGS_MARKETPLACEURL`` | ++----------------------------------------------------------------------+--------------------------------------------------------------------+ .. config:setting:: plugins-installedpluginstates :displayname: Installed plugin state (Plugins - Management) @@ -172,11 +169,11 @@ Marketplace URL Installed plugin state ~~~~~~~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ -| This setting is a list of installed plugins and their status as enabled or disabled. | - System Config path: **Plugins > Plugin Management** | -| | - ``config.json`` setting: ``.PluginSettings.PluginStates`` | -| The ``config.json`` setting is an object. The object keys are plugin IDs, e.g. ``com.mattermost.apps``. Each key maps to an object that contains an ``Enable`` key that can be set as ``true`` or ``false``. | - Environment variable: ``MM_PLUGINSETTINGS_PLUGINSTATES`` | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ +| This setting is a list of installed plugins and their status as enabled or disabled. | - System Config path: **Plugins > Plugin Management** | +| | - ``config.json`` setting: ``PluginSettings`` > ``PluginStates`` | +| The ``config.json`` setting is an object. The object keys are plugin IDs, e.g. ``com.mattermost.apps``. Each key maps to an object that contains an ``Enable`` key that can be set as ``true`` or ``false``. | - Environment variable: ``MM_PLUGINSETTINGS_PLUGINSTATES`` | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: plugins-pluginsettings :displayname: Plugin settings (Plugins - Management) @@ -188,11 +185,11 @@ Installed plugin state Plugin settings ~~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -| This setting contains plugin-specific data. | - System Config path: **Plugins > Plugin Management** | -| | - ``config.json`` setting: ``.PluginSettings.Plugins`` | -| The ``config.json`` setting is an object. The object keys are plugin IDs, e.g. ``com.mattermost.apps``. Each key maps to an object that contains plugin-specific data. | - Environment variable: ``MM_PLUGINSETTINGS_PLUGINS`` | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ +| This setting contains plugin-specific data. | - System Config path: **Plugins > Plugin Management** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` | +| The ``config.json`` setting is an object. The object keys are plugin IDs, e.g. ``com.mattermost.apps``. Each key maps to an object that contains plugin-specific data. | - Environment variable: ``MM_PLUGINSETTINGS_PLUGINS`` | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ ---- @@ -216,11 +213,11 @@ Access the following configuration settings in the System Console by going to ** Enable plugin ~~~~~~~~~~~~~ -+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| - **true**: (Default) Enables the Calls plugin on your Mattermost workspace. | - System Config path: **Plugins > Calls** | -| - **false**: Disables the Calls plugin on your Mattermost workspace. | - ``config.json`` setting: ``PluginSettings.PluginStates.com.mattermost.calls.Enable`` | -| | - Environment variable: ``MM_PLUGINSETTINGS_PLUGINSTATES_COM_MATTERMOST_CALLS`` | -+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ +| - **true**: (Default) Enables the Calls plugin on your Mattermost workspace. | - System Config path: **Plugins > Calls** | +| - **false**: Disables the Calls plugin on your Mattermost workspace. | - ``config.json`` setting: ``PluginSettings`` > ``PluginStates`` > ``com.mattermost.calls`` > ``Enable`` | +| | - Environment variable: ``MM_PLUGINSETTINGS_PLUGINSTATES_COM_MATTERMOST_CALLS`` | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-callsrtcserveraddress :displayname: RTC server port (UDP) (Plugins - Calls) @@ -235,14 +232,15 @@ RTC server address (UDP) .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ -| This setting controls the IP address the RTC server listens for UDP connections. All calls UDP traffic will be served through this IP. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.udpserveraddress`` | -| Changing this setting requires a plugin restart to take effect. | - Environment variable: N/A | -| If left unset (default value) the service will listen on all the available interfaces. | | -+--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ -| **Note**: This setting is only applicable when not running calls through the standalone ``rtcd`` service. | -+--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| This setting controls the IP address the RTC server listens for UDP connections. All calls UDP traffic will be served through this IP. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` ``Plugins`` > ``com.mattermost.calls`` > ``udpserveraddress`` | +| Changing this setting requires a plugin restart to take effect. | - Environment variable: N/A | +| If left unset (default value) the service will listen on all the available interfaces. | | ++--------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is only applicable when not running calls through the standalone ``rtcd`` service. .. config:setting:: plugins-callsrtcserveraddress :displayname: RTC server port (TCP) (Plugins - Calls) @@ -257,18 +255,15 @@ RTC server address (TCP) .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ -| This setting controls the IP address the RTC server listens for TCP connections. All calls TCP traffic will be served through this IP. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.tcpserveraddress`` | -| Changing this setting requires a plugin restart to take effect. | - Environment variable: N/A | -| If left unset (default value) the service will listen on all the available interfaces. | | -+--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ -| **Note**: | -| | -| - This setting is only applicable when not running calls through the standalone ``rtcd`` service. | -| | -| - This setting is available starting in plugin version 0.17. | -+--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| This setting controls the IP address the RTC server listens for TCP connections. All calls TCP traffic will be served through this IP. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``tcpserveraddress`` | +| Changing this setting requires a plugin restart to take effect. | - Environment variable: N/A | +| If left unset (default value) the service will listen on all the available interfaces. | | ++--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is available starting in plugin version 0.17, and is only applicable when not running calls through the standalone ``rtcd`` service. .. config:setting:: plugins-callsrtcserverportudp :displayname: RTC server port (UDP) (Plugins - Calls) @@ -283,16 +278,17 @@ RTC server port (UDP) .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| This setting controls the UDP port listened on by the RTC server. All calls UDP traffic will be served through this port. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.udpserverport`` | -| | - Environment variable: N/A | -| Changing this setting requires a plugin restart to take effect. | | -| | | -| Default is **8443**. | | -+-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| **Note**: This setting is only applicable when not running calls through the standalone ``rtcd`` service. | -+-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| This setting controls the UDP port listened on by the RTC server. All calls UDP traffic will be served through this port. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``udpserverport`` | +| | - Environment variable: N/A | +| Changing this setting requires a plugin restart to take effect. | | +| | | +| Default is **8443**. | | ++-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is only applicable when not running calls through the standalone ``rtcd`` service. .. config:setting:: plugins-callsrtcserverporttcp :displayname: RTC server port (TCP) (Plugins - Calls) @@ -307,19 +303,17 @@ RTC server port (TCP) .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| This setting controls the TCP port listened on by the RTC server. All calls TCP traffic will be served through this port. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.tcpserverport`` | -| | - Environment variable: N/A | -| Changing this setting requires a plugin restart to take effect. | | -| | | -| Default is **8443**. | | -+-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| **Note**: | -| | -| - This setting is only applicable when not running calls through the standalone ``rtcd`` service. | -| - This setting is available starting in plugin version 0.17. | -+-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ +| This setting controls the TCP port listened on by the RTC server. All calls TCP traffic will be served through this port. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``tcpserverport`` | +| | - Environment variable: N/A | +| Changing this setting requires a plugin restart to take effect. | | +| | | +| Default is **8443**. | | ++-------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is available starting in plugin version 0.17, and is only applicable when not running calls through the standalone ``rtcd`` service. .. config:setting:: plugins-enableonspecificchannels :displayname: Enable on specific channels (Plugins - Calls) @@ -336,11 +330,11 @@ Enable on specific channels .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+----------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| - **true**: Channel admins can enable or disable calls on specific channels. Participants in DMs/GMs can also enable or disable calls. | - System Config path: **Plugins > Calls** | -| - **false**: Only system admins can enable or disable calls on specific channels. | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.allowenablecalls`` | -| | - Environment variable: N/A | -+----------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| - **true**: Channel admins can enable or disable calls on specific channels. Participants in DMs/GMs can also enable or disable calls. | - System Config path: **Plugins > Calls** | +| - **false**: Only system admins can enable or disable calls on specific channels. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``allowenablecalls`` | +| | - Environment variable: N/A | ++----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-testmode :displayname: Test mode (Plugins - Calls) @@ -357,11 +351,11 @@ Test mode .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| - **false**: Test mode is enabled and only system admins can start calls in channels. | - System Config path: **Plugins > Calls** | -| - **true**: Live mode is enabled and all team members can start calls in channels. | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.defaultenabled`` | -| | - Environment variable: N/A | -+-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| - **false**: Test mode is enabled and only system admins can start calls in channels. | - System Config path: **Plugins > Calls** | +| - **true**: Live mode is enabled and all team members can start calls in channels. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``defaultenabled`` | +| | - Environment variable: N/A | ++-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ .. note:: Use this setting as a system admin to confirm calls work as expected. When **false**, users attempting to start calls are prompted to contact a system admin, and system admins are prompted to confirm that calls are working as expected before switching to live mode. @@ -379,21 +373,21 @@ ICE host override .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| This setting can be used to override the host addresses that get advertised to clients when connecting to calls. The accepted formats are the following: | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.icehostoverride`` | -| | | -| - A single IP address (e.g. ``10.0.0.1``). | | -| - A single hostname or FQDN (e.g. ``calls.myserver.tld``). | | -| - (starting in v0.17.0) A comma separated list of externalAddr/internalAddr mappings (e.g. ``10.0.0.1/172.0.0.1,10.0.0.2/172.0.0.2``). | | -| | | -| This is an optional field. Changing this setting requires a plugin restart to take effect. | | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Note**: | -| - This setting is only applicable when not running calls through the standalone ``rtcd`` service. | -| - Depending on the network infrastructure (e.g. instance behind a NAT device) it may be necessary to set this field to the client facing external IP for clients to connect. When empty or unset, the RTC service will attempt to find the instance's public IP through STUN. | -| - A hostname (e.g. domain name) can be specified in this setting, but an IP address will be passed to clients. This means that a DNS resolution happens on the Mattermost instance which could result in a different IP address from the one the clients would see, causing connectivity to fail. When in doubt, we recommend using an IP address directly or confirming that the resolution on the host side reflects the one on the client. | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| This setting can be used to override the host addresses that get advertised to clients when connecting to calls. The accepted formats are the following: | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``icehostoverride`` | +| | | +| - A single IP address (e.g. ``10.0.0.1``). | | +| - A single hostname or FQDN (e.g. ``calls.myserver.tld``). | | +| - (starting in v0.17.0) A comma separated list of externalAddr/internalAddr mappings (e.g. ``10.0.0.1/172.0.0.1,10.0.0.2/172.0.0.2``). | | +| | | +| This is an optional field. Changing this setting requires a plugin restart to take effect. | | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +.. note:: + - This setting is only applicable when not running calls through the standalone ``rtcd`` service. + - Depending on the network infrastructure (e.g. instance behind a NAT device) it may be necessary to set this field to the client facing external IP for clients to connect. When empty or unset, the RTC service will attempt to find the instance's public IP through STUN. + - A hostname (e.g. domain name) can be specified in this setting, but an IP address will be passed to clients. This means that a DNS resolution happens on the Mattermost instance which could result in a different IP address from the one the clients would see, causing connectivity to fail. When in doubt, we recommend using an IP address directly or confirming that the resolution on the host side reflects the one on the client. .. |ice_host_override_link| replace:: :ref:`ICE Host Override ` @@ -410,17 +404,17 @@ ICE host port override .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| This setting can be used to override the port used in the ICE host candidates that get advertised to clients when connecting to calls. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.icehostportoverride`` | -| | - Environment variable: N/A | -| This can be useful in case there are additional network components (e.g. NLBs) in front of the RTC server that may route the calls traffic through a different port.| | -| Changing this setting requires a plugin restart to take effect. | | -| | | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| **Note**: this value will apply to both UDP and TCP host candidates. | -| | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| This setting can be used to override the port used in the ICE host candidates that get advertised to clients when connecting to calls. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``icehostportoverride`` | +| | - Environment variable: N/A | +| This can be useful in case there are additional network components (e.g. NLBs) in front of the RTC server that may route the calls traffic through a different port.| | +| Changing this setting requires a plugin restart to take effect. | | +| | | ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This value will apply to both UDP and TCP host candidates. .. config:setting:: plugins-callsrtcdserviceurl :displayname: RTCD service URL (Plugins - Calls) @@ -437,17 +431,16 @@ RTCD service URL +---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | The URL to a running `rtcd `__ service instance that will host the calls. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.rtcdserviceurl`` | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``rtcdserviceurl`` | | | - Environment variable: ``MM_CALLS_RTCD_URL`` | | When set (non empty) all the calls will be handled by this external service. | | | | | | This is an optional field. Changing this setting requires a plugin restart to take effect. | | +---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Note**: | -| | -| - The client will self-register the first time it connects to the service and store the authentication key in the database. If no client ID is explicitly provided, the diagnostic ID of the Mattermost installation will be used. | -| - The service URL supports credentials in the form ``http://clientID:authKey@hostname``. Alternatively these can be passed through environment overrides to the Mattermost server, namely ``MM_CALLS_RTCD_CLIENT_ID`` and ``MM_CALLS_RTCD_AUTH_KEY`` | -+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + - The client will self-register the first time it connects to the service and store the authentication key in the database. If no client ID is explicitly provided, the diagnostic ID of the Mattermost installation will be used. + - The service URL supports credentials in the form ``http://clientID:authKey@hostname``. Alternatively these can be passed through environment overrides to the Mattermost server, namely ``MM_CALLS_RTCD_CLIENT_ID`` and ``MM_CALLS_RTCD_AUTH_KEY`` .. config:setting:: plugins-callsmaxcallparticipants :displayname: Max call participants (Plugins - Calls) @@ -462,15 +455,15 @@ Max call participants .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| This setting limits the number of participants that can join a single call. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.maxcallparticipants`` | -| | - Environment variable: ``MM_CALLS_MAX_PARTICIPANTS`` | -| Default is **0** (no limit). | | -+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| **Note**: This setting is optional, but the recommended maximum number of participants is **50**. Call participant limits greatly depends on instance resources. | -| See the :doc:`Calls self-hosted deployment ` documentation for details. | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| This setting limits the number of participants that can join a single call. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``maxcallparticipants``| +| | - Environment variable: ``MM_CALLS_MAX_PARTICIPANTS`` | +| Default is **0** (no limit). | | ++-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is optional, but the recommended maximum number of participants is **50**. Call participant limits greatly depends on instance resources. See the :doc:`Calls self-hosted deployment ` documentation for details. .. config:setting:: plugins-callsiceservers :displayname: ICE server configurations (Plugins - Calls) @@ -485,20 +478,18 @@ ICE servers configurations .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| This setting stores a list of ICE servers (STUN/TURN) in JSON format to be used by the service. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.iceserversconfigs`` | -| | - Environment variable: N/A | -| This is an optional field. Changing this setting may require a plugin restart to take effect. | | -| | | -| Default is ``[{"urls": ["stun:stun.global.calls.mattermost.com:3478"]}]`` | | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| **Note**: | | -| | | -| - The configurations above, containing STUN and TURN servers, are sent to the clients and used to generate local candidates. | | -| | | -| - If hosting calls through the plugin (i.e. not using the |rtcd_service|) any configured STUN server may also be used to find the instance's public IP when none is provided through the |ice_host_override_link| option. | | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| This setting stores a list of ICE servers (STUN/TURN) in JSON format to be used by the service. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``iceserversconfigs`` | +| | - Environment variable: N/A | +| This is an optional field. Changing this setting may require a plugin restart to take effect. | | +| | | +| Default is ``[{"urls": ["stun:stun.global.calls.mattermost.com:3478"]}]`` | | ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. note:: + - The configurations above, containing STUN and TURN servers, are sent to the clients and used to generate local candidates. + - If hosting calls through the plugin (i.e. not using the |rtcd_service|) any configured STUN server may also be used to find the instance's public IP when none is provided through the |ice_host_override_link| option. .. |rtcd_service| replace:: :ref:`rtcd service ` @@ -529,9 +520,8 @@ ICE servers configurations "urls": ["turn:turn.example.com:443"] }] -+---------------------------------------------------------------------------------------------------------------------------------------+ -| **Note**: To get TURN generated credentials to work you must provide a secret through the *TURN static auth secret* setting below. | -+---------------------------------------------------------------------------------------------------------------------------------------+ +.. note:: + To get TURN generated credentials to work you must provide a secret through the *TURN static auth secret* setting below. .. config:setting:: plugins-callsturnauthsecret :displayname: TURN static auth secret (Plugins - Calls) @@ -546,11 +536,11 @@ TURN static auth secret .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| A static secret used to generate short-lived credentials for TURN servers. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.turnstaticauthsecret`` | -| This is an optional field. | - Environment variable: N/A | -+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| A static secret used to generate short-lived credentials for TURN servers. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``turnstaticauthsecret`` | +| This is an optional field. | - Environment variable: N/A | ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-callsturncredentialsexpiration :displayname: TURN credentials expiration (Plugins - Calls) @@ -565,12 +555,12 @@ TURN credentials expiration .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| The expiration, in minutes, of the short-lived credentials generated for TURN servers. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.turncredentialsexpirationminutes`` | -| | - Environment variable: N/A | -| Default is **1440** (one day). | | -+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| The expiration, in minutes, of the short-lived credentials generated for TURN servers. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``turncredentialsexpirationminutes`` | +| | - Environment variable: N/A | +| Default is **1440** (one day). | | ++----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-callsserversideturn :displayname: Server side TURN (Plugins - Calls) @@ -587,12 +577,12 @@ Server side TURN .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| - **true**: The RTC server will use the configured TURN candidates for server-initiated connections. | - System Config path: **Plugins > Calls** | -| - **false**: TURN will be used only on the client-side. | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.serversideturn`` | -| | - Environment variable: N/A | -| Changing this setting requires a plugin restart to take effect. | | -+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| - **true**: The RTC server will use the configured TURN candidates for server-initiated connections. | - System Config path: **Plugins > Calls** | +| - **false**: TURN will be used only on the client-side. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``serversideturn`` | +| | - Environment variable: N/A | +| Changing this setting requires a plugin restart to take effect. | | ++------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-callsallowscreensharing :displayname: Allow screen sharing (Plugins - Calls) @@ -609,12 +599,12 @@ Allow screen sharing .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| - **true**: Call participants will be allowed to share their screen. | - System Config path: **Plugins > Calls** | -| - **false**: Call participants won't be allowed to share their screen. | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.allowscreensharing`` | -| | - Environment variable: N/A | -| Changing this setting requires a plugin restart to take effect. | | -+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| - **true**: Call participants will be allowed to share their screen. | - System Config path: **Plugins > Calls** | +| - **false**: Call participants won't be allowed to share their screen. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``allowscreensharing`` | +| | - Environment variable: N/A | +| Changing this setting requires a plugin restart to take effect. | | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-callsenablesimulcast :displayname: (Experimental) Enable simulcast for screen sharing (Plugins - Calls) @@ -631,15 +621,16 @@ Enable simulcast for screen sharing (Experimental) .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| - **true**: Enables simulcast for screen sharing. This can help to improve screen sharing quality. | - System Config path: **Plugins > Calls** | -| - **false**: Disables simulcast for screen sharing. | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.enablesimulcast`` | -| | - Environment variable: N/A | -+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| **Note**: This functionality has the following requirements: | -| - Calls plugin version >= v0.16.0 | -| - ``rtcd`` version >= v0.10.0 (if in use) | -+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| - **true**: Enables simulcast for screen sharing. This can help to improve screen sharing quality. | - System Config path: **Plugins > Calls** | +| - **false**: Disables simulcast for screen sharing. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``enablesimulcast`` | +| | - Environment variable: N/A | ++------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This functionality has the following requirements: + - Calls plugin version >= v0.16.0 + - ``rtcd`` version >= v0.10.0 (if in use) .. config:setting:: plugins-enablecallrecordings :displayname: Enable call recordings (Plugins - Calls) @@ -656,14 +647,14 @@ Enable call recordings .. include:: ../_static/badges/ent-selfhosted-only.rst :start-after: :nosearch: -+-------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| - **true**: Allows call hosts to record meeting video and audio. | - System Config path: **Plugins > Calls** | -| - **false**: **(Default)** Call recording functionality is not available to hosts. | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.enablerecordings`` | -| | | -| Recordings include the entire call window view along with participants' audio track and any shared screen video. Recordings are stored in Mattermost. | | -| | | -| Changing this setting requires a plugin restart to take effect. | | -+-------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| - **true**: Allows call hosts to record meeting video and audio. | - System Config path: **Plugins > Calls** | +| - **false**: **(Default)** Call recording functionality is not available to hosts. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``enablerecordings`` | +| | | +| Recordings include the entire call window view along with participants' audio track and any shared screen video. Recordings are stored in Mattermost. | | +| | | +| Changing this setting requires a plugin restart to take effect. | | ++-------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-jobserviceurl :displayname: Job service URL (Plugins - Calls) @@ -678,19 +669,18 @@ Job service URL .. include:: ../_static/badges/ent-selfhosted-only.rst :start-after: :nosearch: -+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| The URL to a running job service where all the processing related to recordings happens. The recorded files produced are stored in Mattermost. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.jobserviceurl`` | -| This is a required field. Changing this setting requires a plugin restart to take effect. | - Environment variable: ``MM_CALLS_JOB_SERVICE_URL`` | -+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| **Note**: | -| | -| - The client will self-register the first time it connects to the service and store the authentication key in the database. If no client ID is explicitly provided, the diagnostic ID of the Mattermost installation will be used. | -| - The service URL supports credentials in the form ``http://clientID:authKey@hostname``. Alternatively these can be passed through environment overrides to the Mattermost server, namely ``MM_CALLS_JOB_SERVICE_CLIENT_ID`` | -| and ``MM_CALLS_JOB_SERVICE_AUTH_KEY``. | -| - As of Calls v0.25 it's possible to override the site URL used by jobs to connect by setting the ``MM_CALLS_RECORDER_SITE_URL`` or ``MM_CALLS_TRANSCRIBER_SITE_URL`` environment variables respectively. This can be helpful to avoid the jobs | -| from connecting through the public Site URL configured in Mattermost and thus potentially bypass the public network. | -+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| The URL to a running job service where all the processing related to recordings happens. The recorded files produced are stored in Mattermost. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``jobserviceurl`` | +| This is a required field. Changing this setting requires a plugin restart to take effect. | - Environment variable: ``MM_CALLS_JOB_SERVICE_URL`` | ++------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + - The client will self-register the first time it connects to the service and store the authentication key in the database. If no client ID is explicitly provided, the diagnostic ID of the Mattermost installation will be used. + - The service URL supports credentials in the form ``http://clientID:authKey@hostname``. Alternatively these can be passed through environment overrides to the Mattermost server, namely ``MM_CALLS_JOB_SERVICE_CLIENT_ID`` + and ``MM_CALLS_JOB_SERVICE_AUTH_KEY``. + - As of Calls v0.25 it's possible to override the site URL used by jobs to connect by setting the ``MM_CALLS_RECORDER_SITE_URL`` or ``MM_CALLS_TRANSCRIBER_SITE_URL`` environment variables respectively. This can be helpful to avoid the jobs + from connecting through the public Site URL configured in Mattermost and thus potentially bypass the public network. .. config:setting:: plugins-maximumcallrecordingduration :displayname: Maximum call recording duration (Plugins - Calls) @@ -705,12 +695,12 @@ Maximum call recording duration .. include:: ../_static/badges/ent-selfhosted-only.rst :start-after: :nosearch: -+-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| The maximum duration of a call recording in minutes. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.maxrecordingduration`` | -| | - Environment variable: N/A | -| The default is **60**. The maximum is **180**. This is a required value. | | -+-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| The maximum duration of a call recording in minutes. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``maxrecordingduration``| +| | - Environment variable: N/A | +| The default is **60**. The maximum is **180**. This is a required value. | | ++-----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-recordingquality :displayname: Call recording quality (Plugins - Calls) @@ -727,11 +717,12 @@ Call recording quality +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | The audio and video quality of call recordings. Available options are: *Low*, *Medium* and *High*. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.recordingquality`` | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``recordingquality`` | | The default is **Medium**. This is a required value. | | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Note**: The quality setting will affect the performance of the job service and the file size of recordings. Refer to the :ref:`deployment section ` for more information. | -+-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + The quality setting will affect the performance of the job service and the file size of recordings. Refer to the :ref:`deployment section ` for more information. .. config:setting:: plugins-enablecalltranscriptions :displayname: Enable call transcriptions (Plugins - Calls) @@ -748,14 +739,15 @@ Enable call transcriptions (Beta) .. include:: ../_static/badges/ent-selfhosted-only.rst :start-after: :nosearch: -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| - **true**: Enables automatic transcriptions of calls. | - System Config path: **Plugins > Calls** | -| - **false**: **(Default)** Call transcriptions functionality is disabled. | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.enabletranscriptions`` | -| | | -| Transcriptions are generated from the call participants' audio tracks and the resulting files are attached to the call thread when the recording ends. Captions will be optionally rendered on top of the recording file video player. | | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| **Note**: Call transcriptions require :ref:`call recordings ` to be enabled. This setting is available starting in plugin version 0.22. | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| - **true**: Enables automatic transcriptions of calls. | - System Config path: **Plugins > Calls** | +| - **false**: **(Default)** Call transcriptions functionality is disabled. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``enabletranscriptions`` | +| | | +| Transcriptions are generated from the call participants' audio tracks and the resulting files are attached to the call thread when the recording ends. Captions will be optionally rendered on top of the recording file video player. | | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is available starting in plugin version 0.22. Call transcriptions require :ref:`call recordings ` to be enabled. .. config:setting:: plugins-transcribermodelsize :displayname: Call transcriber model size (Plugins - Calls) @@ -770,14 +762,14 @@ Transcriber model size .. include:: ../_static/badges/ent-selfhosted-only.rst :start-after: :nosearch: -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| The speech-to-text model size to use. Heavier models will produce more accurate results at the expense of processing time and resources usage. Available options are: *Tiny*, *Base* and *Small*. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.transcribermodelsize`` | -| The default is **Base**. This is a required value. | | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| **Note**: The model size setting will affect the performance of the job service. Refer to the :ref:`configure call recordings, transcriptions, and live captions ` documentation for more information. | -| This setting is available starting in plugin version 0.22. | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| The speech-to-text model size to use. Heavier models will produce more accurate results at the expense of processing time and resources usage. Available options are: *Tiny*, *Base* and *Small*. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``transcribermodelsize`` | +| The default is **Base**. This is a required value. | | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is available starting in plugin version 0.22. The model size setting will affect the performance of the job service. Refer to the :ref:`configure call recordings, transcriptions, and live captions ` documentation for more information. .. config:setting:: plugins-transcribernumthreads :displayname: Call transcriber threads (Plugins - Calls) @@ -794,11 +786,12 @@ Call transcriber threads +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | The number of threads used by the post-call transcriber. This must be in the range [1, numCPUs]. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.transcribernumthread`` | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``transcribernumthread`` | | The default is 2. This is a required value. | | +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Note**: The call transcriber threads setting will affect the performance of the job service. Refer to the :ref:`configure call recordings, transcriptions, and live captions ` documentation for more information. This setting is available starting in plugin version 0.26.2. | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + The call transcriber threads setting will affect the performance of the job service. Refer to the :ref:`configure call recordings, transcriptions, and live captions ` documentation for more information. This setting is available starting in plugin version 0.26.2. .. config:setting:: plugins-enablelivecaptions :displayname: (Experimental) Enable live captions (Plugins - Calls) @@ -816,18 +809,17 @@ Enable live captions (Beta) .. include:: ../_static/badges/ent-selfhosted-only.rst :start-after: :nosearch: -+---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| - **true**: Enables live captioning of calls. | - System Config path: **Plugins > Calls** | -| - **false**: **(Default)** Live captions functionality is disabled. | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.enablelivecaptions`` | -| | | -| Live captions are generated from the call participants' audio tracks | | -| and the resulting captions can be optionally displayed on the call | | -| clients by clicking the `[cc]` button. | | -+---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **Note**: Live captions require :ref:`call recordings ` and | -| :ref:`call transcriptions ` to be enabled. | -| This setting is available starting in plugin version 0.26.2. | -+---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| - **true**: Enables live captioning of calls. | - System Config path: **Plugins > Calls** | +| - **false**: **(Default)** Live captions functionality is disabled. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``enablelivecaptions`` | +| | | +| Live captions are generated from the call participants' audio tracks | | +| and the resulting captions can be optionally displayed on the call | | +| clients by clicking the **[cc]** option. | | ++---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is available starting in plugin version 0.26.2. Live captions require :ref:`call recordings ` and :ref:`call transcriptions ` to be enabled. .. config:setting:: plugins-livecaptionsmodelsize :displayname: Live captions: Model size (Plugins - Calls) @@ -842,13 +834,14 @@ Live captions: Model size .. include:: ../_static/badges/ent-selfhosted-only.rst :start-after: :nosearch: -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ -| The speech-to-text model size to use for live captions. While heavier models can produce more accurate results, live captioning requires the transcriber to process up to ten seconds of audio within two seconds. Therefore a maximum of size `base` is recommended. Available options are: *Tiny*, *Base* and *Small*. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.livecaptionsmodelsize`` | -| The default is **Tiny**. This is a required value. | | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ -| **Note**: The model size setting will affect the performance of the job service. Refer to the `performance and scalability recommendations `_ documentation for more information. This setting is available starting in plugin version 0.26.2. | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| The speech-to-text model size to use for live captions. While heavier models can produce more accurate results, live captioning requires the transcriber to process up to ten seconds of audio within two seconds. Therefore a maximum of size `base` is recommended. Available options are: *Tiny*, *Base* and *Small*. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``livecaptionsmodelsize`` | +| The default is **Tiny**. This is a required value. | | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is available starting in plugin version 0.26.2. The model size setting will affect the performance of the job service. Refer to the `performance and scalability recommendations `_ documentation for more information. .. config:setting:: plugins-livecaptionsnumtranscribers :displayname: Live captions: Number of transcribers used per call (Plugins - Calls) @@ -863,13 +856,14 @@ Live captions: Number of transcribers used per call .. include:: ../_static/badges/ent-selfhosted-only.rst :start-after: :nosearch: -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| The number of separate live captions transcribers for each call. Each transcribes one audio stream at a time. The product of LiveCaptionsNumTranscribers * LiveCaptionsNumThreadsPerTranscriber must be in the range [1, numCPUs]. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.livecaptionsnumtranscribers`` | -| The default is 1. This is a required value. | | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| **Note**: The live captions number of transcribers setting will affect the performance of the job service. Refer to the `performance and scalability recommendations `_ documentation for more information. This setting is available starting in plugin version 0.26.2. | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| The number of separate live captions transcribers for each call. Each transcribes one audio stream at a time. The product of LiveCaptionsNumTranscribers * LiveCaptionsNumThreadsPerTranscriber must be in the range [1, numCPUs]. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``livecaptionsnumtranscribers`` | +| The default is 1. This is a required value. | | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is available starting in plugin version 0.26.2. The live captions number of transcribers setting will affect the performance of the job service. Refer to the `performance and scalability recommendations `_ documentation for more information. .. config:setting:: plugins-livecaptionsnumthreadspertranscriber :displayname: Live captions: Number of threads per transcriber (Plugins - Calls) @@ -884,13 +878,14 @@ Live captions: Number of threads per transcriber .. include:: ../_static/badges/ent-selfhosted-only.rst :start-after: :nosearch: -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| The number of threads per live-captions transcriber. The product of ``LiveCaptionsNumTranscribers`` * ``LiveCaptionsNumThreadsPerTranscriber`` must be in the range [1, numCPUs]. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.livecaptionsnumthreadspertranscriber`` | -| The default is 2. This is a required value. | | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Note**: The live captions number of threads per transcriber setting will affect the performance of the job service. Refer to the `performance and scalability recommendations `_ documentation for more information. This setting is available starting in plugin version 0.26.2. | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| The number of threads per live-captions transcriber. The product of ``LiveCaptionsNumTranscribers`` * ``LiveCaptionsNumThreadsPerTranscriber`` must be in the range [1, numCPUs]. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``livecaptionsnumthreadspertranscriber`` | +| The default is 2. This is a required value. | | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is available starting in plugin version 0.26.2. The live captions number of threads per transcriber setting will affect the performance of the job service. Refer to the `performance and scalability recommendations `_ documentation for more information .. config:setting:: plugins-livecaptionslanguage :displayname: Live captions language (Plugins - Calls) @@ -905,11 +900,11 @@ Live captions language .. include:: ../_static/badges/ent-selfhosted-only.rst :start-after: :nosearch: -+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| The language passed to the live captions transcriber. Should be a 2-letter ISO 639 Set 1 language code, e.g. 'en'. | - System Config path: **Plugins > Calls** | -| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.livecaptionslanguage`` | -| If blank, the lange will be set to 'en' (English) as default. | | -+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| The language passed to the live captions transcriber. Should be a 2-letter ISO 639 Set 1 language code, e.g. 'en'. | - System Config path: **Plugins > Calls** | +| | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``livecaptionslanguage``| +| If blank, the lange will be set to 'en' (English) as default. | | ++---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-callsenableipv6 :displayname: (Experimental) Enable IPv6 (Plugins - Calls) @@ -928,15 +923,13 @@ Live captions language +----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | - **true**: The RTC service will work in dual-stack mode, listening for IPv6 connections and generating candidates in addition to IPv4 ones. | - System Config path: **Plugins > Calls** | -| - **false**: **(Default)** The RTC service will only listen for IPv4 connections. | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.enableipv6`` | +| - **false**: **(Default)** The RTC service will only listen for IPv4 connections. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``enableipv6`` | | | - Environment variable: N/A | | Changing this setting requires a plugin restart to take effect. | | +----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| **Note**: | -| | -| - This setting is only applicable when not running calls through the standalone ``rtcd`` service. | -| - This setting is available starting in plugin version 0.17. | -+----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is available starting in plugin version 0.17, and is only applicable when not running calls through the standalone ``rtcd`` service. .. config:setting:: plugins-enablecallringing :displayname: Enable call ringing (Plugins - Calls) @@ -949,13 +942,12 @@ Live captions language Enable call ringing ~~~~~~~~~~~~~~~~~~~ - -+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| - **true**: Ringing functionality is enabled. Direct and group message | - System Config path: **Plugins > Calls** | -| participants receive a desktop app alert and a ringing notification | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls. enableringing`` | -| when a call starts. | - Environment variable: N/A | -| - **false**: **(Default**) Ringing functionality is disabled. | | -+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| - **true**: Ringing functionality is enabled. Direct and group message | - System Config path: **Plugins > Calls** | +| participants receive a desktop app alert and a ringing notification | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``enableringing`` | +| when a call starts. | - Environment variable: N/A | +| - **false**: **(Default**) Ringing functionality is disabled. | | ++--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-enableav1 :displayname: Enable AV1 codec for screen sharing (Plugins - Calls) @@ -966,19 +958,21 @@ Enable call ringing - **true**: Enables the ability to use the AV1 codec to encode screen sharing tracks. This can result in improved screen sharing quality for clients that support it. - **false**: **(False)** AV1 codec is disabled for screen sharing tracks. + Enable AV1 (Experimental) ~~~~~~~~~~~~~~~~~~~~~~~~~ ++--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| - **true**: Enables the ability to use the AV1 codec to encode screen | - System Config path: **Plugins > Calls** | +| sharing tracks. Can result in improved screen sharing quality via | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``enableAV1`` | +| clients that support AV1 encoding. | - Environment variable: N/A | +| - **false**: **(Default**) AV1 codec is disabled for screen sharing | | +| tracks. | | ++--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + +.. note:: + This setting is ignored when + :ref:`simulcast is enabled for screen sharing `. -+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| - **true**: Enables the ability to use the AV1 codec to encode screen | - System Config path: **Plugins > Calls** | -| sharing tracks. Can result in improved screen sharing quality via | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.enableav1`` | -| clients that support AV1 encoding. | - Environment variable: N/A | -| - **false**: **(Default**) AV1 codec is disabled for screen sharing | | -| tracks. | | -+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| **Note**: This setting is ignored when | -| :ref:`simulcast is enabled for screen sharing `. | -+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ .. config:setting:: plugins-enabledcsignaling :displayname: Use data channels for signaling media tracks (Plugins - Calls) @@ -992,15 +986,16 @@ Enable AV1 (Experimental) Enable DC signaling (Experimental) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| - **true**: Clients will use WebRTC data channels for signaling of media | - System Config path: **Plugins > Calls** | -| tracks (i.e., voice, screen). This can result in a more efficient and | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.enabledcsignaling`` | -| less race-prone process, especially in case of poor network connections. | - Environment variable: N/A | -| - **false**: **(Default**) Clients will use WebSockets for signaling | | -| media tracks. | | -+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| **Note**: Version v0.18.0 or higher of the |rtcd_service| is required for this functionality to work when hosting calls through the dedicated WebRTC service. | -+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| - **true**: Clients will use WebRTC data channels for signaling of media | - System Config path: **Plugins > Calls** | +| tracks (i.e., voice, screen). This can result in a more efficient and | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``enabledcsignaling`` | +| less race-prone process, especially in case of poor network connections. | - Environment variable: N/A | +| - **false**: **(Default**) Clients will use WebSockets for signaling | | +| media tracks. | | ++----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. note:: + Version v0.18.0 or higher of the |rtcd_service| is required for this functionality to work when hosting calls through the dedicated WebRTC service. ---- @@ -1089,7 +1084,6 @@ See the :doc:`Connect Microsoft Calendar to Mattermost MS Teams Meetings) :systemconsole: Plugins > MS Teams Meetings @@ -1145,9 +1139,10 @@ Enable plugin | - **true**: Enables MS Teams plugin on your Mattermost workspace. | | | - **false**: **(Default)** Disables the MS Teams plugin. | | +------------------------------------------------------------------------+----------------------------------------------------+ -| **Note**: Use the `Enabled Teams <#enabled-teams>`__ configuration option to specify which Mattermost teams synchronize | -| direct and group messages with Microsoft Teams chats. | -+------------------------------------------------------------------------+----------------------------------------------------+ + +.. note:: + Use the `Enabled Teams <#enabled-teams>`__ configuration option to specify which Mattermost teams synchronize + direct and group messages with Microsoft Teams chats. .. config:setting:: plugins-msteamstenantid :displayname: Tenant ID (Plugins - MS Teams) @@ -1213,8 +1208,9 @@ At rest encryption key | | - Environment variable: N/A | | Alpha-numeric value. | | +------------------------------------------------------------------------+---------------------------------------------------+ -| **Note**: Select **Regenerate** to generate a new key. | -+------------------------------------------------------------------------+---------------------------------------------------+ + +.. note:: + Select **Regenerate** to generate a new key. .. config:setting:: plugins-msteamsgeneratewebhooksecret :displayname: Webhook secret (Plugins - MS Teams) @@ -1231,8 +1227,9 @@ Webhook secret | messages to Mattermost. | - ``config.json`` setting: N/A | | | - Environment variable: N/A | +------------------------------------------------------------------------+---------------------------------------------------+ -| **Note**: Select **Regenerate** to generate a new key. | -+------------------------------------------------------------------------+---------------------------------------------------+ + +.. note:: + Select **Regenerate** to generate a new key. .. config:setting:: plugins-msteamsuseevaluationapipaymodel :displayname: Use the evaluation API pay model (Plugins - MS Teams) diff --git a/source/configure/site-configuration-settings.rst b/source/configure/site-configuration-settings.rst index 4805da508de..8e85fd191a6 100644 --- a/source/configure/site-configuration-settings.rst +++ b/source/configure/site-configuration-settings.rst @@ -39,7 +39,7 @@ Site name +----------------------------------------------------------------+-----------------------------------------------------------------+ | Name of the site shown in login screens and user interface. | - System Config path: **Site Configuration > Customization** | -| | - ``config.json`` setting: ``.TeamSettings.SiteName`` | +| | - ``config.json`` setting: ``TeamSettings`` > ``SiteName`` | | String input. Maximum 30 characters. Default is ``Mattermost`` | - Environment variable: ``MM_TEAMSETTINGS_SITENAME`` | +----------------------------------------------------------------+-----------------------------------------------------------------+ @@ -53,11 +53,11 @@ Site name Site description ~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| Text displayed above the login form. When not specified, the phrase "Log in" is displayed. | - System Config path: **Site Configuration > Customization** | -| | - ``config.json`` setting: ``.TeamSettings.CustomDescriptionText`` | -| String input. | - Environment variable: ``MM_TEAMSETTINGS_CUSTOMDESCRIPTIONTEXT`` | -+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ +| Text displayed above the login form. When not specified, the phrase "Log in" is displayed. | - System Config path: **Site Configuration > Customization** | +| | - ``config.json`` setting: ``TeamSettings`` > ``CustomDescriptionText`` | +| String input. | - Environment variable: ``MM_TEAMSETTINGS_CUSTOMDESCRIPTIONTEXT`` | ++--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ .. config:setting:: custom-enablecustombranding :displayname: Enable custom branding (Customization) @@ -75,14 +75,14 @@ Enable custom branding

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+--------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| - **true**: Enables the display of a custom image and text on the login page | - System Config path: **Site Configuration > Customization** | -| - **false**: **(Default)** Custom branding is disabled | - ``config.json`` setting: ``.TeamSettings.EnableCustomBrand: false`` | -| | - Environment variable: ``MM_TEAMSETTINGS_ENABLECUSTOMBRAND`` | -| See also the `custom brand image <#custom-brand-image>`__ and | | -| `custom brand text <#custom-brand-text>`__ configuration settings for more | | -| branding options. | | -+--------------------------------------------------------------------------------+-----------------------------------------------------------------------+ ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| - **true**: Enables the display of a custom image and text on the login page | - System Config path: **Site Configuration > Customization** | +| - **false**: **(Default)** Custom branding is disabled | - ``config.json`` setting: ``TeamSettings`` > ``EnableCustomBrand`` > ``false`` | +| | - Environment variable: ``MM_TEAMSETTINGS_ENABLECUSTOMBRAND`` | +| See also the `custom brand image <#custom-brand-image>`__ and | | +| `custom brand text <#custom-brand-text>`__ configuration settings for more | | +| branding options. | | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ .. config:setting:: custom-custombrandimage :displayname: Custom brand image (Customization) @@ -110,11 +110,11 @@ Custom brand image Custom brand text ~~~~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ -| Text that will be shown below the **Custom brand image** on the login page. You can format this text using the same :doc:`Markdown formatting ` as in Mattermost messages. | - System Config path: **Site Configuration > Customization** | -| | - ``config.json`` setting: ``.TeamSettings.CustomBrandText`` | -| String input. Maximum 500 characters. `Enable custom branding <#enable-custom-branding>`__ must be set to **true** to display the text. | - Environment variable: ``MM_TEAMSETTINGS_CUSTOMBRANDTEXT`` | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ +| Text that will be shown below the **Custom brand image** on the login page. You can format this text using the same :doc:`Markdown formatting ` as in Mattermost messages. | - System Config path: **Site Configuration > Customization** | +| | - ``config.json`` setting: ``TeamSettings`` > ``CustomBrandText`` | +| String input. Maximum 500 characters. `Enable custom branding <#enable-custom-branding>`__ must be set to **true** to display the text. | - Environment variable: ``MM_TEAMSETTINGS_CUSTOMBRANDTEXT`` | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ .. config:setting:: custom-enableaskcommunitylink :displayname: Enable Ask Community link (Customization) @@ -128,12 +128,12 @@ Custom brand text Enable Ask Community link ~~~~~~~~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| - **true**: **(Default)** A link to the `Mattermost Community `__ appears as **Ask the community** under the **Help** menu in the channel header. | - System Config path: **Site Configuration > Customization** | -| - **false**: The link does not appear. | - ``config.json`` setting: ``.SupportSettings.EnableAskCommunityLink: true`` | -| | - Environment variable: ``MM_SUPPORTSETTINGS_ENABLEASKCOMMUNITYLINK`` | -| The link does not display on mobile apps. | | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| - **true**: **(Default)** A link to the `Mattermost Community `__ appears as **Ask the community** under the **Help** menu in the channel header. | - System Config path: **Site Configuration > Customization** | +| - **false**: The link does not appear. | - ``config.json`` setting: ``SupportSettings`` > ``EnableAskCommunityLink`` > ``true`` | +| | - Environment variable: ``MM_SUPPORTSETTINGS_ENABLEASKCOMMUNITYLINK`` | +| The link does not display on mobile apps. | | ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ .. config:setting:: custom-helplink :displayname: Help link (Customization) @@ -147,13 +147,14 @@ Enable Ask Community link Help link ~~~~~~~~~ -+------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ -| This field sets the URL for the Help link on the login and sign up pages, as well as the **Help Resources** link under the **Help** menu in the channel header. | - System Config path: **Site Configuration > Customization** | -| | - ``config.json`` setting: ``.SupportSettings.HelpLink`` | -| String input. Default is ``https://about.mattermost.com/default-help/``. | - Environment variable: ``MM_SUPPORTSETTINGS_HELPLINK`` | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ -| **Note**: If this value is empty, the Help link is hidden on the login and sign up pages. However, the **Help Resources** link remains available under the **Help** menu. | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ +| This field sets the URL for the Help link on the login and sign up pages, as well as the **Help Resources** link under the **Help** menu in the channel header. | - System Config path: **Site Configuration > Customization** | +| | - ``config.json`` setting: ``SupportSettings`` > ``HelpLink`` | +| String input. Default is ``https://about.mattermost.com/default-help/``. | - Environment variable: ``MM_SUPPORTSETTINGS_HELPLINK`` | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ + +.. note:: + If this value is empty, the Help link is hidden on the login and sign up pages. However, the **Help Resources** link remains available under the **Help** menu. .. config:setting:: custom-termsofuselink :displayname: Terms of Use link (Customization) @@ -170,15 +171,16 @@ Terms of Use link .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| This field sets the URL for the Terms of Use of a self-hosted site. A link to the terms appears at the bottom of the sign-up and login pages. | - System Config path: **Site Configuration > Customization** | -| | - ``config.json`` setting: ``.SupportSettings.TermsOfServiceLink`` | -| The default URL links to a `Terms of Use `__ page hosted on ``mattermost.com``. This includes the Mattermost Acceptable Use Policy explaining the terms under which Mattermost software is provided to end users. If you change the default link to add your own terms, the new terms **must include a link** to the default terms so end users are aware of the Mattermost Acceptable Use Policy. | - Environment variable: ``MM_SUPPORTSETTINGS_TERMSOFSERVICELINK`` | -| | | -| String input. Default is ``https://about.mattermost.com/default-terms/``. | | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| **Note**: This setting doesn't change the **Terms of Use** link in the **About Mattermost** window. | -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ +| This field sets the URL for the Terms of Use of a self-hosted site. A link to the terms appears at the bottom of the sign-up and login pages. | - System Config path: **Site Configuration > Customization** | +| | - ``config.json`` setting: ``SupportSettings`` > ``TermsOfServiceLink`` | +| The default URL links to a `Terms of Use `__ page hosted on ``mattermost.com``. This includes the Mattermost Acceptable Use Policy explaining the terms under which Mattermost software is provided to end users. If you change the default link to add your own terms, the new terms **must include a link** to the default terms so end users are aware of the Mattermost Acceptable Use Policy. | - Environment variable: ``MM_SUPPORTSETTINGS_TERMSOFSERVICELINK`` | +| | | +| String input. Default is ``https://about.mattermost.com/default-terms/``. | | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ + +.. note:: + This setting doesn't change the **Terms of Use** link in the **About Mattermost** window. .. config:setting:: custom-privacypolicylink :displayname: Privacy Policy link (Customization) @@ -195,13 +197,14 @@ Privacy Policy link .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ -| This field sets the URL for the Privacy Policy of a self-hosted site. A link to the policy appears at the bottom of the sign-up and login pages. If this field is empty, the link does not appear. | - System Config path: **Site Configuration > Customization** | -| | - ``config.json`` setting: ``.SupportSettings.PrivacyPolicyLink`` | -| String input. Default is ``https://about.mattermost.com/default-privacy-policy/``. | - Environment variable: ``MM_SUPPORTSETTINGS_PRIVACYPOLICYLINK`` | -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ -| **Note**: This setting does not change the **Privacy Policy** link in the **About Mattermost** window. | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| This field sets the URL for the Privacy Policy of a self-hosted site. A link to the policy appears at the bottom of the sign-up and login pages. If this field is empty, the link does not appear. | - System Config path: **Site Configuration > Customization** | +| | - ``config.json`` setting: ``SupportSettings`` > ``PrivacyPolicyLink`` | +| String input. Default is ``https://about.mattermost.com/default-privacy-policy/``. | - Environment variable: ``MM_SUPPORTSETTINGS_PRIVACYPOLICYLINK`` | ++----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ + +.. note:: + This setting does not change the **Privacy Policy** link in the **About Mattermost** window. .. config:setting:: custom-aboutlink :displayname: About link (Customization) @@ -220,7 +223,7 @@ About link +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ | This field sets the URL for a page containing general information about a self-hosted site. A link to the About page appears at the bottom of the sign-up and login pages. If this field is empty the link does not appear. | - System Config path: **Site Configuration > Customization** | -| | - ``config.json`` setting: ``.SupportSettings.AboutLink`` | +| | - ``config.json`` setting: ``SupportSettings`` > ``AboutLink``| | String input. Default is ``https://about.mattermost.com/default-about/``. | - Environment variable: ``MM_SUPPORTSETTINGS_ABOUTLINK`` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ @@ -236,16 +239,14 @@ Forgot Password custom link +-------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | When the **Forgot Password** link is enabled on the Mattermost login page, | - System Config path: **Site Configuration > Forgot password custom link** | -| users are taken to a custom URL to recover or change their password. | - ``config.json`` setting: ``.SupportSettings.ForgetPasswordCustomLink`` | +| users are taken to a custom URL to recover or change their password. | - ``config.json`` setting: ``SupportSettings`` > ``ForgetPasswordCustomLink`` | | | - Environment variable: ``MM_SUPPORTSETTINGS_FORGETPASSWORDCUSTOMLINK`` | | Leave this field blank to use Mattermost's Password Reset workflow. | | +-------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| **Notes**: | -| | -| - You can control whether the **Forgot Password** link is visible or hidden by going to **Authentication > Password > Enable Forgot Password Link**. | -| See the :ref:`configuration ` documentation for details. | -| - This configuration setting applies to all Mattermost clients, including web, desktop app, and mobile app. | -+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + +.. note:: + This configuration setting applies to all Mattermost clients, including web, desktop app, and mobile app. You can control whether the **Forgot Password** link is visible or hidden in clients by going to **Authentication > Password > Enable Forgot Password Link**. See the :ref:`configuration ` documentation for details. + .. config:setting:: custom-reportaproblemlink :displayname: Report a Problem link (Customization) @@ -260,11 +261,11 @@ Report a Problem link .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+-------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| This field sets the URL for the **Report a Problem** link in the channel header **Help** menu. If this field is empty the link does not appear. | - System Config path: **Site Configuration > Customization** | -| | - ``config.json`` setting: ``.SupportSettings.ReportAProblemLink`` | -| String input. Default is ``https://about.mattermost.com/default-report-a-problem``. | - Environment variable: ``MM_SUPPORTSETTINGS_REPORTAPROBLEMLINK`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ +| This field sets the URL for the **Report a Problem** link in the channel header **Help** menu. If this field is empty the link does not appear. | - System Config path: **Site Configuration > Customization** | +| | - ``config.json`` setting: ``SupportSettings`` > ``ReportAProblemLink`` | +| String input. Default is ``https://about.mattermost.com/default-report-a-problem``. | - Environment variable: ``MM_SUPPORTSETTINGS_REPORTAPROBLEMLINK`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ .. config:setting:: custom-appdownloadlink :displayname: Mattermost apps download page link (Customization) @@ -279,13 +280,13 @@ Mattermost apps download page link .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+-------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ -| This field sets the URL for the Download Apps link in the **Product** menu. If this field is empty, the link does not appear. | - System Config path: **Site Configuration > Customization** | -| | - ``config.json`` setting: ``.NativeAppSettings.AppDownloadLink`` | -| If you have an Enterprise App Store, set the link to the appropriate download page for your Mattermost apps. | - Environment variable: ``MM_NATIVEAPPSETTINGS_APPDOWNLOADLINK`` | -| | | -| String input. Default is ``https://about.mattermost.com/downloads/``. | | -+-------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| This field sets the URL for the Download Apps link in the **Product** menu. If this field is empty, the link does not appear. | - System Config path: **Site Configuration > Customization** | +| | - ``config.json`` setting: ``NativeAppSettings`` > ``AppDownloadLink`` | +| If you have an Enterprise App Store, set the link to the appropriate download page for your Mattermost apps. | - Environment variable: ``MM_NATIVEAPPSETTINGS_APPDOWNLOADLINK`` | +| | | +| String input. Default is ``https://about.mattermost.com/downloads/``. | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ .. config:setting:: custom-androiddownloadlink :displayname: Android app download link (Customization) @@ -300,13 +301,13 @@ Android app download link .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -| This field sets the URL to download the Mattermost Android app. Users who access the Mattermost site on a mobile browser will be prompted to download the app through this link. If this field is empty, the prompt does not appear. | - System Config path: **Site Configuration > Customization** | -| | - ``config.json`` setting: ``.NativeAppSettings.AndroidAppDownloadLink`` | -| If you have an Enterprise App Store, link to your Android app. | - Environment variable: ``MM_NATIVEAPPSETTINGS_ANDROIDAPPDOWNLOADLINK`` | -| | | -| String input. Default is ``https://about.mattermost.com/mattermost-android-app/``. | | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| This field sets the URL to download the Mattermost Android app. Users who access the Mattermost site on a mobile browser will be prompted to download the app through this link. If this field is empty, the prompt does not appear. | - System Config path: **Site Configuration > Customization** | +| | - ``config.json`` setting: ``NativeAppSettings`` > ``AndroidAppDownloadLink`` | +| If you have an Enterprise App Store, link to your Android app. | - Environment variable: ``MM_NATIVEAPPSETTINGS_ANDROIDAPPDOWNLOADLINK`` | +| | | +| String input. Default is ``https://about.mattermost.com/mattermost-android-app/``. | | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. config:setting:: custom-iosdownloadlink :displayname: iOS app download link (Customization) @@ -321,13 +322,13 @@ iOS app download link .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| This field sets the URL to download the Mattermost iOS app. Users who access the site on a mobile browser will be prompted to download the app through this link. If this field is empty, the prompt does not appear. | - System Config path: **Site Configuration > Customization** | -| | - ``config.json`` setting: ``.NativeAppSettings.IosAppDownloadLink`` | -| If you use an Enterprise App Store, link to your iOS app. | - Environment variable: ``MM_NATIVEAPPSETTINGS_IOSAPPDOWNLOADLINK`` | -| | | -| String input. Default is ``https://about.mattermost.com/mattermost-ios-app/``. | | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ +| This field sets the URL to download the Mattermost iOS app. Users who access the site on a mobile browser will be prompted to download the app through this link. If this field is empty, the prompt does not appear. | - System Config path: **Site Configuration > Customization** | +| | - ``config.json`` setting: ``NativeAppSettings`` > ``IosAppDownloadLink``| +| If you use an Enterprise App Store, link to your iOS app. | - Environment variable: ``MM_NATIVEAPPSETTINGS_IOSAPPDOWNLOADLINK`` | +| | | +| String input. Default is ``https://about.mattermost.com/mattermost-ios-app/``. | | ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: exp-appcustomurlschemes :displayname: App custom URL schemes (Customization) @@ -390,22 +391,23 @@ Access the following configuration settings in the System Console by going to ** :environment: MM_LOCALIZATIONSETTINGS_DEFAULTSERVERLOCALE :description: The default language for system messages and logs. Default value is **en**. -Default server language + ~~~~~~~~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------+ -| The default language for system messages and logs. | - System Config path: **Site Configuration > Localization** | -| | - ``config.json`` setting: ``.LocalizationSettings.DefaultServerLocale`` | -| Options: ``"bg"``, ``"de"``, ``"en"``, ``"en-AU"``, ``"es"``, ``"fa"``, | - Environment variable: ``MM_LOCALIZATIONSETTINGS_DEFAULTSERVERLOCALE`` | -| ``"fr"``, ``"hu"``, ``"it"``, ``"ja"``, ``"ko"``, ``"nl"``, ``"pl"``, | | -| ``"pt-br"``, ``"ro"``, ``"ru"``, ``"sv"``, ``"tr"``, ``"uk"``, ``"vi"``, | | -| ``"zh-Hans"``, and ``"zh-Hant"``. | | -| | | -| Default is ``"en"``. | | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------+ -| **Note**: Changing this configuration setting changes the default server language for users who haven't set a language preference via **Settings**. | -| Mattermost applies the user's language preference when specified. | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| The default language for system messages and logs. | - System Config path: **Site Configuration > Localization** | +| | - ``config.json`` setting: ``LocalizationSettings`` > ``DefaultServerLocale`` | +| Options: ``"bg"``, ``"de"``, ``"en"``, ``"en-AU"``, ``"es"``, ``"fa"``, | - Environment variable: ``MM_LOCALIZATIONSETTINGS_DEFAULTSERVERLOCALE`` | +| ``"fr"``, ``"hu"``, ``"it"``, ``"ja"``, ``"ko"``, ``"nl"``, ``"pl"``, | | +| ``"pt-br"``, ``"ro"``, ``"ru"``, ``"sv"``, ``"tr"``, ``"uk"``, ``"vi"``, | | +| ``"zh-Hans"``, and ``"zh-Hant"``. | | +| | | +| Default is ``"en"``. | | ++--------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + +.. note:: + Changing this configuration setting changes the default server language for users who haven't set a language preference via **Settings**. + Mattermost applies the user's language preference when specified. .. config:setting:: l10n-defaultclientlanguage :displayname: Default client language (Localization) @@ -417,19 +419,19 @@ Default server language Default client language ~~~~~~~~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------+ -| The default language for new users and pages where the user isn't logged in. | - System Config path: **Site Configuration > Localization** | -| | - ``config.json`` setting: ``.LocalizationSettings.DefaultClientLocale`` | -| Options: ``"bg"``, ``"de"``, ``"en"``, ``"en-AU"``, ``"es"``, ``"fa"``, | - Environment variable: ``MM_LOCALIZATIONSETTINGS_DEFAULTCLIENTLOCALE`` | -| ``"fr"``, ``"hu"``, ``"it"``, ``"ja"``, ``"ko"``, ``"nl"``, ``"pl"``, | | -| ``"pt-br"``, ``"ro"``, ``"ru"``, ``"sv"``, ``"tr"``, ``"uk"``, ``"vi"``, | | -| ``"zh-Hans"``, and ``"zh-Hant"``. | | -| | | -| Default is ``"en"``. | | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------+ -| **Note**: Changing this configuration setting changes the default client language for users who haven't set a language preference via **Settings**. | -| Mattermost applies the user's language preference when specified. | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| The default language for new users and pages where the user isn't logged in. | - System Config path: **Site Configuration > Localization** | +| | - ``config.json`` setting: ``LocalizationSettings`` > ``DefaultClientLocale`` | +| Options: ``"bg"``, ``"de"``, ``"en"``, ``"en-AU"``, ``"es"``, ``"fa"``, | - Environment variable: ``MM_LOCALIZATIONSETTINGS_DEFAULTCLIENTLOCALE`` | +| ``"fr"``, ``"hu"``, ``"it"``, ``"ja"``, ``"ko"``, ``"nl"``, ``"pl"``, | | +| ``"pt-br"``, ``"ro"``, ``"ru"``, ``"sv"``, ``"tr"``, ``"uk"``, ``"vi"``, | | +| ``"zh-Hans"``, and ``"zh-Hant"``. | | +| | | +| Default is ``"en"``. | | ++--------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + +.. note:: + Changing this configuration setting changes the default client language for users who haven't set a language preference via **Settings**. Mattermost applies the user's language preference when specified. .. config:setting:: l10n-availablelanguages :displayname: Available languages (Localization) @@ -443,7 +445,7 @@ Available languages +--------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | Sets the list of languages users see under **Settings > Display > Language**. | - System Config path: **Site Configuration > Localization** | -| If this field is left blank, users see all supported languages. | - ``config.json`` setting: ``.LocalizationSettings.AvailableLocales`` | +| If this field is left blank, users see all supported languages. | - ``config.json`` setting: ``LocalizationSettings`` > ``AvailableLocales``| | Newly supported languages are added automatically. | - Environment variable: ``MM_LOCALIZATIONSETTINGS_AVAILABLELOCALES`` | | If this field is not blank, it must contain the **Default client language**, | | | in addition to any other languages. For example, to limit the language | | @@ -477,23 +479,23 @@ Access the following configuration settings in the System Console by going to ** Max users per team ~~~~~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------+-------------------------------------------------------------------+ -| The **Max users per team** is the maximum total number of users per team, | - System Config path: **Site Configuration > Users and Teams** | -| including activated and deactivated users. | - ``config.json`` setting: ``.TeamSettings.MaxUsersPerTeam: 50`` | -| | - Environment variable: ``MM_TEAMSETTINGS_MAXUSERSPERTEAM`` | -| In Mattermost, a team of people should be a small organization with a | | -| specific goal. In the physical world, a team could sit around a single | | -| table. The default maximum (50) should be enough for most teams, but | | -| with appropriate `hardware `__, this limit can be increased to | | -| thousands of users. | | -| | | -| :doc:`Channels ` are | | -| another way of organizing communications within teams on different topics. | | -| | | -| Numerical input. Default is **50** self-hosted deployments, and **10000** | | -| for Cloud deployments. | | -+------------------------------------------------------------------------------+-------------------------------------------------------------------+ ++------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ +| The **Max users per team** is the maximum total number of users per team, | - System Config path: **Site Configuration > Users and Teams** | +| including activated and deactivated users. | - ``config.json`` setting: ``TeamSettings`` > ``MaxUsersPerTeam`` > ``50`` | +| | - Environment variable: ``MM_TEAMSETTINGS_MAXUSERSPERTEAM`` | +| In Mattermost, a team of people should be a small organization with a | | +| specific goal. In the physical world, a team could sit around a single | | +| table. The default maximum (50) should be enough for most teams, but | | +| with appropriate `hardware `__, this limit can be increased to | | +| thousands of users. | | +| | | +| :doc:`Channels ` are | | +| another way of organizing communications within teams on different topics. | | +| | | +| Numerical input. Default is **50** self-hosted deployments, and **10000** | | +| for Cloud deployments. | | ++------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ .. config:setting:: users-maxchannelsperteam :displayname: Max channels per team (Users and teams) @@ -505,12 +507,12 @@ Max users per team Max channels per team ~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| The maximum number of channels per team, including both active and archived channels. | - System Config path: **Site Configuration > Users and Teams** | -| | - ``config.json`` setting: ``.TeamSettings.MaxChannelsPerTeam: 2000`` | -| Numerical input. Default is **2000** for self-hosted deployments, and **10000** | - Environment variable: ``MM_TEAMSETTINGS_MAXCHANNELSPERTEAM`` | -| for Cloud deployments. | | -+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| The maximum number of channels per team, including both active and archived channels. | - System Config path: **Site Configuration > Users and Teams** | +| | - ``config.json`` setting: ``TeamSettings`` > ``MaxChannelsPerTeam`` > ``2000`` | +| Numerical input. Default is **2000** for self-hosted deployments, and **10000** | - Environment variable: ``MM_TEAMSETTINGS_MAXCHANNELSPERTEAM`` | +| for Cloud deployments. | | ++---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ .. config:setting:: users-enablejoinleavemessages :displayname: Enable join/leave messages by default (Users and Teams) @@ -525,16 +527,16 @@ Max channels per team Enable join/leave messages by default ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ -| Specify the default configuration of system messages displayed when users | - System Config path: **Site Configuration > Users and Teams** | -| join or leave channels. | - ``config.json`` setting: ``.TeamSettings.EnableJoinLeaveMessageByDefault: true`` | -| | - Environment variable: ``MM_TEAMSETTINGS_ENABLEJOINLEAVEMESSAGEBYDEFAULT`` | -| - **true**: **(Default)** Join/Leave messages are displayed. | | -| - **false**: Join/Leave messages are hidden. | | -| | | -| Users can override this default by going to **Settings > Advanced > | | -| Enable Join/Leave Messages**. | | -+---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| Specify the default configuration of system messages displayed when users | - System Config path: **Site Configuration > Users and Teams** | +| join or leave channels. | - ``config.json`` setting: ``TeamSettings`` > ``EnableJoinLeaveMessageByDefault`` > ``true`` | +| | - Environment variable: ``MM_TEAMSETTINGS_ENABLEJOINLEAVEMESSAGEBYDEFAULT`` | +| - **true**: **(Default)** Join/Leave messages are displayed. | | +| - **false**: Join/Leave messages are hidden. | | +| | | +| Users can override this default by going to **Settings > Advanced > | | +| Enable Join/Leave Messages**. | | ++---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ .. config:setting:: users-restrictdirectmessage :displayname: Enable users to open direct message channels with (Users and Teams) @@ -549,13 +551,13 @@ Enable join/leave messages by default Enable users to open direct message channels with ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| This setting determines whether a user can open a direct message channel with anyone on the Mattermost server or only to members of the same team. This setting only affects the options presented in the user interface. It does not affect permissions on the backend server. | - System Config path: **Site Configuration > Users and Teams** | -| | - ``config.json`` setting: ``.TeamSettings.RestrictDirectMessage`` | -| - **Any user on the Mattermost server**: **(Default)** Users can send a direct message to any user through the **Direct Messages > More** menu. ``config.json`` setting: ``"any"`` | - Environment variable: ``MM_TEAMSETTINGS_RESTRICTDIRECTMESSAGE`` | -| | | -| - **Any member of the team**: The **Direct Messages > More** menu only allows direct messages to users on the same team. Pressing :kbd:`Ctrl` :kbd:`K` on Windows or Linux, or :kbd:`⌘` :kbd:`K` on Mac, only lists other users on the team currently being viewed. A user who is a member of multiple teams can only send direct messages to the team that is being viewed. However, the user can receive messages from other teams, regardless of the team currently being viewed. ``config.json`` setting: ``"team"`` | | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| This setting determines whether a user can open a direct message channel with anyone on the Mattermost server or only to members of the same team. This setting only affects the options presented in the user interface. It does not affect permissions on the backend server. | - System Config path: **Site Configuration > Users and Teams** | +| | - ``config.json`` setting: ``TeamSettings`` > ``RestrictDirectMessage``| +| - **Any user on the Mattermost server**: **(Default)** Users can send a direct message to any user through the **Direct Messages > More** menu. ``config.json`` setting: ``"any"`` | - Environment variable: ``MM_TEAMSETTINGS_RESTRICTDIRECTMESSAGE`` | +| | | +| - **Any member of the team**: The **Direct Messages > More** menu only allows direct messages to users on the same team. Pressing :kbd:`Ctrl` :kbd:`K` on Windows or Linux, or :kbd:`⌘` :kbd:`K` on Mac, only lists other users on the team currently being viewed. A user who is a member of multiple teams can only send direct messages to the team that is being viewed. However, the user can receive messages from other teams, regardless of the team currently being viewed. ``config.json`` setting: ``"team"`` | | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ .. config:setting:: users-teammatenamedisplay :displayname: Teammate name display (Users and Teams) @@ -571,23 +573,23 @@ Enable users to open direct message channels with Teammate name display ~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ -| This setting determines how names appear in posts and under the **Direct Messages** list. | - System Config path: **Site Configuration > Users and Teams** | -| Users can change this setting in their interface under **Settings > Display > | - ``config.json`` setting: ``.TeamSettings.TeammateNameDisplay: username`` | -| Teammate Name Display**, unless this setting is locked by a system admin | - Environment variable: ``MM_TEAMSETTINGS_TEAMMATENAMEDISPLAY`` | -| via the **Lock teammate name display for all users** configuration setting. | | -| | | -| - **Show username**: **(Default for self-hosted deployments)** Displays usernames. | | -| ``config.json`` option: ``"username"``. | | -| - **Show nickname if one exists...**: Displays the user’s nickname. If the user doesn't have a | | -| nickname, their full name is displayed. If the user doesn't have a full name, their username | | -| is displayed. ``config.json`` option: ``"nickname_full_name"``. | | -| - **Show first and last name**: **(Default for Cloud deployments)** Displays user’s full name. | | -| If the user doesn't have a full name, their username is displayed. Recommended when using | | -| :doc:`SAML ` or | | -| :doc:`LDAP ` if first name and last name | | -| attributes are configured. ``config.json`` option: ``"full_name"``. | | -+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| This setting determines how names appear in posts and under the **Direct Messages** list. | - System Config path: **Site Configuration > Users and Teams** | +| Users can change this setting in their interface under **Settings > Display > | - ``config.json`` setting: ``TeamSettings`` > ``TeammateNameDisplay`` > ``username`` | +| Teammate Name Display**, unless this setting is locked by a system admin | - Environment variable: ``MM_TEAMSETTINGS_TEAMMATENAMEDISPLAY`` | +| via the **Lock teammate name display for all users** configuration setting. | | +| | | +| - **Show username**: **(Default for self-hosted deployments)** Displays usernames. | | +| ``config.json`` option: ``"username"``. | | +| - **Show nickname if one exists...**: Displays the user’s nickname. If the user doesn't have a | | +| nickname, their full name is displayed. If the user doesn't have a full name, their username | | +| is displayed. ``config.json`` option: ``"nickname_full_name"``. | | +| - **Show first and last name**: **(Default for Cloud deployments)** Displays user’s full name. | | +| If the user doesn't have a full name, their username is displayed. Recommended when using | | +| :doc:`SAML ` or | | +| :doc:`LDAP ` if first name and last name | | +| attributes are configured. ``config.json`` option: ``"full_name"``. | | ++-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ .. config:setting:: users-lockteammatenamedisplay :displayname: Lock teammate name display for all users (Users and Teams) @@ -605,13 +607,13 @@ Lock teammate name display for all users .. include:: ../_static/badges/ent-only.rst :start-after: :nosearch: -+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ -| This setting controls whether users can change settings under **Settings > Display > Teammate Name Display**. | - System Config path: **Site Configuration > Users and Teams** | -| | - ``config.json`` setting: ``.TeamSettings.LockTeammateNameDisplay: false`` | -| - **true**: Users **cannot** change the Teammate Name Display. | - Environment variable: ``MM_TEAMSETTINGS_LOCKTEAMMATENAMEDISPLAY`` | -| - **false**: **(Default)** Users can change the Teammate Name Display setting. | | -| | | -+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +| This setting controls whether users can change settings under **Settings > Display > Teammate Name Display**. | - System Config path: **Site Configuration > Users and Teams** | +| | - ``config.json`` setting: ``TeamSettings`` > ``LockTeammateNameDisplay`` > ``false`` | +| - **true**: Users **cannot** change the Teammate Name Display. | - Environment variable: ``MM_TEAMSETTINGS_LOCKTEAMMATENAMEDISPLAY`` | +| - **false**: **(Default)** Users can change the Teammate Name Display setting. | | +| | | ++---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ .. config:setting:: users-viewarchivedchannels :displayname: Allow users to view archived channels (Users and Teams) @@ -625,13 +627,14 @@ Lock teammate name display for all users Allow users to view archived channels ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| - **true**: **(Default)** Allows users to access the content of archived channels of which they were a member. | - System Config path: **Site Configuration > Users and Teams** | -| - **false**: Users are unable to access content in archived channels. | - ``config.json`` setting: ``.TeamSettings.ExperimentalViewArchivedChannels: true`` | -| | - Environment variable: ``MM_TEAMSETTINGS_EXPERIMENTALVIEWARCHIVEDCHANNELS`` | -+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| **Note**: Cloud admins can't modify this configuration setting. | -+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Allows users to access the content of archived channels of which they were a member. | - System Config path: **Site Configuration > Users and Teams** | +| - **false**: Users are unable to access content in archived channels. | - ``config.json`` setting: ``TeamSettings`` > ``ExperimentalViewArchivedChannels`` > ``true`` | +| | - Environment variable: ``MM_TEAMSETTINGS_EXPERIMENTALVIEWARCHIVEDCHANNELS`` | ++----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + +.. note:: + Cloud admins can't modify this configuration setting. .. config:setting:: users-showemailaddress :displayname: Show email address (Users and Teams) @@ -645,12 +648,12 @@ Allow users to view archived channels Show email address ~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| - **true**: **(Default)** All users can see the email addresses of every other user. | - System Config path: **Site Configuration > Users and teams** | -| - **false**: Hides email addresses in the client user interface, except from system admins | - ``config.json`` setting: ``.PrivacySettings.ShowEmailAddress: true`` | -| and the System Roles with read/write access to Compliance, Billing, or User Management | - Environment variable: ``MM_PRIVACYSETTINGS_SHOWEMAILADDRESS`` | -| (users/teams/channels/groups etc). | | -+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| - **true**: **(Default)** All users can see the email addresses of every other user. | - System Config path: **Site Configuration > Users and teams** | +| - **false**: Hides email addresses in the client user interface, except from system admins | - ``config.json`` setting: ``PrivacySettings`` > ``ShowEmailAddress`` > ``true`` | +| and the System Roles with read/write access to Compliance, Billing, or User Management | - Environment variable: ``MM_PRIVACYSETTINGS_SHOWEMAILADDRESS`` | +| (users/teams/channels/groups etc). | | ++---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ .. config:setting:: users-showfullname :displayname: Show full name (Users and Teams) @@ -664,11 +667,11 @@ Show email address Show full name ~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| - **true**: **(Default)** Full names are visible to all users in the client user interface. | - System Config path: **Site Configuration > Users and Teams** | -| - **false**: Hides full names from all users, except system admins. Username is shown in place of the full name. | - ``config.json`` setting: ``.PrivacySettings.ShowFullName: true`` | -| | - Environment variable: ``MM_PRIVACYSETTINGS_SHOWFULLNAME`` | -+------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| - **true**: **(Default)** Full names are visible to all users in the client user interface. | - System Config path: **Site Configuration > Users and Teams** | +| - **false**: Hides full names from all users, except system admins. Username is shown in place of the full name. | - ``config.json`` setting: ``PrivacySettings`` > ``ShowFullName`` > ``true`` | +| | - Environment variable: ``MM_PRIVACYSETTINGS_SHOWFULLNAME`` | ++------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ .. config:setting:: users-enablecustomstatuses :displayname: Enable custom user statuses (Users and Teams) @@ -682,11 +685,11 @@ Show full name Enable custom user statuses ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ -| - **true**: **(Default)** Users can set status messages and emojis that are visible to all users. | - System Config path: **Site Configuration > Users and Teams** | -| - **false**: Users cannot set custom statuses. | - ``config.json`` setting: ``.TeamSettings.EnableCustomUserStatuses: true`` | -| | - Environment variable: ``MM_TEAMSETTINGS_ENABLECUSTOMUSERSTATUSES`` | -+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Users can set status messages and emojis that are visible to all users. | - System Config path: **Site Configuration > Users and Teams** | +| - **false**: Users cannot set custom statuses. | - ``config.json`` setting: ``TeamSettings`` > ``EnableCustomUserStatuses`` > ``true`` | +| | - Environment variable: ``MM_TEAMSETTINGS_ENABLECUSTOMUSERSTATUSES`` | ++---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ .. config:setting:: users-enablelastactivetime :displayname: Enable last active time (Users and Teams) @@ -700,11 +703,11 @@ Enable custom user statuses Enable last active time ~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ -| - **true**: **(Default)** Users can see when deactivated users were last active on a | - System Config path: **Site Configuration > Users and Teams** | -| user's profile and in direct message channel headers. | - ``config.json`` setting: ``.TeamSettings.EnableLastActiveTime: true`` | -| - **false**: Users can't see when deactivated users were last online. | - Environment variable: ``MM_TEAMSETTINGS_ENABLELASTACTIVETIME`` | -+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Users can see when deactivated users were last active on a | - System Config path: **Site Configuration > Users and Teams** | +| user's profile and in direct message channel headers. | - ``config.json`` setting: ``TeamSettings`` > ``EnableLastActiveTime`` > ``true`` | +| - **false**: Users can't see when deactivated users were last online. | - Environment variable: ``MM_TEAMSETTINGS_ENABLELASTACTIVETIME`` | ++---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ .. config:setting:: users-enablecustomusergroups :displayname: Enable custom user groups (Users and Teams) @@ -737,13 +740,13 @@ Enable custom user groups User statistics update time ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| Set the server time for updating the user post statistics, including each user's total | - System Config path: **Site Configuration > Users and Teams** | -| message count, and the timestamp of each user's most recently sent message. | - ``config.json`` setting: ``.ServiceSettings.RefreshPostStatsRunTime: 00:00`` | -| | - Environment variable: ``MM_SERVICESETTINGS.REFRESHPOSTSTATSRUNTIME`` | -| Must be a 24-hour time stamp in the form ``HH:MM`` based on the local time of the server. | | -| Default is **00:00**. | | -+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| Set the server time for updating the user post statistics, including each user's total | - System Config path: **Site Configuration > Users and Teams** | +| message count, and the timestamp of each user's most recently sent message. | - ``config.json`` setting: ``ServiceSettings`` > ``RefreshPostStatsRunTime`` > ``00:00`` | +| | - Environment variable: ``MM_SERVICESETTINGS.REFRESHPOSTSTATSRUNTIME`` | +| Must be a 24-hour time stamp in the form ``HH:MM`` based on the local time of the server. | | +| Default is **00:00**. | | ++--------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ ---- @@ -767,11 +770,11 @@ Access the following configuration settings in the System Console by going to ** Show @channel, @all, or @here confirmation dialog ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| - **true**: **(Default)** Requires users to confirm when posting @channel, @all, @here, or group mentions in channels with more than 5 members. | - System Config path: **Site Configuration > Notifications** | -| - **false**: No confirmation is required. | - ``config.json`` setting: ``.TeamSettings.EnableConfirmNotificationsToChannel: true`` | -| | - Environment variable: ``MM_TEAMSETTINGS_ENABLECONFIRMNOTIFICATIONSTOCHANNEL`` | -+-----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Requires users to confirm when posting @channel, @all, @here, or group mentions in channels with more than 5 members. | - System Config path: **Site Configuration > Notifications** | +| - **false**: No confirmation is required. | - ``config.json`` setting: ``TeamSettings`` > ``EnableConfirmNotificationsToChannel`` > ``true`` | +| | - Environment variable: ``MM_TEAMSETTINGS_ENABLECONFIRMNOTIFICATIONSTOCHANNEL`` | ++-----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ .. config:setting:: notification-enableemail :displayname: Enable email notifications (Notifications) @@ -785,17 +788,16 @@ Show @channel, @all, or @here confirmation dialog Enable email notifications ~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ -| - **true**: **(Default)** Enables automatic email notifications for posts. | - System Config path: **Site Configuration > Notifications** | -| - **false**: Disables notifications. A developer may choose this option to speed development by skipping email setup (see also the **Enable preview mode banner** setting). | - ``config.json`` setting: ``.EmailSettings.SendEmailNotifications: ture`` | -| | - Environment variable: ``MM_EMAILSETTINGS_SENDEMAILNOTIFICATIONS`` | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ -| **Notes**: | -| | -| - Cloud admins can't modify this configuration setting. | -| - If this setting is **false**, and the SMTP server is set up, account-related emails (such as authentication messages) will be sent regardless of this setting. | -| - Email invitations and account deactivation emails aren't affected by this setting. | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Enables automatic email notifications for posts. | - System Config path: **Site Configuration > Notifications** | +| - **false**: Disables notifications. A developer may choose this option to speed development by skipping email setup (see also the **Enable preview mode banner** setting). | - ``config.json`` setting: ``EmailSettings`` > ``SendEmailNotifications`` > ``ture`` | +| | - Environment variable: ``MM_EMAILSETTINGS_SENDEMAILNOTIFICATIONS`` | ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ + +.. note:: + - Cloud admins can't modify this configuration setting. + - If this setting is **false**, and the SMTP server is set up, account-related emails (such as authentication messages) will be sent regardless of this setting. + - Email invitations and account deactivation emails aren't affected by this setting. .. config:setting:: notification-enablepreviewbanner :displayname: Enable preview mode banner (Notifications) @@ -811,13 +813,14 @@ Enable email notifications Enable preview mode banner ~~~~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ -| - **true**: **(Default)** When **Send email notifications** is **false**, users see the Preview Mode banner. This banner alerts users that email notifications are disabled. | - System Config path: **Site Configuration > Notifications** | -| - **false**: Preview Mode banner does not appear. | - ``config.json`` setting: ``.EmailSettings.EnablePreviewModeBanner: true`` | -| | - Environment variable: ``MM_EMAILSETTINGS_ENABLEPREVIEWMODEBANNER`` | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ -| **Note**: Cloud admins can't modify this configuration setting. | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +| - **true**: **(Default)** When **Send email notifications** is **false**, users see the Preview Mode banner. This banner alerts users that email notifications are disabled. | - System Config path: **Site Configuration > Notifications** | +| - **false**: Preview Mode banner does not appear. | - ``config.json`` setting: ``EmailSettings`` > ``EnablePreviewModeBanner`` > ``true`` | +| | - Environment variable: ``MM_EMAILSETTINGS_ENABLEPREVIEWMODEBANNER`` | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ + +.. note:: + Cloud admins can't modify this configuration setting. .. config:setting:: notification-enableemailbatching :displayname: Enable email batching (Notifications) @@ -831,18 +834,17 @@ Enable preview mode banner Enable email batching ~~~~~~~~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -| - **true**: Multiple email notifications for mentions and direct messages over a given time period are batched into a single email. The time period can be customized by each user under **Settings > Notifications**. The default time period is 15 minutes. | - System Config path: **Site Configuration > Notifications** | -| - **false**: **(Default)** Emails will be sent for each mention or direct message. | - ``config.json`` setting: ``.EmailSettings.EnableEmailBatching: false`` | -| | - Environment variable: ``MM_EMAILSETTINGS_ENABLEEMAILBATCHING`` | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -| **Notes**: | -| | -| - Cloud admins can't modify this configuration setting. | -| - Regardless of this setting, a user can turn off these notifications under **Settings > Notifications**. | -| - The :ref:`Site Url ` and :ref:`SMTP Email Server ` must be configured to allow email batching. | -| - Email batching in :ref:`High Availability Mode ` is planned, but not yet supported. | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ +| - **true**: Multiple email notifications for mentions and direct messages over a given time period are batched into a single email. The time period can be customized by each user under **Settings > Notifications**. The default time period is 15 minutes. | - System Config path: **Site Configuration > Notifications** | +| - **false**: **(Default)** Emails will be sent for each mention or direct message. | - ``config.json`` setting: ``EmailSettings`` > ``EnableEmailBatching`` > ``false`` | +| | - Environment variable: ``MM_EMAILSETTINGS_ENABLEEMAILBATCHING`` | ++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ + +.. note:: + - Cloud admins can't modify this configuration setting. + - Regardless of this setting, a user can turn off these notifications under **Settings > Notifications**. + - The :ref:`Site Url ` and :ref:`SMTP Email Server ` must be configured to allow email batching. + - Email batching in :ref:`High Availability Mode ` is planned, but not yet supported. .. config:setting:: notification-emailcontents :displayname: Email notification contents (Notifications) @@ -863,11 +865,11 @@ Email notification contents

Also available in legacy Mattermost Enterprise Edition E20

-+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ -| - **Send full message contents**: **(Default)** Email notifications include the full message contents, along with the name of the sender and the channel. ``config.json`` setting: ``"full"`` | - System Config path: **Site Configuration > Notifications** | -| | - ``config.json`` setting: ``.EmailSettings.EmailNotificationContentsType`` | -| - **Send generic description with only sender name**: Only the name of the sender and team name are included in email notifications. Use this option if Mattermost contains confidential information and policy dictates it cannot be stored in email. ``config.json`` setting: ``"generic"`` | - Environment variable: ``MM_EMAILSETTINGS_EMAILNOTIFICATIONCONTENTSTYPE`` | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| - **Send full message contents**: **(Default)** Email notifications include the full message contents, along with the name of the sender and the channel. ``config.json`` setting: ``"full"`` | - System Config path: **Site Configuration > Notifications** | +| | - ``config.json`` setting: ``EmailSettings`` > ``EmailNotificationContentsType`` | +| - **Send generic description with only sender name**: Only the name of the sender and team name are included in email notifications. Use this option if Mattermost contains confidential information and policy dictates it cannot be stored in email. ``config.json`` setting: ``"generic"`` | - Environment variable: ``MM_EMAILSETTINGS_EMAILNOTIFICATIONCONTENTSTYPE`` | ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ .. config:setting:: notification-displayname :displayname: Notification display name (Notifications) @@ -879,11 +881,11 @@ Email notification contents Notification display name ~~~~~~~~~~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ -| Display name for email notifications sent from the Mattermost system. | - System Config path: **Site Configuration > Notifications** | -| | - ``config.json`` setting: ``.EmailSettings.FeedbackName`` | -| String input. No default setting. This field is required when changing settings in the System Console. | - Environment variable: ``MM_EMAILSETTINGS_FEEDBACKNAME`` | -+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ +| Display name for email notifications sent from the Mattermost system. | - System Config path: **Site Configuration > Notifications** | +| | - ``config.json`` setting: ``EmailSettings`` > ``FeedbackName`` | +| String input. No default setting. This field is required when changing settings in the System Console. | - Environment variable: ``MM_EMAILSETTINGS_FEEDBACKNAME`` | ++--------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ .. config:setting:: notification-fromaddress :displayname: Notification from address (Notifications) @@ -895,11 +897,11 @@ Notification display name Notification from address ~~~~~~~~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ -| Email address for notification emails from the Mattermost system. This address should be monitored by a system admin. | - System Config path: **Site Configuration > Notifications** | -| | - ``config.json`` setting: ``.EmailSettings.FeedbackEmail`` | -| String input. Default is ``test@example.com``. This field is required when changing settings in the System Console. | - Environment variable: ``MM_EMAILSETTINGS_FEEDBACKEMAIL`` | -+-----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ +| Email address for notification emails from the Mattermost system. This address should be monitored by a system admin. | - System Config path: **Site Configuration > Notifications** | +| | - ``config.json`` setting: ``EmailSettings`` > ``FeedbackEmail`` | +| String input. Default is ``test@example.com``. This field is required when changing settings in the System Console. | - Environment variable: ``MM_EMAILSETTINGS_FEEDBACKEMAIL`` | ++-----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ .. config:setting:: notification-supportemailaddress :displayname: Support email address (Notifications) @@ -911,11 +913,11 @@ Notification from address Support email address ~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ -| Sets a user support (or feedback) email address that is displayed on email notifications and during the Getting Started tutorial. This address should be monitored by a system admin. If no value is set, email notifications will not contain a way for users to request assistance. | - System Config path: **Site Configuration > Notifications** | -| | - ``config.json`` setting: ``.SupportSettings.SupportEmail`` | -| String input. Default is ``feedback@mattermost.com``. This field is required when changing settings in the System Console. | - Environment variable: ``MM_SUPPORTSETTINGS_SUPPORTEMAIL`` | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ +| Sets a user support (or feedback) email address that is displayed on email notifications and during the Getting Started tutorial. This address should be monitored by a system admin. If no value is set, email notifications will not contain a way for users to request assistance. | - System Config path: **Site Configuration > Notifications** | +| | - ``config.json`` setting: ``SupportSettings`` > ``SupportEmail`` | +| String input. Default is ``feedback@mattermost.com``. This field is required when changing settings in the System Console. | - Environment variable: ``MM_SUPPORTSETTINGS_SUPPORTEMAIL`` | ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ .. config:setting:: notification-replytoaddress :displayname: Notification reply-to address (Notifications) @@ -927,11 +929,11 @@ Support email address Notification reply-to address ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ -| Email address used in the reply-to header when sending notification emails from the Mattermost system. This address should be monitored by a system admin. | - System Config path: **Site Configuration > Notifications** | -| | - ``config.json`` setting: ``.EmailSettings.ReplyToAddress`` | -| String input. Default is ``test@example.com``. | - Environment variable: ``MM_EMAILSETTINGS_REPLYTOADDRESS`` | -+------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ +| Email address used in the reply-to header when sending notification emails from the Mattermost system. This address should be monitored by a system admin. | - System Config path: **Site Configuration > Notifications** | +| | - ``config.json`` setting: ``EmailSettings`` > ``ReplyToAddress`` | +| String input. Default is ``test@example.com``. | - Environment variable: ``MM_EMAILSETTINGS_REPLYTOADDRESS`` | ++------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. config:setting:: notification-feedbackorganization :displayname: Notification footer mailing address (Notifications) @@ -943,11 +945,11 @@ Notification reply-to address Notification footer mailing address ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| Optional setting to include the organization’s name and mailing address in the footer of email notifications. If not set, nothing will appear. | - System Config path: **Site Configuration > Notifications** | -| | - ``config.json`` setting: ``.EmailSettings.FeedbackOrganization`` | -| String input. | - Environment variable: ``MM_EMAILSETTINGS_FEEDBACKORGANIZATION`` | -+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ +| Optional setting to include the organization’s name and mailing address in the footer of email notifications. If not set, nothing will appear. | - System Config path: **Site Configuration > Notifications** | +| | - ``config.json`` setting: ``EmailSettings`` > ``FeedbackOrganization`` | +| String input. | - Environment variable: ``MM_EMAILSETTINGS_FEEDBACKORGANIZATION`` | ++------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ .. config:setting:: notification-pushnotificationcontents :displayname: Push notification contents (Notifications) @@ -963,39 +965,39 @@ Notification footer mailing address Push notification contents ~~~~~~~~~~~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| - **Generic description with only sender name**: Push notifications include the sender’s name, | - System Config path: **Site Configuration > Notifications** | -| but not the channel name or message contents. ``config.json`` setting: ``"generic_no_channel"`` | - ``config.json`` setting: ``.EmailSettings.PushNotificationContents`` | -| | - Environment variable: ``MM_EMAILSETTINGS_PUSHNOTIFICATIONCONTENTS`` | -| - **Generic description with sender and channel names**: **(Default)** Push notifications | | -| include the name of the sender and channel, but not the message contents. | | -| ``config.json`` setting: ``"generic"`` | | -| | | -| - **Full message content sent in the notification payload**: Includes the message | | -| contents in the push notification payload, which may be sent through | | -| `Apple’s Push Notification service `__ or `Google’s Firebase Cloud Messaging `__ . | | -| We **highly recommended** this option only be used with an ``https`` protocol to encrypt | | -| the connection and protect confidential information. ``config.json`` setting: ``"full"`` | | -| | | -| - **Full message content fetched from the server on receipt** (*Available in Mattermost Enterprise*): | | -| The notification payload contains no message content. Instead it contains a unique message ID used | | -| to fetch message content from the Mattermost server when a push notification is received via a | | -| `notification service app extension `__ on iOS or `an expandable notification | | -| pattern `__ on Android. | | -| | | -| If the server cannot be reached, a generic push notification is displayed without message | | -| content or sender name. For customers who wrap the Mattermost mobile application in a secure | | -| container, the container must fetch the message contents using the unique message ID when | | -| push notifications are received. | | -| | | -| If the container is unable to execute the fetch, the push notification contents cannot be received | | -| by the customer's mobile application without passing the message contents through Apple's or | | -| Google's notification service. ``config.json`` setting: ``"id_loaded"`` | | -+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ +| - **Generic description with only sender name**: Push notifications include the sender’s name, | - System Config path: **Site Configuration > Notifications** | +| but not the channel name or message contents. ``config.json`` setting: ``"generic_no_channel"`` | - ``config.json`` setting: ``EmailSettings`` > ``PushNotificationContents`` | +| | - Environment variable: ``MM_EMAILSETTINGS_PUSHNOTIFICATIONCONTENTS`` | +| - **Generic description with sender and channel names**: **(Default)** Push notifications | | +| include the name of the sender and channel, but not the message contents. | | +| ``config.json`` setting: ``"generic"`` | | +| | | +| - **Full message content sent in the notification payload**: Includes the message | | +| contents in the push notification payload, which may be sent through | | +| `Apple’s Push Notification service `__ or `Google’s Firebase Cloud Messaging `__ . | | +| We **highly recommended** this option only be used with an ``https`` protocol to encrypt | | +| the connection and protect confidential information. ``config.json`` setting: ``"full"`` | | +| | | +| - **Full message content fetched from the server on receipt** (*Available in Mattermost Enterprise*): | | +| The notification payload contains no message content. Instead it contains a unique message ID used | | +| to fetch message content from the Mattermost server when a push notification is received via a | | +| `notification service app extension `__ on iOS or `an expandable notification | | +| pattern `__ on Android. | | +| | | +| If the server cannot be reached, a generic push notification is displayed without message | | +| content or sender name. For customers who wrap the Mattermost mobile application in a secure | | +| container, the container must fetch the message contents using the unique message ID when | | +| push notifications are received. | | +| | | +| If the container is unable to execute the fetch, the push notification contents cannot be received | | +| by the customer's mobile application without passing the message contents through Apple's or | | +| Google's notification service. ``config.json`` setting: ``"id_loaded"`` | | ++--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ .. config:setting:: perf-enablenotificationmonitoring :displayname: Enable notification monitoring (Notification Monitoring) @@ -1009,19 +1011,20 @@ Push notification contents Enable notification monitoring ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------+---------------------------------------------------------------------------------------+ -| Enable or disable notification metrics data | - System Config path: **Environment > Performance Monitoring** | -| collection. | - ``config.json setting``: ``".MetricsSettings.EnableNotificationMetrics": true",`` | -| | - Environment variable: ``MM_METRICSSETTINGS_ENABLENOTIFICATIONMETRICS`` | -| - **true**: **(Default)** Mattermost | | -| notification data collection is enabled for | | -| client-side web and desktop app users. | | -| - **false**: Mattermost notification | | -| data collection is disabled. | | -+-----------------------------------------------+---------------------------------------------------------------------------------------+ -| See the :ref:`performance monitoring ` documentation | -| to learn more about Mattermost Notification Health metrics. | -+-----------------------------------------------+---------------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------------------+ +| Enable or disable notification metrics data | - System Config path: **Environment > Performance Monitoring** | +| collection. | - ``config.json`` setting: ``MetricsSettings`` > ``EnableNotificationMetrics`` > ``true`` | +| | - Environment variable: ``MM_METRICSSETTINGS_ENABLENOTIFICATIONMETRICS`` | +| - **true**: **(Default)** Mattermost | | +| notification data collection is enabled for | | +| client-side web and desktop app users. | | +| - **false**: Mattermost notification | | +| data collection is disabled. | | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------+ + +.. note:: + See the :ref:`performance monitoring ` documentation + to learn more about Mattermost Notification Health metrics. ---- @@ -1045,11 +1048,11 @@ Access the following configuration settings in the System Console by going to ** Enable system-wide notifications ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------------+---------------------------------+---------------------------------------------------+ -| - **true**: Enable system-wide notifications to display at the top | - System Config path: **Site Configuration > System-wide notifications** | -| of the Mattermost interface for all users across all teams. | - ``config.json`` setting: ``.AnnouncementSettings.SystemWideNotifications: false`` | -| - **false**: **(Default)** Disable system-wide notifications. | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_SYSTEMWIDENOTIFICATIONS`` | -+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------+---------------------------------+-------------------------------------------------------------+ +| - **true**: Enable system-wide notifications to display at the top | - System Config path: **Site Configuration > System-wide notifications** | +| of the Mattermost interface for all users across all teams. | - ``config.json`` setting: ``AnnouncementSettings`` > ``SystemWideNotifications`` > ``false`` | +| - **false**: **(Default)** Disable system-wide notifications. | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_SYSTEMWIDENOTIFICATIONS`` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ .. config:setting:: system-wide-notification-text :displayname: Banner text (System-wide notifications) @@ -1061,11 +1064,11 @@ Enable system-wide notifications Banner text ~~~~~~~~~~~ -+------------------------------------------------------------+----------------------------------+---------------------------------------+ -| The text of the system-wide notification, when enabled. | - System Config path: **Site Configuration > System-wide notifications** | -| | - ``config.json`` setting: ``.AnnouncementSettings.BannerText`` | -| String input. | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_BANNERTEXT`` | -+------------------------------------------------------------+--------------------------------------------------------------------------+ ++------------------------------------------------------------+----------------------------------+--------------------------------------------+ +| The text of the system-wide notification, when enabled. | - System Config path: **Site Configuration > System-wide notifications** | +| | - ``config.json`` setting: ``AnnouncementSettings`` > ``BannerText`` | +| String input. | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_BANNERTEXT`` | ++------------------------------------------------------------+-------------------------------------------------------------------------------+ .. config:setting:: banner-color :displayname: Banner color (System-wide notifications) @@ -1077,11 +1080,11 @@ Banner text Banner color ~~~~~~~~~~~~ -+-----------------------------------------------------+-----------------------------------------------------------------------------+ -| The background color of system-wide notifications. | - System Config path: **Site Configuration > System-wide notifications** | -| | - ``config.json`` setting: ``.AnnouncementSettings.BannerColor: "#f2a93b"`` | -| String input of a CSS color value. | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_BANNERCOLOR`` | -+-----------------------------------------------------+-----------------------------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------------------------------+ +| The background color of system-wide notifications. | - System Config path: **Site Configuration > System-wide notifications** | +| | - ``config.json`` setting: ``AnnouncementSettings`` > ``BannerColor`` > ``"#f2a93b"`` | +| String input of a CSS color value. | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_BANNERCOLOR`` | ++-----------------------------------------------------+---------------------------------------------------------------------------------------+ .. config:setting:: banner-textcolor :displayname: Banner text color (System-wide notifications) @@ -1093,11 +1096,11 @@ Banner color Banner text color ~~~~~~~~~~~~~~~~~ -+------------------------------------------------------+---------------------------------------------------------------------------------+ -| The color of the text in system-wide notifications. | - System Config path: **Site Configuration > System-wide notifications** | -| | - ``config.json`` setting: ``.AnnouncementSettings.BannerTextColor: "#333333"`` | -| String input of a CSS color value. | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_BANNERTEXTCOLOR`` | -+------------------------------------------------------+---------------------------------------------------------------------------------+ ++------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| The color of the text in system-wide notifications. | - System Config path: **Site Configuration > System-wide notifications** | +| | - ``config.json`` setting: ``AnnouncementSettings`` > ``BannerTextColor`` > ``"#333333"`` | +| String input of a CSS color value. | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_BANNERTEXTCOLOR`` | ++------------------------------------------------------+-------------------------------------------------------------------------------------------+ .. config:setting:: banner-allowdismissal :displayname: Allow banner dismissal (System-wide notifications) @@ -1111,13 +1114,13 @@ Banner text color Allow banner dismissal ~~~~~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+ -| - **true**: **(Default)** Users can dismiss the system-wide notification. | - System Config path: **Site Configuration > System-wide notifications** | -| It will re-appear the next time the user logs in, and when the text is | - ``config.json`` setting: ``.AnnouncementSettings.AllowBannerDismissal: true`` | -| updated by an admin, or when an admin disables system-wide notifications | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_ALLOWBANNERDISMISSAL`` | -| and reenables them. | | -| - **false**: Users cannot dismiss the banner. | | -+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Users can dismiss the system-wide notification. | - System Config path: **Site Configuration > System-wide notifications** | +| It will re-appear the next time the user logs in, and when the text is | - ``config.json`` setting: ``AnnouncementSettings`` > ``AllowBannerDismissal`` > ``true`` | +| updated by an admin, or when an admin disables system-wide notifications | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_ALLOWBANNERDISMISSAL`` | +| and reenables them. | | +| - **false**: Users cannot dismiss the banner. | | ++-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------+ ---- @@ -1141,11 +1144,11 @@ Access the following configuration settings in the System Console by going to ** Enable emoji picker ~~~~~~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ -| - **true**: **(Default)** Enables an emoji picker when composing messages and for message reactions. | - System Config path: **Site Configuration > Emoji** | -| - **false**: Disables the emoji picker in message composition and reactions. | - ``config.json`` setting: ``.ServiceSettings.EnableEmojiPicker: true`` | -| | - Environment variable: ``MM_SERVICESETTINGS_ENABLEEMOJIPICKER`` | -+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| - **true**: **(Default)** Enables an emoji picker when composing messages and for message reactions. | - System Config path: **Site Configuration > Emoji** | +| - **false**: Disables the emoji picker in message composition and reactions. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableEmojiPicker`` > ``true`` | +| | - Environment variable: ``MM_SERVICESETTINGS_ENABLEEMOJIPICKER`` | ++------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ .. config:setting:: emoji-enablecustom :displayname: Enable custom emoji (Emoji) @@ -1159,14 +1162,15 @@ Enable emoji picker Enable custom emoji ~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -| - **true**: **(Default)** Allows users to add up to 6000 emojis through a | - System Config path: **Site Configuration > Emoji** | -| **Custom Emoji** option in the emoji picker. Emojis can be GIF, PNG, or | - ``config.json`` setting: ``.ServiceSettings.EnableCustomEmoji: true`` | -| JPG files up to 512 KB in size. | - Environment variable: ``MM_SERVICESETTINGS_ENABLECUSTOMEMOJI`` | -| - **false**: Disables custom emojis. | | -+-------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -| **Note**: While Mattermost supports up to 6000 custom emojis, an increase in custom emojis can slow your server’s performance. | -+-------------------------------------------------------------------------------+--------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Allows users to add up to 6000 emojis through a | - System Config path: **Site Configuration > Emoji** | +| **Custom Emoji** option in the emoji picker. Emojis can be GIF, PNG, or | - ``config.json`` setting: ``ServiceSettings`` > ``EnableCustomEmoji`` > ``true`` | +| JPG files up to 512 KB in size. | - Environment variable: ``MM_SERVICESETTINGS_ENABLECUSTOMEMOJI`` | +| - **false**: Disables custom emojis. | | ++-------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ + +.. note:: + While Mattermost supports up to 6000 custom emojis, an increase in custom emojis can slow your server’s performance. ---- @@ -1193,21 +1197,19 @@ Automatically follow threads .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+-------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| - **true**: **(Default)** Enables automatic following for all threads that a user starts, | - System Config path: **Site Configuration > Posts** | -| or in which the user participates or is mentioned. A **Threads** table in the database | - ``config.json`` setting: ``.ServiceSettings.ThreadAutoFollow: true`` | -| tracks threads and thread participants. A **ThreadMembership** table tracks followed threads | - Environment variable: ``MM_SERVICESETTINGS_THREADAUTOFOLLOW`` | -| for each user and whether the thread is read or unread. | | -| - **false**: Disables automatic following of threads. | | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Notes**: | -| | -| - This setting **must** be enabled for :doc:`threaded discussions ` to function. | -| - Enabling this setting does not automatically follow threads based on previous user actions. | -| For example, threads a user participated in prior to enabling this setting won't be automatically followed, unless the user adds a new comment or is mentioned | -| in the thread. | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - ++-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| - **true**: **(Default)** Enables automatic following for all threads that a user starts, | - System Config path: **Site Configuration > Posts** | +| or in which the user participates or is mentioned. A **Threads** table in the database | - ``config.json`` setting: ``ServiceSettings`` > ``ThreadAutoFollow`` > ``true`` | +| tracks threads and thread participants. A **ThreadMembership** table tracks followed threads | - Environment variable: ``MM_SERVICESETTINGS_THREADAUTOFOLLOW`` | +| for each user and whether the thread is read or unread. | | +| - **false**: Disables automatic following of threads. | | ++-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. note:: + - This setting **must** be enabled for :doc:`threaded discussions ` to function. + - Enabling this setting does not automatically follow threads based on previous user actions. + For example, threads a user participated in prior to enabling this setting won't be automatically followed, unless the user adds a new comment or is mentioned + in the thread. .. config:setting:: posts-threadeddiscussions :displayname: Threaded discussions (Posts) :systemconsole: Site Configuration > Posts @@ -1226,15 +1228,15 @@ Threaded discussions Customers upgrading from a legacy Mattermost release prior to v7.0 must review the `administrator’s guide to enabling threaded discussions `__ (formally known as Collapsed Reply Threads) prior to enabling this functionality. -+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| - **Always On**: **(Default)** Enables :doc:`threaded discussions ` | - System Config path: **Site Configuration > Posts** | -| on the server and for all users. This is the recommended configuration for optimal user experience | - ``config.json`` setting: ``.ServiceSettings.ThreadedDiscussions`` | -| and to ensure consistency in how users read and respond to threaded conversations. | - Environment variable: ``MM_SERVICESETTINGS_THREADEDDISCUSSIONS`` | -| ``config.json`` setting: ``"always_on"`` | | -| - **Default On**: Enables threaded discussions on the server and for all users. | | -| - **Default Off**: Enables threaded discussions on the server but **not** for users. | | -| - **Disabled**: Users cannot enable threaded discussions. ``config.json`` setting: ``"disabled"`` | | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ +| - **Always On**: **(Default)** Enables :doc:`threaded discussions ` | - System Config path: **Site Configuration > Posts** | +| on the server and for all users. This is the recommended configuration for optimal user experience | - ``config.json`` setting: ``ServiceSettings`` > ``ThreadedDiscussions`` | +| and to ensure consistency in how users read and respond to threaded conversations. | - Environment variable: ``MM_SERVICESETTINGS_THREADEDDISCUSSIONS`` | +| ``config.json`` setting: ``"always_on"`` | | +| - **Default On**: Enables threaded discussions on the server and for all users. | | +| - **Default Off**: Enables threaded discussions on the server but **not** for users. | | +| - **Disabled**: Users cannot enable threaded discussions. ``config.json`` setting: ``"disabled"`` | | ++---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ .. config:setting:: posts-messagepriority :displayname: Message priority (Posts) @@ -1248,17 +1250,18 @@ Threaded discussions Message priority ~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------------------+------------------------------------------------------------------------+ -| - **true**: **(Default)** Enables message priority for all users which | - System Config path: **Site Configuration > Posts** | -| enables them to set a visual indiciator for important or urgent root | - ``config.json`` setting: ``.ServiceSettings.PostPriority: true`` | -| messages. | - Environment variable: ``MM_SERVICESETTINGS_POSTPRIORITY`` | -| - **false**: Disables the ability to set message priority and request | | -| acknowledgements. | | -+-----------------------------------------------------------------------------+------------------------------------------------------------------------+ -| **Note**: `Mattermost Enterprise or Professional `__ customers can additionally request message acknowledgements to | -| track that specific, time-sensitive messages have been seen and actioned. See the | -| :doc:`message priority ` documentation to learn more. | -+-----------------------------------------------------------------------------+------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------+----------------------------------------------------------------------------------+ +| - **true**: **(Default)** Enables message priority for all users which | - System Config path: **Site Configuration > Posts** | +| enables them to set a visual indiciator for important or urgent root | - ``config.json`` setting: ``ServiceSettings`` > ``PostPriority`` > ``true`` | +| messages. | - Environment variable: ``MM_SERVICESETTINGS_POSTPRIORITY`` | +| - **false**: Disables the ability to set message priority and request | | +| acknowledgements. | | ++-----------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. note:: + `Mattermost Enterprise or Professional `__ customers can additionally request message acknowledgements to + track that specific, time-sensitive messages have been seen and actioned. See the + :doc:`message priority ` documentation to learn more. .. config:setting:: posts-persistentnotifications :displayname: Persistent notifications (Posts) @@ -1272,11 +1275,11 @@ Message priority Persistent notifications ~~~~~~~~~~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| - **true**: **(Default)** Users can trigger repeating notifications to | - System Config path: **Site Configuration > Posts** | -| mentioned recipients of urgent messages. | - ``config.json`` setting: ``.ServiceSettings.AllowPersistentNotifications: true`` | -| - **false**: Disables the ability to send repeating notifications. | - Environment variable: ``MM_SERVICESETTINGS_ALLOWPERSISTENTNOTIFICATIONS`` | -+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Users can trigger repeating notifications to | - System Config path: **Site Configuration > Posts** | +| mentioned recipients of urgent messages. | - ``config.json`` setting: ``ServiceSettings`` > ``AllowPersistentNotifications`` > ``true`` | +| - **false**: Disables the ability to send repeating notifications. | - Environment variable: ``MM_SERVICESETTINGS_ALLOWPERSISTENTNOTIFICATIONS`` | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ .. config:setting:: posts-maxnumberofrecipientsforpersistentnotifications :displayname: Maximum number of recipients for persistent notifications (Posts) @@ -1288,12 +1291,12 @@ Persistent notifications Maximum number of recipients for persistent notifications ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| The maximum number of recipients users may send persistent | - System Config path: **Site Configuration > Posts** | -| notifications to. | - ``config.json`` setting: ``.ServiceSettings.PersistentNotificationMaxRecipients: 5`` | -| | - Environment variable: ``MM_SERVICESETTINGS_PERSISTENTNOTIFICATIONSMAXRECIPIENTS`` | -| Numerical input. Default is **5**. | | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+ ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ +| The maximum number of recipients users may send persistent | - System Config path: **Site Configuration > Posts** | +| notifications to. | - ``config.json`` setting: ``ServiceSettings`` > ``PersistentNotificationMaxRecipients`` > ``5`` | +| | - Environment variable: ``MM_SERVICESETTINGS_PERSISTENTNOTIFICATIONSMAXRECIPIENTS`` | +| Numerical input. Default is **5**. | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ .. config:setting:: posts-frequencyofpersistentnotifications :displayname: Frequency of persistent notifications (Posts) @@ -1305,12 +1308,12 @@ Maximum number of recipients for persistent notifications Frequency of persistent notifications ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| The number of minutes between repeated notifications for | - System Config path: **Site Configuration > Posts** | -| urgent messages sent with persistent notifications. | - ``config.json`` setting: ``.ServiceSettings.PersistentNotificationIntervalMinutes: 5`` | -| | - Environment variable: ``MM_SERVICESETTINGS_PERSISTENTNOTIFICATIONINTERVALMINUTES`` | -| Numerical input. Default is **5**. Minimum is **2**. | | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| The number of minutes between repeated notifications for | - System Config path: **Site Configuration > Posts** | +| urgent messages sent with persistent notifications. | - ``config.json`` setting: ``ServiceSettings`` > ``PersistentNotificationIntervalMinutes`` > ``5`` | +| | - Environment variable: ``MM_SERVICESETTINGS_PERSISTENTNOTIFICATIONINTERVALMINUTES`` | +| Numerical input. Default is **5**. Minimum is **2**. | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ .. config:setting:: posts-totalnumberofpersistentnotificationsperpost :displayname: Total number of persistent notifications per post (Posts) @@ -1322,12 +1325,12 @@ Frequency of persistent notifications Total number of persistent notifications per post ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------+------------------------------------------------------------------------------------+ -| The maximum number of times users may receive persistent | - System Config path: **Site Configuration > Posts** | -| notifications. | - ``config.json`` setting: ``.ServiceSettings.PersistentNotificationMaxCount: 6`` | -| | - Environment variable: ``MM_SERVICESETTINGS_PERSISTENTNOTIFICATIONMAXCOUNT`` | -| Numerical input. Default is **6**. | | -+-------------------------------------------------------------+------------------------------------------------------------------------------------+ ++-------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| The maximum number of times users may receive persistent | - System Config path: **Site Configuration > Posts** | +| notifications. | - ``config.json`` setting: ``ServiceSettings`` > ``PersistentNotificationMaxCount`` > ``6`` | +| | - Environment variable: ``MM_SERVICESETTINGS_PERSISTENTNOTIFICATIONMAXCOUNT`` | +| Numerical input. Default is **6**. | | ++-------------------------------------------------------------+----------------------------------------------------------------------------------------------+ .. config:setting:: posts-enablelinkpreviews :displayname: Enable website link previews (Posts) @@ -1341,13 +1344,14 @@ Total number of persistent notifications per post Enable website link previews ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -| - **true**: The server generates a preview of the first website, image, or YouTube video linked in a message. Users can disable website previews, but not image or YouTube previews, under **Settings > Display > Website Link Previews**. | - System Config path: **Site Configuration > Posts** | -| - **false**: **(Default)** All previews are disabled and the server does not request metadata for any links contained in messages. | - ``config.json`` setting: ``.ServiceSettings.EnableLinkPreviews: true`` | -| | - Environment variable: ``MM_SERVICESETTINGS_ENABLELINKPREVIEWS`` | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -| **Note**: The server must be connected to the internet to generate previews. This connection can be established through a :doc:`firewall or outbound proxy ` if necessary. | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ +| - **true**: The server generates a preview of the first website, image, or YouTube video linked in a message. Users can disable website previews, but not image or YouTube previews, under **Settings > Display > Website Link Previews**. | - System Config path: **Site Configuration > Posts** | +| - **false**: **(Default)** All previews are disabled and the server does not request metadata for any links contained in messages. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableLinkPreviews`` > ``true`` | +| | - Environment variable: ``MM_SERVICESETTINGS_ENABLELINKPREVIEWS`` | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ + +.. note:: + The server must be connected to the internet to generate previews. This connection can be established through a :doc:`firewall or outbound proxy ` if necessary. .. config:setting:: posts-disablepreviewsperdomain :displayname: Disable link previews for specific domains (Posts) @@ -1359,11 +1363,11 @@ Enable website link previews Disable link previews for specific domains ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| Use this setting to disable previews of links for specific domains. | - System Config path: **Site Configuration > Posts** | -| | - ``config.json`` setting: ``.ServiceSettings.RestrictLinkPreviews`` | -| String input of a comma-separated list of domains, for example: ``"mattermost.com, images.example.com"`` | - Environment variable: ``MM_SERVICESETTINGS_RESTRICTLINKPREVIEWS`` | -+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ +| Use this setting to disable previews of links for specific domains. | - System Config path: **Site Configuration > Posts** | +| | - ``config.json`` setting: ``ServiceSettings`` > ``RestrictLinkPreviews`` | +| String input of a comma-separated list of domains, for example: ``"mattermost.com, images.example.com"`` | - Environment variable: ``MM_SERVICESETTINGS_RESTRICTLINKPREVIEWS`` | ++----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ .. config:setting:: posts-enablemessagelinkpreviews :displayname: Enable message link previews (Posts) @@ -1377,11 +1381,11 @@ Disable link previews for specific domains Enable message link previews ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| - **true**: **(Default)** :doc:`Share links to Mattermost messages ` will generate a preview for any users that have access to the original message. | - System Config path: **Site Configuration > Posts** | -| - **false**: Share links do not generate a preview. | - ``config.json`` setting: ``.ServiceSettings.EnablePermalinkPreviews: true`` | -| | - Environment variable: ``MM_SERVICESETTINGS_ENABLEPERMALINKPREVIEWS`` | -+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| - **true**: **(Default)** :doc:`Share links to Mattermost messages ` will generate a preview for any users that have access to the original message. | - System Config path: **Site Configuration > Posts** | +| - **false**: Share links do not generate a preview. | - ``config.json`` setting: ``ServiceSettings`` > ``EnablePermalinkPreviews`` > ``true`` | +| | - Environment variable: ``MM_SERVICESETTINGS_ENABLEPERMALINKPREVIEWS`` | ++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ .. config:setting:: posts-enablesvg :displayname: Enable SVGs (Posts) @@ -1395,13 +1399,14 @@ Enable message link previews Enable SVGs ~~~~~~~~~~~ -+-------------------------------------------------------------------------------+------------------------------------------------------------------+ -| - **true**: Enables previews of SVG files attached to messages. | - System Config path: **Site Configuration > Posts** | -| - **false**: **(Default)** Disables previews of SVG files. | - ``config.json`` setting: ``.ServiceSettings.EnableSVGs: false``| -| | - Environment variable: ``MM_SERVICESETTINGS_ENABLESVGS`` | -+-------------------------------------------------------------------------------+------------------------------------------------------------------+ -| **Warning**: Enabling SVGs is not recommended in environments where not all users are trusted. | -+--------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------+----------------------------------------------------------------------------+ +| - **true**: Enables previews of SVG files attached to messages. | - System Config path: **Site Configuration > Posts** | +| - **false**: **(Default)** Disables previews of SVG files. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableSVGs`` > ``false``| +| | - Environment variable: ``MM_SERVICESETTINGS_ENABLESVGS`` | ++-------------------------------------------------------------------------------+----------------------------------------------------------------------------+ + +.. warning:: + Enabling SVGs is not recommended in environments where not all users are trusted. .. config:setting:: posts-enablelatex :displayname: Enable LaTeX code block rendering (Posts) @@ -1415,13 +1420,14 @@ Enable SVGs Enable LaTeX code block rendering ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+----------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ -| - **true**: Enables rendering of :ref:`LaTeX in code blocks `. | - System Config path: **Site Configuration > Posts** | -| - **false**: **(Default)** Disables rendering in blocks. Instead, LaTeX code is highlighted. | - ``config.json`` setting: ``.ServiceSettings.EnableLatex: false``| -| | - Environment variable: ``MM_SERVICESETTINGS_ENABLELATEX`` | -+----------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ -| **Warning**: Enabling LaTeX rendering is not recommended in environments where not all users are trusted. | -+----------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ +| - **true**: Enables rendering of :ref:`LaTeX in code blocks `. | - System Config path: **Site Configuration > Posts** | +| - **false**: **(Default)** Disables rendering in blocks. Instead, LaTeX code is highlighted. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableLatex`` > ``false``| +| | - Environment variable: ``MM_SERVICESETTINGS_ENABLELATEX`` | ++----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ + +.. warning:: + Enabling LaTeX rendering is not recommended in environments where not all users are trusted. .. config:setting:: posts-enableinlinelatex :displayname: Enable inline LaTeX rendering (Posts) @@ -1435,13 +1441,14 @@ Enable LaTeX code block rendering Enable inline LaTeX rendering ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -| - **true**: Enables rendering of :ref:`LaTeX in message text `. | - System Config path: **Site Configuration > Posts** | -| - **false**: **(Default)** Disables inline rendering of LaTeX. Instead, LaTeX in message text is highlighted. | - ``config.json`` setting: ``.ServiceSettings.EnableInlineLatex: false`` | -| LaTeX can also be rendered in a code block, if that feature is enabled. See **Enable LaTeX code block rendering**. | - Environment variable: ``MM_SERVICESETTINGS_ENABLEINLINELATEX`` | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -| **Warning**: Enabling LaTeX rendering isn't recommended in environments where not all users are trusted. | -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ +| - **true**: Enables rendering of :ref:`LaTeX in message text `. | - System Config path: **Site Configuration > Posts** | +| - **false**: **(Default)** Disables inline rendering of LaTeX. Instead, LaTeX in message text is highlighted. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableInlineLatex`` > ``false`` | +| LaTeX can also be rendered in a code block, if that feature is enabled. See **Enable LaTeX code block rendering**. | - Environment variable: ``MM_SERVICESETTINGS_ENABLEINLINELATEX`` | ++-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ + +.. warning:: + Enabling LaTeX rendering isn't recommended in environments where not all users are trusted. .. config:setting:: posts-customurlschemes :displayname: Custom URL schemes (Posts) @@ -1453,11 +1460,11 @@ Enable inline LaTeX rendering Custom URL schemes ~~~~~~~~~~~~~~~~~~ -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| A list of URL schemes that will automatically create a link in message text, for example: ``["git", "smtp"]``. These schemes always create links: ``http``, ``https``, ``ftp``, ``tel``, and ``mailto``. | - System Config path: **Site Configuration > Posts** | -| | - ``config.json`` setting: ``.DisplaySettings.CustomURLSchemes: []`` | -| ``config.json`` setting: an array of strings | - Environment variable: ``MM_DISPLAYSETTINGS_CUSTOMURLSCHEMES`` | -+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| A list of URL schemes that will automatically create a link in message text, for example: ``["git", "smtp"]``. These schemes always create links: ``http``, ``https``, ``ftp``, ``tel``, and ``mailto``. | - System Config path: **Site Configuration > Posts** | +| | - ``config.json`` setting: ``DisplaySettings`` > ``CustomURLSchemes`` > ``[]`` | +| ``config.json`` setting: an array of strings | - Environment variable: ``MM_DISPLAYSETTINGS_CUSTOMURLSCHEMES`` | ++----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ .. config:setting:: posts-maxmarkdownnodes :displayname: Maximum Markdown nodes (Posts) @@ -1469,17 +1476,18 @@ Custom URL schemes Maximum Markdown nodes ~~~~~~~~~~~~~~~~~~~~~~ -+-------------------------------------------------------------+-----------------------------------------------------------------------+ -| The maximum number of Markdown elements (such as emojis, | - System Config path: **Site Configuration > Posts** | -| links, or table cells), that can be included in a single | - ``config.json`` setting: ``.DisplaySettings.MaxMarkdownNodes: 0`` | -| piece of text in a message. | - Environment variable: ``MM_DISPLAYSETTINGS_MAXMARKDOWNNODES`` | -| | | -| Numerical input. Default is **0** which applies a | | -| Mattermost-specified limit. | | -+-------------------------------------------------------------+-----------------------------------------------------------------------+ -| **Note**: This limit applies to all Mattermost clients, including web, desktop app, and mobile app. | -+-------------------------------------------------------------+-----------------------------------------------------------------------+ - ++-------------------------------------------------------------+---------------------------------------------------------------------------------+ +| The maximum number of Markdown elements (such as emojis, | - System Config path: **Site Configuration > Posts** | +| links, or table cells), that can be included in a single | - ``config.json`` setting: ``DisplaySettings`` > ``MaxMarkdownNodes`` > ``0`` | +| piece of text in a message. | - Environment variable: ``MM_DISPLAYSETTINGS_MAXMARKDOWNNODES`` | +| | | +| Numerical input. Default is **0** which applies a | | +| Mattermost-specified limit. | | ++-------------------------------------------------------------+---------------------------------------------------------------------------------+ + +.. note:: + This limit applies to all Mattermost clients, including web, desktop app, and mobile app. + .. config:setting:: posts-googleapikey :displayname: Google API key (Posts) :systemconsole: Site Configuration > Posts @@ -1493,16 +1501,14 @@ Google API key .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| If a key is provided in this setting, Mattermost displays titles of embedded YouTube videos and detects if a video is no longer available. Setting a key should also prevent Google from throttling access to embedded videos that receive a high number of views. | - System Config path: **Site Configuration > Posts** | -| | - ``config.json`` setting: ``.ServiceSettings.GoogleDeveloperKey`` | -| String input. | - Environment variable: ``MM_SERVICESETTINGS_GOOGLEDEVELOPERKEY`` | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ -| **Notes**: | -| | -| - The key must have the YouTube Data API added as a service. | -| - This key is used in client-side Javascript. | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ +| If a key is provided in this setting, Mattermost displays titles of embedded YouTube videos and detects if a video is no longer available. Setting a key should also prevent Google from throttling access to embedded videos that receive a high number of views. | - System Config path: **Site Configuration > Posts** | +| | - ``config.json`` setting: ``ServiceSettings`` > ``GoogleDeveloperKey`` | +| String input. | - Environment variable: ``MM_SERVICESETTINGS_GOOGLEDEVELOPERKEY`` | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ + +.. note:: + This key is used in client-side Javascript, and must have the YouTube Data API added as a service. .. config:setting:: posts-AllowSyncedDrafts :displayname: Enable server syncing of message drafts (Posts) @@ -1514,18 +1520,18 @@ Google API key Enable server syncing of message drafts ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------------------------------+--------------------------------------------------------------------------------------+ -| Enable or disable the ability to synchronize draft | - System Config path: **Site Configuration > Posts** | -| messages across all supported Mattermost clients. | - ``config.json`` setting: ``".ServiceSettings.AllowSyncedDrafts: true,`` | -| | - Environment variable: ``MM_SERVICESETTINGS_ALLOWSYNCEDDRAFTS`` | -| - **true**: **(Default)** Message drafts are saved | | -| on the server and may be accessed from different | | -| clients. Users may still disable server | | -| synchronization of draft messages by going | | -| to **Settings > Advanced Settings**. | | -| - **false**: Draft messages are stored locally | | -| on each device. | | -+------------------------------------------------------+--------------------------------------------------------------------------------------+ ++------------------------------------------------------+------------------------------------------------------------------------------------------+ +| Enable or disable the ability to synchronize draft | - System Config path: **Site Configuration > Posts** | +| messages across all supported Mattermost clients. | - ``config.json`` setting: ``ServiceSettings`` > ``AllowSyncedDrafts`` > ``true`` | +| | - Environment variable: ``MM_SERVICESETTINGS_ALLOWSYNCEDDRAFTS`` | +| - **true**: **(Default)** Message drafts are saved | | +| on the server and may be accessed from different | | +| clients. Users may still disable server | | +| synchronization of draft messages by going | | +| to **Settings > Advanced Settings**. | | +| - **false**: Draft messages are stored locally | | +| on each device. | | ++------------------------------------------------------+------------------------------------------------------------------------------------------+ .. config:setting:: posts-UniqueEmojiReactionLimit :displayname: Unique emoji reaction limit (Posts) @@ -1537,13 +1543,13 @@ Enable server syncing of message drafts Unique emoji reaction limit ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------------------------------+---------------------------------------------------------------------------------------+ -| Limit the number of unique emoji reactions on each | - System Config path: **Site Configuration > Posts** | -| message. Increasing this limit can lead to poor | - ``config.json`` setting: ``".ServiceSettings.UniqueEmojiReactionLimitPerPost: 50,`` | -| client performance. | - Environment variable: ``MM_SERVICESETTINGS_UNIQUEEMOJIREACTIONLIMITPERPOST`` | -| | | -| Numerical input. Default is **50**. Maximum is 500. | | -+------------------------------------------------------+---------------------------------------------------------------------------------------+ ++------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| Limit the number of unique emoji reactions on each | - System Config path: **Site Configuration > Posts** | +| message. Increasing this limit can lead to poor | - ``config.json`` setting: ``ServiceSettings`` > ``UniqueEmojiReactionLimitPerPost`` > ``50`` | +| client performance. | - Environment variable: ``MM_SERVICESETTINGS_UNIQUEEMOJIREACTIONLIMITPERPOST`` | +| | | +| Numerical input. Default is **50**. Maximum is 500. | | ++------------------------------------------------------+----------------------------------------------------------------------------------------------------+ ---- @@ -1567,11 +1573,11 @@ Access the following configuration settings in the System Console by going to ** Allow file sharing ~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ -| - **true**: **(Default)** Allows users to attach files to messages. | - System Config path: **Site Configuration > File Sharing and Downloads** | -| - **false**: Prevents users from attaching files (including images) to a message. This affects users on all clients and devices, including mobile apps. | - ``config.json`` setting: ``.FileSettings.EnableFileAttachments: true`` | -| | - Environment variable: ``MM_FILESETTINGS_ENABLEFILEATTACHMENTS`` | -+---------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Allows users to attach files to messages. | - System Config path: **Site Configuration > File Sharing and Downloads** | +| - **false**: Prevents users from attaching files (including images) to a message. This affects users on all clients and devices, including mobile apps. | - ``config.json`` setting: ``FileSettings`` > ``EnableFileAttachments`` > ``true`` | +| | - Environment variable: ``MM_FILESETTINGS_ENABLEFILEATTACHMENTS`` | ++---------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ .. config:setting:: fileshare-allowuploadsonmobile :displayname: Allow file uploads on mobile (File sharing) @@ -1592,11 +1598,11 @@ Allow file uploads on mobile

Also available in legacy Mattermost Enterprise Edition E20

-+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ -| - **true**: **(Default)** Allows users to attach files to messages from mobile apps. | - System Config path: **Site Configuration > File Sharing and Downloads** | -| - **false**: Prevents users from attaching files (including images) to messages from mobile apps. | - ``config.json`` setting: ``.FileSettings.EnableMobileUpload: true`` | -| | - Environment variable: ``MM_FILESETTINGS_ENABLEMOBILEUPLOAD`` | -+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Allows users to attach files to messages from mobile apps. | - System Config path: **Site Configuration > File Sharing and Downloads** | +| - **false**: Prevents users from attaching files (including images) to messages from mobile apps. | - ``config.json`` setting: ``FileSettings`` > ``EnableMobileUpload`` > ``true`` | +| | - Environment variable: ``MM_FILESETTINGS_ENABLEMOBILEUPLOAD`` | ++---------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ .. config:setting:: fileshare-allowdownloadsonmobile :displayname: Allow file downloads on mobile (File sharing) @@ -1617,11 +1623,11 @@ Allow file downloads on mobile

Also available in legacy Mattermost Enterprise Edition E20

-+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ -| - **true**: **(Default)** Enables file downloads on mobile apps. | - System Config path: **Site Configuration > File sharing and downloads** | -| - **false**: Disables file downloads on mobile apps. Users can still download files from a mobile web browser. | - ``config.json`` setting: ``.FileSettings.EnableMobileDownload: true`` | -| | - Environment variable: ``MM_FILESETTINGS_ENABLEMOBILEDOWNLOAD`` | -+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| - **true**: **(Default)** Enables file downloads on mobile apps. | - System Config path: **Site Configuration > File sharing and downloads** | +| - **false**: Disables file downloads on mobile apps. Users can still download files from a mobile web browser. | - ``config.json`` setting: ``FileSettings`` > ``EnableMobileDownload`` > ``true`` | +| | - Environment variable: ``MM_FILESETTINGS_ENABLEMOBILEDOWNLOAD`` | ++----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ ---- @@ -1645,13 +1651,14 @@ Access the following configuration settings in the System Console by going to ** Enable public file links ~~~~~~~~~~~~~~~~~~~~~~~~ -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| - **true**: Allows users to create :doc:`public links ` to files attached to Mattermost messages. | - System Config path: **Site Configuration > Public Links** | -| - **false**: **(Default)** Prevents users from creating public links to files and disables all previously created links. | - ``config.json`` setting: ``.FileSettings.EnablePublicLink: false`` | -| | - Environment variable: ``MM_FILESETTINGS_ENABLEPUBLICLINK`` | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| **Note**: When set to ``false``, anyone who tries to visit a previously created public link will receive an error message. If the setting is returned to ``true``, previously created links will be accessible, unless the **Public link salt** has been regenerated. | -+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| - **true**: Allows users to create :doc:`public links ` to files attached to Mattermost messages. | - System Config path: **Site Configuration > Public Links** | +| - **false**: **(Default)** Prevents users from creating public links to files and disables all previously created links. | - ``config.json`` setting: ``FileSettings`` > ``EnablePublicLink`` > ``false`` | +| | - Environment variable: ``MM_FILESETTINGS_ENABLEPUBLICLINK`` | ++-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ + +.. note:: + When set to **false**, anyone who tries to visit a previously created public link will receive an error message. If the setting is returned to **true**, previously created links will be accessible, unless the **Public link salt** has been regenerated. .. config:setting:: publink-salt :displayname: Public link salt (Public links) @@ -1665,7 +1672,7 @@ Public link salt +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ | 32-character salt added to the URL of public file links. Changing this setting will **invalidate** all previously generated links. The salt is randomly generated when Mattermost is installed, and can be regenerated by selecting **Regenerate** in the System Console. | - System Config path: **Site Configuration > Public Links** | -| | - ``config.json`` setting: ``.FileSettings.PublicLinkSalt`` | +| | - ``config.json`` setting: ``FileSettings`` > ``PublicLinkSalt``| | String input. | - Environment variable: ``MM_FILESETTINGS_PUBLICLINKSALT`` | +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ @@ -1691,11 +1698,11 @@ Access the following configuration settings in the System Console by going to ** Enable admin notices ~~~~~~~~~~~~~~~~~~~~ -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ -| - **true**: **(Default)** System admins will receive :doc:`in-product notices ` about server upgrades and administration features. | - System Config path: **Site Configuration > Notices** - | -| | - ``config.json`` setting: ``.AnnouncementSettings.AdminNoticesEnabled: true`` | -| - **false**: System admins will not receive specific notices. Admins will still receive notices for all users (see **Enable end user notices**) | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_ADMINNOTICESENABLED`` | -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +| - **true**: **(Default)** System admins will receive :doc:`in-product notices ` about server upgrades and administration features. | - System Config path: **Site Configuration > Notices** - | +| | - ``config.json`` setting: ``AnnouncementSettings`` > ``AdminNoticesEnabled`` > ``true`` | +| - **false**: System admins will not receive specific notices. Admins will still receive notices for all users (see **Enable end user notices**) | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_ADMINNOTICESENABLED`` | ++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ .. config:setting:: notices-enableendusernotices :displayname: Enable end user notices (Notices) @@ -1709,8 +1716,8 @@ Enable admin notices Enable end user notices ~~~~~~~~~~~~~~~~~~~~~~~ -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| - **true**: **(Default)** All users receive :doc:`in-product notices ` about client upgrades and end user features. | - System Config path: **Site Configuration > Notices** | -| - **false**: Users will not receive in-product notices. | - ``config.json`` setting: ``.AnnouncementSettings.UserNoticesEnabled: true`` | -| | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_USERNOTICESENABLED`` | -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| - **true**: **(Default)** All users receive :doc:`in-product notices ` about client upgrades and end user features. | - System Config path: **Site Configuration > Notices** | +| - **false**: Users will not receive in-product notices. | - ``config.json`` setting: ``AnnouncementSettings`` > ``UserNoticesEnabled`` > ``true`` | +| | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_USERNOTICESENABLED`` | ++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+