Plugins configuration settings#

plans-img Available on all plans

deployment-img Cloud and self-hosted deployments

Self-hosted can manage the following configuration settings in System Console > Plugins or by editing the config.json file as described in the following tables.

Plugin management#

Access the following configuration settings in the System Console by going to Plugins > Plugin Management.

Enable plugins#

  • true: (Default) Enables plugins on your Mattermost server. See the Use plugins with Mattermost documentation for details.

  • false: Disables plugins on your Mattermost server.

  • System Config path: Plugins > Plugin Management

  • config.json setting: .PluginSettings.Enable: true

  • Environment variable: MM_PLUGINSETTINGS_ENABLE

Require plugin signature#

Note

deployment-img-yellow Available only for self-hosted deployments

  • true: (Default) Enables plugin signature validation for managed and unmanaged plugins.

  • false: Disables plugin signature validation for managed and unmanaged plugins.

  • System Config path: Plugins > Plugin Management

  • config.json setting: .PluginSettings.RequirePluginSignature: true

  • Environment variable: MM_PLUGINSETTINGS_REQUIREPLUGINSIGNATURE

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.

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.

  • false: Mattermost does not automatically install or upgrade pre-packaged plugins. Pre-packaged plugins may be installed manually from the Marketplace, even when offline.

  • System Config path: Plugins > Plugin Management

  • config.json setting: .PluginSettings.AutomaticPrepackagedPlugins: true

  • Environment variable: MM_PLUGINSETTINGS_AUTOMATICPREPACKAGEDPLUGINS

Upload Plugin#

Note

deployment-img-yellow Available only for self-hosted deployments

  • true: Enables you to upload plugins from your local computer to your Mattermost server for all system admins.

  • false: (Default) Disables uploading of plugins from your local computer to your Mattermost server for all system admins.

  • System Config path: Plugins > Plugin Management

  • 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 MaxFileSize configuration setting isn’t large enough to support the plugin file upload. Additional proxy setting updateds may also be required.

Enable Marketplace#

  • true: (Default) Enables the plugin Marketplace on your Mattermost server for all System Admins.

  • false: Disables the plugin Marketplace on your Mattermost server for all System Admins.

  • System Config path: Plugins > Plugin Management

  • config.json setting: .PluginSettings.EnableMarketplace: true

  • Environment variable: MM_PLUGINSETTINGS_ENABLEMARKETPLACE

Enable remote Marketplace#

  • true: (Default) Mattermost attempts to connect to the endpoint set in Marketplace URL. If the connection fails, an error is displayed, and the Marketplace only shows pre-packaged and installed plugins.

  • false: Mattermost does not attempt to connect to a remote Marketplace. The Marketplace shows only pre-packaged and installed plugins. Use this setting if your Mattermost server cannot connect to the Internet.

  • System Config path: Plugins > Plugin Management

  • config.json setting: .PluginSettings.EnableRemoteMarketplace: true

  • Environment variable: MM_PLUGINSETTINGS_ENABLEREMOTEMARKETPLACE

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.

Marketplace URL#

This setting stores the URL for the remote Markeplace.

String input. Default is https://api.integrations.mattermost.com

  • System Config path: Plugins > Plugin Management

  • config.json setting: .PluginSettings.MarketplaceURL

  • Environment variable: MM_PLUGINSETTINGS_MARKETPLACEURL

Installed plugin state#

This setting is a list of installed plugins and their status as enabled or disabled.

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.

  • System Config path: Plugins > Plugin Management

  • config.json setting: .PluginSettings.PluginStates

  • Environment variable: MM_PLUGINSETTINGS_PLUGINSTATES

Plugin settings#

This setting contains plugin-specific data.

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.

  • System Config path: Plugins > Plugin Management

  • config.json setting: .PluginSettings.Plugins

  • Environment variable: MM_PLUGINSETTINGS_PLUGINS

Apps#

plans-img Available on all plans

deployment-img Cloud and self-hosted deployments

Note

From Mattermost v8.1, this third-party plugin is managed by the Mattermost Community.

Access the following configuration settings in the System Console by going to Plugins > Apps.

To create your own Mattermost App, see the Mattermost Apps developer documentation.

