From ccdaee391350b3e97fc1405e9e67ed0fda562ab5 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Mon, 14 Aug 2023 13:03:07 -0400 Subject: [PATCH 1/2] Clearly labeled all third-party plugin configs --- .../plugins-configuration-settings.rst | 92 ++++++++++++------- 1 file changed, 57 insertions(+), 35 deletions(-) diff --git a/source/configure/plugins-configuration-settings.rst b/source/configure/plugins-configuration-settings.rst index f08e256a0a6..4c57a1f423c 100644 --- a/source/configure/plugins-configuration-settings.rst +++ b/source/configure/plugins-configuration-settings.rst @@ -18,7 +18,7 @@ Both self-hosted and Cloud admins can access the following configuration setting - `GIF commands <#gif-commands>`__ - `Mattermost Boards <#mattermost-boards>`__ - `MS Teams Sync <#ms-teams-sync>`__ -- Playbooks <#mattermost-playbooks>`__ +- Playbooks <#playbooks>`__ - `User Satisfaction surveys <#user-satisfaction-surveys>`__ - `Zoom <#zoom>`__ @@ -91,7 +91,7 @@ Automatic prepackaged plugins :configjson: EnableUploads :environment: MM_PLUGINSETTINGS_ENABLEUPLOADS -Upload Plugin +Upload plugin ~~~~~~~~~~~~~ +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ @@ -195,6 +195,10 @@ Agenda .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: +.. note:: + + From Mattermost v8.1, this third-party plugin is managed by the Mattermost Community. + Access the following configuration settings in the System Console by going to **Plugins > Agenda**. .. config:setting:: plugins-agendaenable @@ -222,6 +226,10 @@ Antivirus .. include:: ../_static/badges/selfhosted-only.rst :start-after: :nosearch: +.. note:: + + From Mattermost v8.1, this third-party plugin is managed by the Mattermost Community. + This plugin allows the forwarding of uploaded files to an antivirus scanning application, `ClamAV anti-virus software `__, and prevents the upload from completing if there is a virus detected in the file. Use this plugin to prevent users from inadvertently spreading malware or viruses via your Mattermost server. See the `Mattermost Antivirus Plugin `__ documentation for details. @@ -284,6 +292,10 @@ Apps .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: +.. note:: + + From Mattermost v8.1, this third-party plugin is managed by the Mattermost Community. + Access the following configuration settings in the System Console by going to **Plugins > Apps**. To create your own Mattermost App, see the `Mattermost Apps `__ developer documentation. @@ -314,6 +326,10 @@ Autolink .. include:: ../_static/badges/allplans-selfhosted.rst :start-after: :nosearch: +.. note:: + + From Mattermost v8.1, this third-party plugin is managed by the Mattermost Community. + This plugin creates regular expression patterns that are reformatted into a Markdown link before the message is saved into the database. This plugin can be configured through the System Console, ``config.json`` file, or ``/autolink`` slash command. See the `Autolink Plugin `__ documentation for details. Access the following configuration settings in the System Console by going to **Plugins > Autolink**. @@ -398,6 +414,10 @@ AWS SNS .. include:: ../_static/badges/allplans-selfhosted.rst :start-after: :nosearch: +.. note:: + + From Mattermost v8.1, this third-party plugin is managed by the Mattermost Community. + This plugin is used to receive alert notifications from `Amazon AWS CloudWatch `__ to Mattermost channels via `AWS Simple Notification Server (SNS) `__. Access the following configuration settings in the System Console by going to **Plugins > AWS SNS**. @@ -519,7 +539,7 @@ RTC server address (UDP) | Changing this setting requires a plugin restart to take effect. | - Environment variable: N/A | | If left unset (default value) the service will listen on all the available interfaces. | | +--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ -| **Note**: This setting is only applicable when not running calls through the standalone ``rtcd`` service. | | +| **Note**: This setting is only applicable when not running calls through the standalone ``rtcd`` service. | +--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-callsrtcserveraddress @@ -541,11 +561,11 @@ RTC server address (TCP) | Changing this setting requires a plugin restart to take effect. | - Environment variable: N/A | | If left unset (default value) the service will listen on all the available interfaces. | | +--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ -| **Note**: | | -| | | -| - This setting is only applicable when not running calls through the standalone ``rtcd`` service. | | -| | | -| - This setting is available starting in plugin version 0.17. | | +| **Note**: | +| | +| - This setting is only applicable when not running calls through the standalone ``rtcd`` service. | +| | +| - This setting is available starting in plugin version 0.17. | +--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-callsrtcserverportudp @@ -569,7 +589,7 @@ RTC server port (UDP) | | | | Default is **8443**. | | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| **Note**: This setting is only applicable when not running calls through the standalone ``rtcd`` service. | | +| **Note**: This setting is only applicable when not running calls through the standalone ``rtcd`` service. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-callsrtcserverporttcp @@ -593,11 +613,11 @@ RTC server port (TCP) | | | | Default is **8443**. | | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| **Note**: | | -| | | -| - This setting is only applicable when not running calls through the standalone ``rtcd`` service. | | -| | | -| - This setting is available starting in plugin version 0.17. | | +| **Note**: | +| | +| - This setting is only applicable when not running calls through the standalone ``rtcd`` service. | +| | +| - This setting is available starting in plugin version 0.17. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ @@ -880,11 +900,11 @@ Enable simulcast for screen sharing (Experimental) | - **false**: Disables simulcast for screen sharing. | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.enablesimulcast`` | | | - Environment variable N/A | +------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| **Note**: This functionality has the following requirements: | | -| | | -| - Calls plugin version >= v0.16.0 | | -| | | -| - ``rtcd`` version >= v0.10.0 (if in use) | | +| **Note**: This functionality has the following requirements: | +| | +| - Calls plugin version >= v0.16.0 | +| | +| - ``rtcd`` version >= v0.10.0 (if in use) | +------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ .. config:setting:: plugins-enablecallrecordings @@ -992,11 +1012,9 @@ Call recording quality | | | | Changing this setting requires a plugin restart to take effect. | | +----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| **Note**: | | -| | | -| - This setting is only applicable when not running calls through the standalone ``rtcd`` service. | | -| | | -| - This setting is available starting in plugin version 0.17. | | +| **Note**: | +| - This setting is only applicable when not running calls through the standalone ``rtcd`` service. | +| - This setting is available starting in plugin version 0.17. | +----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ .. |note| replace:: . @@ -1026,6 +1044,10 @@ Channel export .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: +.. note:: + + From Mattermost v8.1, this third-party plugin is managed by the Mattermost Community. + Access the following configuration settings in the System Console by going to **Plugins > Channel Export**. .. config:setting:: plugins-channelexportenable @@ -1037,13 +1059,12 @@ Access the following configuration settings in the System Console by going to ** - **true**: Enables the Channel Export plugin on your Mattermost workspace. - **false**: (Default) Disables the Channel Export plugin on your Mattermost workspace. -Enable Plugin +Enable plugin ~~~~~~~~~~~~~ +-----------------------------------------------------------------------------------------+----------------------------------------------------+ | - **true**: Enables the Channel Export plugin on your Mattermost workspace. | - System Config path: **Plugins > Channel Export** | | - **false**: (Default) Disables the Channel Export plugin on your Mattermost workspace. | | -| | | +-----------------------------------------------------------------------------------------+----------------------------------------------------+ ---- @@ -1085,7 +1106,6 @@ Channel name +----------------------------------------------------------------------------------+-------------------------------------------------+ | Specify the channel to use as part of the demo plugin, when enabled. | - System Config path: **Plugins > Demo Plugin** | -| | | | If the specified channel does not exist, the plugin creates the channel for you. | | +----------------------------------------------------------------------------------+-------------------------------------------------+ @@ -1101,7 +1121,6 @@ Username +----------------------------------------------------------------------------+-------------------------------------------------+ | Specify the user for the demo plugin, when enabled. | - System Config path: **Plugins > Demo Plugin** | -| | | | If the specified user does not exist, the plugin creates the user for you. | | +----------------------------------------------------------------------------+-------------------------------------------------+ @@ -1113,6 +1132,10 @@ GIF commands .. include:: ../_static/badges/allplans-selfhosted.rst :start-after: :nosearch: +.. note:: + + From Mattermost v8.1, this third-party plugin is managed by the Mattermost Community. + Access the following configuration settings in the System Console by going to **Plugins > GIF commands**. This plugin is used to post GIFs from Gfycat, Giphy, or Tenor using slash commands. @@ -1146,8 +1169,6 @@ Display the GIF as +---------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------+ | Display the GIF as an embedded image where the GIF can't be collapsed, or as a collapsible image preview where the full URL displays. | - System Config path: **Plugins > GIF commands** | -| | | -| | | +---------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------+ | **Note**: | | - `Link previews `__ must be enabled to display GIF previews. | @@ -1288,6 +1309,10 @@ Mattermost Boards .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: +.. note:: + + From Mattermost v8.1, this third-party plugin is managed by the Mattermost Community. + Mattermost Boards is an open source alternative to Trello, Notion, and Asana. Boards is a project management tool that helps define, organize, track and manage work across teams, using a familiar kanban board view. See the `Mattermost Boards `__ product documentation for details. Access the following configuration settings in the System Console by going to **Plugins > Mattermost Boards**. @@ -1295,8 +1320,6 @@ Access the following configuration settings in the System Console by going to ** .. config:setting:: plugins-boardsenable :displayname: Enable plugin (Plugins - Boards) :systemconsole: Plugins > Mattermost Boards - :configjson: - :environment: - **true**: Enables the Mattermost Boards plugin on your Mattermost workspace. - **false**: Disables the Mattermost Boards plugin on your Mattermost workspace. @@ -1306,8 +1329,7 @@ Enable plugin +----------------------------------------------------------------------------------+-------------------------------------------------------+ | - **true**: Enables the Mattermost Boards plugin on your Mattermost workspace. | - System Config path: **Plugins > Mattermost Boards** | -| - **false**: Disables the Mattermost Boards plugin on your Mattermost workspace. | - ``config.json`` setting: | -| | - Environment variable: | +| - **false**: Disables the Mattermost Boards plugin on your Mattermost workspace. | | +----------------------------------------------------------------------------------+-------------------------------------------------------+ ---- @@ -1889,4 +1911,4 @@ Specify the `Chimera `__ URL used by Matt +-------------------------------------------------------------------------------------------------------------------------+ | This feature's ``config.json`` setting is ``"ChimeraOAuthProxyUrl": {}`` with string input. | -+-------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------------------------+ \ No newline at end of file From e19d99bdf76e6cfb211d774947b0e6023dbf07a3 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Mon, 14 Aug 2023 13:20:06 -0400 Subject: [PATCH 2/2] Added back necessary search metadata --- source/configure/plugins-configuration-settings.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/source/configure/plugins-configuration-settings.rst b/source/configure/plugins-configuration-settings.rst index 4c57a1f423c..495c4906ed4 100644 --- a/source/configure/plugins-configuration-settings.rst +++ b/source/configure/plugins-configuration-settings.rst @@ -18,7 +18,7 @@ Both self-hosted and Cloud admins can access the following configuration setting - `GIF commands <#gif-commands>`__ - `Mattermost Boards <#mattermost-boards>`__ - `MS Teams Sync <#ms-teams-sync>`__ -- Playbooks <#playbooks>`__ +- Playbooks <#mattermost-playbooks>`__ - `User Satisfaction surveys <#user-satisfaction-surveys>`__ - `Zoom <#zoom>`__ @@ -91,7 +91,7 @@ Automatic prepackaged plugins :configjson: EnableUploads :environment: MM_PLUGINSETTINGS_ENABLEUPLOADS -Upload plugin +Upload Plugin ~~~~~~~~~~~~~ +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ @@ -1320,6 +1320,8 @@ Access the following configuration settings in the System Console by going to ** .. config:setting:: plugins-boardsenable :displayname: Enable plugin (Plugins - Boards) :systemconsole: Plugins > Mattermost Boards + :configjson: + :environment: - **true**: Enables the Mattermost Boards plugin on your Mattermost workspace. - **false**: Disables the Mattermost Boards plugin on your Mattermost workspace. @@ -1330,6 +1332,7 @@ Enable plugin +----------------------------------------------------------------------------------+-------------------------------------------------------+ | - **true**: Enables the Mattermost Boards plugin on your Mattermost workspace. | - System Config path: **Plugins > Mattermost Boards** | | - **false**: Disables the Mattermost Boards plugin on your Mattermost workspace. | | +| | - Environment variable: | +----------------------------------------------------------------------------------+-------------------------------------------------------+ ----