Skip to content

Commit

Permalink
Merge branch 'master' into amyblais-patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
amyblais authored Jul 24, 2023
2 parents b0f1c86 + 82d0608 commit e559e64
Show file tree
Hide file tree
Showing 12 changed files with 261 additions and 119 deletions.
4 changes: 2 additions & 2 deletions source/about/editions-and-offerings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ For customers using our service in a self-hosted deployment, the Mattermost Free

The Mattermost Professional and Mattermost Enterprise editions are only available after deploying our Mattermost Enterprise Edition code base, and then applying a valid license key that comes with a subscription purchase, or by starting a 30-day free trial that can be activated either in-product (**System Console > Edition and License > Start trial**) or online at https://mattermost.com/trial/.

Mattermost Free
---------------
Mattermost Free (Self-Hosted only)
---------------------------------------------

Mattermost Free is a set of collaboration features for accelerating your technical team’s productivity, shipping software faster with higher quality, and improving alignment among team members.

Expand Down
63 changes: 45 additions & 18 deletions source/about/install-mattermost-app-in-microsoft-teams.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ Install the Mattermost App in Microsoft Teams
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

.. note::
With `Mattermost for Microsoft Teams </about/mattermost-for-microsoft-teams.html>`__, you can embed your Mattermost workspace within your Microsoft Teams instance and take advantage of `embedded app features <#benefits-of-the-embedded-app>`_.

You must `install the Microsoft Teams plugin in Mattermost </plugins/install-mattermost-for-microsoft-teams-plugin>`__ before you can install the Mattermost app in Microsoft Teams.
.. important::

You must `install the Microsoft Teams plugin in Mattermost </plugins/install-mattermost-for-microsoft-teams-plugin>`__ before you can embed the Mattermost app within Microsoft Teams.

To install the Mattermost app in Microsoft Teams:

1. In Mattermost, as an administrator, go to System Console > Plugins > Mattermost for Microsoft 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.
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.
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.

Expand All @@ -20,27 +22,52 @@ Pin the Mattermost app in Microsoft Teams
------------------------------------------

1. Add the Mattermost app by selecting **Apps** within the left-hand sidebar, select **Add** located next to the Mattermost for Microsoft Teams app, then select **Add** again. Once added, your Mattermost workspace is now embedded in your Microsoft Teams instance.
2. Pin the Mattermost app in your left-hand sidebar to access it easily in the future, by right-clicking the Mattermost tab and selecting **Pin**.
3. Sign in with your email/password credentials, and use the Mattermost app to collaborate with technical and operations teams.
2. Pin the Mattermost app in your left-hand sidebar, to access it easily in the future, by right-clicking the Mattermost tab and selecting **Pin**.
3. Sign in with your credentials, and use the Mattermost app to collaborate with technical and operations teams.

Demonstration: Embed Mattermost within Microsoft Teams
-------------------------------------------------------

Check out this `YouTube demo <https://youtu.be/MxegqqfErEg>`__, from Doug Lauder, Senior Software Design Engineer at Mattermost, to learn how to embed Mattermost within Microsoft Teams:

.. raw:: html

<iframe width="560" height="315" src="https://www.youtube.com/embed/MxegqqfErEg" alt="Install the Mattermost app in Microsoft Teams" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>


Get users started with the embedded app
----------------------------------------

See our end user documentation for a `video walkthrough of using Mattermost embedded within Microsoft Teams </channels/collaborate-using-mattermost-for-microsoft-teams.html#demonstration-mattermost-embedded-in-microsoft-teams>`__.

Benefits of the embedded app
----------------------------

- **Improved reaction time in the event of an incident** by accessing alerting features in Mattermost directly from within Microsoft Teams.

Mattermost is open-source and can be extensively customized to integrate with various system monitoring and alerting tools. If your tech team has set up unique alerting features in Mattermost, use the app to access these directly from within Teams, including system status updates, improving reaction time in the event of an incident.

- **Simplified workflows through a single interface** for communication and DevOps management.

If your technical team uses specific DevOps tools (such as Jenkins, Jira, GitHub, etc.) that are tightly integrated with Mattermost, embedding Mattermost in Teams can give direct access to these integrated services. This simplifies workflows by providing a single interface for DevOps use cases.

- **Quickly run scripts within Microsoft Teams**.

Mattermost supports the use of a CLI, which can be a major advantage for tech teams. If you need to run scripts or execute commands via Mattermost, embedding it within Teams allows you to use this functionality from either platform.

- **Embed custom functionality to accelerate technical workflows**.

If your tech team has created custom bots and plugins that function with Mattermost, embedding it within Microsoft Teams will allow everyone to access these utilities. These may include custom bots for streamlining incident management, security operations and red/blue team workflows.

Limitations
------------

