Skip to content

Commit

Permalink
Merge branch 'master' into mattermost-supported-integrations
Browse files Browse the repository at this point in the history
  • Loading branch information
mattermost-build authored Apr 24, 2024
2 parents 7ad7a36 + 0f6302d commit 7bd0b2d
Show file tree
Hide file tree
Showing 15 changed files with 50 additions and 49 deletions.
6 changes: 1 addition & 5 deletions source/collaborate/archive-unarchive-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <collaborate/join-leave-channels:leave a channel>` 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 </collaborate/create-channels>`.
- 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.``
Expand All @@ -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 <configure/compliance-configuration-settings:data retention policies>`.

.. 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 <collaborate/join-leave-channels:leave a channel>` 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**.
Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/collaborate-within-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <collaborate/archive-unarchive-channels:archive a channel>`, :ref:`unarchive <collaborate/archive-unarchive-channels:unarchive a channel>`, or :ref:`leave <collaborate/join-leave-channels:leave a channel>` these channels.
All users are added to the **Off-Topic** and **Town Square** channels automatically. Town Square can't be :ref:`archived <collaborate/archive-unarchive-channels:archive a channel>` or :doc:`converted to a private channel </collaborate/convert-public-channels>`, and users can't :ref:`leave <collaborate/join-leave-channels:leave a channel>` the Town Square channel.

Channel sidebar
----------------
Expand Down
4 changes: 2 additions & 2 deletions source/collaborate/convert-public-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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 <manage/mmctl-command-line-tool:mmctl channel modify>`.
Alternatively, system admins can convert private channels to public channels using the :ref:`mmctl channel modify command <manage/mmctl-command-line-tool:mmctl channel modify>`.
2 changes: 2 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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":
Expand Down
6 changes: 3 additions & 3 deletions source/configure/database-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -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
Expand Down
24 changes: 12 additions & 12 deletions source/configure/smtp-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -177,16 +177,16 @@ Enable security alerts

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

+-----------------------------------------------------------------+----------------------------------------------------------------------------------+
| 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 <manage/telemetry:security update check feature>` 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 <manage/telemetry:security update check feature>` documentation to learn more. |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------+

.. config:setting:: smtp-servertimeout
:displayname: SMTP server timeout (SMTP)
Expand Down
2 changes: 1 addition & 1 deletion source/getting-started/enterprise-roll-out-checklist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
36 changes: 18 additions & 18 deletions source/guides/community-chat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ Connect with thousands of contributors, customers, partners, and users to build,
General channels
----------------

- `~Contributors <https://community.mattermost.com/core/channels/tickets>`__
- `~Community Team <https://community.mattermost.com/core/channels/community-team>`__
- `~Developers <https://community.mattermost.com/core/channels/developers>`__
- `~New Channel Notifications <https://community.mattermost.com/core/channels/new-channel-notifications>`__
- `~Off-Topic <https://community.mattermost.com/core/channels/off-topic-pub>`__
- `~Reception <https://community.mattermost.com/core/channels/town-square>`__
- `Contributors <https://community.mattermost.com/core/channels/tickets>`__
- `Community Team <https://community.mattermost.com/core/channels/community-team>`__
- `Developers <https://community.mattermost.com/core/channels/developers>`__
- `New Channel Notifications <https://community.mattermost.com/core/channels/new-channel-notifications>`__
- `Off-Topic <https://community.mattermost.com/core/channels/off-topic-pub>`__
- `Reception <https://community.mattermost.com/core/channels/town-square>`__

Technical support channels
--------------------------

To familiarize yourself with our community support process, start by reading the :doc:`Get Help </guides/get-help>` documentation page.

- `~Ask Anything <https://community.mattermost.com/core/channels/ask-anything>`__
- `~Bugs <https://community.mattermost.com/core/channels/bugs>`__
- `~Peer-to-peer Help <https://community.mattermost.com/core/channels/peer-to-peer-help>`__
- `Ask Anything <https://community.mattermost.com/core/channels/ask-anything>`__
- `Bugs <https://community.mattermost.com/core/channels/bugs>`__
- `Peer-to-peer Help <https://community.mattermost.com/core/channels/peer-to-peer-help>`__

