Plugins configuration settings#
Available on all plans
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#
|
|
Require plugin signature#
Note
Available only for self-hosted deployments
|
|
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 being disabled in the System Console.
Automatic prepackaged plugins#
|
|
Upload Plugin#
Note
Available only for self-hosted deployments
|
|
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.The ability to upload plugin files is disabled when the Require plugin signature configuration setting is enabled.
Enable Marketplace#
|
|
Enable remote Marketplace#
|
|
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 tofalse
, and this configuration setting must be set totrue
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 |
|
Installed plugin state#
This setting is a list of installed plugins and their status as enabled or disabled. The |
|
Plugin settings#
This setting contains plugin-specific data. The |
|
Calls#
Available on all plans
Cloud and self-hosted deployments
Access the following configuration settings in the System Console by going to Plugins > Calls.
Enable plugin#
|
|
RTC server address (UDP)#
Note
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. |
|
Note
This setting is only applicable when not running calls through the standalone rtcd
service.
RTC server address (TCP)#
Note
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. |
|
Note
This setting is available starting in plugin version 0.17, and is only applicable when not running calls through the standalone rtcd
service.
RTC server port (UDP)#
Note
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. |
|
Note
This setting is only applicable when not running calls through the standalone rtcd
service.
RTC server port (TCP)#
Note
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. |
|
Note
This setting is available starting in plugin version 0.17, and is only applicable when not running calls through the standalone rtcd
service.
Enable on specific channels#
Admins can’t configure this setting from Mattermost v7.7; it’s hidden and always enabled
Note
Available only for self-hosted deployments
|
|
Test mode#
This setting was called Enable on all channels until Mattermost v7.7. It was renamed to defaultenabled in code and Test Mode in-product.
Note
Available only for self-hosted deployments
|
|
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.
ICE host override#
Note
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:
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 port override#
Note
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. |
|
Note
This value will apply to both UDP and TCP host candidates.
RTCD service URL#
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. |
|
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, namelyMM_CALLS_RTCD_CLIENT_ID
andMM_CALLS_RTCD_AUTH_KEY
Max call participants#
Note
Available only for self-hosted deployments
This setting limits the number of participants that can join a single call. 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 Calls self-hosted deployment documentation for details.
ICE servers configurations#
Note
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 |
|
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
Available only for self-hosted deployments
A static secret used to generate short-lived credentials for TURN servers. This is an optional field. |
|
TURN credentials expiration#
Note
Available only for self-hosted deployments
The expiration, in minutes, of the short-lived credentials generated for TURN servers. Default is 1440 (one day). |
|
Server side TURN#
Note
Available only for self-hosted deployments
Changing this setting requires a plugin restart to take effect. |
|
Allow screen sharing#
Note
Available only for self-hosted deployments
Changing this setting requires a plugin restart to take effect. |
|
Enable simulcast for screen sharing (Experimental)#
Note
Available only for self-hosted deployments
|
|
Note
This functionality has the following requirements:
- Calls plugin version >= v0.16.0
- rtcd
version >= v0.10.0 (if in use)
Enable call recordings#
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. |
|
Job service URL#
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. |
|
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, namelyMM_CALLS_JOB_SERVICE_CLIENT_ID
andMM_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
orMM_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#
The maximum duration of a call recording in minutes. The default is 60. The maximum is 180. This is a required value. |
|
Call recording quality#
The audio and video quality of call recordings. Available options are: Low, Medium and High. 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 deployment section for more information.
Enable call transcriptions (Beta)#
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 call recordings to be enabled.
Transcriber model size#
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. |
|
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 configure call recordings, transcriptions, and live captions documentation for more information.
Call transcriber threads#
The number of threads used by the post-call transcriber. This must be in the range [1, numCPUs]. 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 configure call recordings, transcriptions, and live captions documentation for more information. This setting is available starting in plugin version 0.26.2.
(Experimental) Enable IPv6#
Note
Available only for self-hosted deployments
Changing this setting requires a plugin restart to take effect. |
|
Note
This setting is available starting in plugin version 0.17, and is only applicable when not running calls through the standalone rtcd
service.
Enable call ringing#
|
|
Enable AV1 (Experimental)#
|
|
Note
This setting is ignored when simulcast is enabled for screen sharing.
Enable DC signaling (Experimental)#
|
|
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.
GitLab#
Available on all plans
Cloud and self-hosted deployments
See the Connect GitLab to Mattermost product documentation for available Mattermost configuration options.
GitHub#
Available on all plans
Cloud and self-hosted deployments
See the Connect GitHub to Mattermost product documentation for available Mattermost configuration options.
Jira#
Available on all plans
Cloud and self-hosted deployments
See the Connect Jira to Mattermost product documentation for available Mattermost configuration options.
Legal hold#
Available on Enterprise plans
Cloud and self-hosted deployments
See the Legal holds product documentation for details.
Microsoft Calendar#
Available on all plans
Cloud and self-hosted deployments
See the Connect Microsoft Calendar to Mattermost product documentation for available Mattermost configuration options.
Microsoft Teams Meetings#
Available on all plans
Cloud and self-hosted deployments
See the Connect Microsoft Teams Meetings to Mattermost product documentation for available Mattermost configuration options.
MS Teams#
Available on all plans
Cloud and self-hosted deployments
Mattermost for Microsoft Teams enables you to break through siloes in a mixed Mattermost and Teams environment by forwarding real-time chat notifications from Teams to Mattermost.
Tip
Download our Mattermost for Microsoft Teams datasheet to learn how Mattermost helps your organization get more from your Microsoft tools.
Access the following configuration settings in the System Console by going to Plugins > MS Teams.
Enable plugin#
Enable the Mattermost for Microsoft Teams plugin for all Mattermost teams.
|
|
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 from the Azure portal. |
|
Client ID#
Specify the Microsoft Teams Client ID of your registered OAuth app in the Azure portal. |
|
Client secret#
Specify the client secret of your registered OAuth app in Azure portal. Alpha-numeric value. |
|
At rest encryption key#
Regenerate a new encryption secret. This encryption secret will be used to encrypt and decrypt the OAuth token. Alpha-numeric value. |
|
Note
Select Regenerate to generate a new key.
Webhook secret#
Generate the webhook secret that Microsoft Teams will use to send messages to Mattermost. |
|
Note
Select Regenerate to generate a new key.
Use the evaluation API pay model#
Enable this only for testing purposes. You need the pay model to be able to support enough message notifications to work in a real world scenario.
|
|
Sync notifications#
Notify connected users in Mattermost on receipt of a chat or group chat from Microsoft Teams.
|
|
Maximum size of attachments to support complete one time download#
Specify the maximum file size, in mebibytes (MiB), 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 MiB. |
|
Buffer size for streaming files#
Specify the buffer size, in mebibytes (MiB), for streaming attachment files from Microsoft Teams to Mattermost. Numerical value. Default is 20 MiB. |
|
Performance metrics#
Available on Enterprise plans
Cloud and self-hosted deployments
See the Monitor performance metrics product documentation for available Mattermost configuration options.
Collaborative playbooks#
Available on Enterprise plans
Cloud and self-hosted deployments
Use collaborative playbooks in Mattermost to provide structure, monitoring and automation for repeatable, team-based processes integrated with the Mattermost platform.
Access the following configuration settings in the System Console by going to Plugins > Collaborative playbooks.
Enable plugin#
|
|
Enabled teams#
Enable collaborative playbooks for all Mattermost teams, or for only selected teams. |
|
Enable experimental features#
|
|
User satisfaction surveys#
Available on all plans
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#
|
|
Enable user satisfaction survey#
|
|
Note: See the Mattermost Privacy Policy for more information on the collection and use of information by Mattermost. |
ServiceNow#
Available on all plans
Cloud and self-hosted deployments
See the Connect ServiceNow to Mattermost product documentation for available Mattermost configuration options.
Zoom#
Available on all plans
Cloud and self-hosted deployments
See the Connect Zoom to Mattermost product documentation for available Mattermost configuration options.
config.json-only settings#
Available on all plans
self-hosted deployments
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 |
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 |