The Mattermost app currently only supports email/password log in to the Mattermost workspace. SSO authentication with SAML 2.0 providers (Okta, OneLogin, Microsoft ADFS) and with your Microsoft365 account are under consideration.
The embedded Mattermost app currently only supports email/password log in to the Mattermost workspace. SSO authentication with SAML 2.0 providers (Okta, OneLogin, Microsoft ADFS) and with your Microsoft365 account are under consideration.

Troubleshooting
----------------
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 <https://github.com/mattermost/mattermost-plugin-msteams-sync/issues/new>`__.
- Or, create a new topic in our `peer-to-peer troubleshooting forum <https://forum.mattermost.com/c/trouble-shoot/16>`__.

Demonstration
--------------

Check out this `YouTube demo <https://youtu.be/MxegqqfErEg>`__, from Doug Lauder, Senior Software Design Engineer at Mattermost, to get started with Mattermost for Microsoft Teams:

.. raw:: html

<iframe width="560" height="315" src="https://www.youtube.com/embed/MxegqqfErEg" alt="Install the Mattermost app in Microsoft Teams" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
- Or, create a new topic in our `peer-to-peer troubleshooting forum <https://forum.mattermost.com/c/trouble-shoot/16>`__.
37 changes: 29 additions & 8 deletions source/about/install-mattermost-for-microsoft-teams-plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,47 @@ Install the Mattermost for Microsoft Teams plugin
To install the `Mattermost for Microsoft Teams </plugins/mattermost-for-microsoft-teams>`__ plugin in Mattermost:

1. Log in to your Mattermost workspace as a system administrator.
2. Download the `latest plugin binary release <https://github.com/mattermost/mattermost-plugin-msteams-sync/releases>`__, compatible with Mattermost v8.0.1 and later.
2. Download version v0.3.9 of `the plugin binary release <https://github.com/mattermost/mattermost-plugin-msteams-sync/releases>`__, compatible with Mattermost v8.0.1 and later.

.. tip::

If you are using an earlier version of Mattermost, `follow our documentation </upgrade/upgrading-mattermost-server.html>`__ 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 > Installed Plugins**, search for ``MS Teams Sync``, and select **Enable Plugin**.
4. Go to **System Console > Plugins > Plugin Management**. In the **Installed Plugins** section, scroll to **MS Teams Sync**, and select **Enable Plugin**.

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**.
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 `MS Teams Sync plugin configuration settings </configure/plugins-configuration-settings.html#ms-teams-sync>`__ documentation for details.

Demonstration
--------------
Get started with the plugin
---------------------------

See our `collaborate using Mattermost for MS Teams </channels/collaborate-using-mattermost-for-microsoft-teams>`__ documentation for details on how to collaborate across both Mattermost and Microsoft Teams at the same time.

Troubleshooting
---------------

If you encounter issues when connecting user accounts or linking channels, we recommend restarting 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**.
3. Select **Enable** and wait for the State to change to **Running**.

Check out this `YouTube demo <https://youtu.be/Mg-stF7_Bjk>`__, from Doug Lauder, Senior Software Design Engineer at Mattermost, to learn how to embed Mattermost in Microsoft Teams:
Get help
---------

.. raw:: html

<iframe width="560" height="315" src="https://www.youtube.com/embed/Mg-stF7_Bjk" alt="Install Matterrmost for Microsoft Teams plugin" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
If you face any issues while installing the Mattermost for Microsoft Teams sync plugin, you can either:

- Open a new issue in the `Mattermost for Microsoft Teams GitHub repository <https://github.com/mattermost/mattermost-plugin-msteams-sync/issues/new>`__.
- Or, create a new topic in our `peer-to-peer troubleshooting forum <https://forum.mattermost.com/c/trouble-shoot/16>`__.
17 changes: 0 additions & 17 deletions source/about/mattermost-for-microsoft-teams.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,4 @@ See the following product documentation to install and use Mattermost for Micros
- `Install the Mattermost app in Microsoft Teams </about/install-mattermost-app-in-microsoft-teams.html>`__
- `Collaborate using Mattermost for Microsoft Teams </channels/collaborate-using-mattermost-for-microsoft-teams.html>`__

Additional integration features include:

- **Improved reaction time in the event of an incident** by accessing alerting features in Mattermost directly from within Teams.

Mattermost is open-source and can be extensively customized to integrate with various system monitoring and alerting tools. If your tech team has set up unique alerting features in Mattermost, use the app to access these directly from within Teams, including system status updates, improving reaction time in the event of an incident.

- **Simplified workflows through a single interface** for communication and DevOps management.

If your technical team uses specific DevOps tools (such as Jenkins, Jira, GitHub, etc.) that are tightly integrated with Mattermost, embedding Mattermost in Teams can give direct access to these integrated services. This simplifies workflows by providing a single interface for DevOps use cases.

