Skip to content

Commit

Permalink
Merge branch 'master' into logout-clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
cwarnermm authored Aug 15, 2023
2 parents 9b2f7bd + 169279e commit 243a52d
Show file tree
Hide file tree
Showing 8 changed files with 87 additions and 132 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Install the Mattermost for Microsoft Teams plugin
To install the `Mattermost for Microsoft Teams </plugins/mattermost-for-microsoft-teams>`__ plugin in Mattermost:

1. Log in to your Mattermost workspace as a system administrator.
2. Download version v0.3.9 of `the plugin binary release <https://github.com/mattermost/mattermost-plugin-msteams-sync/releases>`__, compatible with Mattermost v8.0.1 and later.
2. Download the latest version of `the plugin binary release <https://github.com/mattermost/mattermost-plugin-msteams-sync/releases>`__, compatible with Mattermost v8.0.1 and later.

.. tip::

Expand Down Expand Up @@ -47,7 +47,7 @@ If you encounter issues when connecting user accounts or linking channels, we re
Get help
---------

If you face any issues while installing the Mattermost for Microsoft Teams sync plugin, you can either:
If you face any issues while installing the Mattermost for Microsoft Teams Sync plugin, you can either:

- Open a new issue in the `Mattermost for Microsoft Teams GitHub repository <https://github.com/mattermost/mattermost-plugin-msteams-sync/issues/new>`__.
- Or, create a new topic in our `peer-to-peer troubleshooting forum <https://forum.mattermost.com/c/trouble-shoot/16>`__.
2 changes: 1 addition & 1 deletion source/about/subscription.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ If you represent an open source community or project that is not hosted under a
How to apply?
~~~~~~~~~~~~~

To apply for the Mattermost Nonprofit License, `please complete this form <https://mattermost.typeform.com/to/gbM6xGkS>`__.
To apply for the Mattermost Nonprofit License, `please complete this form <https://support.mattermost.com/hc/en-us/requests/new?ticket_form_id=17664739497236>`__.
Please note that it may take up to six weeks for us to respond to your request.

Mattermost educational license program
Expand Down
146 changes: 22 additions & 124 deletions source/configure/calls-deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ This document provides information on how to successfully make the Calls plugin
- `Requirements <#requirements>`__
- `Limitations <#limitations>`__
- `Configuration <#configuration>`__
- `Kubernetes deployments <#kubernetes-deployments>`__
- `Performance <#performance>`__
- `RTCD Service <#the-rtcd-service>`__
- `Configure recording <#configure-recording>`__
- `Kubernetes deployments <#kubernetes-deployments>`__
- `Frequently asked questions <#frequently-asked-questions>`__

Terminology
Expand Down Expand Up @@ -138,129 +138,6 @@ rtcd (HA)
.. image:: ../images/calls-deployment-image2.png
:alt: A diagram of an rtcd deployment.

Kubernetes deployments
----------------------

.. image:: ../images/calls-deployment-kubernetes.png
:alt: A diagram of calls deployed in a Kubernetes cluster.

If Mattermost isn't deployed in a Kubernetes cluster, and you want to use this deployment type, visit the `Kubernetes operator guide </install/mattermost-kubernetes-operator.html>`__.

``rtcd`` is deployed with a Helm chart. To install this Helm chart run:

.. code-block:: none
helm repo add mattermost https://helm.mattermost.com
More info about the version and the chart itself, please check here. Regarding changing the parameters of the helm chart, please check and copy the default values from here.

An example with sample values:

