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

Deployment Section Restructure [WIP] #7816

Open
wants to merge 24 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
4cd3d33
Initial Restructure - Deployment Section
DSchalla Mar 21, 2025
3796c63
Review pass #1
cwarnermm Mar 24, 2025
f86526d
Merge branch 'master' into restructure_nav
cwarnermm Mar 25, 2025
7d972f9
Merge conflict resolutions
cwarnermm Mar 25, 2025
53ed7b9
Updated page syntax for tab display
cwarnermm Mar 25, 2025
3156681
Updated page syntax for tab display (K8S)
cwarnermm Mar 25, 2025
17dac6e
Updated page syntax for tab display (containers)
cwarnermm Mar 25, 2025
749e62b
Build error fix
cwarnermm Mar 25, 2025
24604f8
Merge branch 'master' into restructure_nav
cwarnermm Mar 26, 2025
57d53b2
build fixes & legacy page removals
cwarnermm Mar 26, 2025
e52224c
Merge branch 'restructure_nav' of https://github.com/mattermost/docs …
cwarnermm Mar 26, 2025
ed05ee4
Content simplifications
cwarnermm Mar 26, 2025
76cdd88
Merge branch 'master' into restructure_nav
cwarnermm Mar 27, 2025
4c8b30b
Removed Bitnami, clarified Linux recommendations
cwarnermm Mar 27, 2025
946d2c8
1st pass through desktop app deploy section
cwarnermm Mar 27, 2025
8ac664a
formatting updates
cwarnermm Mar 27, 2025
b7699ac
1st pass through mobile app deploy section
cwarnermm Mar 28, 2025
df0f937
Merge branch 'master' into restructure_nav
cwarnermm Mar 31, 2025
ede868c
Finalized mobile section draft
cwarnermm Mar 31, 2025
3431ef0
Merge branch 'restructure_nav' of https://github.com/mattermost/docs …
cwarnermm Mar 31, 2025
86cb247
Removed legacy pages & added ref arch diagrams
cwarnermm Mar 31, 2025
01fb693
TLS & NGINX deploy setup
cwarnermm Apr 1, 2025
e8b851a
Moved another batch of pages Unknown
cwarnermm Apr 1, 2025
d99fc76
Container Guidance;Navbar Wording
DSchalla Apr 1, 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/_templates/custom-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ <h4>Admin guide</h4>
</section>

<section class='masthead-cards-section'>
<h2 class='masthead-h2'>Use Mattermost</h2>
<h2 class='masthead-h2'>User Guide</h2>
<div class='masthead-cards'>
<a
href='guides/collaborate.html'
Expand Down
18 changes: 4 additions & 14 deletions source/collaborate/access-your-workspace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,12 @@ Access your workspace
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

Your Mattermost :doc:`workspace </guides/use-mattermost>` is accessible through a URL link. You'll receive a link from your Mattermost system admin or through an email invitation. You can use that link in a web browser, or as a server connection in the :doc:`desktop app </collaborate/install-desktop-app>`, the :doc:`mobile app for iOS </collaborate/install-ios-app>`, or the :doc:`mobile app for Android </collaborate/install-android-app>`.
Access Mattermost using a web browser, the desktop app, or the mobile app for iOS or Android. You can log in using your email address, username, or single sign-on (SSO) credentials, depending on how your system admin has configured Mattermost.

.. tip::

Can't find your Mattermost link? Ask your company's IT department or your Mattermost system admin for your organization's **Mattermost Site URL**. It'll look something like ``https://example.com/company/mattermost``, ``mattermost.yourcompanydomain.com``, or ``chat.yourcompanydomain.com``. These URLs could also end in ``.net``.

.. toctree::
:maxdepth: 1
:hidden:
:titlesonly:

Install the desktop app </collaborate/install-desktop-app>
Install the iOS mobile app </collaborate/install-ios-app>
Install the Android mobile app </collaborate/install-android-app>
Log out of Mattermost </collaborate/log-out>

.. tab:: Web/Desktop

**Web browser**
Expand All @@ -30,12 +20,12 @@ Your Mattermost :doc:`workspace </guides/use-mattermost>` is accessible through

.. tip::