- The ability to **quickly run scripts within Microsoft Teams**.

Mattermost supports the use of a CLI, which can be a major advantage for tech teams. If you need to run scripts or execute commands via Mattermost, embedding it within Teams allows you to use this functionality from either platform.

- The ability to **embed custom functionality to accelerate technical workflows**.

If your tech team has created custom bots and plugins that function with Mattermost, embedding it within Teams will allow everyone to access these utilities. These may include custom bots for streamlining incident management, security operations and red/blue team workflows.

Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,75 @@ Collaborate using Mattermost for 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.
.. |plus-icon| image:: ../images/plus_F0415.svg
:alt: Open menus using the plus icon.

Join us on `Mattermost Academy <https://academy.mattermost.com/>`__ to enroll in the `Mattermost for Microsoft Teams <https://academy.mattermost.com/p/mattermost-for-microsoft-teams>`__ training course where you'll learn how to start collaborating with colleagues across both systems.
`Mattermost for Microsoft Teams </about/mattermost-for-microsoft-teams.html>`__ enables you to collaborate with technical & operations teams seamlessly through the Mattermost app, without leaving Microsoft Teams.

Join us on `Mattermost Academy <https://academy.mattermost.com/>`__ to enroll in the `Mattermost for Microsoft Teams <https://academy.mattermost.com/p/mattermost-for-microsoft-teams>`__ training course where you'll learn how to start collaborating with colleagues across both systems.

Connect your Mattermost account to your MS Teams account
---------------------------------------------------------

To use the Mattermost for Microsoft Teams plugin, you must connect your Mattermost user account to Microsoft Teams. You only need to complete this step once.

1. Log into Mattermost using your credentials.
2. When you log in, you’ll be prompted to enter your Microsoft Teams user information, including your Microsoft Teams email address and your Microsoft Teams password.

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 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:

- `Through direct and group messages <#collaborate-through-messages>`_
- `Through linked channels <#collaborate-through-linked-channels>`_

Collaborate through messages
----------------------------

You can start a direct or group message between Mattermost and Microsoft Teams users unless your Mattermost administrator has `disabled the ability to do so in the System Console </configure/plugins-configuration-settings.html#sync-direct-and-group-messages>`__.

- Within Mattermost select the |plus-icon| icon next to **Direct Messages** in the left pane, then search for the user you want to message. Your direct or group conversation is visible in both Mattermost and Microsoft Teams.

- Within Microsoft Teams, select **Chat > New chat**, and select the users you want to chat with. Your conversation is visible in both Mattermost and Microsoft Teams for all users who have connected their Mattermost user account to their Microsoft Teams user account.

Collaborate through linked channels
------------------------------------

Collaborating through linked channels starts with a Mattermost admin linking a Mattermost public or private channel to a Microsot Teams channel.

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.

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

Collaborate with colleagues
~~~~~~~~~~~~~~~~~~~~~~~~~~~

You have many ways to collaborate with colleagues in linked channels using a web browser or the Mattermost desktop app, including:

- `Send messages </channels/send-messages.html>`__ and `reply to messages <https://docs.mattermost.com/channels/reply-to-messages.html>`__
- `Attach files to messages </channels/share-files-in-messages.html>`__
- `Express yourself with emojis </channels/react-to-messages.html>`__
- `Share complex systems data and formatted code </channels/format-messages.html>`__
- `Edit or delete sent messages </channels/send-messages.html#edit-or-delete-messages>`__

No matter which tool you use, your message is visible across both Mattermost and Microsoft Teams.

Demonstration: Mattermost embedded in Microsoft Teams
------------------------------------------------------

Check out this `YouTube demo <https://youtu.be/Mg-stF7_Bjk>`__, from Doug Lauder, Senior Software Design Engineer at Mattermost, to learn more about using the embedded Mattermost instance within Microsoft Teams:

.. raw:: html

<iframe width="560" height="315" src="https://www.youtube.com/embed/Mg-stF7_Bjk" alt="Install Matterrmost for Microsoft Teams plugin" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
1 change: 0 additions & 1 deletion source/channels/organize-conversations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,3 @@ In particular, please be aware of these important known issues and risks:
- You may experience lag in your desktop or web client if you're following many threads or opening threads with many replies.
- Server performance for instances with many users and posts may be impacted.
- You should expect to see more unread channels and notifications on your mobile device than you'll see on your desktop instance of Mattermost. This is expected when running a mobile app release older than v1.46.
- For a comprehensive list of known issues, and to see our work queue in priority order, check out our `Kanban board <https://mattermost.atlassian.net/secure/RapidBoard.jspa?rapidView=91&quickFilter=499>`__.
Loading

0 comments on commit e559e64

Please sign in to comment.