We also recommend using the `Troubleshooting forum <https://forum.mattermost.com/c/trouble-shoot/16>`__ for technical support.

Expand All @@ -29,15 +29,15 @@ Contributor community channels

To familiarize yourself with our community contribution process, start by exploring the `Contribute to Mattermost <https://mattermost.com/contribute/>`__ documentation.

- `~AI Exchange <https://community.mattermost.com/core/channels/ai-exchange>`__
- `~Developers: Meeting <https://community.mattermost.com/core/channels/developers-meeting>`__
- `~DWG: Documentation Working Group <https://community.mattermost.com/core/channels/dwg-documentation-working-group>`__
- `~Feature Proposals <https://community.mattermost.com/core/channels/feature-ideas>`__
- `~i18n - Localization <https://community.mattermost.com/core/channels/localization>`__
- `~Open Source Fridays (OSF) <https://community.mattermost.com/core/channels/open-source-fridays>`__
- `~Public Speakers <https://community.mattermost.com/core/channels/public-speakers>`__
- `~QA: Contributors <https://community.mattermost.com/core/channels/qa-contributors>`__
- `~Thank you! <https://community.mattermost.com/core/channels/thank-you>`__
- `AI Exchange <https://community.mattermost.com/core/channels/ai-exchange>`__
- `Developers: Meeting <https://community.mattermost.com/core/channels/developers-meeting>`__
- `DWG: Documentation Working Group <https://community.mattermost.com/core/channels/dwg-documentation-working-group>`__
- `Feature Proposals <https://community.mattermost.com/core/channels/feature-ideas>`__
- `i18n - Localization <https://community.mattermost.com/core/channels/localization>`__
- `Open Source Fridays (OSF) <https://community.mattermost.com/core/channels/open-source-fridays>`__
- `Public Speakers <https://community.mattermost.com/core/channels/public-speakers>`__
- `QA: Contributors <https://community.mattermost.com/core/channels/qa-contributors>`__
- `Thank you! <https://community.mattermost.com/core/channels/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 <https://handbook.mattermost.com/company/about-mattermost/list-of-terms#lhs>`__ “🔍 Find channel” search bar on the community server.

Expand Down
2 changes: 1 addition & 1 deletion source/guides/contribute-to-documentation.rst
Original file line number Diff line number Diff line change
@@ -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 <https://community.mattermost.com/core/channels/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 <https://community.mattermost.com/core/channels/dwg-documentation-working-group>`_ so we can support and celebrate you!

How to get started
------------------
Expand Down
Binary file modified source/images/focus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions source/install/software-hardware-requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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 </scale/performance-monitoring>` available in Mattermost Enterprise.
- Grafana to visualize the system health metrics collected by Prometheus with the :doc:`performance monitoring feature </scale/performance-monitoring>`. 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 </scale/elasticsearch>`.
- 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 <configure/environment-configuration-settings:file storage>`.
- 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 <configure/environment-configuration-settings:file storage>`.
2 changes: 1 addition & 1 deletion source/onboard/ad-ldap-groups-synchronization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <configure/experimental-configuration-settings:default channels>`.
- 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 <configure/experimental-configuration-settings:default channels>`.
- 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
Expand Down
2 changes: 1 addition & 1 deletion source/onboard/user-provisioning-workflows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <configure/experimental-configuration-settings:default channels>` 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 </onboard/bulk-loading-data>` 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 <https://api.mattermost.com>`__ 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.

Expand Down
2 changes: 1 addition & 1 deletion source/scale/performance-alerting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://developers.mattermost.com/integrate/admin-guide/admin-webhooks-incoming/>`__ for the Alerts channel and copy the URL.
b. Create an `incoming webhook <https://developers.mattermost.com/integrate/webhooks/incoming/>`__ for the Alerts channel and copy the URL.

2. In Grafana:

Expand Down
Loading

0 comments on commit 7bd0b2d

Please sign in to comment.