Skip to content

Commit

Permalink
Merge branch 'master' into MM-55587
Browse files Browse the repository at this point in the history
  • Loading branch information
cwarnermm authored Dec 15, 2023
2 parents f41c46d + 5e992cb commit 6fd744a
Show file tree
Hide file tree
Showing 16 changed files with 180 additions and 117 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,6 @@ The following software is required to build the documentation:
cd build
```
7. Then, preview your changes by opening the `source/html/index.html` file.
7. Then, preview your changes by opening the `build/html/index.html` file.
Build errors are written to the `build/warnings.log` file.
28 changes: 14 additions & 14 deletions source/collaborate/install-desktop-app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ You can `download the desktop app directly from our Downloads page <https://matt

**Install the Mattermost Desktop App**

1. Download the latest version of the Mattermost desktop app: `32/64-bit version of Windows <https://releases.mattermost.com/desktop/5.5.1/mattermost-desktop-setup-5.5.1-win.exe>`__
2. From the **\Downloads** folder, right-click on the file ``mattermost-desktop-setup-5.5.1-win.exe``, then select **Open** to start an installer for the app. Once finished, the Mattermost desktop app opens automatically.
1. Download the latest version of the Mattermost desktop app: `32/64-bit version of Windows <https://releases.mattermost.com/desktop/5.6.0/mattermost-desktop-setup-5.6.0-win.exe>`__
2. From the **\Downloads** folder, right-click on the file ``mattermost-desktop-setup-5.6.0-win.exe``, then select **Open** to start an installer for the app. Once finished, the Mattermost desktop app opens automatically.

**MSI Installer and group policies (beta)**

You can download the latest version of the Mattermost desktop app MSI installer (Beta):

- MSI for `64-bit version of Windows <https://releases.mattermost.com/desktop/5.5.1/mattermost-desktop-5.5.1-x64.msi>`__
- MSI for `32-bit version of Windows <https://releases.mattermost.com/desktop/5.5.1/mattermost-desktop-5.5.1-x86.msi>`__
- MSI for `64-bit version of Windows <https://releases.mattermost.com/desktop/5.6.0/mattermost-desktop-5.6.0-x64.msi>`__
- MSI for `32-bit version of Windows <https://releases.mattermost.com/desktop/5.6.0/mattermost-desktop-5.6.0-x86.msi>`__

The following group policies are available:

Expand Down Expand Up @@ -72,8 +72,8 @@ You can `download the desktop app directly from our Downloads page <https://matt

1. Download the latest version of the Mattermost desktop app:

- `Intel systems <https://releases.mattermost.com/desktop/5.5.1/mattermost-desktop-5.5.1-mac-x64.dmg>`__
- `M1 systems <https://releases.mattermost.com/desktop/5.5.1/mattermost-desktop-5.5.1-mac-m1.dmg>`__ (Beta)
- `Intel systems <https://releases.mattermost.com/desktop/5.6.0/mattermost-desktop-5.6.0-mac-x64.dmg>`__
- `M1 systems <https://releases.mattermost.com/desktop/5.6.0/mattermost-desktop-5.6.0-mac-m1.dmg>`__ (Beta)

2. Double-click the download to open the disk image.

Expand Down Expand Up @@ -127,22 +127,22 @@ You can `download the desktop app directly from our Downloads page <https://matt

1. Download the latest version of the Mattermost desktop app:

- 64-bit systems `mattermost-desktop-5.5.1-linux-x86_64.rpm <https://releases.mattermost.com/desktop/5.5.1/mattermost-desktop-5.5.1-linux-x86_64.rpm>`__
- 32-bit systems `mattermost-desktop-5.5.1-linux-i686.rpm <https://releases.mattermost.com/desktop/5.5.1/mattermost-desktop-5.5.1-linux-i686.rpm>`__
- 64-bit systems `mattermost-desktop-5.6.0-linux-x86_64.rpm <https://releases.mattermost.com/desktop/5.6.0/mattermost-desktop-5.6.0-linux-x86_64.rpm>`__
- 32-bit systems `mattermost-desktop-5.6.0-linux-i686.rpm <https://releases.mattermost.com/desktop/5.6.0/mattermost-desktop-5.6.0-linux-i686.rpm>`__

