Skip to content
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
10 changes: 10 additions & 0 deletions source/deployment-guide/desktop/desktop-app-deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ In Matermost, users are notified under **Downloads** when new desktop app releas

See additional deployment options below to manage distribution of the mobile app to your users.

Windows distribution channels
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

From desktop v6.1, organizations deploying on Windows have 2 primary distribution options:

- **Windows Store** (recommended): Provides automatic updates through the Microsoft Store infrastructure. This is the recommended option for most organizations seeking streamlined update management.
- **MSI packages**: Traditional deployment method with full control over installation timing. See the :doc:`MSI installer and group policy guide </deployment-guide/desktop/desktop-msi-installer-and-group-policy-install>` for details.

The desktop v6.1 app includes in-app update notifications. All distribution channels (Windows Store, MSI, Mac App Store, Flathub, APT/RPM) release simultaneously to prevent notification and availability mismatches across deployment methods.

Deployment options
------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,37 @@ This page provides guidance on installing the desktop app MSI and use Group Poli

Want to :doc:`distribute the official Windows desktop app silently </deployment-guide/desktop/silent-windows-desktop-distribution>` to your end users instead?

Windows distribution options
----------------------------

From desktop v6.1, organizations deploying on Windows have 2 primary distribution options:

- **Windows Store**: Primary option for automatic updates. Recommended for most users. The Windows Store version handles updates automatically through the Microsoft Store infrastructure.
- **MSI installer**: Direct download option for traditional deployment methods. This guide covers MSI deployment.

The desktop v6.1 app includes in-app update notifications that check the Mattermost website for new versions. All distribution channels (Windows Store, MSI, Mac App Store, Flathub, APT/RPM) release simultaneously to ensure users receive consistent update notifications regardless of their installation method.

Upgrading to v6.1.0 with MSI installer
---------------------------------------

Users upgrading from earlier Desktop app versions using the MSI installer may need to recreate taskbar shortcuts once after the upgrade. The v6.1.0 installer uses a more reliable method for shortcut icons that prevents shortcuts from breaking during future upgrades. This fixes a long-standing issue where shortcuts could break during MSI upgrades. This is a one-time action for the upgrade to v6.1.0. Future upgrades to v6.1.1 and later won't require shortcut recreation. Windows Store deployments aren't affected by this change.

We recommend telling your users in advance that they may need to re-pin the taskbar shortcut after upgrading to desktop app v6.1. Desktop shortcuts are typically unaffected while taskbar shortcuts are most commonly impacted.

If a user reports a broken shortcut after upgrading to v6.1.0, the user should:

1. Right-click the broken shortcut on the taskbar and select **Unpin from taskbar**.
2. Launch Mattermost Desktop from the Start Menu.
3. Right-click the Mattermost icon in the taskbar.
4. Select **Pin to taskbar**.

Download group policy and MSI installer files
----------------------------------------------

1. Using a newly created Windows VM or dedicated Windows computer, make sure to use a Windows version that supports ``Edit group policy`` out of the box (i.e. Windows 10 Pro or Enterprise).

.. image:: ../../images/desktop/msi_gpo/msi_gpo_installation_test_00001.png
:alt: When downloading group policy and MIS installer files, ensure to use a Windows version that supports Edit group policy.
:alt: When downloading group policy and MIS installer files, ensure to use a Windows version that supports Edit group policy.

2. Navigate to the `Mattermost Desktop <https://github.com/mattermost/desktop>`__ repository on `GitHub.com <https://github.com/>`__.

Expand Down Expand Up @@ -53,10 +77,10 @@ The following group policies are available supporting a state option of Not Conf

2. Navigate to the unzipped ``desktop-6.0.3\resources\windows\gpo`` folder and copy the contents.

.. image:: ../../images/desktop/msi_gpo/msi_gpo_installation_test_00005.png
.. image:: ../../images/desktop/msi_gpo/msi_gpo_installation_test_00005.png
:alt: Go to the \resources\windows\gpo directory and copy its contents.

3. Navigate to the ``C:\Windows\PolicyDefinitions`` folder and paste the files copied in the last step.
3. Navigate to the ``C:\Windows\PolicyDefinitions`` folder and paste the files copied in the last step.

.. image:: ../../images/desktop/msi_gpo/msi_gpo_installation_test_00006.png
:alt: Go to the Windows\PolicyDefinitions directory and paste the files you copied in the previous step.
Expand Down Expand Up @@ -88,7 +112,7 @@ Configure Mattermost using group policy settings
.. image:: ../../images/desktop/msi_gpo/msi_gpo_installation_test_00009.png
:alt: When configuring Mattermost using group policy settings, run the Edit group policy application by going to Start, typing gpedit into the search field, then selecting the resulting Edit group policy search option.

2. In the **Edit group policy** window, navigate to ``Local Computer Policy\Computer Configuration\Administrative Templates\Mattermost``. In this example, double-click on ``DefaultServerList`` to set one or more default servers that will appear on app launch.
2. In the **Edit group policy** window, navigate to ``Local Computer Policy\Computer Configuration\Administrative Templates\Mattermost``. In this example, double-click on ``DefaultServerList`` to set one or more default servers that will appear on app launch.

.. image:: ../../images/desktop/msi_gpo/msi_gpo_installation_test_00010.png
:alt: In the Edit group policy window, go to Local Computer Policy > Computer Configuration > Administrative Templates > Mattermost. To set one or more default servers to appear on app launch, for example, double-click on DefaultServerList to begin.
Expand Down Expand Up @@ -135,7 +159,7 @@ Install the Mattermost Desktop App using the MSI installer

