From 8dd52356733b9bdbeaf79a187422a38b49a5357b Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Fri, 15 Nov 2024 14:11:42 -0500 Subject: [PATCH 1/3] Cleaned up shared channel config deprecation --- source/conf.py | 5 +- .../deprecated-configuration-settings.rst | 59 +++++++++++++------ .../reporting-configuration-settings.rst | 18 +++--- .../configure/site-configuration-settings.rst | 5 +- source/onboard/ad-ldap.rst | 2 +- source/onboard/connected-workspaces.rst | 6 +- 6 files changed, 63 insertions(+), 32 deletions(-) diff --git a/source/conf.py b/source/conf.py index ff7b67b5c82..52ebf4eca00 100644 --- a/source/conf.py +++ b/source/conf.py @@ -1889,7 +1889,10 @@ def setup(_: Sphinx): "https://docs.mattermost.com/configure/environment-configuration-settings.html#database", "configure/experimental-configuration-settings.html#enable-shared-channels": "https://docs.mattermost.com/configure/site-configuration-settings.html#enable-connected-workspaces", - +"configure/experimental-configuration-settings.rst#enable-shared-channels": + "https://docs.mattermost.com/configure/deprecated-configuration-settings.html#enable-shared-channels-experimental", +"configure/experimental-configuration-settings.rst#remote-clusters": + "https://docs.mattermost.com/configure/deprecated-configuration-settings.html#enable-remote-cluster-service-experimental", # Deploy redirects "deploy/mobile-apps-faq.html": diff --git a/source/configure/deprecated-configuration-settings.rst b/source/configure/deprecated-configuration-settings.rst index 6ac78ad710a..5d84702db12 100644 --- a/source/configure/deprecated-configuration-settings.rst +++ b/source/configure/deprecated-configuration-settings.rst @@ -20,6 +20,7 @@ The following Mattermost configuration settings are deprecated and are no longer - `Image settings <#image-settings>`__ - `Experimental display settings <#experimental-display-settings>`__ - `Experimental API endpoint settings <#experimental-api-endpoint-settings>`__ +- `Shared channels settings <#shared-channels-settings>`__ - `Other deprecated settings <#other-deprecated-settings>`__ ---- @@ -783,6 +784,45 @@ The file must be in the same directory as your ``config.json`` file if you set a ---- +Shared channels settings +------------------------ + +Enable remote cluster service (Experimental) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Deprecated in November 16th, 2024 release in favor of :ref:`Connected Workspaces ` configuration settings + +This setting isn't available in the System Console and can only be set in ``config.json``. + +Enable this setting to add, remove, and view remote clusters for shared channels. + +**True**: System admins can manage remote clusters using the System Console. + +**False**: (**Default**) Remote cluster management is disabled. + ++---------------------------------------------------------------------------------------------------------------------------------------+ +| This feature's ``config.json`` setting is ``"ExperimentalSettings.EnableRemoteClusters": false`` with options ``true`` and ``false``. | ++---------------------------------------------------------------------------------------------------------------------------------------+ + +Enable shared channels (Experimental) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Deprecated in November 16th, 2024 release in favor of :ref:`Connected Workspaces ` configuration settings + +This setting isn't available in the System Console and can only be set in ``config.json``. + +Enable the ability to establish secure connections between Mattermost instances, and invite secured connections to shared channels where secure connections can participate as they would in any public and private channel. + +**True**: System admins can establish secure connections between Mattermost instances. + +**False**: (**Default**) The ability to establish secure connections is disabled. + ++---------------------------------------------------------------------------------------------------------------------------------------+ +| This feature's ``config.json`` setting is ``"ExperimentalSettings.EnableSharedChannels": false`` with options ``true`` and ``false``. | ++---------------------------------------------------------------------------------------------------------------------------------------+ + +---- + Other deprecated settings -------------------------- @@ -834,21 +874,4 @@ This configuration setting disables the ability to send inactivity email notific Disable Apps Bar ~~~~~~~~~~~~~~~~ -This setting is enabled for all customers by default from Mattermost v8.0. This setting disables the Apps Bar and moves all Mattermost integration icons from the vertical pane on the far right back to the channel header. - -Remote clusters -~~~~~~~~~~~~~~~ - -*Deprecated in November 16th, 2024 release in favor of Connected Workspaces* - -This setting isn't available in the System Console and can only be set in ``config.json``. - -Enable this setting to add, remove, and view remote clusters for shared channels. - -**True**: System admins can manage remote clusters using the System Console. - -**False**: (**Default**) Remote cluster management is disabled. - -+------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"RemoteClusters": false`` with options ``true`` and ``false``. | -+------------------------------------------------------------------------------------------------------------+ \ No newline at end of file +This setting is enabled for all customers by default from Mattermost v8.0. This setting disables the Apps Bar and moves all Mattermost integration icons from the vertical pane on the far right back to the channel header. \ No newline at end of file diff --git a/source/configure/reporting-configuration-settings.rst b/source/configure/reporting-configuration-settings.rst index bdf9016cf8d..c1e9f32558c 100644 --- a/source/configure/reporting-configuration-settings.rst +++ b/source/configure/reporting-configuration-settings.rst @@ -29,7 +29,7 @@ Site statistics | | | - Bots, deactivated users, and synthetic users in | | :doc:`Microsoft Teams integrations ` | -| and :doc:`connected workspaces ` users aren't counted towards the total number of activated users. | +| and :doc:`connected workspaces ` users aren't counted towards the total number of activated users. | | - For billing purposes, activated guest accounts do consume a licensed seat, which is returned when the guest account is | | deactivated. This means that guest accounts count as a paid user in your Mattermost | | :doc:`workspace `. | @@ -44,15 +44,15 @@ Team statistics

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+---------------------------------------------------------------+---------------------------------------------------------------+ -| View statistics per team on number of activated users, | - System Config path: **Reporting > Team Statistics** | -| number of public and private channels, total post count, and | - ``config.json`` setting: N/A | -| count of paid users (self-hosted only). | - Environment variable: N/A | -+---------------------------------------------------------------+---------------------------------------------------------------+ -| **Note**: Bots, deactivated users, and synthetic users in | -| :doc:`Microsoft Teams integrations ` | ++---------------------------------------------------------------+----------------------------------------------------------------+ +| View statistics per team on number of activated users, | - System Config path: **Reporting > Team Statistics** | +| number of public and private channels, total post count, and | - ``config.json`` setting: N/A | +| count of paid users (self-hosted only). | - Environment variable: N/A | ++---------------------------------------------------------------+----------------------------------------------------------------+ +| **Note**: Bots, deactivated users, and synthetic users in | +| :doc:`Microsoft Teams integrations ` | | and :doc:`connected workspaces ` users aren't counted towards the total number of active users. | -+---------------------------------------------------------------+---------------------------------------------------------------+ ++---------------------------------------------------------------+----------------------------------------------------------------+ ---- diff --git a/source/configure/site-configuration-settings.rst b/source/configure/site-configuration-settings.rst index d0d8526d507..1ef0db4c548 100644 --- a/source/configure/site-configuration-settings.rst +++ b/source/configure/site-configuration-settings.rst @@ -1752,7 +1752,7 @@ Connected workspaces The following settings aren't available in the System Console and can only be set in ``config.json``. When connected workspaces are enabled, system admins can :doc:`create and manage connected workspaces ` in the System Console by going to **Site Configuration > Connected Workspaces (Beta)**. -.. config:setting:: enable-connected-workspace +.. config:setting:: enable-connected-workspaces :displayname: Enable connected workspaces (Beta) :systemconsole: Site Configuration > Connected Workspaces (Beta) :configjson: ConnectedWorkspacesSettings.EnableSharedChannels, ConnectedWorkspacesSettings.EnableRemoteClusterService @@ -1772,8 +1772,9 @@ This feature's two ``config.json`` settings include: .. note:: - - Neither setting is available in the System Console and can only be set in ``config.json``. + - Neither setting is available in the System Console and can only be set in ``config.json`` under ``ConnectedWorkspacesSettings``. - System admins for Cloud deployments can submit a request to have these required configuration settings enabled for their Cloud deployment instance. + - Following an upgrade to Mattermost v10.2 or later, existing configuration values for shared channels, including ``EnableSharedChannels`` and ``EnableRemoteClusterService`` are automatically converted to :ref:`connected workspace configuration settings ` in the ``config.json`` file. The :ref:`deprecated shared channels experimental settings ` remain in the ``config.json`` file to support backwards compatibility. .. config:setting:: disable-status-sync :displayname: Disable shared channel status sync diff --git a/source/onboard/ad-ldap.rst b/source/onboard/ad-ldap.rst index 86c22db0589..979fdbe32b7 100644 --- a/source/onboard/ad-ldap.rst +++ b/source/onboard/ad-ldap.rst @@ -281,7 +281,7 @@ To address this issue you can set the :ref:`max page size `__. -2. Using the System Console or slash commands, system admins create a secure and trusted connection with other Mattermost Enterprise instances. This process involves creating a password-protected, encrypted invitation, creating a strong decryption password, then sending the invitation and password to the system admin of a remote Mattermost instance. +2. Using the System Console or slash commands, system admins `create a secure and trusted connection <#create-a-secure-connection>`__ with other Mattermost Enterprise instances. This process involves creating a password-protected, encrypted invitation, creating a strong decryption password, then sending the invitation and password to the system admin of a remote Mattermost instance. 3. Using the System Console or slash commands, a remote system admin receives the invitation and `accepts the invitation <#accept-a-secure-connection-invitation>`__. @@ -43,6 +43,10 @@ System admins must enable connected workspaces functionality for their Mattermos See the :ref:`Site Configuration Settings ` documentation for details. +.. note:: + + Following an upgrade to Mattermost v10.2 or later, existing configuration values for shared channels, including ``EnableSharedChannels`` and ``EnableRemoteClusterService`` are automatically converted to :ref:`connected workspace configuration settings ` in the ``config.json`` file. The :ref:`deprecated shared channels experimental settings ` remain in the ``config.json`` file to support backwards compatibility. + Create a secure connection --------------------------- From 06a4e9ea540f0bf1ae626ec2b31d96d38f1340d0 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Fri, 15 Nov 2024 15:10:47 -0500 Subject: [PATCH 2/3] Update source/configure/site-configuration-settings.rst --- source/configure/site-configuration-settings.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/configure/site-configuration-settings.rst b/source/configure/site-configuration-settings.rst index 1ef0db4c548..6418ea4be56 100644 --- a/source/configure/site-configuration-settings.rst +++ b/source/configure/site-configuration-settings.rst @@ -1774,7 +1774,7 @@ This feature's two ``config.json`` settings include: - Neither setting is available in the System Console and can only be set in ``config.json`` under ``ConnectedWorkspacesSettings``. - System admins for Cloud deployments can submit a request to have these required configuration settings enabled for their Cloud deployment instance. - - Following an upgrade to Mattermost v10.2 or later, existing configuration values for shared channels, including ``EnableSharedChannels`` and ``EnableRemoteClusterService`` are automatically converted to :ref:`connected workspace configuration settings ` in the ``config.json`` file. The :ref:`deprecated shared channels experimental settings ` remain in the ``config.json`` file to support backwards compatibility. + - Following an upgrade to Mattermost v10.2 or later, existing configuration values for shared channels, including ``EnableSharedChannels`` and ``EnableRemoteClusterService`` are automatically converted to connected workspace configuration settings in the ``config.json`` file. The :ref:`deprecated shared channels experimental settings ` remain in the ``config.json`` file to support backwards compatibility. .. config:setting:: disable-status-sync :displayname: Disable shared channel status sync From e575fdd6fdcd69fffcc387f43610b02ba5389839 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Mon, 18 Nov 2024 09:28:37 -0500 Subject: [PATCH 3/3] Added Beta label to config settings --- .../deprecated-configuration-settings.rst | 4 ++-- .../configure/site-configuration-settings.rst | 20 +++++++++---------- source/onboard/connected-workspaces.rst | 8 ++++---- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/source/configure/deprecated-configuration-settings.rst b/source/configure/deprecated-configuration-settings.rst index 5d84702db12..15dfbda6161 100644 --- a/source/configure/deprecated-configuration-settings.rst +++ b/source/configure/deprecated-configuration-settings.rst @@ -790,7 +790,7 @@ Shared channels settings Enable remote cluster service (Experimental) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Deprecated in November 16th, 2024 release in favor of :ref:`Connected Workspaces ` configuration settings +Deprecated in November 16th, 2024 release in favor of :ref:`Connected Workspaces ` configuration settings This setting isn't available in the System Console and can only be set in ``config.json``. @@ -807,7 +807,7 @@ Enable this setting to add, remove, and view remote clusters for shared channels Enable shared channels (Experimental) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Deprecated in November 16th, 2024 release in favor of :ref:`Connected Workspaces ` configuration settings +Deprecated in November 16th, 2024 release in favor of :ref:`Connected Workspaces ` configuration settings This setting isn't available in the System Console and can only be set in ``config.json``. diff --git a/source/configure/site-configuration-settings.rst b/source/configure/site-configuration-settings.rst index 6418ea4be56..903259e5cc2 100644 --- a/source/configure/site-configuration-settings.rst +++ b/source/configure/site-configuration-settings.rst @@ -1743,8 +1743,8 @@ Enable end user notices | | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_USERNOTICESENABLED`` | +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -Connected workspaces ---------------------- +Connected workspaces (Beta) +--------------------------- .. include:: ../_static/badges/ent-cloud-selfhosted.rst :start-after: :nosearch: @@ -1759,8 +1759,8 @@ When connected workspaces are enabled, system admins can :doc:`create and manage :environment: N/A :description: Establish secure connections between Mattermost instances, and invite secured connections to shared channels -Enable connected workspaces -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Enable connected workspaces (Beta) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Enable the ability to establish secure connections between Mattermost instances, and invite secured connections to shared channels where users can participate as they would in any public and private channel. Both configuration settings are disabled by default and must be enabled in order to share channels with secure connections. Enabling connected workspace functionality requires a server restart. @@ -1777,7 +1777,7 @@ This feature's two ``config.json`` settings include: - Following an upgrade to Mattermost v10.2 or later, existing configuration values for shared channels, including ``EnableSharedChannels`` and ``EnableRemoteClusterService`` are automatically converted to connected workspace configuration settings in the ``config.json`` file. The :ref:`deprecated shared channels experimental settings ` remain in the ``config.json`` file to support backwards compatibility. .. config:setting:: disable-status-sync - :displayname: Disable shared channel status sync + :displayname: Disable shared channel status sync (Beta) :systemconsole: N/A :configjson: ConnectedWorkspacesSettings.DisableSharedChannelsStatusSync :environment: N/A @@ -1785,8 +1785,8 @@ This feature's two ``config.json`` settings include: - **true**: Channel as well as member status and availability isn't synchronized. - **false**: **(Default)** Channel as well as channel member status and availability is synchronized at regular intervals. -Disable shared channel status sync -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Disable shared channel status sync (Beta) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Disable member status and availability synchronization between connected workspaces. @@ -1797,14 +1797,14 @@ Disable member status and availability synchronization between connected workspa +----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ .. config:setting:: default-maxpostspersync - :displayname: Default maximum posts per sync + :displayname: Default maximum posts per sync (Beta) :systemconsole: N/A :configjson: ConnectedWorkspacesSettings.DefaultMaxPostsPerSync :environment: N/A :description: Define the default maximum number of mesages to synchronize at a time between connected workspaces. Default is 50. -Default maximum posts per sync -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Default maximum posts per sync (Beta) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | Define the default maximum number of mesages to synchronize at a time. | - System Config path: N/A | diff --git a/source/onboard/connected-workspaces.rst b/source/onboard/connected-workspaces.rst index 16d022e0a81..925f6151e4f 100644 --- a/source/onboard/connected-workspaces.rst +++ b/source/onboard/connected-workspaces.rst @@ -41,11 +41,11 @@ System admins must enable connected workspaces functionality for their Mattermos - ``ConnectedWorkspacesSettings.EnableRemoteClusterService = true`` - ``ConnectedWorkspacesSettings.EnableSharedChannels = true`` -See the :ref:`Site Configuration Settings ` documentation for details. +See the :ref:`Site Configuration Settings ` documentation for details. .. note:: - Following an upgrade to Mattermost v10.2 or later, existing configuration values for shared channels, including ``EnableSharedChannels`` and ``EnableRemoteClusterService`` are automatically converted to :ref:`connected workspace configuration settings ` in the ``config.json`` file. The :ref:`deprecated shared channels experimental settings ` remain in the ``config.json`` file to support backwards compatibility. + Following an upgrade to Mattermost v10.2 or later, existing configuration values for shared channels, including ``EnableSharedChannels`` and ``EnableRemoteClusterService`` are automatically converted to :ref:`connected workspace configuration settings ` in the ``config.json`` file. The :ref:`deprecated shared channels experimental settings ` remain in the ``config.json`` file to support backwards compatibility. Create a secure connection --------------------------- @@ -272,9 +272,9 @@ When a user is added to a shared channel, member status is synchronized within a When using Mattermost in a web browser, Mattermost polls the server every minute. Refreshing the browser page triggers immediate synchronization. -By default, a maximum of 50 messages are synchronized at a time, and :ref:`this value is configurable `. +By default, a maximum of 50 messages are synchronized at a time, and :ref:`this value is configurable `. -Channel as well as member status and availability synchronization :ref:`can be disabled `. +Channel as well as member status and availability synchronization :ref:`can be disabled `. Do connection interruptions affect message synchronization? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~