- We recommend bookmarking the Mattermost URL in your browser of choice so logging into Mattermost is easy in the future.
- We recommend bookmarking the Mattermost URL in your web browser of choice so logging into Mattermost is easy in the future.
- The credentials you use to log in depend on how your system admin has configured Mattermost. You may be prompted for an `email address or username <#email-address-or-username>`__ and a password, or you may be able to `log in using other credentials <#single-sign-on-sso>`__. Contact your system admin for more information.

**Desktop app**

1. Download and install the Mattermost :doc:`desktop app </collaborate/install-desktop-app>`.
1. Download and install the Mattermost desktop app.
2. 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 </preferences/connect-multiple-workspaces>` documentation for details.
3. Enter your user credentials to log into Mattermost.
4. 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.
Expand All @@ -52,7 +42,7 @@ Your Mattermost :doc:`workspace </guides/use-mattermost>` is accessible through
4. 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.

.. tip::

The credentials you use to log in depend on how your system admin has configured Mattermost. You may be prompted for an email address or username and a password, or you may be able to log in using other credentials. Contact your system admin for details.

Reset your password
Expand Down
314 changes: 0 additions & 314 deletions source/collaborate/install-desktop-app.rst

This file was deleted.

2 changes: 1 addition & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2405,7 +2405,7 @@ def setup(_: Sphinx):
"install/config-apache2.html":
"https://forum.mattermost.com/t/configuring-apache2-as-a-proxy-for-mattermost-server/11938",
"install/deploy-bitnami.html":
"https://docs.mattermost.com/install/deploying-team-edition-on-bitnami.html",
"https://docs.mattermost.com/deploy/server/deploy-kubernetes.html",
"install/desktop.html":
"https://docs.mattermost.com/collaborate/install-desktop-app.html",
"install/desktop-managed-resources.html":
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
:orphan:
:nosearch:

Configure Mattermost to enable push notifications to Mattermost clients by going to **System Console > Environment > Push Notification Server**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect.
Configure mobile push notifications for Mattermost by going to **System Console > Environment > Push Notification Server**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect.

.. config:setting:: enable-push-notifications
:displayname: Enable push notifications (Push Notifications)
:systemconsole: Environment > Push Notification Server
:configjson: .EmailSettings.SendPushNotifications
:environment: MM_EMAILSETTINGS_SENDPUSHNOTIFICATIONS

- **true**: **(Default)** Your Mattermost server sends mobile push notifications.
- **false**: Mobile push notifications are disabled.
- **Do not send push notifications**: Mobile push notifications are disabled.
- **Use HPNS connection with uptime SLA to send notifications to iOS and Android apps**: **(Default)** Use Mattermost's hosted push notification service.
- **Use TPNS connection to send notifications to iOS and Android apps**: Use Mattermost's test push notification service.
- **Manually enter Push Notification Service location**: When building your own custom mobile apps, you must host your own mobile push proxy service, and specify that URL in the Push Notification Server field.

Enable push notifications
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -32,13 +34,39 @@ Enable push notifications
| **Push Notification Server** field. | |
+------------------------------------------------------------------+--------------------------------------------------------------------------------+

.. note::
Hosted Push Notifications Service (HPNS)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

Mattermost Enterprise, Professional, and Cloud customers can use Mattermost's Hosted Push Notification Service (HPNS). The HPNS offers:

- Access to a publicly-hosted Mattermost Push Notification Service (MPNS) `available on GitHub. <https://github.com/mattermost/mattermost-push-proxy>`__
- An explicit `privacy policy <https://mattermost.com/data-processing-addendum/>`__ for the contents of unencrypted messages.
- Encrypted TLS connections:

- Between HPNS and Apple Push Notification Services
- Between HPNS and Google’s Firebase Cloud Messaging Service
- HPNS and your Mattermost Server
- Production-level uptime expectations.
- Out-of-box configuration for new servers means nothing is required to enable HPNS for new deployments. HPNS can be `enabled for existing deployments <#enable-hpns-for-existing-deployments>`_.

