Skip to content

Added channel banner docs & new SKU badges #8043

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

Merged
merged 3 commits into from
Jun 13, 2025
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
14 changes: 14 additions & 0 deletions source/_static/badges/ent-adv-cloud-selfhosted.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
:orphan:
:nosearch:

.. raw:: html

<div class="mm-plans-badge">

|plans-img| Available on `Enterprise Advanced plans <https://mattermost.com/pricing/>`__

|deployment-img| `Cloud <https://mattermost.com/sign-up/>`__ and `self-hosted <https://mattermost.com/download/>`__ deployments

.. raw:: html

</div>
9 changes: 9 additions & 0 deletions source/_static/badges/ent-adv-only.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
```{raw} html
<div class="mm-plans-badge">
```

![plans-img](/_static/images/badges/flag_icon.svg) Available only on [Enterprise Advanced](https://mattermost.com/pricing/) plans

```{raw} html
</div>
```
16 changes: 16 additions & 0 deletions source/_static/badges/ent-adv-only.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
:orphan:
:nosearch:

.. If used with include::, note the paths for images

.. raw:: html

<div class="mm-badge mm-badge--note">

Note

|plans-img-yellow| Available only on `Enterprise Advanced <https://mattermost.com/pricing/>`__ plans

.. raw:: html

</div>
2 changes: 2 additions & 0 deletions source/collaborate/collaborate-within-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Learn more about collaborating within Mattermost channels:
Communicate a channel's focus and scope </collaborate/channel-header-purpose>
Create channels </collaborate/create-channels>
Rename channels </collaborate/rename-channels>
Display channel banners </collaborate/display-channel-banners>
Convert public channels to private channels </collaborate/convert-public-channels>
Convert group messages to private channels </collaborate/convert-group-messages>
Join and leave channels </collaborate/join-leave-channels>
Expand All @@ -55,6 +56,7 @@ Learn more about collaborating within Mattermost channels:
* :doc:`Navigate between channels </collaborate/navigate-between-channels>` - Learn how to navigate between channels.
* :doc:`Create channels </collaborate/create-channels>` - Create channels to organize discussion by topic, project, or focus.
* :doc:`Rename a channel </collaborate/rename-channels>` - Rename channels to make them more discoverable.
* :doc:`Display channel banners </collaborate/display-channel-banners>` - Display a fixed banner at the top of channels to warn users about the presence of classified or sensitive information.
* :doc:`Convert public channels to private channels </collaborate/convert-public-channels>` - Learn how to convert channel access and visibility.
* :doc:`Convert group messages to private channels </collaborate/convert-group-messages>` - Learn how to convert group messages to private channels.
* :doc:`Manage channel members </collaborate/manage-channel-members>` - Add and remove users from channels.
Expand Down
38 changes: 38 additions & 0 deletions source/collaborate/display-channel-banners.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Display channel headers
=======================

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

From Mattermost v10.9, users with admin permissions can enable channel banners to remind channel members about being diligent to avoid data spillage in channels that aren't intended for classified or sensitive information. These non-dismissible banners can be styled using Markdown and are visible across all Mattermost clients, including web browsers, the desktop app, and the mobile app.

Channel banner use cases include the following:

- Security classifications, such as **CONTROLLED UNCLASSIFIED: IMPACT LEVEL 5** with a distinctive color to alert members of the required security level.
- Important notices, such as **Reminder: Code complete deadlines are Fridays at 3 PM**, for recurring reminders.
- Policy or terms, such as **All discussion in this channel is private and restricted** with a red color to signal caution.

Mattermost :ref:`channel admins <collaborate/learn-about-roles:channel admin>`, :ref:`team admins <collaborate/learn-about-roles:team admin>`, and :ref:`system admins <collaborate/learn-about-roles:system admin>` can enable a banner with custom text at the top of Mattermost public or private channels.

Create a channel banner:

1. Open a channel where you have administrative permissions.
2. Select the channel name at the top of the center pane to access the drop-down menu, then select **Channel Settings**.
3. Select **Configuration** and enable the **Channel Banner** option.
4. Specify the banner text you want to display at the top of the channel. You can style the text using :ref:`Markdown <collaborate/format-messages:use markdown>`, if desired.
5. Select the banner color.
6. Select **Save** to apply the changes. The banner displays immediately.

Change a channel banner
------------------------

You can change the banner text or color at any time by following the same steps above. The new banner text or color displays immediately.

Remove a channel banner
-------------------------

Disable the **Channel Banner** option in the channel settings to remove the banner from the channel.

.. tip::

System admins can grant any user the ability to create and manage channel banners by assigning the **Manage Channel Banners** permission in the System Console. See the :doc:`advanced permissions </onboard/advanced-permissions>` documentation for details.
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,8 @@ Permissions in Mattermost are a property of the server code base and are not cre
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| order_bookmark_private_channel | channel | Reorder bookmarks in a private channel. |
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| manage_channel_banner | channel | Manage channel banners. |
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

``Roles`` field
~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -284,6 +286,7 @@ The following built-in roles with default permissions are available:
- edit_bookmark_private_channel
- delete_bookmark_private_channel
- order_bookmark_private_channel
- manage_channel_banner

*channel_guest*

Expand Down Expand Up @@ -456,6 +459,7 @@ The following built-in roles with default permissions are available:
- edit_bookmark_private_channel
- delete_bookmark_private_channel
- order_bookmark_private_channel
- manage_channel_banner

*system_custom_group_admin*

Expand Down Expand Up @@ -636,6 +640,7 @@ The following built-in roles with default permissions are available:
- edit_bookmark_private_channel
- delete_bookmark_private_channel
- order_bookmark_private_channel
- manage_channel_banner

*team_guest*

Expand Down