diff --git a/source/collaborate/archive-unarchive-channels.rst b/source/collaborate/archive-unarchive-channels.rst index d4f762704dd..e4e9f3577f6 100644 --- a/source/collaborate/archive-unarchive-channels.rst +++ b/source/collaborate/archive-unarchive-channels.rst @@ -17,7 +17,7 @@ When a channel is archived, it's deleted from the user interface, but a copy exi .. note:: - - All users are added to the **Off-Topic** and **Town Square** channels automatically. Users can't archive, `unarchive <#unarchive-a-channel>`__, or :ref:`leave ` these channels. + - All users are added to the **Off-Topic** and **Town Square** channels automatically. Town Square can't be archived. - System admins can archive channels in the System Console without needing to be a channel member. - Because a copy of the channel exists on the server, you can't reuse the URL of an archived channel when :doc:`creating a new channel `. - Instead of archiving the channel, you can also leave it open and post a message in the channel saying it's considered archived, such as: ``# This channel is archived.`` @@ -41,10 +41,6 @@ Unarchive a channel System admins and Team admins can restore archived channels. When a channel is unarchived, channel membership and all its content is restored, unless messages and files have been deleted based on the :ref:`data retention policy `. -.. note:: - - All users are added to the **Off-Topic** and **Town Square** channels automatically. Users can't `archive <#archive-a-channel>`__, unarchive, or :ref:`leave ` these channels. - .. tab:: Web/Desktop Search for the channel if required. Then, open the channel, select the channel name at the top of the center pane to access the drop-down menu and select **Unarchive Channel**. diff --git a/source/collaborate/collaborate-within-channels.rst b/source/collaborate/collaborate-within-channels.rst index 63f1d9b65af..9587e7941a7 100644 --- a/source/collaborate/collaborate-within-channels.rst +++ b/source/collaborate/collaborate-within-channels.rst @@ -27,7 +27,7 @@ Everyone who joins a Mattermost workspace is automatically added to two default - **Off-Topic** is great for fun, social, non-work-related conversations. .. note:: - All users are added to the **Off-Topic** and **Town Square** channels automatically. Users can't :ref:`archive `, :ref:`unarchive `, or :ref:`leave ` these channels. + All users are added to the **Off-Topic** and **Town Square** channels automatically. Town Square can't be :ref:`archived ` or :doc:`converted to a private channel `, and users can't :ref:`leave ` the Town Square channel. Channel sidebar ---------------- diff --git a/source/collaborate/convert-public-channels.rst b/source/collaborate/convert-public-channels.rst index 82666136dc9..d0a69253753 100644 --- a/source/collaborate/convert-public-channels.rst +++ b/source/collaborate/convert-public-channels.rst @@ -11,7 +11,7 @@ Convert public channels to private channels You must be a system admin or team admin to convert public channels to private channels. When a channel is converted from public to private, its history and membership are preserved. Membership in a private channel remains as invitation only. Publicly-shared files remain accessible to anyone with the link. .. note:: - Default channels such as ``Town Square`` and ``Off-Topic`` can't be converted to private channels. + The default channel ``Town Square`` can't be converted to a private channel. .. tab:: Web/Desktop @@ -42,4 +42,4 @@ Due to potential security concerns with sharing private channel history, only sy .. tip:: - Alternatively, system admins can convert private channels to public channels using the :ref:`mmctl channel modify command `. \ No newline at end of file + Alternatively, system admins can convert private channels to public channels using the :ref:`mmctl channel modify command `. diff --git a/source/conf.py b/source/conf.py index e2b8a070892..7803b6428cc 100644 --- a/source/conf.py +++ b/source/conf.py @@ -364,6 +364,8 @@ def setup(_: Sphinx): "https://docs.mattermost.com/manage/mmctl-command-line-tool.html#mmctl-channel-delete", "administration/version-archive.html": "https://docs.mattermost.com/upgrade/version-archive.html", +"administration/mmctl-cli-tool.html#local-mode": + "https://docs.mattermost.com/configure/experimental-configuration-settings.html#enable-local-mode-for-mmctl", # Boards redirects "boards/navigating-mattermost-boards.html": diff --git a/source/configure/database-configuration-settings.rst b/source/configure/database-configuration-settings.rst index 701fa09dbd8..929d935ef88 100644 --- a/source/configure/database-configuration-settings.rst +++ b/source/configure/database-configuration-settings.rst @@ -153,7 +153,7 @@ Data source :systemconsole: Environment > Database :configjson: SqlSettings.MaxIdleConns :environment: MM_SQLSETTINGS_MAXIDLECONNS - :description: The maximum number of idle connections held open to the database. Default is **10**. + :description: The maximum number of idle connections held open to the database. Default is **20**. Maximum idle database connections ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -164,9 +164,9 @@ Maximum idle database connections +--------------------------------------------------------+------------------------------------------------------------------+ | The maximum number of idle connections held open | - System Config path: **Environment > Database** | -| to the database. | - ``config.json`` setting: ``".SqlSettings.MaxIdleConns": 10,`` | +| to the database. | - ``config.json`` setting: ``".SqlSettings.MaxIdleConns": 20,`` | | | - Environment variable: ``MM_SQLSETTINGS_MAXIDLECONNS`` | -| Numerical input. Default is **10**. | | +| Numerical input. Default is **20**. | | +--------------------------------------------------------+------------------------------------------------------------------+ .. config:setting:: database-maxopenconnections diff --git a/source/configure/smtp-configuration-settings.rst b/source/configure/smtp-configuration-settings.rst index 4d7c5cbf5e3..76c2c47aa38 100644 --- a/source/configure/smtp-configuration-settings.rst +++ b/source/configure/smtp-configuration-settings.rst @@ -164,8 +164,8 @@ Skip server certificate verification .. config:setting:: smtp-enablesecurityalerts :displayname: Enable security alerts (SMTP) :systemconsole: Environment > SMTP - :configjson: .EmailSettings.EnableSecurityFixAlert - :environment: MM_EMAILSETTINGS_ENABLESECURITYFIXALERT + :configjson: .ServiceSettings.EnableSecurityFixAlert + :environment: MM_SERVICESETTINGS_ENABLESECURITYFIXALERT - **true**: **(Default)** System Admins are notified by email if a relevant security fix alert is announced. Requires email to be enabled. - **false**: Security alerts are disabled. @@ -177,16 +177,16 @@ Enable security alerts

