Mattermost MS Teams Plugin

Table of Contents

• License
• Overview
• Features
• Installation
• Setup
• Connecting to MS Teams
• FAQs

Overview

This plugin integrates MS Teams with Mattermost by providing automated syncing of messages from Mattermost to MS Teams and vice versa. For a stable production release, please download the latest version from the Plugin Marketplace and follow the instructions to install and configure the plugin. If you are a developer who wants to work on this plugin, please switch to the Developer docs.

Features

This plugin supports the following features:

• Connect to MS Teams account using the OAuth2 flow.

• Link Mattermost channels with MS Teams channels and sync messages between the linked channels.

• Link Mattermost DMs and group messages with Teams chats and sync messages.

• Sync Mattermost and MS Teams messages for any changes made in any existing messages on either side.

• Deletion of MS Teams messages is synced with Mattermost but it's not vice versa.

• Sync posts containing markdown and attachments.

  

• Sync reactions on posts.

Installation

These installation instructions assume you already have a Mattermost instance running PostgreSQL. Note that this plugin does not support MySQL.

1. Go to the releases page of this GitHub repository and download the latest release for your Mattermost server: https://github.com/mattermost/mattermost-plugin-msteams/releases
2. Upload this file on the Mattermost System Console > Plugins > Management page to install the plugin. To learn more about how to upload a plugin, see the documentation.
3. Enable the plugin from System Console > Plugins > MS Teams.

Setup

• Microsoft Azure Setup
• Plugin Setup

Connecting to MS Teams

There are two methods by which you can connect your Mattermost account to your MS Teams account.

• Using slash command

  • Run the slash command /msteams connect in any channel.

  • You will get an ephemeral message from the MS Teams bot containing a link to connect your account.

  • Click on that link. If it asks for login, enter your Microsoft credentials to connect your account.

• Using the button in the full screen modal

  • If the setting "Enforce connected accounts" is enabled in the plugin's config settings, then a full screen modal appears that looks like this -

  

  • Click on the "Connect account" button.

  • A window appears containing a link to connect your account.

  • Open that link. If it asks for login, enter your Microsoft credentials to connect your account.

• Connecting the bot account

  • Run the slash command /msteams connect-bot in any channel.
  • This command is visible and accessible by system admins only.
  • After running the slash command, you will get an ephemeral message from the MS Teams bot containing a link to connect the bot account.
  • Click on that link. If it asks for login, enter the Microsoft credentials for the dummy account created following these steps.
  • Refer here for more details.

Slash commands

• /msteams connect :- This is used to connect your Mattermost account to MS Teams account.
• /msteams disconnect :- This is used to disconnect your Mattermost account from MS Teams account.
• /msteams link :- This is used to link the currently active Mattermost channel with an MS Teams channel and it can only be run by users who are channel admins and above. To run this command, you must have your Mattermost account connected with MS Teams. This command takes two arguments - MS Teams team ID and channel ID which you can get from command autocomplete.
• /msteams unlink :- This is used to unlink the currently active Mattermost channel with the MS Teams channel and it can only be run by users who are channel admins and above. To run this command, you don't need to have your Mattermost account connected to MS Teams.
• /msteams show :- This is used to show the link of the currently active Mattermost channel. It displays the team name and channel name of MS Teams to which the currently active MM channel is linked.

System admins only

• /msteams connect-bot :- This is used to connect the bot account in Mattermost to an account in MS Teams and it can only be run by system admins.
• /msteams disconnect-bot :- This is used to disconnect the bot account in Mattermost from the MS Teams account and it can only be run by system admins.
• /msteams show-links :- This is used to show all the currently active links and can only be run by system admins. It displays all the links that contain Mattermost team, Mattermost channel, MS Teams team, MS Teams channel.
• /msteams promote :- This is used to promote a synthetic user to a normal user and can only be run by system admins. This command takes two parameters i.e. current_username and the new_username. The promoted user must reset their password or request assistance from the administrator in order to log in to Mattermost. Note that after promoting the user, he will be counted under the Mattermost license.

FAQs

- Read about the FAQs [here](./docs/faqs.md)

License

This repository is licensed under the Mattermost Source Available License and requires a valid Enterprise Edition License when used for production. See frequently asked questions to learn more.

Although a valid Mattermost Enterprise Edition License is required if using this plugin in production, the Mattermost Source Available License allows you to compile and test this plugin in development and testing environments without a Mattermost Enterprise Edition License. As such, we welcome community contributions to this plugin.

If you're running an Enterprise Edition of Mattermost and don't already have a valid license, you can obtain a trial license from System Console > Edition and License. If you're running the Team Edition of Mattermost, including when you run the server directly from source, you may instead configure your server to enable both testing (ServiceSettings.EnableTesting) and developer mode (ServiceSettings.EnableDeveloper). These settings are not recommended in production environments.