2. At the command line, execute one of the following commands based on the package you downloaded:

- 64-bit systems:

.. code-block:: none
sudo rpm -i mattermost-desktop-5.5.1-linux-x86_64.rpm
sudo rpm -i mattermost-desktop-5.6.0-linux-x86_64.rpm
- 32-bit systems:

.. code-block:: none
sudo rpm -i mattermost-desktop-5.5.1-linux-i686.rpm
sudo rpm -i mattermost-desktop-5.6.0-linux-i686.rpm
3. Run Mattermost as a desktop app.

Expand All @@ -152,13 +152,13 @@ You can `download the desktop app directly from our Downloads page <https://matt

.. code-block:: none
sudo rpm -u mattermost-desktop-5.5.1-linux-x86_64.rpm
sudo rpm -u mattermost-desktop-5.6.0-linux-x86_64.rpm
- 32-bit systems:

.. code-block:: none
sudo rpm -u mattermost-desktop-5.5.1-linux-i686.rpm
sudo rpm -u mattermost-desktop-5.6.0-linux-i686.rpm
.. tip::
You can review the current version of your desktop app by selecting the **More** |more-icon-vertical| icon located in the top left corner of the desktop app, then selecting **Help > Version...**.
Expand All @@ -169,8 +169,8 @@ You can `download the desktop app directly from our Downloads page <https://matt

1. Download the latest version of the Mattermost desktop app:

- 64-bit systems: `mattermost-desktop-5.5.1-linux-x64.tar.gz <https://releases.mattermost.com/desktop/5.5.1/mattermost-desktop-5.5.1-linux-x64.tar.gz>`__
- 32-bit systems: `mattermost-desktop-5.5.1-linux-ia32.tar.gz <https://releases.mattermost.com/desktop/5.5.1/mattermost-desktop-5.5.1-linux-ia32.tar.gz>`__
- 64-bit systems: `mattermost-desktop-5.6.0-linux-x64.tar.gz <https://releases.mattermost.com/desktop/5.6.0/mattermost-desktop-5.6.0-linux-x64.tar.gz>`__
- 32-bit systems: `mattermost-desktop-5.6.0-linux-ia32.tar.gz <https://releases.mattermost.com/desktop/5.6.0/mattermost-desktop-5.6.0-linux-ia32.tar.gz>`__

2. Extract the archive to a convenient location, then execute ``mattermost-desktop`` located inside the extracted directory.

Expand Down
66 changes: 65 additions & 1 deletion source/deploy/desktop-app-changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,70 @@ This changelog summarizes updates to Mattermost desktop app releases for `Matter
:backlinks: top
:depth: 2

Release v5.6
--------------

**Release Date: December 15, 2023**

**Download Binaries:** `Mattermost Desktop on GitHub <https://github.com/mattermost/desktop/releases/latest>`_

Compatibility
~~~~~~~~~~~~~~~

- Desktop App is supported on any currently `supported Mattermost server version <https://docs.mattermost.com/upgrade/release-lifecycle.html>`_.
- Updated Chromium minimum supported version to 118+.

Improvements
~~~~~~~~~~~~~~~

All Platforms
^^^^^^^^^^^^^

- Added Vietnamese as a new language (Beta).
- Removed ``gconf`` dependency for Debian/Ubuntu.
- Stopped auto-opening Boards/Playbooks tabs.

Architectural Changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Major version upgrade of Electron to v27.0.2. Electron is the underlying technology used to build the Desktop App.

Bug Fixes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

All Platforms
^^^^^^^^^^^^^

- Fixed an issue where some notifications did not navigate to the channel.
- Set the category for the main menu correctly for installations with Debian package.
- Fixed an issue where servers on a subpath could not grant the ``media`` permission.
- Fixed an issue where users could not fullscreen embedded videos.
- Fixed a deep linking issue for servers with subpaths.
- Fixed an issue where the "session expired" badge wasn't displayed.

