V5.38 documentation (#4914)

* Update conf.py * Update open-source-components.rst * Update release-lifecycle.rst * Reliable Websockets: default to true Documentation for: mattermost/mattermost#17890 Updated: - Set Up, Manage, Onboard, and Comply > Set Up Mattermost > Self-Managed Deployments > Configuration Settings > Experimental Settings only in config.json > Enable Reliable Websockets - Updated the default value of the config setting to ``true`` * PR didn't follow internal processes for submission * Re-added file deleted in error * Re-added the correct file that was deleted in error * MM-36779 - Add ChimeraOAuthProxyURL config option (#4928) * MM-36779 - Add ChimeraOAuthProxyURL config option Documentation for: mattermost/mattermost#17888 Updated: - Set Up, Manage, Onboard, and Comply > Set Up Mattermost > Self-Managed Deployments > Configuration Settings > Plugins (Beta) - Added the Chimera OAuth Proxy URL configuration setting * Added ChimeraOAuthProxyUrl to Telemetry * added note about the setting being available only via config.json * Update source/configure/configuration-settings.rst Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com> * Update source/configure/configuration-settings.rst Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com> Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com> * Reliable Websockets: default to true (#4918) Documentation for: mattermost/mattermost#17890 Updated: - Set Up, Manage, Onboard, and Comply > Set Up Mattermost > Self-Managed Deployments > Configuration Settings > Experimental Settings only in config.json > Enable Reliable Websockets - Updated the default value of the config setting to ``true`` * Added functionality to archive/unarchive teams from system console (#4927) * Added functionality to archive/unarchive teams from system console Documentation for: mattermost/mattermost-webapp#8129 Updated: - Set Up, Manage, Onboard, and Comply > Manage Mattermost > Self-Managed Deployments > Managing Team and Channel Members (E20) > Team Profile - Updated section to include details on how to archive/unarchive the team * Added archive/unarchive updates to Cloud-specific page * Updated LHS - Moved self-managed topic from all instances to self-managed - Added Cloud-specific topic * added mmctl equivalent for team restore * added mmctl equivalent for team restore (self-managed) * Update source/manage/cloud-team-and-channel.rst Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com> * Update source/manage/team-channel-members.rst Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com> * Update data-retention-policy.rst (#4937) * Update data-retention-policy.rst Adding docs for custom data retention policies. * Update data-retention-policy.rst * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update data-retention-policy.rst * Update data-retention-policy.rst * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update source/comply/data-retention-policy.rst Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update important-upgrade-notes.rst (#4811) * Update important-upgrade-notes.rst * Update important-upgrade-notes.rst * Update important-upgrade-notes.rst * Fix typos * MM-36547 Renamed 'Mute Channel' and 'Edit Channel Header' menus (#4941) Documentation for: mattermost/mattermost-webapp#8313 Updated: - Messaging > Manage Teams, Channels, and Members > Managing Channels > Creating a Direct or Group Message - Updated section to include mute, unmute, and edit header options for group and direct messages * MM-35722: CRT, post click open thread (#4942) Documentation for: mattermost/mattermost-webapp#8342 Updated: - Messages > Work with Messages > Organizing Conversations using Collapsed Reply Threads (Beta) > Start or Reply to Threads - Updated Tip bullet point #1 to clarify that uses can click anywhere in a message in the center pane to view it/reply to it * MM-35470 Disable config watching logic (#4951) * MM-35470 Disable config watching logic Documentation for: mattermost/mattermost#17913 Updated: - Set Up, Manage, Onboard, and Comply > Set Up Mattermost > Self-Managed Deployments > Configuration Settings - Updated introductory content to remove < v5.12 legacy note and add config watcher note and link to mmctl command * Update source/configure/configuration-settings.rst Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com> * v5.38.0 Changelog (#4810) * Update self-managed-changelog.md * Update self-managed-changelog.md * Update self-managed-changelog.md * Update self-managed-changelog.md * Update self-managed-changelog.md * Update self-managed-changelog.md * Update self-managed-changelog.md * Apply suggestions from code review Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update self-managed-changelog.md * Update self-managed-changelog.md * Update self-managed-changelog.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com> Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com>
mattermost · Aug 16, 2021 · 68d7777 · 68d7777
1 parent 74abb1a
commit 68d7777
Show file tree

Hide file tree

Showing 13 changed files with 266 additions and 44 deletions.
diff --git a/source/comply/data-retention-policy.rst b/source/comply/data-retention-policy.rst
@@ -5,23 +5,40 @@ Data Retention Policy (E20)
 
 By default, Mattermost stores all message history providing an unlimited search history to admins and end users.
 
-In Mattermost Enterprise E20, you can set a custom policy to manage how long messages and file uploads are kept in Mattermost channels and direct messages.
+In Mattermost Enterprise E20, you can set a global retention policy as well as custom retention policies to manage how long messages and file uploads are kept in Mattermost channels and Direct Messages
 
 .. warning:: 
-  Once a message or a file is deleted, the action is irreversible. Please use caution when setting up a custom data retention policy.
+  Once a message or a file is deleted, the action is irreversible. Please use caution when setting up global or custom data retention policies.
 
-Configuring a Data Retention Policy
-------------------------------------
+Configuring a Global Data Retention Policy
+-------------------------------------------
 
-To set a custom data retention policy:
+To set a global data retention policy in Mattermost v5.38 and later:
 
-1. Go to **System Console > Compliance > Data Retention Policy**.
-2. Select a **Message Retention** option. When a time is specified, messages, including file attachments, older than the duration you set will be deleted at the specified time. The minimum retention period is one day.
-3. Select a **File Retention** option. When a time is specified uploaded files which are older than the duration you set will be deleted from your file storage system (either from your local disk or your Amazon S3 service as specified in **System Console > Environment > File Storage** at the specified time. The minimum retention period is one day.
-4. Set the start time of the daily scheduled data retention job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form HH:MM.
+1. Go to **System Console > Compliance > Data Retention Policies**.
+2. Select **Edit** from the menu located to the right of the **Global retention policy** table. 
+3. Specify a global retention policy for channel messages and Direct Messages by selecting a **Channel & direct message retention** option from the dropdown, then set how long to keep those messages. When a time is set, messages and file attachments older than the duration you set will be deleted. The minimum retention period is one day.
+4. Select a **File retention** option from the dropdown. Set the number of days or ears to keep files. When a time is set, uploaded files which are older than the duration you set will be deleted from your file storage system (either from your local disk or your Amazon S3 service as specified in **System Console > Environment > File Storage**. The minimum retention period is one day. The global file policy deletes all files regardless of whether they're in a direct message, private, or public channel.
+5. Under the **Policy log** section, select **Edit** to specify the start time of the daily scheduled data retention job. Choose a time when fewer people are using your system. 
 
-Save the settings and restart your server. Messages and files older than the duration you set will be deleted at the specified server time, if applicable.
+Select **Save**. Messages and files older than the duration you set will be deleted at the specified server time, as applicable.
 
+Configuring a Custom Data Retention Policy
+-------------------------------------------
+
+To set a custom data retention policy in Mattermost v5.38 and later:
+
+1. Go to **System Console > Compliance > Data Retention Policies**.
+2. Select **Add policy** to the right of the **Custom retention policies** table. 
+3. Specify a name for your policy. 
+4. Specify a custom retention policy for channel and Direct Messages by selecting a **Channel & direct message retention** option from the dropdown, then set how long to keep uploaded files. When a time is set, messages and file attachments older than the duration you set will be deleted. The minimum retention period is one day.
+5. Assign teams and channels to this policy by selecting **Add teams** and searching for a specific team, or by selecting **Add channels** and searching for a specific channel. If only teams are specified, all channels for selected teams will be included in the a policy. 
+6. Under the **Policy log** section, select **Edit** to specify the start time of the daily scheduled data retention job. Choose a time when fewer people are using your system. If a time is already set for a global retention policy, then the same time applies to custom data retention policies. 
+
+Save the settings. Messages and files older than the duration you set will be deleted at the specified server time, as applicable.
+
+Running a Deletion Job Manually
+--------------------------------
 You can also run the deletion job manually at any time by selecting **Run Deletion Job Now** in **System Console > Compliance > Data Retention Policy**.
 
 .. note::
@@ -33,12 +50,14 @@ Frequently Asked Questions (FAQs)
 What happens when a message is deleted?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The message is removed from the Mattermost user interface and deleted from the ``Posts`` table. The message is no longer searchable and cannot be retrieved in pinned posts or saved posts lists.
+The message is removed from the Mattermost user interface and deleted from the ``Posts`` table. The message is no longer searchable and cannot be retrieved in pinned posts or saved posts lists. 
 
 Replies that did not exceed the message duration are still displayed in the user interface. However, further replies are no longer possible.
 
-What happens when a file is deleted?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+If there was a file attached to the message, it will be removed from the user interface only.  
+
+What happens when a file is deleted by the file retention policy?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The file attachment is removed from the Mattermost user interface, deleted from the ``FileInfo`` table, and from your local disk or Amazon S3 service as specified in **System Console > Environment > File Storage**.
 
@@ -59,14 +78,6 @@ Why do I see ``Pending`` in the deletion job table with no details?
 
 This usually means another data retention job is in progress. You can verify this in the deletion job table in  **System Console > Compliance > Data Retention Policy**.
 
-If no jobs are in progress and the job has stayed ``Pending`` for more than 2 minutes, then you may not have restarted your server after enabling the data retention policy. Restart your server and try again.
-
-How do I set a custom policy per team or channel?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Setting custom policies for each team and channel are in the roadmap but not yet supported.
-
-If you are interested in this feature, consider upvoting the `existing feature proposal <https://mattermost.uservoice.com/forums/306457-general/suggestions/31731844-ee-data-retention-policy-for-individual-teams-and>`__ and share your feedback in the comments.
 
 How is data retention handled in the mobile apps?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/source/conf.py b/source/conf.py
@@ -340,9 +340,9 @@ def setup(app):
 # built documents.
 #
 # The short X.Y version.
-# version = '5.37'
+# version = '5.38'
 # The full version, including alpha/beta/rc tags.
-# release = '5.37'
+# release = '5.38'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/source/configure/configuration-settings.rst b/source/configure/configuration-settings.rst
@@ -1,14 +1,15 @@
 Configuration Settings
 ======================
 
-.. note::
-   The order of the configuration settings below are reflective of a reorganization of the System Console in version 5.12 released on June 16th, 2019. To view the configuration settings based on the organization of the System Console in versions prior to version 5.12, please see `this documentation <https://docs.mattermost.com/administration/prev-config-settings.html>`_ instead.
-
 Mattermost configuration settings are maintained in the ``config.json`` configuration file, located in the ``mattermost/config`` directory. You can modify the configuration file using the System Console, or by using a text editor to modify it directly.
 
-Mattermost must have write permissions to ``config.json``, otherwise changes made in the System Console will have no effect.
+.. important::
+
+   Mattermost must have write permissions to ``config.json``, otherwise changes made in the System Console will have no effect.
+
+   On new installations from v5.14, the ``default.json`` file used to create the initial ``config.json`` has been removed from the binary and replaced with a build step that generates a fresh ``config.json``. This is to ensure the initial configuration file has all the correct defaults provided in the server code. Existing ``config.json`` files are not affected by this change.
 
-On new installations starting from v5.14, the ``default.json`` file used to create the initial ``config.json`` has been removed from the binary and replaced with a build step that generates a fresh ``config.json``. This is to ensure the initial configuration file has all the correct defaults provided in the server code. Existing ``config.json`` files are not affected by this change.
+   From Mattermost v5.38 (released August 16, 2021), the “config watcher” (the mechanism that automatically reloads the ``config.json`` file) has been deprecated in favor of the mmctl command `mmctl config reload <https://docs.mattermost.com/manage/mmctl-command-line-tool.html#mmctl-config-reload>`__ that must be run to apply configuration changes after they're made. This change will improve configuration performance and robustness.
 
 Configuration in Database
 --------------------------
@@ -1274,7 +1275,7 @@ Where:
   - Advanced logging supports hot-reloading of logger configuration.
 
 +----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| This feature’s ``config.json`` setting is ``LogSettings.AdvancedLoggingConfig`` which can contain a filespec to another config file, a database DSN, or JSON.        |                                                        
+| This feature’s ``config.json`` setting is ``LogSettings.AdvancedLoggingConfig`` which can contain a filespec to another config file, a database DSN, or JSON.        |                                                        
 +----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 Options outlined in `this text file <https://github.com/mattermost/docs/files/5066579/Log.Settings.Options.txt>`__ are described in the following table.
@@ -1380,7 +1381,7 @@ Options outlined in `this text file <https://github.com/mattermost/docs/files/50
 .. Note::
     Filenames for ``AdvancedLoggingConfig`` can contain an absolute filename, a relative filename, or embedded JSON.
 
-See the :download:`Advanced Logging Options Sample JSON ZIP file <../samples/advanced-logging-options-sample-json.zip>` for a sample configuration file. 
+See the :download:`Advanced Logging Options Sample JSON ZIP file <../samples/advanced-logging-options-sample-json.zip>` for a sample configuration file. 
 
 Standard Logging 
 ~~~~~~~~~~~~~~~~
@@ -1436,7 +1437,7 @@ Changes to this setting require a server restart before taking effect.
 Colorize plain text console logs
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-This setting can only be changed from ``config.json`` file, it cannot be changed from the System Console user interface.
+This setting can only be changed from ``config.json`` file, it cannot be changed from the System Console user interface.
 
 **True**: When logged events are output to the console as plain text, colorize log levels details.
 
@@ -3834,9 +3835,22 @@ Signature Public Key Files
 
 In addition to the Mattermost plugin signing key built into the server, each public key specified here is trusted to validate plugin signatures.
 
-+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| This feature's ``config.json`` setting is ``"SignaturePublicKeyFiles": {}`` with with string array input consisting of contents that are relative or absolute paths to signature files.                        |
-+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| This feature's ``config.json`` setting is ``"SignaturePublicKeyFiles": {}`` with string array input consisting of contents that are relative or absolute paths to signature files.              |
++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+Chimera OAuth Proxy URL
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Specify the `Chimera <https://github.com/mattermost/chimera>`__ URL used by Mattermost plugins to connect with pre-created OAuth applications.
+
++-------------------------------------------------------------------------------------------------------------------------+
+| This feature's ``config.json`` setting is ``"ChimeraOAuthProxyUrl": {}`` with string input.                             |
++-------------------------------------------------------------------------------------------------------------------------+
+
+.. note::
+
+   This setting isn't available in the System Console and can only be set in ``config.json``.
 
 Autolink
 ~~~~~~~~
@@ -5186,7 +5200,7 @@ Replica Lag Settings
 Specifies a connection string and user-defined SQL queries on the database to measure replica lag for a single replica instance. These settings monitor absolute lag based on binlog distance/transaction queue length, and the time taken for the replica to catch up.
 
 +-------------------------------------------------------------------------------------------------------+
-| This feature’s ``config.json`` setting is ``"ReplicaLagSettings": []`` with string array input.       |
+| This feature’s ``config.json`` setting is ``"ReplicaLagSettings": []`` with string array input.       |
 +-------------------------------------------------------------------------------------------------------+
 
 String array input consists of:
@@ -5412,7 +5426,7 @@ Enable Reliable Websockets
 Enable this setting to make websocket messages more reliable by buffering messages during a connection loss and then re-transmitting all unsent messages when the connection is revived.
 
 +-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| This feature's ``config.json`` setting is ``"EnableReliableWebsockets": false`` with options ``true`` and ``false``.                                              |
+| This feature's ``config.json`` setting is ``"EnableReliableWebsockets": true`` with options ``true`` and ``false``.                                               |
 +-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 Remote Clusters

diff --git a/source/guides/setup-onboard-manage-comply.rst b/source/guides/setup-onboard-manage-comply.rst
@@ -127,6 +127,7 @@ Cloud Workspaces
    :maxdepth: 1
    :glob:
 
+   /manage/cloud-team-channel.rst
    /manage/cloud-billing.rst
    /manage/cloud-reporting.rst
    /manage/cloud-user-satisfaction-surveys.rst
@@ -159,4 +160,4 @@ Cloud Workspaces
    /comply/cloud-compliance-and-oversight.rst
    /comply/cloud-compliance-export.rst
    /comply/cloud-data-retention-policy.rst
-   /comply/cloud-custom-terms-of-service.rst
+   /comply/cloud-custom-terms-of-service.rst