Enable plugin#

  • true: Enables the Apps plugin on your Mattermost server.

  • false: (Default) Disables the Apps plugin on your Mattermost server.

  • System Config path: Plugins > Apps

Calls#

plans-img Available on all plans

deployment-img Cloud and self-hosted deployments

Access the following configuration settings in the System Console by going to Plugins > Calls.

Enable plugin#

  • true: (Default) Enables the Calls plugin on your Mattermost workspace.

  • false: Disables the Calls plugin on your Mattermost workspace.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.PluginStates.com.mattermost.calls.Enable

  • Environment variable: MM_PLUGINSETTINGS_PLUGINSTATES_COM_MATTERMOST_CALLS

RTC server address (UDP)#

Note

deployment-img-yellow Available only for self-hosted deployments

This setting controls the IP address the RTC server listens for UDP connections. All calls UDP traffic will be served through this IP.

Changing this setting requires a plugin restart to take effect. If left unset (default value) the service will listen on all the available interfaces.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.udpserveraddress

  • Environment variable: N/A

Note: This setting is only applicable when not running calls through the standalone rtcd service.

RTC server address (TCP)#

Note

deployment-img-yellow Available only for self-hosted deployments

This setting controls the IP address the RTC server listens for TCP connections. All calls TCP traffic will be served through this IP.

Changing this setting requires a plugin restart to take effect. If left unset (default value) the service will listen on all the available interfaces.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.tcpserveraddress

  • Environment variable: N/A

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.

RTC server port (UDP)#

Note

deployment-img-yellow Available only for self-hosted deployments

This setting controls the UDP port listened on by the RTC server. All calls UDP traffic will be served through this port.

Changing this setting requires a plugin restart to take effect.

Default is 8443.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.udpserverport

  • Environment variable: N/A

Note: This setting is only applicable when not running calls through the standalone rtcd service.

RTC server port (TCP)#

Note

deployment-img-yellow Available only for self-hosted deployments

This setting controls the TCP port listened on by the RTC server. All calls TCP traffic will be served through this port.

Changing this setting requires a plugin restart to take effect.

Default is 8443.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.tcpserverport

  • Environment variable: N/A

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.

Enable on specific channels#

Admins can’t configure this setting from Mattermost v7.7; it’s hidden and always enabled

Note

deployment-img-yellow Available only for self-hosted deployments

  • true: Channel admins can enable or disable calls on specific channels. Participants in DMs/GMs can also enable or disable calls.

  • false: Only System Admins can enable or disable calls on specific channels.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.allowenablecalls

  • Environment variable: N/A

Test mode#

This setting was called Enable on all channels up until Mattermost v7.7

Note

deployment-img-yellow Available only for self-hosted deployments

  • true: Only System Admins can start calls in channels.

  • false: All team members can start calls in channels.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.defaultenabled

  • Environment variable: N/A

Note: Use this setting to confirm calls work as expected. When true, users attempting to start calls are prompted to contact System Admins. System Admins are prompted to confirm that calls are working as expected before switching to live mode.

ICE host override#

Note

deployment-img-yellow Available only for self-hosted deployments

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:

  • 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.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.icehostoverride
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 port override#

Note

deployment-img-yellow Available only for self-hosted deployments

This setting can be used to override the port used in the ICE host candidates that get advertised to clients when connecting to calls.

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.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.icehostportoverride

  • Environment variable: N/A

Note: this value will apply to both UDP and TCP host candidates.

RTCD service URL#

Note

plans-img-yellow Available only on Enterprise plans

deployment-img-yellow Available only for self-hosted deployments

The URL to a running rtcd service instance that will host the calls.

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.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.rtcdserviceurl

  • Environment variable: MM_CALLS_RTCD_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_RTCD_CLIENT_ID and MM_CALLS_RTCD_AUTH_KEY

Max call participants#

Note

deployment-img-yellow Available only for self-hosted deployments

This setting limits the number of participants that can join a single call.

Default is 0 (no limit).

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.maxcallparticipants

  • Environment variable: MM_CALLS_MAX_PARTICIPANTS

Note: This setting is optional, but the recommended maximum number of participants is 200.

