From 56409bdc6edd40423d1d999877948917ec369876 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Tue, 5 Nov 2024 13:59:03 -0500 Subject: [PATCH] Added upgrade & maintenance guidance for plugins --- source/guides/integrate-and-extend.rst | 12 ++++++++++++ source/integrate/github-interoperability.rst | 5 +++++ source/integrate/gitlab-interoperability.rst | 5 +++++ source/integrate/jira-interoperability.rst | 5 +++++ .../microsoft-calendar-interoperability.rst | 12 +++++++++++- .../integrate/microsoft-teams-interoperability.rst | 12 +++++++++++- .../microsoft-teams-meetings-interoperability.rst | 10 ++++++++++ source/integrate/servicenow-interoperability.rst | 8 ++++++-- source/integrate/zoom-interoperability.rst | 5 +++++ 9 files changed, 70 insertions(+), 4 deletions(-) diff --git a/source/guides/integrate-and-extend.rst b/source/guides/integrate-and-extend.rst index be463fbddb8..16d34d50ea9 100644 --- a/source/guides/integrate-and-extend.rst +++ b/source/guides/integrate-and-extend.rst @@ -36,3 +36,15 @@ Your Mattermost deployment comes with the following integrations you can configu .. tip:: Visit the `Mattermost Developer Documentation `__ for details on developing `webhooks `__, developing `custom slash commands `_, `custom plugins `__, building advanced bots and integrations using the `Mattermost REST API `__, `embedding Mattermost `__ into web browsers and web apps, `customizing the Mattermost source code `__, and developing `interactive messages `__ on the Mattermost platform. + +Mattermost Marketplace integrations +----------------------------------- + +Additional Mattermost integrations are available on the `Mattermost Marketplace `_. You can install these integrations directly from the Marketplace, by uploading them in the System Console, or by using the REST API. + +.. important:: + + - Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended. + - Mattermost uses the latest integration version available within the following directories: ``/prepackaged-plugins`` and ``FileSettings.Directory/plugins``, where the latter is the source of truth for installed plugins and contains ``*.tar.gz`` files. + - We strongly recommend that system admins ensure that ``{{FileStore.Directory}}/plugins`` is mounted at startup to avoid integration downgrades. + - We also strongly recommend testing integration updates in a staging environment before deploying to production, and regularly backing up integrations. \ No newline at end of file diff --git a/source/integrate/github-interoperability.rst b/source/integrate/github-interoperability.rst index eb85d5e182b..9113156e47e 100644 --- a/source/integrate/github-interoperability.rst +++ b/source/integrate/github-interoperability.rst @@ -102,6 +102,11 @@ Upgrade We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page `__ for the latest release, available releases, and compatibiilty considerations. +.. important:: + + - We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins ` is disabled because precise control over plugin versions is preferred. + - Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended. + Usage ----- diff --git a/source/integrate/gitlab-interoperability.rst b/source/integrate/gitlab-interoperability.rst index 1c3e3dd3304..20cb9552f80 100644 --- a/source/integrate/gitlab-interoperability.rst +++ b/source/integrate/gitlab-interoperability.rst @@ -59,6 +59,11 @@ Upgrade We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page `__ for the latest release, available releases, and compatibiilty considerations. +.. important:: + + - We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins ` is disabled because precise control over plugin versions is preferred. + - Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended. + Usage ----- diff --git a/source/integrate/jira-interoperability.rst b/source/integrate/jira-interoperability.rst index 39f8df7d743..075437f1ea7 100644 --- a/source/integrate/jira-interoperability.rst +++ b/source/integrate/jira-interoperability.rst @@ -162,6 +162,11 @@ Upgrade We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page `__ for the latest release, available releases, and compatibiilty considerations. +.. important:: + + - We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins ` is disabled because precise control over plugin versions is preferred. + - Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended. + Usage ----- diff --git a/source/integrate/microsoft-calendar-interoperability.rst b/source/integrate/microsoft-calendar-interoperability.rst index e0bed9209a8..655d3653e5d 100644 --- a/source/integrate/microsoft-calendar-interoperability.rst +++ b/source/integrate/microsoft-calendar-interoperability.rst @@ -112,4 +112,14 @@ Usage Users who want to use Microsoft Calendar interconnectivity must connect a Microsoft Office account to Mattermost. -Once connected, you'll receive direct messages from the Microsoft Calendar bot in Mattermost for Microsoft Calendar activity. \ No newline at end of file +Once connected, you'll receive direct messages from the Microsoft Calendar bot in Mattermost for Microsoft Calendar activity. + +Upgrade +------- + +We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page `__ for the latest release, available releases, and compatibiilty considerations. + +.. important:: + + - We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins ` is disabled because precise control over plugin versions is preferred. + - Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended. \ No newline at end of file diff --git a/source/integrate/microsoft-teams-interoperability.rst b/source/integrate/microsoft-teams-interoperability.rst index 8ce267c7397..45a62986722 100644 --- a/source/integrate/microsoft-teams-interoperability.rst +++ b/source/integrate/microsoft-teams-interoperability.rst @@ -104,7 +104,7 @@ See the :ref:`Microsoft Teams plugin configuration settings `_, and upload it to your server via **System Console > Plugin Management**. + - From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, v2.0 of 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 `_, and upload it to your server via **System Console > Plugin Management**. - We recommend making a copy of your webhook secret and encryption key, as it will only be visible to you once. Monitor performance @@ -129,6 +129,16 @@ Usage See the :doc:`collaborate within connected microsoft teams ` product documentation to get started using Microsoft Teams interoperability. +Upgrade +------- + +We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page `__ for the latest release, available releases, and compatibiilty considerations. + +.. important:: + + - We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins ` is disabled because precise control over plugin versions is preferred. + - Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended. + Frequently asked questions -------------------------- diff --git a/source/integrate/microsoft-teams-meetings-interoperability.rst b/source/integrate/microsoft-teams-meetings-interoperability.rst index 695599b46e0..59392b9ebd7 100644 --- a/source/integrate/microsoft-teams-meetings-interoperability.rst +++ b/source/integrate/microsoft-teams-meetings-interoperability.rst @@ -118,6 +118,16 @@ Disconnect a Microsoft Teams account from Mattermost Run the `/mstmeetings disconnect` slash command to disconnect a Microsoft Teams account from Mattermost. +Upgrade +------- + +We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page `__ for the latest release, available releases, and compatibiilty considerations. + +.. important:: + + - We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins ` is disabled because precise control over plugin versions is preferred. + - Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended. + Get help -------- diff --git a/source/integrate/servicenow-interoperability.rst b/source/integrate/servicenow-interoperability.rst index 63420d14d38..b600441c5e1 100644 --- a/source/integrate/servicenow-interoperability.rst +++ b/source/integrate/servicenow-interoperability.rst @@ -107,8 +107,12 @@ Notify your teams that they can `connect their ServiceNow accounts to Mattermost Upgrade ------- -We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. -Visit the `Releases page `__ for the latest release, available releases, and compatibiilty considerations. +We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page `__ for the latest release, available releases, and compatibiilty considerations. + +.. important:: + + - We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins ` is disabled because precise control over plugin versions is preferred. + - Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended. Usage ----- diff --git a/source/integrate/zoom-interoperability.rst b/source/integrate/zoom-interoperability.rst index faad9111861..8e1e1a90db7 100644 --- a/source/integrate/zoom-interoperability.rst +++ b/source/integrate/zoom-interoperability.rst @@ -88,6 +88,11 @@ Upgrade We recommend updating this integration when new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page `__ for information on the latest release, previous releases, and compatibiilty considerations. +.. important:: + + - We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins ` is disabled because precise control over plugin versions is preferred. + - Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended. + Usage -----