.. code-block:: none
image:
repository: mattermost/rtcd
pullPolicy: IfNotPresent
tag: "v0.9.0"
imagePullSecrets: []
nameOverride: ""
fullnameOverride: ""
serviceAccount:
create: true
annotations: {}
name: ""
podAnnotations: {}
podSecurityContext: {}
securityContext: {}
# Which deployment method you'd like to use "deployment" or "daemonset"
deploymentType: "deployment"
configuration:
# Only needed if deploymentType is set to "deployment"
replicas: 2
environmentVariables:
RTCD_API_SECURITY_ALLOWSELFREGISTRATION: "\"true\""
RTCD_RTC_ICESERVERS:
"\'[{\"urls\":[\"stun:stun.global.calls.mattermost.com:3478\"]}]\'"
RTCD_LOGGER_CONSOLELEVEL: "\"DEBUG\""
RTCD_LOGGER_ENABLEFILE: "\"false\""
maxUnavailable: 1 # Only used when updateStrategy is set to "RollingUpdate"
updateStrategy: RollingUpdate
terminationGracePeriod: 18000 # 5 hours, used to gracefully draining the instance.
service:
# APIport is the port used by rtcd HTTP/WebSocket API.
APIport: 8045
# RTCport is the UDP port used to route all the calls related traffic.
RTCport: 8443
ingress:
enabled: false
classname: nginx-calls
annotations:
hosts:
- host: mattermost-rtcd.local
paths:
- "/"
resources:
limits:
cpu: 7800m # Values for c5.2xlarge in AWS
memory: 15Gi # Values for c5.2xlarge in AWS
requests:
cpu: 100m
memory: 32Mi
nodeSelector:
kops.k8s.io/instancegroup: rtcd
tolerations:
- key: "rtcd"
operator: "Equal"
value: "true"
effect: "NoSchedule"
dnsConfig:
options:
- name: ndots
value: "1"
affinity:
podAntiAffinity:
requiredDuringSchedulingIgnoredDuringExecution:
- labelSelector:
matchExpressions:
- key: app.kubernetes.io/name
operator: In
values:
- mattermost-rtcd
topologyKey: topology.kubernetes.io/zone
preferredDuringSchedulingIgnoredDuringExecution:
- weight: 100
podAffinityTerm:
labelSelector:
matchExpressions:
- key: app.kubernetes.io/name
operator: In
values:
- mattermost-rtcd
topologyKey: topology.kubernetes.io/zone
``rtcd`` will be deployed as a deployment as shown in the `deploymentType` field. For that reason the sections of `deployment.replicas`, `nodeSelector` and `tolerations` are used so that ``rtcd`` to be deployed in specific nodes.

After having the values above, to deploy the ``rtcd`` helm chart run:

.. code-block:: none
helm upgrade mattermost-rtcd mattermost/mattermost-rtcd -f /Users/myuser/rtcd_values.yaml --namespace mattermost-rtcd --create-namespace --install --debug
Performance
-----------

Expand Down Expand Up @@ -439,6 +316,27 @@ Configure recording

Before you can start recording calls, you need to configure the ``calls-offloader`` job service. You can read about how to do that `here <https://github.com/mattermost/calls-offloader/blob/master/docs/getting_started.md>`__. Performance and scalability recommendations related to this service can be found in `here <https://github.com/mattermost/calls-offloader/blob/master/docs/performance.md>`__.

Kubernetes deployments
----------------------

The Calls plugin has been designed to integrate well with Kubernetes to offer improved scalability and control over the deployment.

This is a sample diagram showing how the ``rtcd`` standalone service can be deployed in a Kubernetes cluster:

.. image:: ../images/calls-deployment-kubernetes.png
:alt: A diagram of calls deployed in a Kubernetes cluster.

If Mattermost isn't deployed in a Kubernetes cluster, and you want to use this deployment type, visit the `Kubernetes operator guide </install/mattermost-kubernetes-operator.html>`__.

Helm Charts
~~~~~~~~~~~

The recommended way to deploy Calls related components and services in a Kubernetes deployment is to use the officially provided Helm charts. Related documentation including detailed information on how to deploy these services can be found in our ``mattermost-helm`` repository:

- `rtcd Helm chart <https://github.com/mattermost/mattermost-helm/tree/master/charts/mattermost-rtcd>`__

- `calls-offloader Helm chart <https://github.com/mattermost/mattermost-helm/tree/master/charts/mattermost-calls-offloader>`__

Frequently asked questions
--------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In a Mattermost high availability cluster deployment, the System Console is set
:environment: MM_CLUSTERSETTINGS_ENABLE

- **true**: The Mattermost server will attempt inter-node communication with the other servers in the cluster that have the same cluster name.
**false**: **(Default)** Mattermost high availability mode is disabled.
- **false**: **(Default)** Mattermost high availability mode is disabled.

Enable high availability mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 3 additions & 1 deletion source/configure/reporting-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ Site statistics
| sessions, commands, webhooks, active users, connections, | - ``config.json setting``: N/A |
| playbooks, runs, boards, and cards. | - Environment variable: N/A |
+---------------------------------------------------------------+-------------------------------------------------------------+
| **Note**: Inactive and deactivated users are not counted towards the total number of active users. |
| **Note**: Inactive and deactivated users, as well as remote users in |
| `Microsoft Teams integrations </channels/collaborate-using-mattermost-for-microsoft-teams.html>`__ |
| and `shared channels users </onboard/shared-channels.html>`__, aren't counted towards the total number of active users. |
+---------------------------------------------------------------+-------------------------------------------------------------+