ICE servers configurations#

Note

deployment-img-yellow Available only for self-hosted deployments

This setting stores a list of ICE servers (STUN/TURN) in JSON format to be used by the service.

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"]}]

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.iceserversconfigs

  • Environment variable: N/A

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 option.

Example

[
 {
    "urls":[
       "stun:stun.global.calls.mattermost.com:3478"
    ]
 },
 {
    "urls":[
       "turn:turn.example.com:3478"
    ],
    "username":"webrtc",
    "credentials":"turnpassword"
 }
]

Example (Using generated TURN credentials)

[{
        "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.

TURN static auth secret#

Note

deployment-img-yellow Available only for self-hosted deployments

A static secret used to generate short-lived credentials for TURN servers.

This is an optional field.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.turnstaticauthsecret

  • Environment variable: N/A

TURN credentials expiration#

Note

deployment-img-yellow Available only for self-hosted deployments

The expiration, in minutes, of the short-lived credentials generated for TURN servers.

Default is 1440 (one day).

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.turncredentialsexpirationminutes

  • Environment variable: N/A

Server side TURN#

Note

deployment-img-yellow Available only for self-hosted deployments

  • true: The RTC server will use the configured TURN candidates for server-initiated connections.

  • false: TURN will be used only on the client-side.

Changing this setting requires a plugin restart to take effect.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.serversideturn

  • Environment variable: N/A

Allow screen sharing#

Note

deployment-img-yellow Available only for self-hosted deployments

  • true: Call participants will be allowed to share their screen.

  • false: Call participants won’t be allowed to share their screen.

Changing this setting requires a plugin restart to take effect.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.allowscreensharing

  • Environment variable: N/A

Enable simulcast for screen sharing (Experimental)#

Note

deployment-img-yellow Available only for self-hosted deployments

  • true: Enables simulcast for screen sharing. This can help to improve screen sharing quality.

  • false: Disables simulcast for screen sharing.

  • System Config path: Plugins > Calls

  • 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)

Enable call recordings (Beta)#

Note

plans-img-yellow Available only on Enterprise plans

deployment-img-yellow Available only for self-hosted deployments

  • true: Allows call hosts to record meeting video and audio.

  • false: (Default) Call recording functionality is not available to hosts.

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.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.enablerecordings

Job service URL#

Note

plans-img-yellow Available only on Enterprise plans

deployment-img-yellow Available only for self-hosted deployments

The URL to a running job service where all the processing related to recordings happens. The recorded files produced are stored in Mattermost.

This is a required field. Changing this setting requires a plugin restart to take effect.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.jobserviceurl

  • 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.

Maximum call recording duration#

Note

plans-img-yellow Available only on Enterprise plans

deployment-img-yellow Available only for self-hosted deployments

The maximum duration of a call recording in minutes.

The default is 60. The maximum is 180. This is a required value.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.maxrecordingduration

  • Environment variable: N/A

Call recording quality#

Note

plans-img-yellow Available only on Enterprise plans

deployment-img-yellow Available only for self-hosted deployments

The audio and video quality of call recordings. Available options are: Low, Medium and High.

The default is Medium. This is a required value.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.recordingquality

Note: The quality setting will affect the performance of the job service and the file size of recordings. Refer to the deployment section for more information.

Enable call transcriptions (Experimental)#

Note

plans-img-yellow Available only on Enterprise plans

deployment-img-yellow Available only for self-hosted deployments

  • true: Enables automatic transcriptions of calls.

  • false: (Default) Call transcriptions functionality is disabled.

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.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.enabletranscriptions

Note: Call transcriptions require call recordings to be enabled. This setting is available starting in plugin version 0.22.

Transcriber model size#

Note

plans-img-yellow Available only on Enterprise plans

deployment-img-yellow Available only for self-hosted deployments

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.

The default is Base. This is a required value.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.transcribermodelsize

Note: The model size setting will affect the performance of the job service. Refer to the configure call recordings and transcriptions documentation for more information. This setting is available starting in plugin version 0.22.

(Experimental) Enable IPv6#

Note

deployment-img-yellow Available only for self-hosted deployments

  • true: The RTC service will work in dual-stack mode, listening for IPv6 connections and generating candidates in addition to IPv4 ones.

  • false: The RTC service will only listen for IPv4 connections.

Default value is false.

Changing this setting requires a plugin restart to take effect.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls.enableipv6

  • Environment variable: N/A

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.

Enable call ringing (Beta)#

  • true: Ringing functionality is enabled. Direct and group message participants receive a desktop app alert and a ringing notification when a call starts.

  • false: (Default) Ringing functionality is disabled.

  • System Config path: Plugins > Calls

  • config.json setting: PluginSettings.Plugins.com.mattermost.calls. enableringing

  • Environment variable: N/A

Google Calendar#

plans-img Available on all plans

deployment-img Cloud and self-hosted deployments

The Mattermost Google Calendar plugin enables a two-way integration between Mattermost and Google Calendar.

Access the following configuration settings in the System Console by going to Plugins > Google Calendar.

Enable plugin#

Enable the Mattermost Google Calendar plugin for all Mattermost teams.

  • true: Enables Google Calendar plugin on your Mattermost workspace.

  • false: (Default) Disables the Google Calendar plugin.

  • System Config path: Plugins > Google Calendar

  • config.json setting: N/A

  • Environment variable: N/A

Admin user IDs#

A comma-separated list of users authorized to manage the plugin.

Go to System Console > User Management > Users to access user IDs.

  • System Config path: Plugins > Google Calendar

  • config.json setting: N/A

  • Environment variable: N/A

Copy plugin logs to admins, as bot messages#

The level of detail in log events for the plugin.

Can be one of: None, Debug, Info, Warning, or Error.

  • System Config path: Plugins > Google Calendar

  • config.json setting: N/A

  • Environment variable: N/A

Display full context for each admin log message#

Specify whether full context is displayed for log messages.

  • true: Displays full context for each admin log entry.

  • false: Full context isn’t displayed for each admin log entry.

  • System Config path: Plugins > Google Calendar

  • config.json setting: N/A

  • Environment variable: N/A

Encryption key#

The encryption key used to store data in the database.

  • System Config path: Plugins > Google Calendar

  • config.json setting: N/A

  • Environment variable: N/A

Note: Select Regenerate to generate a new encryption key. When you regenerate this value, all users will need to reconnect their Google Calendar with Mattermost.

Google application client ID#

The Google App Authentication Client ID.

  • System Config path: Plugins > Google Calendar

  • config.json setting: N/A

  • Environment variable: N/A

Google client secret#

The Google App Authentication Client Secret.

  • System Config path: Plugins > Google Calendar

  • config.json setting: N/A

  • Environment variable: N/A

MS Teams#

plans-img Available on all plans

deployment-img Cloud and self-hosted deployments

Mattermost for Microsoft Teams enables you to collaborate with technical & operations teams seamlessly through the Mattermost app, without leaving Microsoft Teams.

Access the following configuration settings in the System Console by going to Plugins > MS Teams.

Mattermost Academy Learn about integrating with Microsoft Teams

Enable plugin#

Enable the Mattermost for Microsoft Teams plugin for all Mattermost teams.

  • true: Enables MS Teams plugin on your Mattermost workspace.

  • false: (Default) Disables the MS Teams plugin.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Note: Use the Enabled Teams configuration option to specify which Mattermost teams synchronize direct and group messages with Microsoft Teams chats.

Tenant ID#

Specify the Microsoft Teams Tenant ID.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Client ID#

Specify the Microsoft Teams Client ID.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Client secret#

Specify the Microsoft Teams Client Secret.

Alpha-numeric value.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

At rest encryption key#

Generate the AES encryption key used to encrypt sotred access tokens.

Alpha-numeric value.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Note: Select Regenerate to generate a new key.

Webhook secret#

Generate the webhook secret that Microsoft Teams will use to send messages to Mattermost.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Note: Select Regenerate to generate a new key.

Use the evaluation API pay model#

Enable the evaluation API pay model to receive a limited number of change notifications. Ensure you keep the number of notifications low.

  • true: Enables the evaluation API pay model.

  • false: (Default) Disables the evaluation API pay model.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Enforce connected accounts#

Requires all users to connect their Mattermost account to their Microsoft Teams account, if the accounts aren’t already connected.

  • true: Users are required to connect their Mattermost and Microsoft Teams accounts each time they refresh the Mattermost browser, refresh the desktop app, or log in to Mattermost.

  • false: (Default) Users aren’t required to connect their Mattermost and Microsoft Teams accounts.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Allow to temporarily skip connect user#

Allow users to temporarily dismiss the prompt to connect their Mattermost account to their Microsoft Teams account. Users will continue to be prompted when they refresh the browser, refresh the desktop app, or log in to Mattermost.

  • true: Enables users to skip the current prompt to connect their Mattermost and Microsoft Teams user accounts.

  • false: (Default) Prevents users from skipping the prompt to connect their Mattermost and Microsoft Teams accounts.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Sync users#

Specify how often, in minutes, to synchronize direct messages, group messages, and chats, between Mattermost and Microsoft Teams users.

Leave this value blank to disble user synchronization. Numerical value.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Sync guest users#

Synchronize Microsoft Teams guest users and Mattermost users.

  • true: Mattermost includes Microsoft Teams guest users when synchronizing.

  • false: (Default) Mattermost doesn’t include Microsoft Teams guest users when synchronizing.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Sync direct and group messages#

Synchronize direct messages, group messages, and chats between Mattermost and Microsoft Teams users.

  • true: (Default) Mattermost synchronizes direct messages, group messages, and chats between Mattermost and Microsoft Teams.

  • false: Mattermost doesn’t synchronize messages and chats.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Enabled teams#

Specify which Mattermost teams synchronize direct messages, group messages, and chats with Microsoft Teams.

Separate multiple team names with commas. Leave this value blank to synchronize all Mattermost teams.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Prompt interval for DMs and GMs#

Specify how often, in hours, to prompt users to connect their Microsoft Teams user account to their Mattermost user account.

Leave this value blank to disble the prompt. Numerical value.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Maximum size of attachments to support complete one time download#

Specify the maximum file size, in megabytes (MB), of attachments that can be loaded into memory. Attachment files larger than this value will be streamed from Microsoft Teams to Mattermost.

Numerical value. Default is 20 MB.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Buffer size for streaming files#

Specify the buffer size, in megabytes (MB), for streaming attachment files from Microsoft Teams to Mattermost.

Numerical value. Default is 20 MB.

  • System Config path: Plugins > MS Teams

  • config.json setting: N/A

  • Environment variable: N/A

Playbooks#

plans-img Available on all plans

deployment-img Cloud and self-hosted deployments

Mattermost Playbooks is an open source, self-hosted collaboration tool for teams. Each playbook represents a recurring outcome or specific goal that your teams collaborate on to achieve, such as service outage recovery or customer onboarding. Teams run a playbook every time they want to orchestrate people, tools, and data to achieve that outcome as quickly as possible while providing visibility to stakeholders. Playbooks also allow teams to incorporate learnings from the retrospective to tweak and improve the playbook with every iteration. See the Mattermost Playbooks plugin documentation for details.

Access the following configuration settings in the System Console by going to Plugins > Playbooks.

Enable plugin#

  • true: (Default) Enables Mattermost Playbooks on your Mattermost workspace.

  • false: Disables Mattermost Playbooks on your Mattermost workspace.

  • System Config path: Plugins > Playbooks

  • config.json setting:

  • Environment variable:

Enabled teams#

Enable Playbooks for all Mattermost teams, or for only selected teams.

  • System Config path: Plugins > Playbooks

  • config.json setting:

  • Environment variable:

Enable experimental features#

  • true: Enables experimental Playbooks features on your Mattermost workspace.

  • false: Disables experimental Playbooks features on your Mattermost workspace.

  • System Config path: Plugins > Playbooks

  • config.json setting:

  • Environment variable:

User satisfaction surveys#

plans-img Available on all plans

deployment-img Cloud and self-hosted deployments

This plugin enables Mattermost to send user satisfaction surveys to gather feedback and improve product quality directly from your Mattermost users. Please refer to the Mattermost Privacy Policy for more information on the collection and use of information received through Mattermost services.

Access the following configuration settings in the System Console by going to Plugins > User Satisfaction Surveys.

Enable plugin#

  • true: (Default) Enables the Mattermost User Satisfaction Surveys plugin on your Mattermost workspace.

  • false: Disables the Mattermost User Satisfaction Surveys plugin on your Mattermost workspace.

  • System Config path: Plugins > User Satisfaction Surveys

Enable user satisfaction survey#

  • true: A survey is sent to all users every quarter. Results are used by Mattermost, Inc. to improve the product.

  • false: (Default) User satisfaction surveys are disabled.

  • System Config path: Plugins > User Satisfaction Surveys

Note: See the Mattermost Privacy Policy for more information on the collection and use of information by Mattermost.

Zoom#

plans-img Available on all plans

deployment-img self-hosted deployments

This plugin allows team members to initiate a Zoom meeting with a single click. All participants in a channel can easily join the Zoom meeting and the shared link is updated when the meeting is over. See the Zoom Plugin documentation for details.

Note

To set up this plugin, you need to create a Zoom App using a Zoom Administrator account. See the Zoom plugin documentation for details.

Access the following configuration settings in the System Console by going to Plugins > Zoom.

Enable plugin#

  • true: (Default) Enables the Zoom plugin on your Mattermost server.

  • false: Disables the Zoom plugin on your Mattermost server.

  • System Config path: Plugins > Zoom

Zoom URL#

Specify the URL for a self-hosted private cloud or on-premise Zoom server. For example, https://yourzoom.com. Leave blank if you’re using Zoom’s vendor-hosted SaaS service.

  • System Config path: Plugins > Zoom

Zoom API URL#

Specify the API URL for a self-hosted private cloud or on-premises Zoom server. For example, https://api.yourzoom.com/v2. Leave blank if you’re using Zoom’s vendor-hosted SaaS service.

  • System Config path: Plugins > Zoom

Enable OAuth#

  • true: OAuth will be used as the authentication means with Zoom.

  • false: (Default) JWT will be used as the authentication means with Zoom.

  • System Config path: Plugins > Zoom

Note

If you are currently using a JWT Zoom application and switch to OAuth, all users will need to connect their Zoom account using OAuth the next time they try to start a meeting. See the Zoom plugin documentation for details.

OAuth by account level app (Beta)#

  • true: Only an account administrator must log in. The rest of the users will use their e-mail to log in.

  • false: (Default) All users must use their e-mail to log in.

  • System Config path: Plugins > Zoom

Zoom OAuth client ID#

Specify the Client ID for the OAuth app registered with Zoom. Leave blank if not using OAuth.

  • System Config path: Plugins > Zoom

Zoom OAuth client secret#

Specify the Client Secret for the OAuth app registered with Zoom. Leave blank if not using OAuth.

  • System Config path: Plugins > Zoom

At rest token encryption key#

Generate an AES encryption key for the Zoom OAuth Token used to encrypt stored access tokens by selecting Regenerate. Regenerating the key invalidates your existing Zoom OAuth.

  • System Config path: Plugins > Zoom

API key#

Specify the API Key generated by Zoom used to create meetings and pull user data.

  • System Config path: Plugins > Zoom

API secret#

Specify the API Secret generated by Zoom for your API key.

  • System Config path: Plugins > Zoom

Webhook secret#

Generate a secret for the webhook URL endpoint used to authenticate the webhook to Mattermost. Regenerating the secret invalidates your existing Zoom plugin.

  • System Config path: Plugins > Zoom

Signature public key files#

This setting isn’t available in the System Console and can only be set in config.json.

In addition to the Mattermost plugin signing key built into the server, each public key specified here is trusted to validate plugin signatures.

This feature’s config.json setting is "SignaturePublicKeyFiles": {} with string array input consisting of contents that are relative or absolute paths to signature files.

Chimera OAuth proxy URL#

This setting isn’t available in the System Console and can only be set in config.json.

Specify the Chimera URL used by Mattermost plugins to connect with pre-created OAuth applications.

This feature’s config.json setting is "ChimeraOAuthProxyUrl": {} with string input.