Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc'd prepkg'd plugin install paths & cloud-available list #7387

Merged
merged 2 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion source/about/cloud-dedicated.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,10 @@ Mattermost Cloud Dedicated provides access to :doc:`audit and system logs </mana
Customization
~~~~~~~~~~~~~~

Approved plugins developed and/or tested by Mattermost are supported and available in the `Mattermost Marketplace <https://mattermost.com/marketplace/>`_. See the :ref:`plugins <about/integrations:plugins>` documentation for details on supported plugins in Mattermost Cloud deployments.
Approved plugins developed and/or tested by Mattermost are supported and available in the `Mattermost Cloud Marketplace <https://mattermost.com/marketplace/>`_, including:

.. include:: ./cloud-supported-integrations.rst
:start-after: :nosearch:

Migrate from a self-hosted instance
------------------------------------
Expand Down
7 changes: 6 additions & 1 deletion source/about/cloud-shared.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,12 @@ Mattermost Cloud Dedicated provides access to :doc:`audit and system logs </mana
Customization
~~~~~~~~~~~~~~

Approved plugins developed and/or tested by Mattermost are supported and available in the `Mattermost Marketplace <https://mattermost.com/marketplace/>`_. Custom plugins and integrations outside of Mattermost Marketplace aren’t currently supported. See the :ref:`plugins <about/integrations:plugins>` documentation for details on supported plugins in Mattermost Cloud deployments.
Approved plugins developed and/or tested by Mattermost are supported and available in the `Mattermost Cloud Marketplace <https://mattermost.com/marketplace/>`_, including:

.. include:: ./cloud-supported-integrations.rst
:start-after: :nosearch:

Custom plugins and integrations outside of Mattermost Marketplace aren’t currently supported.

Migrate from a self-hosted instance
------------------------------------
Expand Down
16 changes: 16 additions & 0 deletions source/about/cloud-supported-integrations.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
:orphan:
:nosearch:

- :ref:`Mattermost Calls <configure/plugins-configuration-settings:calls>`
- :doc:`Mattermost Copilot </configure/enable-copilot>`
- :doc:`Mattermost for Microsoft Teams </integrate/microsoft-teams-interoperability>` interoperability
- :doc:`Mattermost Playbooks </guides/repeatable-processes>`
- :doc:`Microsoft Calendar </integrate/microsoft-calendar-interoperability>` interoperability
- :doc:`Microsoft Teams Meetings </integrate/microsoft-teams-meetings-interoperability>` interoperability
- :doc:`GitHub </integrate/github-interoperability>` interoperability
- :doc:`GitLab </integrate/gitlab-interoperability>` interoperability
- :doc:`Jira </integrate/jira-interoperability>` interoperability
- :doc:`ServiceNow </integrate/servicenow-interoperability>` interoperability
- :doc:`User Survey </configure/manage-user-surveys>` integration
- :doc:`User satisfaction surveys </manage/user-satisfaction-surveys>`
- :doc:`Zoom </integrate/zoom-interoperability>`
31 changes: 16 additions & 15 deletions source/about/integrations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Integrations overview

Mattermost provides a variety of methods to add functionality and customize the end-user experience to suit your organization’s needs, whether you want to add new user capabilities with slash commands, build an advanced chatbot, or completely change the functionality of your server.

A wide array of open source integrations are available and ready to use from Mattermost and our community. To see a list of open source integrations please see the `Mattermost Marketplace <https://mattermost.com/marketplace/>`__.
A wide array of open source integrations are available and ready to use from Mattermost and our community. To see a list of open source integrations please see the `Mattermost Marketplace <https://mattermost.com/marketplace/>`_.

For self-hosted deployments in small setups, you might host integrations on the same server on which Mattermost is installed. For larger deployments, you can set up a separate server for integrations, or add them to the server on which the external application is hosted. For example, if you’re self-hosting a Jira server, you could deploy a Jira integration on the Jira server itself. When self-hosting restrictions are less strict, AWS, Heroku, and other public cloud options can also be used.

Expand All @@ -14,52 +14,53 @@ Custom Apps

Apps are lightweight, interactive add-ons that can be written in any language and run on any HTTP-compatible hosting service. They enable you to connect with external services and build interactions that users can easily follow and work across the Mattermost web app, desktop app, and mobile app.

Prebuilt apps are available on the `Mattermost Marketplace <https://mattermost.com/marketplace/>`__.
Prebuilt apps are available on the `Mattermost Marketplace <https://mattermost.com/marketplace/>`_.

API
----