----
Expand Down
26 changes: 26 additions & 0 deletions source/deploy/mobile-faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -346,3 +346,29 @@ You can use the mobile applications hosted by Mattermost in the `Apple App Store
.. note::

The use of hosted applications by Mattermost `can be deployed with Enterprise Mobility Management solutions via AppConfig </deploy/mobile-appconfig.html>`__ but wrapping is not supported. See the `product documentation </deploy/deploy-mobile-apps-using-emm-provider.html#manage-app-configuration-using-appconfig>`__ for details.

How the ``deviceId`` behaves
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``deviceId`` is a identifier provided by a push notification service, such as Apple Push Notification service (APNs) and Firebase Cloud Messaging (FCM), that identifies the relationship between device, app, and the notification service.

When the app starts, if the push notification permissions are enabled, the app will try to connect with the corresponding notification service (APNs for iOS, FCM for Android) to get the ``deviceId``. If there is any change to the ``deviceId``, the app will notify any connected server about this change.

Based on the documentation from `APNs <https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns?changes=_8>`__ and `FCM <https://firebase.google.com/docs/cloud-messaging/android/client#java_1>`__, the ``deviceId`` only will change in the following cases:

- The app is restored from a backup from a different device
- The user clears the app data
- The user reinstalled the app
- The user installed the app on a different device

If the device has a ``deviceId``, when the user logs into a Mattermost server, an audit log entry ``login`` will store the ``deviceId``, and the ``deviceId`` will also be added in the session data in the database. However, it's possible the ``deviceId`` isn't available, due to several reasons including:

- The device is not connected to the network
- The notification service is not reachable for any reason
- The app is not properly signed
- The device has not been granted the needed permissions

In these scenarios, the ``login`` audit log won't have the ``deviceId``, and the session data won't have the ``deviceId``.
If the app receives the ``deviceId`` later, the device will send the new ``deviceId`` to the server, generating an ``attachDeviceId`` audit log, and adding the ``deviceId`` to the session data in the database.

Since the ``deviceId`` relates to the application, connections through the web browser, even on mobile, won't have a ``deviceID``.
33 changes: 31 additions & 2 deletions source/install/cloud-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,41 @@ This changelog summarizes updates to [Mattermost Cloud](https://mattermost.com/g

Latest Mattermost Cloud releases:

- [Release 2023-08-09](#release-2023-08-09)
- [Release 2023-08-03](#release-2023-08-03)
- [Release 2023-07-26](#release-2023-07-26)
- [Release 2023-07-20](#release-2023-07-20)
- [Release 2023-07-19](#release-2023-07-19)
- [Release 2023-07-11](#release-2023-07-11)
- [Release 2023-06-26](#release-2023-06-26)
- [Release 2023-06-13](#release-2023-06-13)

## Release 2023-08-09

### Improvements

#### User Interface (UI)
- The number of channel members is now shown in the **Browse channels** modal.
- Updated the minimum required Edge version to 112+.
- An error is now displayed if a post edit history fails to load.
- Removed the deprecated Insights feature.
- Prepackaged Calls plugin version 0.18.0.
- Pre-packaged Playbooks version 1.38.0.

### Bug Fixes
- Fixed an issue with missing time zone metadata in the Docker container.
- Fixed the error returned by ``PUT /api/v4/channels/{channelid}`` when the provided name already existed in the team.
- Fixed the clickable area of post textboxes being too small.
- Fixed a UI bug in the bot profile popover.
- Fixed an issue with the ``registerMessageWillBeUpdatedHook`` plugin hook.
- Fixed an issue where the **Saved Posts** section would not show channel and team names.

### Known Issues
- Boards public links that follow the URL schema `/boards/public/...` no longer work. They can either be regenerated through the application by going to the board and selecting the **Share** button at the top right, or they can be obtained by replacing the `/boards/public/` part of the URL with `/plugins/focalboard/`.

## Release 2023-08-03

### Bug Fixes
- Fixed an issue where ``FileExportBackend`` should not use Bifrost.
- Fixed an issue related to the export configuration settings.

## Release 2023-07-26

Expand Down
2 changes: 1 addition & 1 deletion source/install/software-hardware-requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ PC web
"Chrome", "v112+", "v112+"
"Firefox", "v102+", "v102+"
"Safari", "v16.2+", "v16.2+"
"Edge", "v110+", "v110+"
"Edge", "v112+", "v112+"

`*` Internet Explorer (IE11) is no longer supported. We recommend using the `Mattermost desktop app <https://mattermost.com/apps/>`_ or another supported browser. See `this forum post <https://forum.mattermost.com/t/mattermost-is-dropping-support-for-internet-explorer-ie11-in-v5-16/7575>`__ to learn more.

Expand Down

0 comments on commit 243a52d

Please sign in to comment.