.. important::

- If the desktop app is running when you install via the MSI, Mattermost prompts you to close the app manually. After acknkowledging the prompt, select **Retry** to continue the MSI installation.
- If the desktop app is running when you install via the MSI, Mattermost prompts you to close the app manually. After acknkowledging the prompt, select **Retry** to continue the MSI installation.
- Avoid selecting **Ignore**. If you do, force close the desktop app using Task Manager, ensure the ``Mattermost.exe`` process is stopped, and then restart the MSI installation.

1. Within the folder the MSI installer was downloaded to, double-click on the MSI installer to begin the Mattermost Desktop installation process.
Expand All @@ -161,7 +185,7 @@ Verify group policy settings in the installed desktop app
2. Verify the app loads the first server you defined in the **Edit group policy** app.

.. image:: ../../images/desktop/msi_gpo/msi_gpo_installation_test_00018.png
:alt: Verify group policy settings in the Mattermost Desktop App by opening the app from the Start menu, and verifying that the app loads the first server you defined in the Edit group policy.
:alt: Verify group policy settings in the Mattermost Desktop App by opening the app from the Start menu, and verifying that the app loads the first server you defined in the Edit group policy.

Advanced MSI options
--------------------
Expand Down
18 changes: 18 additions & 0 deletions source/deployment-guide/desktop/desktop-troubleshooting.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
Desktop app troubleshooting
============================

Broken shortcuts after upgrading to v6.1.0 (Windows MSI only)
Comment thread
cwarnermm marked this conversation as resolved.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

After upgrading to Mattermost Desktop v6.1.0 using the Windows MSI installer from an older release, the desktop or taskbar shortcut shows the wrong icon or fails to launch. This is due to a one-time icon handling change in the Windows MSI installer to improve shortcut reliability for future upgrades.

This issue doesn't block app usage and only affects Windows MSI installer upgrades from pre-v6.1.0 versions. Users can launch Mattermost from the Start Menu or a working desktop shortcut.Future upgrades to v6.1.1 and later will not require shortcut recreation.

To resolve this issue, recreate the shortcut:

1. Right-click the broken shortcut on the taskbar and select **Unpin from taskbar**.
2. Launch Mattermost Desktop from the Start Menu or a working desktop shortcut.
3. Right-click the Mattermost icon in the taskbar while the application is running.
4. Select **Pin to taskbar**.

The new shortcut will work correctly for all future upgrades.

Organizations standardizing on Windows installations can choose between Windows Store (recommended for automatic updates) or MSI packages (traditional deployment). The MSI method includes this one-time shortcut adjustment; the Windows Store method doesn't.

Where is configuration stored locally?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
24 changes: 20 additions & 4 deletions source/end-user-guide/access/install-desktop-app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Install the Mattermost desktop app

Download and install the Mattermost desktop app `for macOS from the App Store <https://apps.apple.com/us/app/mattermost-desktop/id1614666244?mt=12>`_, `for Windows from the Microsoft Store <https://apps.microsoft.com/detail/xp8br8mh3lpklt?hl=en-US&gl=US>`_, or by :doc:`using a package manager (Linux) </deployment-guide/desktop/linux-desktop-install>`. When new desktop app releases become available, your desktop app is automatically updated.

We strongly recommend installing the desktop app on a local drive. Network shares aren't supported.
We strongly recommend installing the desktop app on a local drive. Network shares aren't supported.

1. When prompted, enter the Mattermost server link and a display name for the Mattermost instance. The display name is helpful in cases where you connect to multiple Mattermost instances. See the :doc:`server connections </end-user-guide/preferences/connect-multiple-workspaces>` documentation for details.
2. Enter your user credentials to log into Mattermost.
2. Enter your user credentials to log into Mattermost.
3. The team that displays first in the team sidebar opens. If you're not a member of a team yet, you're prompted to select a team to join.

.. note::
Expand All @@ -19,6 +19,22 @@ We strongly recommend installing the desktop app on a local drive. Network share
Upgrade the desktop app
------------------------

In Matermost, youre notified under **Downloads** when new desktop app releases become available.
In Matermost, you're notified under **Downloads** when new desktop app releases become available.

When automatic updates are disabled, you can manually check for updates by selecting **Help > Check for Updates** from the desktop app menu bar.
When automatic updates are disabled, you can manually check for updates by selecting **Help > Check for Updates** from the desktop app menu bar.

Upgrading to v6.1.0 using Windows MSI installer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you're upgrading from a version earlier than v6.1.0 using the Windows MSI installer, you may need to recreate your taskbar shortcut once after upgrading. This one-time change improves shortcut reliability and prevents shortcuts from breaking during future upgrades.

Prior to v6.1.0, installing over an older Desktop App version could break shortcuts. The v6.1.0 MSI installer uses a more reliable method for shortcut icons that prevents this issue in future upgrades. This only affects Windows MSI installer upgrades. The Windows Store version is not affected, and future upgrades to v6.1.1 and later won't require shortcut recreation.

If your taskbar shortcut shows the wrong icon or fails to launch after upgrading to v6.1.0:

1. Right-click the broken shortcut on your taskbar and select **Unpin from taskbar**.
2. Launch Mattermost Desktop from the Start Menu or desktop shortcut.
3. Right-click the Mattermost icon in the taskbar while it's running.
4. Select **Pin to taskbar**.

Your new shortcut will work correctly for all future updates.