Also available in legacy Mattermost Enterprise Edition E10 or E20

-+-----------------------------------------------------------------+----------------------------------------------------------------------------------+ -| Enable or disable security alerts. | - System Config path: **Environment > SMTP** | -| | - ``config.json setting``: ``".EmailSettings.EnableSecurityFixAlert": true",`` | -| - **true**: **(Default)** System Admins are notified by email | - Environment variable: ``MM_EMAILSETTINGS_ENABLESECURITYFIXALERT`` | -| if a relevant security fix alert is announced. Requires email | | -| to be enabled. | | -| - **false**: Security alerts are disabled. | | -+-----------------------------------------------------------------+----------------------------------------------------------------------------------+ -| See the :ref:`Telemetry ` documentation to learn more. | -+-----------------------------------------------------------------+----------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+------------------------------------------------------------------------------------+ +| Enable or disable security alerts. | - System Config path: **Environment > SMTP** | +| | - ``config.json setting``: ``".ServiceSettings.EnableSecurityFixAlert": true",`` | +| - **true**: **(Default)** System Admins are notified by email | - Environment variable: ``MM_SERVICESETTINGS_ENABLESECURITYFIXALERT`` | +| if a relevant security fix alert is announced. Requires email | | +| to be enabled. | | +| - **false**: Security alerts are disabled. | | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------+ +| See the :ref:`Telemetry ` documentation to learn more. | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------+ .. config:setting:: smtp-servertimeout :displayname: SMTP server timeout (SMTP) diff --git a/source/getting-started/enterprise-roll-out-checklist.rst b/source/getting-started/enterprise-roll-out-checklist.rst index 5891cd5ae5c..e678ee106ad 100644 --- a/source/getting-started/enterprise-roll-out-checklist.rst +++ b/source/getting-started/enterprise-roll-out-checklist.rst @@ -232,7 +232,7 @@ Now that you have an environment in place, we recommend working through the foll - Recommendation: Start with fewer teams in your early roll out - Resource: https://docs.mattermost.com/messaging/organizing-channels.html -- Determine and create key channels to support your users. Town Square and Off-Topic are built in channels in every team +- Determine and create key channels to support your users. Town Square and Off-Topic are automatically created channels available on every team - Recommendation: Add a “Support” channel for your users to escalate questions diff --git a/source/guides/community-chat.rst b/source/guides/community-chat.rst index 5a4c05e0b40..cecce894329 100644 --- a/source/guides/community-chat.rst +++ b/source/guides/community-chat.rst @@ -6,21 +6,21 @@ Connect with thousands of contributors, customers, partners, and users to build, General channels ---------------- -- `~Contributors `__ -- `~Community Team `__ -- `~Developers `__ -- `~New Channel Notifications `__ -- `~Off-Topic `__ -- `~Reception `__ +- `Contributors `__ +- `Community Team `__ +- `Developers `__ +- `New Channel Notifications `__ +- `Off-Topic `__ +- `Reception `__ Technical support channels -------------------------- To familiarize yourself with our community support process, start by reading the :doc:`Get Help ` documentation page. -- `~Ask Anything `__ -- `~Bugs `__ -- `~Peer-to-peer Help `__ +- `Ask Anything `__ +- `Bugs `__ +- `Peer-to-peer Help `__ We also recommend using the `Troubleshooting forum `__ for technical support. @@ -29,15 +29,15 @@ Contributor community channels To familiarize yourself with our community contribution process, start by exploring the `Contribute to Mattermost `__ documentation. -- `~AI Exchange `__ -- `~Developers: Meeting `__ -- `~DWG: Documentation Working Group `__ -- `~Feature Proposals `__ -- `~i18n - Localization `__ -- `~Open Source Fridays (OSF) `__ -- `~Public Speakers `__ -- `~QA: Contributors `__ -- `~Thank you! `__ +- `AI Exchange `__ +- `Developers: Meeting `__ +- `DWG: Documentation Working Group `__ +- `Feature Proposals `__ +- `i18n - Localization `__ +- `Open Source Fridays (OSF) `__ +- `Public Speakers `__ +- `QA: Contributors `__ +- `Thank you! `__ There are many channels that specialize in different areas of the Mattermost platform. To find and join them, search “**Developers:**” in the `LHS `__ “🔍 Find channel” search bar on the community server. diff --git a/source/guides/contribute-to-documentation.rst b/source/guides/contribute-to-documentation.rst index 59c207efb37..c5a1557817b 100644 --- a/source/guides/contribute-to-documentation.rst +++ b/source/guides/contribute-to-documentation.rst @@ -1,7 +1,7 @@ Contribute to this documentation ================================ -Mattermost has a diverse community that extends well beyond code contributions. If you're interested in contributing to Mattermost, why not help improve the documentation? Be sure to join the documentation community in `~DWG: Documentation Working Group `_ so we can support and celebrate you! +Mattermost has a diverse community that extends well beyond code contributions. If you're interested in contributing to Mattermost, why not help improve the documentation? Be sure to join the documentation community in `DWG: Documentation Working Group `_ so we can support and celebrate you! How to get started ------------------ diff --git a/source/images/focus.png b/source/images/focus.png index 352cbdb7a56..3b4cc76d64f 100644 Binary files a/source/images/focus.png and b/source/images/focus.png differ diff --git a/source/install/software-hardware-requirements.rst b/source/install/software-hardware-requirements.rst index fcb8f3100be..38bfa226d96 100644 --- a/source/install/software-hardware-requirements.rst +++ b/source/install/software-hardware-requirements.rst @@ -97,7 +97,7 @@ Database software ^^^^^^^^^^^^^^^^^ - PostgreSQL 11.0+ -- MySQL 5.7.12, 8.0.12+ (see note below on MySQL 8 support) +- MySQL 8.0.12+ (see note below on MySQL 8 support) Amazon Aurora equivalents of both PostgreSQL and MySQL are also supported. @@ -180,4 +180,4 @@ For Enterprise Edition deployments with a multi-server setup, we highly recommen - Prometheus to track system health of your Mattermost deployment, through :doc:`performance monitoring feature ` available in Mattermost Enterprise. - Grafana to visualize the system health metrics collected by Prometheus with the :doc:`performance monitoring feature `. Grafana 5.0.0 and later is recommended. - Elasticsearch to support highly efficient database searches in a cluster environment. Elasticsearch 7.x is supported. :doc:`Learn more here `. -- MinIO or AWS S3. Mattermost is compatible with object storage systems which implement the S3 API. Other S3-compatible systems may work, but are not officially supported. Learn more about file storage configuration options :ref:`in our documentation `. \ No newline at end of file +- MinIO or AWS S3. Mattermost is compatible with object storage systems which implement the S3 API. Other S3-compatible systems may work, but are not officially supported. Learn more about file storage configuration options :ref:`in our documentation `. diff --git a/source/onboard/ad-ldap-groups-synchronization.rst b/source/onboard/ad-ldap-groups-synchronization.rst index cf460421199..a21e80ccc41 100644 --- a/source/onboard/ad-ldap-groups-synchronization.rst +++ b/source/onboard/ad-ldap-groups-synchronization.rst @@ -117,7 +117,7 @@ Channels are nested below the team they belong to in the team and channel list. .. note:: - - When a team is added, the ``Town Square`` and ``Off-Topic`` channels will also be added as default, as well as any default channels set in the :ref:`ExperimentalDefaultChannels config setting `. + - When a team is added, the ``Town Square`` and ``Off-Topic`` channels will also be created automatically, as well as any default channels set in the :ref:`ExperimentalDefaultChannels config setting `. - When a channel is added without setting the team explicitly, the team will be shown in the **Team and Channel Membership** listing, but it won't be added to the group specifically. Because of this dependency, when the channel is removed, the team will also be removed. Teams are listed in parentheses after the channel name in the channel selector. Synchronize teams and channels diff --git a/source/onboard/user-provisioning-workflows.rst b/source/onboard/user-provisioning-workflows.rst index 149b8ffcdca..70da2a16e73 100644 --- a/source/onboard/user-provisioning-workflows.rst +++ b/source/onboard/user-provisioning-workflows.rst @@ -13,7 +13,7 @@ User Provisioning There are currently three recommended user provisioning workflows in Mattermost: -1. **On demand:** If user accounts are not pre-provisioned using one of the methods described below, then a new user account will be provisioned when the user first logs in. When the user logs in, they are asked to select a public team to join (all users must belong to at least one team) and then they are added automatically to Town Square and Off-Topic channels. Mattermost also has a default channel setting that allows everyone to be added to additional channels specified by the organization. +1. **On demand:** If user accounts are not pre-provisioned using one of the methods described below, then a new user account will be provisioned when the user first logs in. When the user logs in, they are asked to select a public team to join (all users must belong to at least one team) and then they are added automatically to Town Square and Off-Topic channels. Mattermost also has a :ref:`default channel setting ` that enables system admins to add everyone to additional channels specified by the organization. 2. **Pre-provisioned via bulk import:** Mattermost features a :doc:`bulk data loading tool ` that can be used for pre-provisioning new users by adding them to teams and channels before their first login to Mattermost. This tool automates the creation of Teams, Channels, Users, and Posts (with file attachments). It can also be used to migrate users and content from an existing system. 3. **Mattermost API:** The Mattermost `RESTful API `__ can be used to pre-provision new user accounts as well as add and remove them from teams and channels. This model is commonly used by enterprises that have central account provisioning applications. diff --git a/source/scale/performance-alerting.rst b/source/scale/performance-alerting.rst index 657daa9ed6a..20dff47523f 100644 --- a/source/scale/performance-alerting.rst +++ b/source/scale/performance-alerting.rst @@ -23,7 +23,7 @@ To get alerts, first set up a Notification Channel in Grafana. Here’s how you 1. In Mattermost: a. Create an Alerts channel. - b. Create an `incoming webhook `__ for the Alerts channel and copy the URL. + b. Create an `incoming webhook `__ for the Alerts channel and copy the URL. 2. In Grafana: diff --git a/source/upgrade/version-archive.rst b/source/upgrade/version-archive.rst index 21fdfbb9ccf..2184e2b3672 100644 --- a/source/upgrade/version-archive.rst +++ b/source/upgrade/version-archive.rst @@ -4,7 +4,10 @@ Version Archive .. include:: ../_static/badges/allplans-selfhosted.rst :start-after: :nosearch: -If you want to check that the version of Mattermost you are installing is the official, unmodified version, compare the SHA-265 checksum or the file's GPG signature with the one published in this version archive. To verify the GPG signature of a Mattermost release, use the public key stored in Keybase: https://keybase.io/mattermost. +.. important:: + Note that our package signing key has been moved away from Keybase. If you still reference Keybase in your deployment steps for retrieving the key, update them to the new key location: https://deb.packages.mattermost.com/pubkey.gpg. + +If you want to check that the version of Mattermost you are installing is the official, unmodified version, compare the SHA-256 checksum or the file's GPG signature with the one published in this version archive. To verify the GPG signature of a Mattermost release, use the public key stored at the following URL: https://deb.packages.mattermost.com/pubkey.gpg. .. important::