macOS
^^^^^^^^^^^^^

- Fixed an issue where clicking on a link to an unregistered protocol on macOS would cause the app to crash.

Open Source Components
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Added ``electron-extension-installer`` and ``node-gyp`` to https://github.com/mattermost/desktop.

Known Issues
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Users seeing an endless "Loading..." screen when attempting to log in to the app may need to manually delete their cache directory. For MacOS it is located in ``/Users/<username>/Library/Containers/Mattermost/Data/Library/Application Support/Mattermost``, for Windows in ``Users/<username>/AppData/Roaming/Mattermost`` and for Linux in ``~/config/Mattermost`` (where ``~`` is the home directory).
- On Linux, a left-click on the Mattermost tray icon doesn't open the app window but opens the tray menu.
- Crashes might be be experienced in some Linux desktop clients due to an upstream bug in the ``libnotifyapp`` library. A recommended workaround is to disable the Mattermost system tray icon via Desktop Settings.
- On apps using GPO configurations, when adding a second server tab, it's possible to drag and drop tabs, but they'll jump back to the original position when releasing the mouse.

Contributors
~~~~~~~~~~~~~~

- `BaumiCoder <https://github.com/BaumiCoder>`_, `ctlaltdieliet <https://github.com/ctlaltdieliet>`_, `devinbinnie <https://github.com/devinbinnie>`_, `larkox <https://github.com/larkox>`_.

Release v5.5
--------------

Expand All @@ -18,7 +82,7 @@ Release v5.5
- **v5.5.0, released 2023-09-15**
- Original v5.5.0 release

**Download Binaries:** `Mattermost Desktop on GitHub <https://github.com/mattermost/desktop/releases/latest>`_
**Download Binaries:** `Mattermost Desktop on GitHub <https://github.com/mattermost/desktop/releases/tag/v5.5.1>`_

**Note:** Mattermost v5.5.0 contains a medium severity level security fix. Upgrading is highly recommended. Details will be posted on our `security updates page <https://mattermost.com/security-updates/>`__ 30 days after release as per the `Mattermost Responsible Disclosure Policy <https://mattermost.com/security-vulnerability-report//>`__.

Expand Down
2 changes: 2 additions & 0 deletions source/deploy/mattermost-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ From Mattermost v9.2, this changelog summarizes updates for the latest cloud and

### Improvements