Mattermost provides complete access to `server APIs <https://api.mattermost.com/>`__, along with language-specific drivers to integrate into your own applications. Interact with users, channels, and everything else that happens on your Mattermost server via a REST API that meets the OpenAPI specification. The API is for developers who want to build bots and other interactions that don’t rely on customizing the Mattermost user experience.

`View the Mattermost API Reference <https://api.mattermost.com/>`__.
Mattermost provides complete access to `server APIs via the Mattermost API Reference <https://api.mattermost.com/>`_, along with language-specific drivers to integrate into your own applications. Interact with users, channels, and everything else that happens on your Mattermost server via a REST API that meets the OpenAPI specification. The API is for developers who want to build bots and other interactions that don’t rely on customizing the Mattermost user experience.

Plugins
-------

Plugins are the most comprehensive way to add new features and customization to self-hosted Mattermost deployments. These powerful integrations are written in Go and React and they’re ideal for customers wanting to change the behavior of the Mattermost server, desktop, and web apps without forking the core codebase to suit their organization’s needs.

Prebuilt plugins are available on the `Mattermost Marketplace <https://mattermost.com/marketplace/>`__, or you can `build your own plugin <https://developers.mattermost.com/integrate/plugins/>`__.
Prebuilt plugins are available on the `Mattermost Marketplace <https://mattermost.com/marketplace/>`_, or you can `build your own plugin <https://developers.mattermost.com/integrate/plugins/>`_.

.. note::

- :doc:`Mattermost Cloud Dedicated </about/cloud-dedicated>` customers supports custom Mattermost plugin uploads.
- Custom Mattermost plugins aren't available in :doc:`Mattermost Cloud Shared </about/cloud-shared>` deployments. You're limited to the plugins available in the Cloud Marketplace, including: :ref:`Mattermost Calls <configure/plugins-configuration-settings:calls>`, :doc:`Mattermost Copilot </configure/enable-copilot>`, :doc:`GitHub </integrate/github-interoperability>` interoperability, :doc:`GitLab </integrate/gitlab-interoperability>` interoperability, :doc:`Jira </integrate/jira-interoperability>` interoperability, :doc:`Playbooks </guides/repeatable-processes>`, :doc:`ServiceNow </integrate/servicenow-interoperability>` interoperability, :doc:`user satisfaction surveys </manage/user-satisfaction-surveys>`, and :doc:`Zoom </integrate/zoom-interoperability>`.
- :doc:`Mattermost Cloud Dedicated </about/cloud-dedicated>` customers supports custom Mattermost plugin uploads.
- Custom Mattermost plugins aren't available in :doc:`Mattermost Cloud Shared </about/cloud-shared>` deployments. You're limited to the plugins available in the Cloud Marketplace, including:

.. include:: ./cloud-supported-integrations.rst
:start-after: :nosearch:

Bots
-----

You can deploy interactive bots to help users with processes and tasks with Mattermost by issuing messages to users they can respond to using buttons and dropdown menus. Bots can be used together with apps and plugins. The Hubot open source project, created by GitHub, Inc., is among the most popular of the bot options.

Prebuilt bots are available on the `Mattermost Marketplace <https://mattermost.com/marketplace/>`__, or you can `configure your own bots <https://developers.mattermost.com/integrate/reference/bot-accounts/>`__.
Prebuilt bots are available on the `Mattermost Marketplace <https://mattermost.com/marketplace/>`_, or you can `configure your own bots <https://developers.mattermost.com/integrate/reference/bot-accounts/>`_.

Learn about `Mattermost Hubot integration (hubot-matteruser on npm) <https://www.npmjs.com/package/hubot-matteruser>`__ and `other open source community bots available <https://integrations.mattermost.com/>`__ or you can `build your own <https://developers.mattermost.com/integrate/reference/bot-accounts/>`__.
Learn about `Mattermost Hubot integration (hubot-matteruser on npm) <https://www.npmjs.com/package/hubot-matteruser>`_ and `other open source community bots available <https://integrations.mattermost.com/>`_ or you can `build your own <https://developers.mattermost.com/integrate/reference/bot-accounts/>`_.

Custom slash commands
---------------------

A :doc:`slash command </collaborate/run-slash-commands>` is similar to an `outgoing webhooks <https://developers.mattermost.com/integrate/webhooks/outgoing/>`__, but instead of listening to a channel, it's used as a command tool in a channel.
A :doc:`slash command </collaborate/run-slash-commands>` is similar to an `outgoing webhooks <https://developers.mattermost.com/integrate/webhooks/outgoing/>`_, but instead of listening to a channel, it's used as a command tool in a channel.

