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

Cleaned up shared channel config deprecation #7603

Merged
merged 5 commits into from
Nov 18, 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/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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":
Expand Down
59 changes: 41 additions & 18 deletions source/configure/deprecated-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`__

----
Expand Down Expand Up @@ -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 <configure/site-configuration-settings:enable connected workspaces (beta)>` 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 <configure/site-configuration-settings:enable connected workspaces (beta)>` 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
--------------------------

Expand Down Expand Up @@ -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``. |
+------------------------------------------------------------------------------------------------------------+
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.
18 changes: 9 additions & 9 deletions source/configure/reporting-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Site statistics
| |
| - Bots, deactivated users, and synthetic users in |
| :doc:`Microsoft Teams integrations </collaborate/collaborate-within-connected-microsoft-teams>` |
| and :doc:`connected workspaces </onboard/connected-workspaces>` users aren't counted towards the total number of activated users. |
| and :doc:`connected workspaces </onboard/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 </guides/use-mattermost>`. |
Expand All @@ -44,15 +44,15 @@ Team statistics

<p class="mm-label-note">Also available in legacy Mattermost Enterprise Edition E10 or E20</p>

+---------------------------------------------------------------+---------------------------------------------------------------+
| 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 </collaborate/collaborate-within-connected-microsoft-teams>` |
+---------------------------------------------------------------+----------------------------------------------------------------+
| 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 </collaborate/collaborate-within-connected-microsoft-teams>` |
| and :doc:`connected workspaces </onboard/connected-workspaces>` users aren't counted towards the total number of active users. |
+---------------------------------------------------------------+---------------------------------------------------------------+
+---------------------------------------------------------------+----------------------------------------------------------------+

----

Expand Down
25 changes: 13 additions & 12 deletions source/configure/site-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1743,24 +1743,24 @@ Enable end user notices
| | - Environment variable: ``MM_ANNOUNCEMENTSETTINGS_USERNOTICESENABLED`` |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+

Connected workspaces
---------------------
Connected workspaces (Beta)
---------------------------

.. include:: ../_static/badges/ent-cloud-selfhosted.rst
:start-after: :nosearch:

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 </onboard/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
: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.
Expand All @@ -1772,20 +1772,21 @@ 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 connected workspace configuration settings in the ``config.json`` file. The :ref:`deprecated shared channels experimental settings <configure/deprecated-configuration-settings:shared channels 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

- **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.

Expand All @@ -1796,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 |
Expand Down
2 changes: 1 addition & 1 deletion source/onboard/ad-ldap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ To address this issue you can set the :ref:`max page size <configure/authenticat
If the error is still occurring, it is likely that no AD/LDAP users have logged into Mattermost yet. Ensure that at least one AD/LDAP user has logged into Mattermost and re-run the synchronization. The error should disappear at that point.

I see the log error ``Missing NameID Element``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This indicates that the AD/LDAP server configuration doesn't include the ``NameID`` element in the SAML assertion. The ``NameID`` element is required for user identification in SAML assertions. Ensure the ``NameID`` is mapped to a unique user identifier, such as the user's email address or another stable attribute that isn't subject to change over time.

Expand Down
12 changes: 8 additions & 4 deletions source/onboard/connected-workspaces.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The process of connecting Mattermost workspaces involves the following 4 steps:

1. Each system admin of a Mattermost instance who wants to connect to another Mattermost workspaces must `enable the connected workflows functionality <#enable-connected-workflows>`__.

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>`__.

Expand All @@ -41,7 +41,11 @@ System admins must enable connected workspaces functionality for their Mattermos
- ``ConnectedWorkspacesSettings.EnableRemoteClusterService = true``
- ``ConnectedWorkspacesSettings.EnableSharedChannels = true``

See the :ref:`Site Configuration Settings <configure/site-configuration-settings:enable connected workspaces>` documentation for details.
See the :ref:`Site Configuration Settings <configure/site-configuration-settings:enable connected workspaces (beta)>` 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 <configure/site-configuration-settings:enable connected workspaces (beta)>` in the ``config.json`` file. The :ref:`deprecated shared channels experimental settings <configure/deprecated-configuration-settings:shared channels settings>` remain in the ``config.json`` file to support backwards compatibility.

Create a secure connection
---------------------------
Expand Down Expand Up @@ -268,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 <configure/site-configuration-settings:default maximum posts per sync>`.
By default, a maximum of 50 messages are synchronized at a time, and :ref:`this value is configurable <configure/site-configuration-settings:default maximum posts per sync (beta)>`.

Channel as well as member status and availability synchronization :ref:`can be disabled <configure/site-configuration-settings:disable shared channel status sync>`.
Channel as well as member status and availability synchronization :ref:`can be disabled <configure/site-configuration-settings:disable shared channel status sync (beta)>`.

Do connection interruptions affect message synchronization?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Loading