See [this walkthrough video](https://www.youtube.com/watch?v=eXA8emM97Bo) on some of the improvements in our latest release below.

#### User Interface (UI)
- Updated pre-packaged Playbooks plugin version to [v1.39.1](https://github.com/mattermost/mattermost-plugin-playbooks/releases/tag/v1.39.1).
- Updated pre-packaged Calls version to [v0.21.1](https://github.com/mattermost/mattermost-plugin-calls/releases/tag/v0.21.1).
Expand Down
26 changes: 26 additions & 0 deletions source/deploy/mobile-app-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,32 @@ This changelog summarizes updates to Mattermost mobile apps releases for [Matter
:depth: 2
```

## 2.11.0 Release
- Release Date: December 15, 2023
- Server Versions Supported: Server v8.1.0+ is required. Self-Signed SSL Certificates are not supported unless the user installs the CA certificate on their device.

### Compatibility
- **Upgrade to server version v8.1.0 or later is required.** Support for server [Extended Support Release](https://docs.mattermost.com/upgrade/extended-support-release.html) (ESR) v7.8.0 has ended and upgrading to server ESR v8.1.0 or later is required. As we innovate and offer newer versions of our mobile apps, we maintain backwards compatibility only with supported server versions. Users who upgrade to the newest mobile apps while being connected to an unsupported server version can be exposed to compatibility issues, which can cause crashes or severe bugs that break core functionality of the app.
- Android operating system 7+ [is required by Google](https://android-developers.googleblog.com/2017/12/improving-app-security-and-performance.html).
- iPhone 5s devices and later with iOS 12.4+ is required.

### Improvements
- Added Vietnamese as a new language (beta).
- Calls: added user interface (UI) redesign and polish.
- Calls: fixed **More messages bar** and added a small redesign for consistency with calls banners.
- Implemented **Copy header text** functionality for channel headers.
- Added the ability to reconnect to a previous server after migrating the app to a new device.

### Bug Fixes
- Fixed an issue where the channel order in the channel sidebar categories got reversed after favoriting or unfavoriting a channel.
- Fixed an issue with channel ordering by recency.
- Fixed issue on Android where notifications didn't open or they opened in the wrong channel.
- Fixed a rare issue where the app would crash when tapping on a push notification.

### Known Issues
- Users are unable to adjust the font size via the OS font size setting.
- Some Google Pixel phones on Android 12+ might not continue past the login screen. This is a known issue with the OS, and the current workaround is to restart the device.

## 2.10.1 Release
- Release Date: November 29, 2023
- Server Versions Supported: Server v8.1.0+ is required. Self-Signed SSL Certificates are not supported unless the user installs the CA certificate on their device.
Expand Down
4 changes: 4 additions & 0 deletions source/guides/deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Learn how to install, deploy, and scale Mattermost for teams and organizations o
Deploy using Omnibus </install/installing-mattermost-omnibus>
Deploy using Kubernetes </install/install-kubernetes>
Deploy on Red Hat </install/install-rhel-8>
Set up an NGINX proxy </install/setup-nginx-proxy>
Set up TLS </install/setup-tls>
Prepare for your Mattermost deployment </guides/prepare-for-your-mattermost-deployment>
Deployment guides </guides/deployment-guides>
Deploy Mattermost Apps </deploy/deploy-mattermost-apps>
Expand All @@ -40,6 +42,8 @@ Learn how to install, deploy, and scale Mattermost for teams and organizations o
* :doc:`Deploy using Omnibus </install/installing-mattermost-omnibus>` - An entire Mattermost installation on a single server.
* :doc:`Deploy using Kubernetes </install/install-kubernetes>` - Install using the Mattermost Helm Chart or Operator and simplified updates.
* :doc:`Deploy on Red Hat </install/install-rhel-8>` - Support for all current Red Hat Enterprise Linux platforms with a tarball.
* :doc:`Set up NGINX proxy </install/setup-nginx-proxy>` - Learn how to configure Mattermost for HTTPS for deployments of more than 200 users.
* :doc:`Set up TLS </install/setup-tls>` - Learn how to configure Mattermost for HTTPS for deployments of fewer than 200 concurrent users.
* :doc:`Deployment guides </guides/deployment-guides>` - for administrators who are ready to integrate Mattermost with their organization’s IT infrastructure.
* :doc:`Deploy Mattermost Apps </deploy/deploy-mattermost-apps>` - Learn how to deploy Mattermost Apps to your server.
* :doc:`Prepare for your Mattermost deployment </guides/prepare-for-your-mattermost-deployment>` - Review software and hardware requirements for Mattermost server, and plan out your Mattermost rollout.
Expand Down
31 changes: 31 additions & 0 deletions source/install/common-deploy-faq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
:orphan:
:nosearch:

Why doesn't Mattermost start at system boot?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To have the Mattermost Server start at system boot, the systemd until file needs to be enabled. Run the following command:

.. code-block:: none
:class: mm-code-block
sudo systemctl enable mattermost.service
Why does Mattermost fail to start at system boot?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If your database is on the same system as your Mattermost Server, we recommend editing the default ``/lib/systemd/system/mattermost.service`` systemd unit file to add ``After=postgresql.service`` and ``BindsTo=postgresql.service`` to the ``[Unit]`` section.

Can I run Mattermost without a proxy?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Yes. Mattermost binds to 443 instead of 8065. The Mattermost binary requires the correct permissions to do that binding. You must activate the ``CAP_NET_BIND_SERVICE`` capability to allow the new Mattermost binary to bind to ports lower than 1024 by running the following command:

.. code-block:: none
:class: mm-code-block
sudo setcap cap_net_bind_service=+ep ./mattermost/bin/mattermost
.. note::

- We highly recommend using a proxy in front of Mattermost server for up to 200 concurrent users. If you have fewer than 200 concurrent users, you can `set up TLS </install/setup-tls.html>`__. If you're exceeding 200 concurrent users, you'll need `a proxy </install/setup-nginx-proxy.html>`__, such as NGINX, in front of Mattermost to manage the traffic.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Desktop MSI installer and group policy installation guides (beta)
.. include:: ../_static/badges/allplans-selfhosted.rst
:start-after: :nosearch:

This guide provides steps to install the MSI and use Group Policies in Windows Professional or Enterprise. The MSI installer package can be downloaded `here <https://github.com/mattermost/desktop/releases/tag/v5.5.1>`_.
This guide provides steps to install the MSI and use Group Policies in Windows Professional or Enterprise. The MSI installer package can be downloaded `here <https://github.com/mattermost/desktop/releases/tag/v5.6.0>`_.

.. note::
The Mattermost MSI installer and Group Policy (GPO) definitions are in Beta. If you are using this installer or GPOs and have feedback, particularly if you are an organization executing remote deployments, please contact us in the `MSI Installer channel on our Community server <https://community.mattermost.com/core/channels/msi-installer>`_ or on our `community forum <https://forum.mattermost.com/>`_. We hope to promote this installer out of Beta when the known issues are addressed and we are confident that the various deployment scenarios expected in production environments are tested sufficiently with the help of organizations using this Beta. Feedback is highly appreciated.
Expand All @@ -27,22 +27,22 @@ Download group policy and MSI installer files
.. image:: ../images/desktop/msi_gpo/msi_gpo_installation_test_00002.png
:alt: Go to the mattermost/desktop repository on GitHub.

3. Navigate to the release page for `version v5.5.1 <https://github.com/mattermost/desktop/releases/tag/v5.5.1>`__ and download the appropriate installer for your version of Windows (32-bit vs. 64-bit).
3. Navigate to the release page for `version v5.6.0 <https://github.com/mattermost/desktop/releases/tag/v5.6.0>`__ and download the appropriate installer for your version of Windows (32-bit vs. 64-bit).

4. Download the `source.zip <https://github.com/mattermost/desktop/archive/v5.5.1.zip>`__ file as well to extract group policy files.
4. Download the `source.zip <https://github.com/mattermost/desktop/archive/v5.6.0.zip>`__ file as well to extract group policy files.

.. image:: ../images/desktop/msi_gpo/msi_gpo_installation_test_00003.png
:alt: In the mattermost/desktop repository on GitHub, go to the release page for the latest desktop release, then download the installer for your version of Windows. Download the source.zip file as well to extract group policy files.

Install group policy files locally
-----------------------------------

1. Browse to the folder the above files were downloaded to and unzip the ``desktop-5.5.1.zip`` file in place.
1. Browse to the folder the above files were downloaded to and unzip the ``desktop-5.6.0.zip`` file in place.

.. image:: ../images/desktop/msi_gpo/msi_gpo_installation_test_00004.png
:alt: Go to the install download directory on your machine and unzip the ZIP file.

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

.. image:: ../images/desktop/msi_gpo/msi_gpo_installation_test_00005.png
:alt: Go to the \resources\windows\gpo directory and copy its contents.
Expand Down Expand Up @@ -140,7 +140,7 @@ Silent installation guide

Perform a silent installation of MSI by running the following command:

``msiexec /i mattermost-desktop-v5.5.1-x64.msi /qn``
``msiexec /i mattermost-desktop-v5.6.0-x64.msi /qn``

.. note::
You'll need to change this command as new versions of the Mattermost Desktop App are released.
2 changes: 1 addition & 1 deletion source/install/install-nginx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Install NGINX server
--------------------
NGINX is a popular web server and is responsible for hosting some of the largest and highest-traffic sites on the internet. It's more resource-friendly than Apache in most cases, and can be used as a web server or reverse proxy.

In a production setting, use a proxy server for greater security and performance of Mattermost.
In a production setting, we recommend using a proxy server for greater security and performance of Mattermost.

- SSL termination
- HTTP to HTTPS redirect
Expand Down
Loading

0 comments on commit 6fd744a

Please sign in to comment.