Slash commands enable users to trigger custom actions, such as creating Jira tickets or GitHub pull requests within Mattermost channels. See the :doc:`built-in slash commands </collaborate/built-in-slash-commands>` product documentation and the `custom slash command <https://developers.mattermost.com/integrate/slash-commands/custom/>`__ developer documentation to learn more.
Slash commands enable users to trigger custom actions, such as creating Jira tickets or GitHub pull requests within Mattermost channels. See the :doc:`built-in slash commands </collaborate/built-in-slash-commands>` product documentation and the `custom slash command <https://developers.mattermost.com/integrate/slash-commands/custom/>`_ developer documentation to learn more.

.. tip::
The Mattermost slash command format is compatible with Slack's format, so you can easily port commands from Slack.

Webhooks
--------

A webhook is a way for one app to send real-time data to another app. In Mattermost, `incoming webhooks <https://developers.mattermost.com/integrate/webhooks/incoming/>`__ receive data from external applications and make a post in a specified channel. They’re great for setting up notifications when something happens in an external application.
A webhook is a way for one app to send real-time data to another app. In Mattermost, `incoming webhooks <https://developers.mattermost.com/integrate/webhooks/incoming/>`_ receive data from external applications and make a post in a specified channel. They’re great for setting up notifications when something happens in an external application.

`Outgoing webhooks <https://developers.mattermost.com/integrate/webhooks/outgoing/>`__ take data from Mattermost, and send it to an external application. Then the outgoing webhook can post a response back in Mattermost. They’re great for listening in on channels, and then notifying external applications when a trigger word is used.
`Outgoing webhooks <https://developers.mattermost.com/integrate/webhooks/outgoing/>`_ take data from Mattermost, and send it to an external application. Then the outgoing webhook can post a response back in Mattermost. They’re great for listening in on channels, and then notifying external applications when a trigger word is used.

.. tip::

Expand All @@ -71,4 +72,4 @@ Source code customizations
--------------------------
As an open source project, we support your ability to modify the source code for the server or web app to make changes and customizations to meet your specific needs.

Learn about `forking our open source repositories <https://developers.mattermost.com/integrate/other-integrations/customization/>`__.
Learn about `forking our open source repositories <https://developers.mattermost.com/integrate/other-integrations/customization/>`_.
2 changes: 2 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -1837,6 +1837,8 @@ def setup(_: Sphinx):
"https://docs.mattermost.com/configure/site-configuration-settings.html#enable-system-wide-notifications",
"configure/plugins-configuration-settings.html#playbooks":
"https://docs.mattermost.com/configure/plugins-configuration-settings.html#collaborative-playbooks",
"configure/manage-user-surveys.html#upload":
"https://docs.mattermost.com/configure/manage-user-surveys.html#install",

# Deploy redirects
"deploy/mobile-apps-faq.html":
Expand Down
21 changes: 11 additions & 10 deletions source/configure/manage-user-surveys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,26 @@ You must be a Mattermost system admin to `upload the plugin <#upload>`__ to your

The User Survey integration is compatible with the following Mattermost Server versions:

- v9.11.2 (Extended Support Release)
- v9.8 or later
- v9.5.2+ (Extended Support Release)
- v8.1 (Extended Support Release)

Upload
------
Install
--------

The User Survey integration must be installed using the `latest binary available for download from the plugin repository <https://github.com/mattermost/mattermost-plugin-user-survey/releases>`_
.. important::

1. Download the binary file from the GitHub repository.
2. Go to **System Console > Plugin Management**.
3. Next to **Upload Plugin**, select **Choose File**.
4. Select the binary file, select **Open**, and then select **Upload**.
Mattermost offers an additonal :doc:`User Satisfaction Surveys </manage/user-satisfaction-surveys>` option with limited customization options within the **Plugins** list where surveys are enabled by default. We recommend :ref:`disabling the User Satisfaction Surveys functionality <manage/user-satisfaction-surveys:how can surveys be disabled?>` when using this user survey integration.

Once the binary is uploaded, the **User Survey** integration is added in the navigation pane under **Plugins**.
1. Log in to your Mattermost workspace as a system administrator.
2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**.
3. Search for or scroll to User Survey, and select **Install**.
4. Once installed, select **Configure**. You're taken to the System Console, directly to the **User Survey** integration page, under **Plugins**.

.. note::

Mattermost offers an additonal :doc:`User Satisfaction Surveys </manage/user-satisfaction-surveys>` option with limited customization options within the **Plugins** list where surveys are enabled by default. We recommend :ref:`disabling the User Satisfaction Surveys functionality <manage/user-satisfaction-surveys:how can surveys be disabled?>` when using this user survey integration.
From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, this plugin is pre-packaged with the Mattermost Server. If your Mattermost deployment is on a release prior to v9.11.2, download the `latest plugin binary release <https://github.com/mattermost/mattermost-plugin-user-survey/releases>`_, and upload it to your server via **System Console > Plugin Management**.

