From 35aeb5a629f120686bcd4a6e95c03e349c561aec Mon Sep 17 00:00:00 2001 From: Aaron Rothschild Date: Fri, 14 Feb 2020 11:53:02 -0800 Subject: [PATCH 1/9] updated pre-packaged plugin info --- source/administration/plugins.rst | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/source/administration/plugins.rst b/source/administration/plugins.rst index a94143b65c2..5dd2930be36 100644 --- a/source/administration/plugins.rst +++ b/source/administration/plugins.rst @@ -20,6 +20,20 @@ The Plugin Marketplace is a collection of plugins that can greatly increase the .. image:: https://user-images.githubusercontent.com/915956/66891467-1b18eb80-ef9e-11e9-9de3-37a3c5899bd8.png +Plugin Labels +~~~~~~~~~~~~~~~~ + +Plugins in the Marketplace are labeled to make it easier for administrators to choose plugins that fit their company's security and risk policies if they do not allow for community plugins to be used. + +**Mattermost Official Plugins** +Plugins identified as "Official" are owned and managed by the Mattermost development team and are available in an open-source licencing repository for review. These plugins are supported by our customer assistance team in production environments. + +**Community Plugins** +Plugins produced by the open-source community or partners and the features/roadmap are not controlled directly by Mattermost. Prior to being listed on the Plugin Marketplace, they are reviewed by the Mattermost development team and code-signed to ensure the code Mattermost reviewed, is delivered. Mattermost does not directly support these plugins in production environments. + +**Beta Plugins** +Plugins may be labeled as "Beta" if they are released to the Plugin Marketplace early for customer previews. We do not recommend running Beta plugins on production servers. + Installing a Plugin ~~~~~~~~~~~~~~~~ @@ -38,7 +52,7 @@ Once a plugin is installed (or pre-installed if shipped with Mattermost binary r Upgrading Plugins ~~~~~~~~~~~~~~~~~ -Upgrade a plugin on demand when a new version becomes available. +Upgrade a plugin on demand when a new version becomes available. New versions of plugins you have already installed will be shown and can be installed with a single click. Upgrading Plugins (prior to v5.18) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -252,7 +266,11 @@ To manage plugins, go to **System Console > Plugins > Plugin Management**. From Pre-packaged Plugins ~~~~~~~~~~~~~~~~~~~ -Mattermost ships with a number of pre-packaged plugins written and maintained by Mattermost. Instead of building these features directly into the product, you can selectively enable the functionality your installation requires. Pre-packaged plugins cannot be removed via the System Console, but can be customized by modifying the ``prepackaged_plugins`` directory in your Mattermost installation. +Mattermost ships with a number of pre-packaged plugins written and maintained by Mattermost. Instead of building these features directly into the product, you can selectively enable the functionality your installation requires. Pre-packaged plugins can be removed after 5.20 via the System Console, or by modifying the ``prepackaged_plugins`` directory in your Mattermost installation. + +As of 5.20 Mattermost now ships pre-downloaded plugins that will be visible in the PLugin marketplace even if your Mattermost server does not have external internat acess as in some secure settings. Only Mattermost "official" plugins are shipped with the Mattermost package as a result, community plugins are not available in the Plugin Marketplace on servers without internet access. + +If you previously had some plugins that were pre-packaged on your server, but were not enabled at time of upgrading to 5.20+, they will no longer be installed your server. As mentioned - those previously pre-packaged plugins will still be available to be installed on your server via the Plugin Marketplace. Custom Plugins ~~~~~~~~~~~~~~ From 113f74231b0cdd180e92829b2b62ed866258ca18 Mon Sep 17 00:00:00 2001 From: Aaron Rothschild Date: Fri, 14 Feb 2020 12:41:03 -0800 Subject: [PATCH 2/9] punctuation Co-Authored-By: Amy Blais --- source/administration/plugins.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/administration/plugins.rst b/source/administration/plugins.rst index 5dd2930be36..d74dd6a74b7 100644 --- a/source/administration/plugins.rst +++ b/source/administration/plugins.rst @@ -270,7 +270,7 @@ Mattermost ships with a number of pre-packaged plugins written and maintained by As of 5.20 Mattermost now ships pre-downloaded plugins that will be visible in the PLugin marketplace even if your Mattermost server does not have external internat acess as in some secure settings. Only Mattermost "official" plugins are shipped with the Mattermost package as a result, community plugins are not available in the Plugin Marketplace on servers without internet access. -If you previously had some plugins that were pre-packaged on your server, but were not enabled at time of upgrading to 5.20+, they will no longer be installed your server. As mentioned - those previously pre-packaged plugins will still be available to be installed on your server via the Plugin Marketplace. +If you previously had some plugins that were pre-packaged on your server, but were not enabled at time of upgrading to 5.20+, they will no longer be installed your server. As mentioned, those previously pre-packaged plugins will still be available to be installed on your server via the Plugin Marketplace. Custom Plugins ~~~~~~~~~~~~~~ From ca836c274e7d7bc67ea8fb570cf0faf9301870d8 Mon Sep 17 00:00:00 2001 From: Aaron Rothschild Date: Fri, 14 Feb 2020 12:50:29 -0800 Subject: [PATCH 3/9] Incorporated suggestions --- source/administration/plugins.rst | 22 ++++------------------ 1 file changed, 4 insertions(+), 18 deletions(-) diff --git a/source/administration/plugins.rst b/source/administration/plugins.rst index d74dd6a74b7..39aa4fb3ed4 100644 --- a/source/administration/plugins.rst +++ b/source/administration/plugins.rst @@ -20,20 +20,6 @@ The Plugin Marketplace is a collection of plugins that can greatly increase the .. image:: https://user-images.githubusercontent.com/915956/66891467-1b18eb80-ef9e-11e9-9de3-37a3c5899bd8.png -Plugin Labels -~~~~~~~~~~~~~~~~ - -Plugins in the Marketplace are labeled to make it easier for administrators to choose plugins that fit their company's security and risk policies if they do not allow for community plugins to be used. - -**Mattermost Official Plugins** -Plugins identified as "Official" are owned and managed by the Mattermost development team and are available in an open-source licencing repository for review. These plugins are supported by our customer assistance team in production environments. - -**Community Plugins** -Plugins produced by the open-source community or partners and the features/roadmap are not controlled directly by Mattermost. Prior to being listed on the Plugin Marketplace, they are reviewed by the Mattermost development team and code-signed to ensure the code Mattermost reviewed, is delivered. Mattermost does not directly support these plugins in production environments. - -**Beta Plugins** -Plugins may be labeled as "Beta" if they are released to the Plugin Marketplace early for customer previews. We do not recommend running Beta plugins on production servers. - Installing a Plugin ~~~~~~~~~~~~~~~~ @@ -52,7 +38,7 @@ Once a plugin is installed (or pre-installed if shipped with Mattermost binary r Upgrading Plugins ~~~~~~~~~~~~~~~~~ -Upgrade a plugin on demand when a new version becomes available. New versions of plugins you have already installed will be shown and can be installed with a single click. +Upgrade a plugin on demand when a new version becomes available. New versions of plugins you have already installed will display a link to easily install the upgraded plugin. Some plugin versions may have breaking changes, check the release notes if performing a major version change. Upgrading Plugins (prior to v5.18) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -266,11 +252,11 @@ To manage plugins, go to **System Console > Plugins > Plugin Management**. From Pre-packaged Plugins ~~~~~~~~~~~~~~~~~~~ -Mattermost ships with a number of pre-packaged plugins written and maintained by Mattermost. Instead of building these features directly into the product, you can selectively enable the functionality your installation requires. Pre-packaged plugins can be removed after 5.20 via the System Console, or by modifying the ``prepackaged_plugins`` directory in your Mattermost installation. +Mattermost ships with a number of pre-packaged plugins written and maintained by Mattermost. Instead of building these features directly into the product, you can selectively enable the functionality your installation requires. Pre-packaged plugins can be removed as of 5.20 via the System Console, or by modifying the ``prepackaged_plugins`` directory in your Mattermost installation. -As of 5.20 Mattermost now ships pre-downloaded plugins that will be visible in the PLugin marketplace even if your Mattermost server does not have external internat acess as in some secure settings. Only Mattermost "official" plugins are shipped with the Mattermost package as a result, community plugins are not available in the Plugin Marketplace on servers without internet access. +As of v5.20, pre-packaged plugins are no longer installed by default, but are available from the plugin marketplace. Installing such plugins from the plugin marketplace works even when your server cannot access the internet by instead installing the version shipped with the server. -If you previously had some plugins that were pre-packaged on your server, but were not enabled at time of upgrading to 5.20+, they will no longer be installed your server. As mentioned, those previously pre-packaged plugins will still be available to be installed on your server via the Plugin Marketplace. +Previously enabled, pre-packaged plugins will remain installed on upgrading to v5.20. Any disabled, pre-packaged plugins will not show up in the system console but may be installed from the plugin marketplace. Custom Plugins ~~~~~~~~~~~~~~ From 513bdde174aa26c04c10d3a210f77818ac2db681 Mon Sep 17 00:00:00 2001 From: Jesse Hallam Date: Mon, 2 Mar 2020 11:08:15 -0400 Subject: [PATCH 4/9] Update source/administration/plugins.rst Co-Authored-By: Amy Blais --- source/administration/plugins.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/administration/plugins.rst b/source/administration/plugins.rst index 39aa4fb3ed4..41ae1fbbd97 100644 --- a/source/administration/plugins.rst +++ b/source/administration/plugins.rst @@ -38,7 +38,7 @@ Once a plugin is installed (or pre-installed if shipped with Mattermost binary r Upgrading Plugins ~~~~~~~~~~~~~~~~~ -Upgrade a plugin on demand when a new version becomes available. New versions of plugins you have already installed will display a link to easily install the upgraded plugin. Some plugin versions may have breaking changes, check the release notes if performing a major version change. +Upgrade a plugin on demand when a new version becomes available. New versions of plugins that you have already installed will display a link to easily install the upgraded plugins. Some plugin versions may have breaking changes; please check the release notes if you are performing a major version change. Upgrading Plugins (prior to v5.18) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 4e077302054f0c34117d07e1a2de2124c74b0e02 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Mon, 6 Apr 2020 14:32:28 +0200 Subject: [PATCH 5/9] Update source/administration/plugins.rst Co-Authored-By: Jesse Hallam --- source/administration/plugins.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/administration/plugins.rst b/source/administration/plugins.rst index 41ae1fbbd97..e808388d12c 100644 --- a/source/administration/plugins.rst +++ b/source/administration/plugins.rst @@ -252,7 +252,7 @@ To manage plugins, go to **System Console > Plugins > Plugin Management**. From Pre-packaged Plugins ~~~~~~~~~~~~~~~~~~~ -Mattermost ships with a number of pre-packaged plugins written and maintained by Mattermost. Instead of building these features directly into the product, you can selectively enable the functionality your installation requires. Pre-packaged plugins can be removed as of 5.20 via the System Console, or by modifying the ``prepackaged_plugins`` directory in your Mattermost installation. +Mattermost ships with a number of pre-packaged plugins written and maintained by Mattermost. Instead of building these features directly into the product, you can selectively enable the functionality your installation requires. Install pre-packaged plugins from the Plugin Marketplace, even if your system cannot directly connect to the internet. As of v5.20, pre-packaged plugins are no longer installed by default, but are available from the plugin marketplace. Installing such plugins from the plugin marketplace works even when your server cannot access the internet by instead installing the version shipped with the server. From 66a1a9176039553b1ade41d331a35b0f9f87beca Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Mon, 6 Apr 2020 14:32:38 +0200 Subject: [PATCH 6/9] Update source/administration/plugins.rst Co-Authored-By: Jesse Hallam --- source/administration/plugins.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/administration/plugins.rst b/source/administration/plugins.rst index e808388d12c..010a669ed73 100644 --- a/source/administration/plugins.rst +++ b/source/administration/plugins.rst @@ -256,8 +256,6 @@ Mattermost ships with a number of pre-packaged plugins written and maintained by As of v5.20, pre-packaged plugins are no longer installed by default, but are available from the plugin marketplace. Installing such plugins from the plugin marketplace works even when your server cannot access the internet by instead installing the version shipped with the server. -Previously enabled, pre-packaged plugins will remain installed on upgrading to v5.20. Any disabled, pre-packaged plugins will not show up in the system console but may be installed from the plugin marketplace. - Custom Plugins ~~~~~~~~~~~~~~ Installing a custom plugin introduces some risk. As a result, plugin uploads are disabled by default and cannot be enabled via the System Console or REST API. From 1bb1892b4f17cd0a855bb4457009a99179f5d7c6 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Mon, 6 Apr 2020 14:32:57 +0200 Subject: [PATCH 7/9] Update source/administration/plugins.rst Co-Authored-By: Jesse Hallam --- source/administration/plugins.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/administration/plugins.rst b/source/administration/plugins.rst index 010a669ed73..2624e28340c 100644 --- a/source/administration/plugins.rst +++ b/source/administration/plugins.rst @@ -254,7 +254,7 @@ Pre-packaged Plugins ~~~~~~~~~~~~~~~~~~~ Mattermost ships with a number of pre-packaged plugins written and maintained by Mattermost. Instead of building these features directly into the product, you can selectively enable the functionality your installation requires. Install pre-packaged plugins from the Plugin Marketplace, even if your system cannot directly connect to the internet. -As of v5.20, pre-packaged plugins are no longer installed by default, but are available from the plugin marketplace. Installing such plugins from the plugin marketplace works even when your server cannot access the internet by instead installing the version shipped with the server. +Prior to v5.20, pre-packaged plugins were installed by default and could not be uninstalled without manually modifying the `prepackaged_plugins` directory. Any prepackaged plugins installed prior to v5.20 and left enabled on upgrade will remain installed, but can now be uninstalled. Custom Plugins ~~~~~~~~~~~~~~ From 72a4da14c6141a2d653ecafd8a36b356bc4db5a5 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Mon, 6 Apr 2020 14:40:29 +0200 Subject: [PATCH 8/9] Update plugins.rst Stylistic changes: Updated headings in line with new style guide, and fixed erroneous prepackaged to pre-packaged. --- source/administration/plugins.rst | 55 +++++++++++++++---------------- 1 file changed, 27 insertions(+), 28 deletions(-) diff --git a/source/administration/plugins.rst b/source/administration/plugins.rst index 2624e28340c..925286cefd1 100644 --- a/source/administration/plugins.rst +++ b/source/administration/plugins.rst @@ -20,27 +20,27 @@ The Plugin Marketplace is a collection of plugins that can greatly increase the .. image:: https://user-images.githubusercontent.com/915956/66891467-1b18eb80-ef9e-11e9-9de3-37a3c5899bd8.png -Installing a Plugin +Installing a plugin ~~~~~~~~~~~~~~~~ When a new plugin becomes available on the Marketplace, it's listed with an option to **Install**. Select **Install** to download and install the latest plugin binary from its respective GitHub repository. If there's a cluster present, the plugin will be distributed to each server automatically. -Configuring and Enabling a Plugin +Configuring and enabling a plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Once a plugin is installed (or pre-installed if shipped with Mattermost binary release): 1. Select **Configure** to open the **Settings** menu. -2. Enter the Plugin settings as required. +2. Enter the plugin settings as required. 3. Set **Enable Plugin** setting to ``True``. If this flag is not enabled, the plugin will not become active. 4. Test out the plugin as needed. -Upgrading Plugins +Upgrading plugins ~~~~~~~~~~~~~~~~~ Upgrade a plugin on demand when a new version becomes available. New versions of plugins that you have already installed will display a link to easily install the upgraded plugins. Some plugin versions may have breaking changes; please check the release notes if you are performing a major version change. -Upgrading Plugins (prior to v5.18) +Upgrading plugins (prior to v5.18) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In v5.16 and v5.17 the Marketplace only supports the installation of new plugins. To upgrade a plugin, you need to manually update it by downloading the binary file from the GitHub repository and then upload it in **System Console > Plugin Management**. @@ -63,17 +63,17 @@ Mattermost Marketplace The `Mattermost Plugin Marketplace `__ is a service run by Mattermost that contains listings of plugins that we have reviewed and, in many cases, built. In the future, we plan to include community-developed plugins that will be labeled separately to Mattermost-developed plugins. as well as settings that would restrict which types of plugins you can install. Comments in our forum are welcome as we develop this feature further. -Mattermost Integration Directory +Mattermost integration directory -------------------------------- There are many ways to integrate Mattermost aside from plugins, and we have created a directory of integration "recipes", some of which are scripts, plugins, or instructions on how to connect Mattermost with your Enterprise systems. Many are sourced from our community of customers. You can browse the directory at `https://integrations.mattermost.com/ `__. -About Plugins +About plugins ------------- Plugins may have one or both of the following parts: - - **Webapp plugins**. Customize the Mattermost user interface by adding buttons to the channel header, overriding the ``RHS``, or even rendering a custom post type within the center channel. All this is possible without having to fork the source code and rebase on every Mattermost release. For a sample plugin, see `our Zoom plugin `__. + - **Web app plugins**. Customize the Mattermost user interface by adding buttons to the channel header, overriding the ``RHS``, or even rendering a custom post type within the center channel. All this is possible without having to fork the source code and rebase on every Mattermost release. For a sample plugin, see `our Zoom plugin `__. - **Server plugins**. Run a Go process alongside the server, filtering messages, or integrating with third-party systems such as Jira, GitLab or Jenkins. For a sample plugin, see `our Jira plugin `__. @@ -86,7 +86,7 @@ While this power enables deep customization and integration, it can be abused in You should only install custom plugins from sources you trust to avoid compromising the security of your installation. -Plugin Signing +Plugin signing --------------- The Plugin Marketplace allows system administrators to download and install plugins from a central repository. Plugins installed via the Plugin Marketplace must be signed by a public key certificate trusted by the local Mattermost server. @@ -103,9 +103,9 @@ Configuring plugin signatures allows finer control over the verification process PluginSettings.RequirePluginSignature = true -is used to enforce plugin signature verification. With flag on, only marketplace plugins will be installed and verified. With flag off, customers will be able to install plugins manually without signature verification. Note that the marketplace plugins will still be verified even if flag is off. +This is used to enforce plugin signature verification. With flag on, only Marketplace plugins will be installed and verified. With flag off, customers will be able to install plugins manually without signature verification. Note that the Marketplace plugins will still be verified even if flag is off. -Key Generation +Key generation ~~~~~~~~~~~~~~~ Public and private key pairs are needed to sign and verify plugins. The private key is used for signing and should be kept in a secure location. The public key is used for verification and can be distributed freely. To generate a key pair, run the following command: @@ -154,7 +154,7 @@ Public and private key pairs are needed to sign and verify plugins. The private .. note:: Key size should be at least 3072 bits. -Exporting the Private Key +Exporting the private key ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Find the ID of your private key first. The ID is a hexadecimal number. @@ -169,7 +169,7 @@ This is your private key and should be kept secret. Your hexadecimal key ID will gpg --export-secret-keys F3FACE45E0DE642C8BD6A8E64C7C6562C192CC1F > ./my-priv-key -Exporting the Public Key +Exporting the public key ~~~~~~~~~~~~~~~~~~~~~~~~ Find the ID of your public key first. The ID is a hexadecimal number. @@ -182,7 +182,7 @@ Find the ID of your public key first. The ID is a hexadecimal number. gpg --export F3FACE45E0DE642C8BD6A8E64C7C6562C192CC1F > ./my-pub-key -Importing the Key +Importing the key ~~~~~~~~~~~~~~~~~ If you already have a public and private key pair, you can import them to the GPG. @@ -193,7 +193,7 @@ If you already have a public and private key pair, you can import them to the GP gpg --import ./my-pub-gpg-key -Running Plugin Signing +Running plugin signing ^^^^^^^^^^^^^^^^^^^^^^ For plugin signing, you have to know the hexadecimal ID of the private key. Let's assume you want to sign `com.mattermost.demo-plugin-0.1.0.tar.gz` file, run: @@ -204,10 +204,10 @@ For plugin signing, you have to know the hexadecimal ID of the private key. Let' This command will generate `com.mattermost.demo-plugin-0.1.0.tar.gz.sig`, which is the signature of your plugin. -Plugin Verification +Plugin verification ^^^^^^^^^^^^^^^^^^^ -Mattermost server will verify plugin signatures downloaded from plugin marketplace. To add custom public keys, run the following command on the Mattermost server: +Mattermost server will verify plugin signatures downloaded from Plugin Marketplace. To add custom public keys, run the following command on the Mattermost server: .. code-block:: sh @@ -219,7 +219,6 @@ Multiple public keys can be added to the Mattermost server: mattermost plugin add key my-pk-file1 my-pk-file2 - To list the names of all public keys installed on your Mattermost server, use: .. code-block:: sh @@ -238,7 +237,7 @@ Implementation See the `implementation document `__ for more information. -Set Up Guide +Set up guide ------------ To manage plugins, go to **System Console > Plugins > Plugin Management**. From here, you can: @@ -250,27 +249,27 @@ To manage plugins, go to **System Console > Plugins > Plugin Management**. From In versions prior to 5.16, go to **System Console > Plugins (Beta) > Configuration**. -Pre-packaged Plugins +Pre-packaged plugins ~~~~~~~~~~~~~~~~~~~ Mattermost ships with a number of pre-packaged plugins written and maintained by Mattermost. Instead of building these features directly into the product, you can selectively enable the functionality your installation requires. Install pre-packaged plugins from the Plugin Marketplace, even if your system cannot directly connect to the internet. -Prior to v5.20, pre-packaged plugins were installed by default and could not be uninstalled without manually modifying the `prepackaged_plugins` directory. Any prepackaged plugins installed prior to v5.20 and left enabled on upgrade will remain installed, but can now be uninstalled. +Prior to v5.20, pre-packaged plugins were installed by default and could not be uninstalled without manually modifying the `prepackaged_plugins` directory. Any pre-packaged plugins installed prior to v5.20 and left enabled on upgrade will remain installed, but can now be uninstalled. -Custom Plugins +Customplugins ~~~~~~~~~~~~~~ Installing a custom plugin introduces some risk. As a result, plugin uploads are disabled by default and cannot be enabled via the System Console or REST API. To enable plugin uploads, manually set **PluginSettings > EnableUploads** to ``true`` in your configuration and restart your server. You can disable plugin uploads at any time without affecting previously uploaded plugins. -With plugin uploads enabled, navigate to **System Console > Plugins > Management** and upload a plugin bundle. Plugin bundles are ``*.tar.gz`` files containing the server executables and webapp resources for the plugin. You can also specify a URL to install a plugin bundle from a remote source. +With plugin uploads enabled, navigate to **System Console > Plugins > Management** and upload a plugin bundle. Plugin bundles are ``*.tar.gz`` files containing the server executables and web app resources for the plugin. You can also specify a URL to install a plugin bundle from a remote source. -Note: When **RequirePluginSignature** is `true` - plugin uploads cannot be enabled, and may only be installed via the Marketplace (which verifies Plugin Code Signatures). +Note: When **RequirePluginSignature** is `true`, plugin uploads cannot be enabled, and may only be installed via the Marketplace (which verifies Plugin Code Signatures). Custom plugins may also be installed via the `command line interface `__. While no longer recommended, plugins may also be installed manually by unpacking the plugin bundle inside the `plugins` directory of a Mattermost installation. -Plugin Uploads in High Availability Mode +Plugin uploads in High Availability mode ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Prior to Mattermost 5.14, Mattermost servers configured for `High Availability mode `_ required plugins to be installed manually. As of Mattermost 5.14, plugins uploaded via the System Console or the command line interface are persisted to the configured file store and automatically installed on all servers that join the cluster. @@ -279,7 +278,7 @@ Manually installed plugins remain supported, but must be individually installed Frequently Asked Questions (FAQs) --------------------------------- -Where Can I Share Feedback on Plugins? +Where can I share feedback on plugins? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Join our community server discussion in the `Toolkit channel `__. @@ -287,10 +286,10 @@ Join our community server discussion in the `Toolkit channel Logs** such as: +If plugin uploads fail and you see ``permission denied`` errors in **System Console > Logs** such as: .. code-block:: text From f9290bc0b22e80bad03daf46a8a4e5d9d4cd38e2 Mon Sep 17 00:00:00 2001 From: Amy Blais Date: Mon, 6 Apr 2020 12:08:40 -0400 Subject: [PATCH 9/9] Update source/administration/plugins.rst --- source/administration/plugins.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/administration/plugins.rst b/source/administration/plugins.rst index 925286cefd1..ea2059d17be 100644 --- a/source/administration/plugins.rst +++ b/source/administration/plugins.rst @@ -255,7 +255,7 @@ Mattermost ships with a number of pre-packaged plugins written and maintained by Prior to v5.20, pre-packaged plugins were installed by default and could not be uninstalled without manually modifying the `prepackaged_plugins` directory. Any pre-packaged plugins installed prior to v5.20 and left enabled on upgrade will remain installed, but can now be uninstalled. -Customplugins +Custom plugins ~~~~~~~~~~~~~~ Installing a custom plugin introduces some risk. As a result, plugin uploads are disabled by default and cannot be enabled via the System Console or REST API.