- Mattermost Enterprise, Professional, and Cloud customers can use Mattermost’s SLA-bound :ref:`Hosted Push Notification Service (HPNS) <deploy/mobile-hpns:hosted push notifications service (hpns)>` in one of two locations, including the United States and Germany.
- Mattermost Team Edition customers can use Mattermost's :ref:`Test Push Notification server (TPNS) <deploy/mobile-hpns:test push notifications service (tpns)>`.
- The TPNS is provided for testing push notifications prior to compiling your own service, and isn't available for Mattermost Cloud deployments. Ensure you’re familiar with its limitations.
- Review the :doc:`mobile push notifications </deploy/mobile-hpns>` and :doc:`mobile apps </deploy/build-custom-mobile-apps>` documentation, including guidance on compiling your own mobile apps and MPNS, before deploying to production. See the :ref:`documentation <deploy/mobile-hpns:host your own push proxy service>` for details on hosting your own push proxy service.
- To confirm push notifications are working, connect to the `Mattermost iOS App <https://apps.apple.com/us/app/mattermost/id1257222717>`__ available on the App Store, or the `Mattermost Android App <https://play.google.com/store/apps/details?id=com.mattermost.rn>`__ available on Google Play.
.. note::
- The HPNS only works with pre-built apps Mattermost deploys through the Apple App Store and Google Play Store. If you build your own mobile apps, you must also `host your own Mattermost push proxy server <#host-your-own-push-proxy-service>`_.
- You must ensure that the push proxy can be reached on the correct port. For HPNS, it's port 443 from the Mattermost server.
- Mattermost doesn't store any notification data. Any data being stored is at the server level only, such as the ``device_id``, since the HPNS needs to know which device the notification must be sent to.

Test Push Notifications Service (TPNS)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Non-commercial and self-hosted customers can use Mattermost's free, basic Test Push Notifications Service (TPNS).

.. note::
- The TPNS isn’t recommended for use in production environments, and doesn’t offer production-level update service level agreements (SLAs).
- The TPNS isn't available for Mattermost Cloud deployments.
- The TPNS only works with the pre-built mobile apps that Mattermost deploys through the Apple App Store and Google Play Store. If you have built your own mobile apps, you must also `host your own Mattermost push proxy service <#host-your-own-push-proxy-service>`_.
- You must ensure that the push proxy can be reached on the correct port. For TPNS, it's port 80 from the Mattermost server.
- If you don't need or want Mattermost to send mobile push notifications, disabling this configuration setting in larger deployments may improve server performance in the following areas:

- Reduced Processing Load: Generating and sending push notifications requires processing power and resources. By disabling them, the server can allocate those resources to other tasks.
Expand All @@ -48,6 +76,23 @@ Enable push notifications
- Simplified Error Handling: Push notification services can sometimes fail or have latency issues, requiring additional error handling. Disabling these notifications simplifies the system's operations.
- However, disabling push notifications can negatively impact user experience, communication efficiency, and overall productivity. It’s important to balance performance improvements with the needs of your organization and users.

ID-only push notifications
^^^^^^^^^^^^^^^^^^^^^^^^^^

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

Admins can enable mobile notifications to be fully private to protect a Mattermost customer against breaches in iOS and Android notification infrastructure by limiting the data sent to Apple and Google through a Mattermost configuration setting.

The standard way to send notifications to iOS and Android applications requires sending clear text messages to Apple or Google so they can be forwarded to a user’s phone and displayed on iOS or Android. While Apple or Google assure the data is not collected or stored, should the organizations be breached or coerced, all standard mobile notifications on the platform could be compromised.

To avoid this risk, Mattermost can be configured to replace mobile notification text with message ID numbers that pass no information to Apple of Google. When received by the Mattermost mobile application on a user’s phone, the message IDs are used to privately communicate with their Mattermost server and to retrieve mobile notification messages over an encrypted channel. This means that, at no time, is the message text visible to Apple or Google’s message relay system. The contents of the message also won't reach Mattermost.

.. note::
Because of the extra steps to retrieve the notifications messages under Mattermost’s private mobility capability with ID-only push notifications, end users may experience a slight delay before the mobile notification is fully displayed compared to sending clear text through Apple and Google’s platform.

See our :ref:`configuration settings <configure/site-configuration-settings:push notification contents>` documentation to learn more about the ID-only push notifications configuration setting. See our :ref:`Mobile Apps FAQ documentation <deploy/mobile/mobile-faq:how can i use id-only push notifications to protect notification content from being exposed to third-party services?>` for details on using ID-only push notifications for data privacy.

.. config:setting:: push-notification-server-location
:displayname: Push notification server location (Push Notifications)
:systemconsole: Environment > Push Notification Server
Expand Down
Loading