Upgrade
~~~~~~~
Expand All @@ -50,7 +51,7 @@ Go to **System Console > Plugins > User Survey** to enable this integration.
Once the integration is installed and enabled, create surveys by completing configuration in the System Console, as described below.

Create surveys
--------------
~~~~~~~~~~~~~~~

Under **Survey setup**, specify the date, time, and details for a new survey:

Expand Down
3 changes: 2 additions & 1 deletion source/guides/integrate-and-extend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ Your Mattermost deployment comes with the following integrations you can configu
* :doc:`GitHub interoperability </integrate/github-interoperability>` - Connect your GitHub instance to your Mattermost instance to subscribe to repositiories, and to stay current with reviews, assignments, and more.
* :doc:`GitLab interoperability </integrate/gitlab-interoperability>` - Connect your GitLab instance to your Mattermost instance to subscribe to repositories, use GitLab events as Mattermost action triggers, and more.
* :doc:`Jira interoperability </integrate/jira-interoperability>` - Connect your Jira instance to your Mattermost instance to create Jira tickets from messages in Mattermost, and to get notified of important Jira updates in Mattermost.
* :doc:`Mattermost Playbooks for Microsoft Teams </integrate/playbooks-for-microsoft-teams>` - Improve cross-organizational alignment and awareness by enabling access to your active, repeatable processes and status updates in Mattermost directly in Microsoft Teams.* :doc:`Microsoft Calendar interoperability </integrate/microsoft-calendar-interoperability>` - Connect your Microsoft O365 Calendar to your Mattermost instance to receive daily sumamryies of calendar events, synchronize your Microsoft O365 status in Mattermost, and accept or decline calendar invites without leaving Mattermost.
* :doc:`Mattermost Playbooks for Microsoft Teams </integrate/playbooks-for-microsoft-teams>` - Improve cross-organizational alignment and awareness by enabling access to your active, repeatable processes and status updates in Mattermost directly in Microsoft Teams.
* :doc:`Microsoft Calendar interoperability </integrate/microsoft-calendar-interoperability>` - Connect your Microsoft O365 Calendar to your Mattermost instance to receive daily sumamryies of calendar events, synchronize your Microsoft O365 status in Mattermost, and accept or decline calendar invites without leaving Mattermost.
* :doc:`Microsoft Teams interoperability </integrate/microsoft-teams-interoperability>` - Connect your Microsoft Teams instance to your Mattermost instance to forward real-time chat notifications from Teams to Mattermost.
* :doc:`Microsoft Teams Meetings interoperability </integrate/microsoft-teams-meetings-interoperability>` - Connect your Microsoft Teams Meetings instance to your Mattermost instance to start and join voice calls, video calls, and use screen sharing without leaving Mattermost.
* :doc:`ServiceNow interoperability </integrate/servicenow-interoperability>` - Connect your ServiceNow instance to your Mattermost instance to subscribe to record changes in ServiceNow and manage them in Mattermost.
Expand Down
16 changes: 12 additions & 4 deletions source/integrate/microsoft-calendar-interoperability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,18 @@ Create a Mattermost App in Azure

You're all set for configuration in the Azure portal.

Install the Microsoft Calendar integration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Log in to your Mattermost workspace as a system administrator.
2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**.
3. Search for or scroll to Microsoft Calendar, and select **Install**.
4. Once installed, select **Configure**. You're taken to the System Console, directly to the **Microsoft Calendar** integration page, under **Plugins**.

.. note::

From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, this plugin is pre-packaged with the Mattermost Server. If your Mattermost deployment is on a release prior to v9.11.2, download the `latest plugin binary release <https://github.com/mattermost/mattermost-plugin-mscalendar/releases>`_, and upload it to your server via **System Console > Plugin Management**.

Enable and configure the Microsoft Calendar integration in Mattermost
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -82,10 +94,6 @@ Enable and configure the Microsoft Calendar integration in Mattermost

2. In Mattermost, go to **System Console > Plugins > Microsoft Calendar** to enable this integration.

.. note::

From Mattermost v10, this plugin is pre-packaged with the Mattermost Server. If your Mattermost deployment is on a release prior to v10, download the `latest plugin binary release <https://github.com/mattermost/mattermost-plugin-mscalendar/releases>`, and upload it to your server via **System Console > Plugin Management**.

3. Copy the **Application (client) ID** and **Directory (tenant) ID** from the Azure portal.

4. In Mattermost, enter the following values in the fields provided. Select **Save** to apply the configuration:
Expand Down
Loading
Loading