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

V10.5 Docs #7701

Open
wants to merge 23 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
ba3001e
Update conf.py
amyblais Jan 16, 2025
e73a1ea
Merge branch 'master' into v10.5-documentation
amyblais Jan 17, 2025
7a26278
Merge branch 'master' into v10.5-documentation
amyblais Jan 20, 2025
615a282
Merge branch 'master' into v10.5-documentation
amyblais Jan 21, 2025
cb88187
Merge branch 'master' into v10.5-documentation
amyblais Jan 23, 2025
67d5e58
Merge branch 'master' into v10.5-documentation
amyblais Jan 24, 2025
547070e
ESR notes (#7713)
amyblais Jan 24, 2025
efc8970
Merge branch 'master' into v10.5-documentation
amyblais Jan 27, 2025
fd52a48
Merge branch 'master' into v10.5-documentation
amyblais Jan 28, 2025
5dd959a
Update prepare-mattermost-database.rst
amyblais Jan 29, 2025
f452c31
Merge branch 'master' into v10.5-documentation
amyblais Jan 31, 2025
109d88c
Merge branch 'master' into v10.5-documentation
amyblais Feb 4, 2025
4a2ddde
Merge branch 'master' into v10.5-documentation
amyblais Feb 5, 2025
a8f4c40
Added S3 storage guidance for Legal Holds (#7727)
cwarnermm Feb 7, 2025
448906a
Added note re: Azure costs incurred & credits (#7732)
cwarnermm Feb 7, 2025
8f65d70
Compliance Export updates (#7719)
cwarnermm Feb 7, 2025
fbb169f
MS Teams v2.1.0 updates (#7725)
cwarnermm Feb 10, 2025
44aff09
Updated bookmark flow (#7726)
cwarnermm Feb 10, 2025
080df19
Added white page troubleshooting details (#7733)
cwarnermm Feb 10, 2025
c49d581
Added local drafts note (#7735)
cwarnermm Feb 10, 2025
8746a22
Merge branch 'master' into v10.5-documentation
cwarnermm Feb 10, 2025
44de53e
Updated self-host install steps for pre-packaged (#7724)
cwarnermm Feb 10, 2025
36fb502
add mmctl config export docs (#7718)
isacikgoz Feb 10, 2025
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
2 changes: 1 addition & 1 deletion source/about/mattermost-mobile-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
```

```{Important}
- Support for Mattermost Server v9.5 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
- Support for Mattermost Server v9.11 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is recommended.
- We strongly recommend using the latest mobile app release available that contains the latest security fixes and user experience enhancements. Mobile app releases are tested against all generally available Mattermost server and extended support releases.
```

Expand Down
2 changes: 1 addition & 1 deletion source/about/mattermost-server-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```

```{Important}
Support for Mattermost Server v9.5 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
Support for Mattermost Server v9.11 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is recommended.
- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the v9.11 ESR.
```

Expand Down
2 changes: 1 addition & 1 deletion source/about/mattermost-v10-changelog.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# v10 changelog

```{Important}
Support for Mattermost Server v9.5 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
Support for Mattermost Server v9.11 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is recommended.
- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the v9.11 ESR.
- See the [Important Upgrade Notes](https://docs.mattermost.com/upgrade/important-upgrade-notes.html) documentation for details on upgrading to a newer release.
- See the [changelog in progress](https://bit.ly/2nK3cVf) for details about the upcoming release.
Expand Down
2 changes: 1 addition & 1 deletion source/about/mattermost-v9-changelog.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# v9 changelog

```{Important}
Support for Mattermost Server v9.5 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
Support for Mattermost Server v9.11 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is recommended.
- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the v9.11 ESR.
- See the [Important Upgrade Notes](https://docs.mattermost.com/upgrade/important-upgrade-notes.html) documentation for details on upgrading to a newer release.
- See the [changelog in progress](https://bit.ly/2nK3cVf) for details about the upcoming release.
Expand Down
12 changes: 6 additions & 6 deletions source/about/release-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,21 +53,21 @@ gantt
tickInterval 2month

section 2024
v9.5 Extended Support :crit, 2024-02-16, 2024-11-15
v9.6 :done, 2024-03-16, 2024-06-15
v9.7 :done, 2024-04-16, 2024-07-15
v9.8 :done, 2024-05-15, 2024-08-15
v9.9 :done, 2024-06-16, 2024-09-15
v9.10 :done, 2024-07-16, 2024-10-15
v9.11 & Desktop App v5.9 Extended Support :crit, 2024-08-16, 2025-05-15
v10.0 :active, 2024-09-16, 2024-12-15
v10.1 :active, 2024-10-16, 2025-01-15
v10.2 :active, 2024-11-15, 2025-02-15
v10.3 :upcoming, 2024-12-16, 2025-03-15
v10.0 :done, 2024-09-16, 2024-12-15
v10.1 :done, 2024-10-16, 2025-01-15
v10.2 :active, 2024-11-15, 2025-02-15
v10.3 :active, 2024-12-16, 2025-03-15

section 2025
v10.4 :upcoming, 2025-01-16, 2025-04-15
v10.4 :active, 2025-01-16, 2025-04-15
v10.5 & Desktop App v5.11 Extended Support :crit, 2025-02-16, 2025-11-15
v10.6 :upcoming, 2025-03-16, 2025-06-15
```

(esr-notifications)=
Expand Down
2 changes: 1 addition & 1 deletion source/about/version-archive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Version archive
:start-after: :nosearch:

.. important::
- Support for Mattermost Server v9.5 :ref:`Extended Support Release <about/release-policy:extended support releases>` has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
- Support for Mattermost Server v9.11 :ref:`Extended Support Release <about/release-policy:extended support releases>` is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is recommended.
- 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,17 @@ Once the integration is installed and configured by a System Administrator, you
2. In any channel, run the ``/msteams connect`` slash command, and select the resulting link.
3. Authenticate with Microsoft Teams using the email address matching your account in Mattermost.

Mattermost will confirm when your account is connected, and prompt you to enable notifications.
Mattermost will confirm when your account is connected.

Enable notifications
----------------------

Once you've connected your Mattermost account to your Microsoft Teams account, Mattermost prompts you to enable notifications. When enabled and you're offline or away from Teams, any messages you receive in a chat or group chat in Microsoft Teams will display in Mattermost as a notification, with a link to open the chat in Microsoft Teams and continue the conversation. These notifications won't appear if you've been recently active in Teams.
Once you've connected your Mattermost account to your Microsoft Teams account, when you're offline or away from Microsoft Teams, any messages you receive in a chat or group chat in Microsoft Teams will display in Mattermost as a notification and include a link to open the chat in Microsoft Teams to continue the conversation. These notifications won't appear if you've been recently active in Teams.

.. image:: ../images/microsoft-teams-chat-notifications.png
:alt: An example of a chat message notification.

Manage notification settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can enable or disable notification settings for the Microsoft Teams integration at any time in **Settings** > **Plugin Preferences**
Manage your Mattermost notification settings for the Microsoft Teams integration at any time in **Settings** > **Plugin Preferences**

.. image:: ../images/teams_plugin_notification_settings.png
:alt: Manage notification settings for the Microsoft Teams integration in Account Settings > Plugin Preferences
Expand All @@ -59,10 +56,10 @@ Frequently asked questions
How does the integration determine when to send chat notifications?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Chat notifications are sent in real-time whenever you're not active in Microsoft Teams and receive a chat or group chat; however, Mattermost uses your online status in Teams to determine if a chat notification should be delivered. Mattermost delivers notifications if you appear **Away** or **Offline** in Microsoft Teams, so the default behavior for when notifications will be delivered depends on the client you typically use to access Microsoft Teams:
Chat notifications are sent in real-time whenever you're not active in Microsoft Teams and receive a chat or group chat. Mattermost uses your online status in Teams to determine if a chat notification should be delivered. Mattermost delivers notifications if you appear **Away** or **Offline** in Microsoft Teams, so the default behavior for when notifications will be delivered depends on the client you typically use to access Microsoft Teams:

- Web browser: Mattermost delivers notifications when you've not had activity in your Microsoft Teams browser tab for 5 minutes or more, or when the browser tab is closed.
- Desktop app: Mattermost delivers notifications when you've not had activity at your computer for 5 minutes or more, or when the Microsoft Teams desktop app is closed.
- Web browser: Mattermost delivers notifications when you've not had activity in your Microsoft Teams browser tab for 5 minutes or more, when the browser tab is closed, or when you mark yourself as **Offline** in Microsoft Teams.
- Desktop app: Mattermost delivers notifications when you've not had activity at your computer for 5 minutes or more, when the Microsoft Teams desktop app is closed, or when you mark yourself as **Offline** in Microsoft Teams.

In order to avoid double notifications, Mattermost won't deliver chat notifications when your availability is set to **Available**, **Busy**, **Do not disturb**, or **Be right back** in Microsoft Teams.

15 changes: 12 additions & 3 deletions source/collaborate/install-desktop-app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -226,13 +226,22 @@ On macOS Catalina, this dialog can be triggered if the Mac Archive Utility is th
Desktop App window is black and doesn't load the page
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. First, make sure you have installed the latest desktop app version.
1. Ensure you have installed the latest desktop app version available.
2. Clear your cache and reload the app from **View > Clear Cache and Reload** or press :kbd:`Ctrl` :kbd:`Shift` :kbd:`R` on Windows or Linux, or :kbd:`` :kbd:`` :kbd:`R` on Mac.
3. Quit the app and restart it to see if the issue clears.
4. Disable GPU hardware acceleration from **File > Settings** on Windows and Linux or **Mattermost > Settings** on macOS, and unselect **Use GPU hardware acceleration**.
4. Disable GPU hardware acceleration.

- On Windows or Linux, select **File > Settings** and clear the **Use GPU hardware acceleration** option.
- On macOS, select **Mattermost > Settings** and clear the **Use GPU hardware acceleration** option.

5. If you are using a special video driver, such as Optimus, try disabling it to see if the problem is resolved.

If none of the above steps resolve the issue, please open a new ticket in the `Troubleshooting forum <https://forum.mattermost.com/c/trouble-shoot/16>`_.
Desktop App window is white and doesn't load the page
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Ensure you have installed the latest desktop app version available.
2. Delete the ``%userprofile%\AppData\Roaming\Mattermost`` directory on your local machine.
3. Reinstall the desktop app.

Desktop App is not visible, but the Mattermost icon is in the Task Bar
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
16 changes: 5 additions & 11 deletions source/collaborate/manage-channel-bookmarks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Manage channel bookmarks
.. include:: ../_static/badges/ent-pro-cloud-selfhosted.rst
:start-after: :nosearch:

From Mattermost v10.1, you can bookmark up to 50 links or files to the top of channels for quick and easy access, unless your system admin has disabled your ability to do so. Bookmarked links and files display in the bookmarks bar located directly below the channel header.
From Mattermost v10.1, you can bookmark up to 50 links or files to the top of channels for quick and easy access, unless your system admin has disabled your ability to do so. Bookmarks display directly under channel headers.

.. tip::

Any file added as a channel bookmark is also searchable in Mattermost.
Any file added as a channel bookmark is also :doc:`searchable </collaborate/search-for-messages>` in Mattermost.

Open a bookmark
---------------
Expand All @@ -20,20 +20,14 @@ Add a bookmark

.. tab:: Web/Desktop

1. In the bookmarks bar, select **Add a bookmark**.

.. image:: ../images/desktop-bookmark-add.png
:alt: Using a web browser or the desktop app, select the Plus icon to add a channel bookmark.
1. From Mattermost v10.5, select the channel name at the top of the center pane to access the drop-down menu, and select **Bookmarks Bar** to add a link or attach a file. In Mattermost versions prior to v10.5, select **Add a bookmark** in the bookmarks bar instead.

- Select **Add a link** to specify the link URL, specify bookmark text, and an optional bookmark icon.
- Select **Add a file** to select a file, specify bookmark text, and an optional bookmark icon.

.. image:: ../images/desktop-bookmark-add-choice.png
:alt: Using a web browser or the desktop app, choose whether to add a link or a file.
- Select **Attach a file** to select a file, specify bookmark text, and an optional bookmark icon.

.. tab:: Mobile

The bookmarks bar is hidden by default when a channel has no bookmarks.
The bookmarks bar is hidden when a channel has no bookmarks.

1. In a channel, select the **More** |more-icon-vertical| icon.

Expand Down
4 changes: 3 additions & 1 deletion source/collaborate/send-messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,9 @@ By default, message drafts are synchronized on the Mattermost server and are acc

.. tab:: Mobile

When composing a message, you can simply opt to complete it later. The partially composed message is kept in the text field and an **Edit** option |edit-icon| displays next to the channel name.
When composing a message, you can simply choose to complete it later. The partially composed message is kept in the text field and an **Edit** option |edit-icon| displays next to the channel name.

From Mattermost v10.5, you'll find local draft messages under **Drafts**. Drafts synchronized to the Mattermost server will be listed under **Drafts** in a future mobile app release.

.. image:: ../images/mobile-draft-a-message.gif
:alt: You can sync a daft message by exiting the channel mid-way while composing the message.
Expand Down
Loading