From 8424ab107ff86acc42baca6726e703ccf0616671 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Tue, 6 Feb 2024 16:03:45 -0500 Subject: [PATCH] Removed "Sync" to align with product naming --- ...-mattermost-app-within-microsoft-teams.rst | 4 +- ...-mattermost-for-microsoft-teams-plugin.rst | 20 +-- ...orate-within-connected-microsoft-teams.rst | 8 +- .../plugins-configuration-settings.rst | 145 ++++++++++-------- 4 files changed, 93 insertions(+), 84 deletions(-) diff --git a/source/about/embed-mattermost-app-within-microsoft-teams.rst b/source/about/embed-mattermost-app-within-microsoft-teams.rst index c6b72b0fa69..29d7226c2e4 100644 --- a/source/about/embed-mattermost-app-within-microsoft-teams.rst +++ b/source/about/embed-mattermost-app-within-microsoft-teams.rst @@ -12,7 +12,7 @@ With the `Microsoft Teams plugin `__ To install the Mattermost app in Microsoft Teams: -1. In Mattermost, as an administrator, go to **System Console > Plugins > MSTeams Sync**. At the bottom of the settings page, select **Download Manifest** to download a ZIP file containing the Microsoft Teams application manifest pre-configured for your Mattermost workspace. +1. In Mattermost, as an administrator, go to **System Console > Plugins > MS Teams**. At the bottom of the settings page, select **Download Manifest** to download a ZIP file containing the Microsoft Teams application manifest pre-configured for your Mattermost workspace. 2. In Microsoft Teams, as an administrator, go to the Microsoft Teams admin center under **Teams Apps > Manage Apps**, or use the following URL: ``https://admin.teams.microsoft.com/policies/manage-apps``. 3. Select **Upload new app**, then upload the app manifest you downloaded in the previous step. @@ -69,5 +69,5 @@ Get help If you face any issues while installing or using the app in Microsoft Teams, you can either: -- Open a new issue in the `Mattermost for Microsoft Teams GitHub repository `__. +- Open a new issue in the `Mattermost for Microsoft Teams GitHub repository `__. - Or, create a new topic in our `peer-to-peer troubleshooting forum `__. \ No newline at end of file diff --git a/source/about/install-mattermost-for-microsoft-teams-plugin.rst b/source/about/install-mattermost-for-microsoft-teams-plugin.rst index 40f55be062c..4ad43fc4481 100644 --- a/source/about/install-mattermost-for-microsoft-teams-plugin.rst +++ b/source/about/install-mattermost-for-microsoft-teams-plugin.rst @@ -12,12 +12,12 @@ Install the Mattermost for Microsoft Teams plugin Looking to `embed Mattermost within Microsoft Teams `__ instead? -To install the `Microsoft Teams plugin `__ in Mattermost: +To install the `Microsoft Teams plugin `__ in Mattermost: 1. Log in to your Mattermost workspace as a system administrator. -2. Download the latest version of `the plugin binary release `__, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, `follow our documentation `__ to upgrade to Mattermost v8.0.1 or later. +2. Download the latest version of `the plugin binary release `__, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, `follow our documentation `__ to upgrade to Mattermost v8.0.1 or later. 3. Go to **System Console > Plugins > Plugin Management > Upload Plugin**, and upload the plugin binary you downloaded in the previous step. -4. Go to **System Console > Plugins > Plugin Management**. In the **Installed Plugins** section, scroll to **MS Teams Sync**, and select **Enable Plugin**. +4. Go to **System Console > Plugins > Plugin Management**. In the **Installed Plugins** section, scroll to **MS Teams**, and select **Enable Plugin**. Set up an OAuth application in Azure ------------------------------------- @@ -34,10 +34,10 @@ Step 1: Create Mattermost App in Azure 4. Fill out the form with the following values: - - **Name**: ``Mattermost MS Teams Sync`` + - **Name**: ``Mattermost MS Teams`` - **Supported account types**: ``Default value (Single tenant)`` - **Platform**: ``Web`` - - **Redirect URI**: ``https://(MM_SITE_URL)/plugins/com.mattermost.msteams-sync/oauth-redirect`` + - **Redirect URI**: ``https://(MM_SITE_URL)/plugins/com.mattermost.msteams/oauth-redirect`` Replace ``(MM_SITE_URL)`` with your Mattermost server's Site URL. Select **Register** to submit the form. @@ -122,14 +122,14 @@ Configure how users will connect accounts Mattermost admins can configure Mattermost to automatically prompt users to connect their Mattermost user account to their Microsoft Teams user account on login. -1. Go to **System Console > Plugins > MS Teams Sync**. +1. Go to **System Console > Plugins > MS Teams**. 2. Enable **Enforce connected accounts** to prompt users to connect if they haven't done so. 3. (Optional) Enable **Allow to temporarily skip connect user** to allow users to skip the connection prompt temporarily. Users are prompted on refresh and login. Configure the plugin -------------------- -Additional configuration settings are available for this plugin. See the `Microsoft Teams Sync plugin configuration settings `__ documentation for details. +Additional configuration settings are available for this plugin. See the `Microsoft Teams plugin configuration settings `__ documentation for details. Monitor plugin performance -------------------------- @@ -139,7 +139,7 @@ You can set up `performance monitoring `__ a - Monitoring enables you to proactively review the overall health of the plugin, including database calls, HTTP requests, and API latency. - Alerting enables you to detect and take action as issues come up, such as the integration being offline. -Grafana dashboards `are available on GitHub `__ for Mattermost Cloud deployments as a useful starting point. These dashboards are designed for use in Mattermost Cloud, and filter to a given ``namespace``. +Grafana dashboards `are available on GitHub `__ for Mattermost Cloud deployments as a useful starting point. These dashboards are designed for use in Mattermost Cloud, and filter to a given ``namespace``. .. image:: ../images/grafana-dashboard-msteams.png :alt: Example of a Grafana monitoring dashboard for a Mattermost instance connected to Microsoft Teams. @@ -159,13 +159,13 @@ Trobleshooting If you encounter issues when connecting user accounts or linking channels, restart the plugin as a Mattermost system admin. 1. Go to **System Console > Plugins > Plugin Management**. -2. Under **Installed Plugins**, scroll to the **MSTeams Sync** section, select **Disable** then wait for the State to change to **Not running**. +2. Under **Installed Plugins**, scroll to the **MS Teams** section, select **Disable** then wait for the State to change to **Not running**. 3. Select **Enable** and wait for the State to change to **Running**. Get help -------- -If you face issues while installing this plugin, gather relevant information, including reproduction steps to accelerate troubleshooting. You're welcome to open a new issue in the `Mattermost for Microsoft Teams GitHub repository `__. +If you face issues while installing this plugin, gather relevant information, including reproduction steps to accelerate troubleshooting. You're welcome to open a new issue in the `Mattermost for Microsoft Teams GitHub repository `__. - **Mattermost Commercial Customers (including Enterprise and Professional plans)**: Visit `Mattermost Support `__ to `submit a support ticket `__. diff --git a/source/collaborate/collaborate-within-connected-microsoft-teams.rst b/source/collaborate/collaborate-within-connected-microsoft-teams.rst index 187e6bd48d3..c4cbbdce80f 100644 --- a/source/collaborate/collaborate-within-connected-microsoft-teams.rst +++ b/source/collaborate/collaborate-within-connected-microsoft-teams.rst @@ -24,8 +24,8 @@ Mattermost will tell you when you’ve successfully connected your account. .. note:: - - If you're not prompted to connect your accounts, display the prompt in a browser window by running the Mattermost slash command ``/msteams-sync connect`` in Mattermost. Follow the link to connect your accounts. - - To change which accounts are linked, in Mattermost, run the slash command ``/msteams-sync disconnect``, then connect your Mattermost account to a new Microsoft Teams account. + - If you're not prompted to connect your accounts, display the prompt in a browser window by running the Mattermost slash command ``/msteams connect`` in Mattermost. Follow the link to connect your accounts. + - To change which accounts are linked, in Mattermost, run the slash command ``/msteams disconnect``, then connect your Mattermost account to a new Microsoft Teams account. - If a Microsoft Teams user account is removed from Microsoft Teams, the linked Mattermost user account is also removed the next time user accounts are synchronized. Once you've connected your Mattermost account to your Microsoft Teams account, you’re ready to collaborate across your organization, regardless of which tool you’re in. You have two ways to collaborate: @@ -50,11 +50,11 @@ Collaborating through linked channels starts with a Mattermost admin linking a M Link channels ~~~~~~~~~~~~~~ -As a Mattermost channel admin, team admin, or system admin, run the following slash command in the channel you want to link: ``/msteams-sync link``, then select the Microsoft Teams team and channel identifiers you want to link the current Mattermost channel to. Mattermost notifies you when the linking is complete or if the channel is already linked. +As a Mattermost channel admin, team admin, or system admin, run the following slash command in the channel you want to link: ``/msteams link``, then select the Microsoft Teams team and channel identifiers you want to link the current Mattermost channel to. Mattermost notifies you when the linking is complete or if the channel is already linked. .. tip:: - Want to change an existing link? Unlink a current Mattermost channel using the ``/msteams-sync unlink`` slash command, then relink to a new Microsoft Teams channel as needed. + Want to change an existing link? Unlink a current Mattermost channel using the ``/msteams unlink`` slash command, then relink to a new Microsoft Teams channel as needed. Collaborate with colleagues ~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/configure/plugins-configuration-settings.rst b/source/configure/plugins-configuration-settings.rst index 0bf3b249d0f..52cda7e446c 100644 --- a/source/configure/plugins-configuration-settings.rst +++ b/source/configure/plugins-configuration-settings.rst @@ -10,7 +10,7 @@ Both self-hosted and Cloud admins can access the following configuration setting - `Apps <#apps>`__ - `Calls <#calls>`__ - `Google Calendar <#google-calendar>`__ -- `MS Teams Sync <#ms-teams-sync>`__ +- `MS Teams <#ms-teams>`__ - `Playbooks <#playbooks>`__ - `User Satisfaction surveys <#user-satisfaction-surveys>`__ - `Zoom <#zoom>`__ @@ -952,45 +952,45 @@ Google client secret ---- -MS Teams Sync -------------- +MS Teams +-------- .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: 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 Sync**. +Access the following configuration settings in the System Console by going to **Plugins > MS Teams**. .. include:: ../_static/badges/academy-msteams.rst :start-after: :nosearch: -.. config:setting:: plugins-msteamssyncenable - :displayname: Enable plugin (Plugins - MS Teams Sync) - :systemconsole: Plugins > MS Teams Sync +.. config:setting:: plugins-msteamsenable + :displayname: Enable plugin (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A - - **true**: Enables the MS Teams Sync plugin on your Mattermost workspace. - - **false**: Disables the MS Teams Sync plugin on your Mattermost workspace. + - **true**: Enables the MS Teams plugin on your Mattermost workspace. + - **false**: Disables the MS Teams plugin on your Mattermost workspace. Enable plugin ~~~~~~~~~~~~~ +------------------------------------------------------------------------+----------------------------------------------------+ -| Enable the Mattermost for Microsoft Teams plugin for all Mattermost | - System Config path: **Plugins > MS Teams Sync** | +| Enable the Mattermost for Microsoft Teams plugin for all Mattermost | - System Config path: **Plugins > MS Teams** | | teams. | - ``config.json`` setting: N/A | | | - Environment variable: N/A | -| - **true**: Enables MS Teams Sync plugin on your Mattermost workspace. | | -| - **false**: **(Default)** Disables the MS Teams Sync 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. | +------------------------------------------------------------------------+----------------------------------------------------+ -.. config:setting:: plugins-msteamssynctenantid - :displayname: Tenant ID (Plugins - MS Teams Sync) - :systemconsole: Plugins > MS Teams Sync +.. config:setting:: plugins-msteamstenantid + :displayname: Tenant ID (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A :description: Specify the Microsoft Teams Tenant ID. @@ -999,14 +999,14 @@ Tenant ID ~~~~~~~~~~ +------------------------------------------------------------------------+---------------------------------------------------+ -| Specify the Microsoft Teams Tenant ID. | - System Config path: **Plugins > MS Teams Sync** | +| Specify the Microsoft Teams Tenant ID. | - System Config path: **Plugins > MS Teams** | | | - ``config.json`` setting: N/A | | | - Environment variable: N/A | +------------------------------------------------------------------------+---------------------------------------------------+ -.. config:setting:: plugins-msteamssyncclientid - :displayname: Client ID (Plugins - MS Teams Sync) - :systemconsole: Plugins > MS Teams Sync +.. config:setting:: plugins-msteamsclientid + :displayname: Client ID (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A :description: Specify the Microsoft Teams Client ID. @@ -1015,14 +1015,14 @@ Client ID ~~~~~~~~~ +------------------------------------------------------------------------+---------------------------------------------------+ -| Specify the Microsoft Teams Client ID. | - System Config path: **Plugins > MS Teams Sync** | +| Specify the Microsoft Teams Client ID. | - System Config path: **Plugins > MS Teams** | | | - ``config.json`` setting: N/A | | | - Environment variable: N/A | +------------------------------------------------------------------------+---------------------------------------------------+ -.. config:setting:: plugins-msteamssyncclientsecret - :displayname: Client secret (Plugins - MS Teams Sync) - :systemconsole: Plugins > MS Teams Sync +.. config:setting:: plugins-msteamsclientsecret + :displayname: Client secret (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A :description: Specify the Microsoft Teams Client Secret. @@ -1031,14 +1031,14 @@ Client secret ~~~~~~~~~~~~~~ +------------------------------------------------------------------------+---------------------------------------------------+ -| Specify the Microsoft Teams Client Secret. | - System Config path: **Plugins > MS Teams Sync** | +| Specify the Microsoft Teams Client Secret. | - System Config path: **Plugins > MS Teams** | | | - ``config.json`` setting: N/A | | Alpha-numeric value. | - Environment variable: N/A | +------------------------------------------------------------------------+---------------------------------------------------+ -.. config:setting:: plugins-msteamssyncgenerateatrestencryptionkey - :displayname: At rest encryption key (Plugins - MS Teams Sync) - :systemconsole: Plugins > MS Teams Sync +.. config:setting:: plugins-msteamsgenerateatrestencryptionkey + :displayname: At rest encryption key (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A :description: Generate the AES encryption key used to encrypt sotred access tokens. @@ -1047,16 +1047,16 @@ At rest encryption key ~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------------------------------------------+---------------------------------------------------+ -| Generate the AES encryption key used to encrypt sotred access tokens. | - System Config path: **Plugins > MS Teams Sync** | +| Generate the AES encryption key used to encrypt sotred access tokens. | - System Config path: **Plugins > MS Teams** | | | - ``config.json`` setting: N/A | | Alpha-numeric value. | - Environment variable: N/A | +------------------------------------------------------------------------+---------------------------------------------------+ | **Note**: Select **Regenerate** to generate a new key. | +------------------------------------------------------------------------+---------------------------------------------------+ -.. config:setting:: plugins-msteamssyncgeneratewebhooksecret - :displayname: Webhook secret (Plugins - MS Teams Sync) - :systemconsole: Plugins > MS Teams Sync +.. config:setting:: plugins-msteamsgeneratewebhooksecret + :displayname: Webhook secret (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A :description: Generate the webhook secret that Microsoft Teams will use to send messages to Mattermost. @@ -1065,16 +1065,16 @@ Webhook secret ~~~~~~~~~~~~~~~ +------------------------------------------------------------------------+---------------------------------------------------+ -| Generate the webhook secret that Microsoft Teams will use to send | - System Config path: **Plugins > MS Teams Sync** | +| Generate the webhook secret that Microsoft Teams will use to send | - System Config path: **Plugins > MS Teams** | | messages to Mattermost. | - ``config.json`` setting: N/A | | | - Environment variable: N/A | +------------------------------------------------------------------------+---------------------------------------------------+ | **Note**: Select **Regenerate** to generate a new key. | +------------------------------------------------------------------------+---------------------------------------------------+ -.. config:setting:: plugins-msteamssyncuseevaluationapipaymodel - :displayname: Use the evaluation API pay model (Plugins - MS Teams Sync) - :systemconsole: Plugins > MS Teams Sync +.. config:setting:: plugins-msteamsuseevaluationapipaymodel + :displayname: Use the evaluation API pay model (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A @@ -1085,16 +1085,16 @@ Use the evaluation API pay model ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------------------------------------------+---------------------------------------------------+ -| Enable the evaluation API pay model to receive a limited number of | - System Config path: **Plugins > MS Teams Sync** | +| Enable the evaluation API pay model to receive a limited number of | - System Config path: **Plugins > MS Teams** | | change notifications. Ensure you keep the number of notifications low. | - ``config.json`` setting: N/A | | | - Environment variable: N/A | | - **true**: Enables the evaluation API pay model. | | | - **false**: **(Default)** Disables the evaluation API pay model. | | +------------------------------------------------------------------------+---------------------------------------------------+ -.. config:setting:: plugins-msteamssyncenforceconnectedaccounts - :displayname: Enforce connected accounts (Plugins - MS Teams Sync) - :systemconsole: Plugins > MS Teams Sync +.. config:setting:: plugins-msteamsenforceconnectedaccounts + :displayname: Enforce connected accounts (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A @@ -1105,7 +1105,7 @@ Enforce connected accounts ~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------------------------------------------+---------------------------------------------------+ -| Requires all users to connect their Mattermost account to their | - System Config path: **Plugins > MS Teams Sync** | +| Requires all users to connect their Mattermost account to their | - System Config path: **Plugins > MS Teams** | | Microsoft Teams account, if the accounts aren't already connected. | - ``config.json`` setting: N/A | | | - Environment variable: N/A | | - **true**: Users are required to connect their Mattermost and | | @@ -1115,9 +1115,9 @@ Enforce connected accounts | Mattermost and Microsoft Teams accounts. | | +------------------------------------------------------------------------+---------------------------------------------------+ -.. config:setting:: plugins-msteamssyncallowtempskipconnectuser - :displayname: Allow to temporarily skip connect user (Plugins - MS Teams Sync) - :systemconsole: Plugins > MS Teams Sync +.. config:setting:: plugins-msteamsallowtempskipconnectuser + :displayname: Allow to temporarily skip connect user (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A @@ -1128,7 +1128,7 @@ Allow to temporarily skip connect user ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------------------------------------------+---------------------------------------------------+ -| Allow users to temporarily dismiss the prompt to connect their | - System Config path: **Plugins > MS Teams Sync** | +| Allow users to temporarily dismiss the prompt to connect their | - System Config path: **Plugins > MS Teams** | | Mattermost account to their Microsoft Teams account. Users will | - ``config.json`` setting: N/A | | continue to be prompted when they refresh the browser, refresh the | - Environment variable: N/A | | desktop app, or log in to Mattermost. | | @@ -1139,9 +1139,9 @@ Allow to temporarily skip connect user | connect their Mattermost and Microsoft Teams accounts. | | +------------------------------------------------------------------------+---------------------------------------------------+ -.. config:setting:: plugins-msteamssyncsyncusers - :displayname: Sync users (Plugins - MS Teams Sync) - :systemconsole: Plugins > MS Teams Sync +.. config:setting:: plugins-msteamssyncusers + :displayname: Skip users (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A :description: Specify how often, in minutes, to synchronize direct messages, group messages, and chats, between Mattermost and Microsoft Teams users. Leave blank to disable user synchronization. @@ -1150,7 +1150,7 @@ Sync users ~~~~~~~~~~ +------------------------------------------------------------------------+---------------------------------------------------+ -| Specify how often, in minutes, to synchronize direct messages, | - System Config path: **Plugins > MS Teams Sync** | +| Specify how often, in minutes, to synchronize direct messages, | - System Config path: **Plugins > MS Teams** | | group messages, and chats, between Mattermost and Microsoft Teams | - ``config.json`` setting: N/A | | users. | - Environment variable: N/A | | | | @@ -1159,8 +1159,8 @@ Sync users +------------------------------------------------------------------------+---------------------------------------------------+ .. config:setting:: plugins-msteamssyncguestusers - :displayname: Sync guest users (Plugins - MS Teams Connect) - :systemconsole: Plugins > MS Teams Connect + :displayname: Synchronize users (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A @@ -1171,7 +1171,7 @@ Sync guest users ~~~~~~~~~~~~~~~~ +------------------------------------------------------------------------+------------------------------------------------------+ -| Synchronize Microsoft Teams guest users and Mattermost users. | - System Config path: **Plugins > MS Teams Connect** | +| Synchronize Microsoft Teams guest users and Mattermost users. | - System Config path: **Plugins > MS Teams** | | | - ``config.json`` setting: N/A | | - **true**: Mattermost includes Microsoft Teams guest users when | - Environment variable: N/A | | synchronizing. | | @@ -1179,11 +1179,20 @@ Sync guest users | guest users when synchronizing. | | +------------------------------------------------------------------------+------------------------------------------------------+ +.. config:setting:: plugins-msteamssyncdirectgroupmessages + :displayname: Synchronize guest users (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams + :configjson: N/A + :environment: N/A + + - **true**: Mattermost synchronizes direct messages, group messages, and chats between Mattermost and Microsoft Teams. + - **false**: Mattermost doesn't synchronize messages and chats. + Sync direct and group messages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------------------------------------------+----------------------------------------------------+ -| Synchronize direct messages, group messages, and chats between | - System Config path: **Plugins > MS Teams Sync** | +| Synchronize direct messages, group messages, and chats between | - System Config path: **Plugins > MS Teams** | | Mattermost and Microsoft Teams users. | - ``config.json`` setting: N/A | | | - Environment variable: N/A | | - **true**: **(Default)** Mattermost synchronizes direct messages, | | @@ -1191,9 +1200,9 @@ Sync direct and group messages | - **false**: Mattermost doesn't synchronize messages and chats. | | +------------------------------------------------------------------------+----------------------------------------------------+ -.. config:setting:: plugins-msteamssyncenabledteams - :displayname: Enabled teams (Plugins - MS Teams Sync) - :systemconsole: Plugins > MS Teams Sync +.. config:setting:: plugins-msteamsenabledteams + :displayname: Enabled teams (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A :description: Specify which Mattermost teams synchronize direct messages, group messages, and chats with Microsoft Teams. @@ -1202,16 +1211,16 @@ Enabled teams ~~~~~~~~~~~~~ +------------------------------------------------------------------------+----------------------------------------------------+ -| Specify which Mattermost teams synchronize direct messages, group | - System Config path: **Plugins > MS Teams Sync** | +| Specify which Mattermost teams synchronize direct messages, group | - System Config path: **Plugins > MS Teams** | | messages, and chats with Microsoft Teams. | - ``config.json`` setting: N/A | | | - Environment variable: N/A | | Separate multiple team names with commas. Leave this value blank to | | | synchronize all Mattermost teams. | | +------------------------------------------------------------------------+----------------------------------------------------+ -.. config:setting:: plugins-msteamssyncpromptinterval - :displayname: Sync users (Plugins - MS Teams Connect) - :systemconsole: Plugins > MS Teams Connect +.. config:setting:: plugins-msteamspromptinterval + :displayname: Prompt interval for DMs and GMs (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A :description: Specify how often, in hours, to prompt users to connect their Microsoft Teams user account to their Mattermost user account. @@ -1220,16 +1229,16 @@ Prompt interval for DMs and GMs ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------------------------------------------+------------------------------------------------------+ -| Specify how often, in hours, to prompt users to connect their | - System Config path: **Plugins > MS Teams Connect** | +| Specify how often, in hours, to prompt users to connect their | - System Config path: **Plugins > MS Teams** | | Microsoft Teams user account to their Mattermost user account. | - ``config.json`` setting: N/A | | | - Environment variable: N/A | | Leave this value blank to disble the prompt. | | | Numerical value. | | +------------------------------------------------------------------------+------------------------------------------------------+ -.. config:setting:: plugins-msteamssyncmaxsizeattachments - :displayname: Maximum size of attachments to support complete one time download (Plugins - MS Teams Connect) - :systemconsole: Plugins > MS Teams Connect +.. config:setting:: plugins-msteamsmaxsizeattachments + :displayname: Maximum size of attachments to support complete one time download (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A :description: 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. @@ -1238,16 +1247,16 @@ Maximum size of attachments to support complete one time download ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------------------------------------------------+----------------------------------------------------------+ -| Specify the maximum file size, in megabytes (MB), of attachments | - System Config path: **Plugins > MS Teams Connect** | +| Specify the maximum file size, in megabytes (MB), of attachments | - System Config path: **Plugins > MS Teams** | | that can be loaded into memory. Attachment files larger than | - ``config.json`` setting: N/A | | this value will be streamed from Microsoft Teams to Mattermost. | - Environment variable: N/A | | | | | Numerical value. Default is **20** MB. | | +--------------------------------------------------------------------+----------------------------------------------------------+ -.. config:setting:: plugins-msteamssyncbuffer - :displayname: Buffer size for streaming files (Plugins - MS Teams Connect) - :systemconsole: Plugins > MS Teams Connect +.. config:setting:: plugins-msteamsbuffer + :displayname: Buffer size for streaming files (Plugins - MS Teams) + :systemconsole: Plugins > MS Teams :configjson: N/A :environment: N/A :description: Specify the buffer size, in megabytes (MB), for streaming attachment files from Microsoft Teams to Mattermost. @@ -1256,7 +1265,7 @@ Buffer size for streaming files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------------------------------------------------+----------------------------------------------------------+ -| Specify the buffer size, in megabytes (MB), for streaming | - System Config path: **Plugins > MS Teams Connect** | +| Specify the buffer size, in megabytes (MB), for streaming | - System Config path: **Plugins > MS Teams** | | attachment files from Microsoft Teams to Mattermost. | - ``config.json`` setting: N/A | | | - Environment variable: N/A | | Numerical value. Default is **20** MB. | |