Skip to content

Commit

Permalink
v9.5 Docs (#6877)
Browse files Browse the repository at this point in the history
* Update conf.py

* Clarified that system roles also control access to related API endpoints (#6901)

* Clarified that system roles include related API endpoints

* Update source/onboard/system-admin-roles.rst

Co-authored-by: Eva Sarafianou <eva.sarafianou@gmail.com>

---------

Co-authored-by: Eva Sarafianou <eva.sarafianou@gmail.com>

* Added new error codes page (#6908)

* Remove legacy MySQL references (#6896)

* Removed legacy references to MySQL v5.x

* Added missing redirect

* Removed "Sync" to align with product naming (#6898)

* Clarified Ent/Pro differentiation (#6899)

* Clarified that bots don't count as active users (#6902)

* Added interactive demo link (#6905)

* Added link to Kubernetes YAML docs via mattermost repo (#6906)

* Clarified supported AllowCorsFrom values (#6897)

* Updated legacy E10/E20 label text (#6900)

* Updated legacy E10/E20 label text

* Add example for E10/E20 label setup

* Test markup for labels

* Another markup test for labels

* And another markup test for labels

* Use raw html markup for E10/E20 labels

* Updated styling for legacy E10/E20 labels

* Change class name

---------

Co-authored-by: emdecr <delacruz.emily@gmail.com>

* Added transcription end user docs (#6910)

* Added Message and File retention config settings for less than 1 day (#6913)

* Added ability to process import file without uploading it to the server (#6914)

* Added ability to process import file without uploading it to the server

* Incorporated reviewer feedback

* Added MAU to true-up reporting process (#6915)

* Added nohte for sign-in with email (#6917)

* Changed "active" to "activated users" in majority of contexts. (#6904)

* Changed "active" to "activated users" in majority of contexts.

* Incorporated reviewer feedback

* Update source/getting-started/architecture-overview.rst

* Added OutgoingIntegrationRequestsDefaultTimeout config setting (#6912)

* Added OutgoingIntegrationRequestsDefaultTimeout config setting

* Applied reviewer feedback

* v9.5 Changelog (#6881)

* v9.5 Changelog

* Update download-latest-tarball.rst

* Update open-source-components.rst

* Update release-lifecycle.rst

* Update deprecated-features.rst

* Update extended-support-release.rst

* Update release-lifecycle.rst

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update important-upgrade-notes.rst

* Update extended-support-release.rst

* Update important-upgrade-notes.rst

* Update release-lifecycle.rst

* Update prepare-to-upgrade-mattermost.rst

* Update version-archive.rst

* Update prepare-to-upgrade-mattermost.rst

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update source/deploy/mattermost-changelog.md

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Add known issues

* Update mattermost-changelog.md

* Update deprecated-features.rst

Added note on safety limit error message

* Update deprecated-features.rst

* Update mattermost-changelog.md

* Update deprecated-features.rst

* Update important-upgrade-notes.rst

* Update deprecated-features.rst

Removed it as it's not a feature deprecation

* Add contributors

* Update mattermost-changelog.md

* Update download-latest-tarball.rst

* Update extended-support-release.rst

* Update mattermost-changelog.md

* Update mattermost-changelog.md

---------

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
Co-authored-by: johndavidlugtu <101303489+johndavidlugtu@users.noreply.github.com>

* Heading syntax fixes

* Release readiness review corrections

---------

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
Co-authored-by: Eva Sarafianou <eva.sarafianou@gmail.com>
Co-authored-by: emdecr <delacruz.emily@gmail.com>
Co-authored-by: johndavidlugtu <101303489+johndavidlugtu@users.noreply.github.com>
  • Loading branch information
5 people authored Feb 16, 2024
1 parent 6073a50 commit 9700101
Show file tree
Hide file tree
Showing 91 changed files with 1,488 additions and 576 deletions.
8 changes: 8 additions & 0 deletions source/_static/mytheme.css
Original file line number Diff line number Diff line change
Expand Up @@ -3019,6 +3019,14 @@ img.mm-badge-flag {
}
}

/* Badge note */

.mm-label-note {
font-size: 12px;
font-style: italic;
margin-top: -20px;
}

/* Config Settings */

.config-setting-result-item {
Expand Down
4 changes: 2 additions & 2 deletions source/about/embed-mattermost-app-within-microsoft-teams.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ With the `Microsoft Teams plugin </about/mattermost-for-microsoft-teams.html>`__

To install the Mattermost app in Microsoft Teams:

1. In Mattermost, as an administrator, go to **System Console > Plugins > MSTeams Sync**. At the bottom of the settings page, select **Download Manifest** to download a ZIP file containing the Microsoft Teams application manifest pre-configured for your Mattermost workspace.
1. In Mattermost, as an administrator, go to **System Console > Plugins > MS Teams**. At the bottom of the settings page, select **Download Manifest** to download a ZIP file containing the Microsoft Teams application manifest pre-configured for your Mattermost workspace.
2. In Microsoft Teams, as an administrator, go to the Microsoft Teams admin center under **Teams Apps > Manage Apps**, or use the following URL: ``https://admin.teams.microsoft.com/policies/manage-apps``.
3. Select **Upload new app**, then upload the app manifest you downloaded in the previous step.

Expand Down Expand Up @@ -69,5 +69,5 @@ Get help

If you face any issues while installing or using the app in Microsoft Teams, 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>`__.
- Open a new issue in the `Mattermost for Microsoft Teams GitHub repository <https://github.com/mattermost/mattermost-plugin-msteams/issues/new>`__.
- Or, create a new topic in our `peer-to-peer troubleshooting forum <https://forum.mattermost.com/c/trouble-shoot/16>`__.
20 changes: 10 additions & 10 deletions source/about/install-mattermost-for-microsoft-teams-plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ Install the Mattermost for Microsoft Teams plugin

Looking to `embed Mattermost within Microsoft Teams </about/embed-mattermost-within-microsoft-teams.html>`__ instead?

To install the `Microsoft Teams plugin </configure/plugins-configuration-settings.html#ms-teams-sync>`__ in Mattermost:
To install the `Microsoft Teams plugin </configure/plugins-configuration-settings.html#ms-teams>`__ in Mattermost:

1. Log in to your Mattermost workspace as a system administrator.
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. If you are using an earlier version of Mattermost, `follow our documentation </upgrade/upgrading-mattermost-server.html>`__ to upgrade to Mattermost v8.0.1 or later.
2. Download the latest version of `the plugin binary release <https://github.com/mattermost/mattermost-plugin-msteams/releases>`__, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, `follow our documentation </upgrade/upgrading-mattermost-server.html>`__ to upgrade to Mattermost v8.0.1 or later.
3. Go to **System Console > Plugins > Plugin Management > Upload Plugin**, and upload the plugin binary you downloaded in the previous step.
4. Go to **System Console > Plugins > Plugin Management**. In the **Installed Plugins** section, scroll to **MS Teams Sync**, and select **Enable Plugin**.
4. Go to **System Console > Plugins > Plugin Management**. In the **Installed Plugins** section, scroll to **MS Teams**, and select **Enable Plugin**.

Set up an OAuth application in Azure
-------------------------------------
Expand All @@ -34,10 +34,10 @@ Step 1: Create Mattermost App in Azure

4. Fill out the form with the following values:

- **Name**: ``Mattermost MS Teams Sync``
- **Name**: ``Mattermost MS Teams``
- **Supported account types**: ``Default value (Single tenant)``
- **Platform**: ``Web``
- **Redirect URI**: ``https://(MM_SITE_URL)/plugins/com.mattermost.msteams-sync/oauth-redirect``
- **Redirect URI**: ``https://(MM_SITE_URL)/plugins/com.mattermost.msteams/oauth-redirect``

Replace ``(MM_SITE_URL)`` with your Mattermost server's Site URL. Select **Register** to submit the form.

Expand Down Expand Up @@ -122,14 +122,14 @@ Configure how users will connect accounts

Mattermost admins can configure Mattermost to automatically prompt users to connect their Mattermost user account to their Microsoft Teams user account on login.

1. Go to **System Console > Plugins > MS Teams Sync**.
1. Go to **System Console > Plugins > MS Teams**.
2. Enable **Enforce connected accounts** to prompt users to connect if they haven't done so.
3. (Optional) Enable **Allow to temporarily skip connect user** to allow users to skip the connection prompt temporarily. Users are prompted on refresh and login.

Configure the plugin
--------------------

Additional configuration settings are available for this plugin. See the `Microsoft Teams Sync plugin configuration settings </configure/plugins-configuration-settings.html#ms-teams-sync>`__ documentation for details.
Additional configuration settings are available for this plugin. See the `Microsoft Teams plugin configuration settings </configure/plugins-configuration-settings.html#ms-teams>`__ documentation for details.

Monitor plugin performance
--------------------------
Expand All @@ -139,7 +139,7 @@ You can set up `performance monitoring </scale/performance-monitoring.html>`__ a
- Monitoring enables you to proactively review the overall health of the plugin, including database calls, HTTP requests, and API latency.
- Alerting enables you to detect and take action as issues come up, such as the integration being offline.

Grafana dashboards `are available on GitHub <https://github.com/mattermost/mattermost-plugin-msteams-sync/blob/main/server/metrics/dashboards/cloud.json>`__ for Mattermost Cloud deployments as a useful starting point. These dashboards are designed for use in Mattermost Cloud, and filter to a given ``namespace``.
Grafana dashboards `are available on GitHub <https://github.com/mattermost/mattermost-plugin-msteams/blob/main/server/metrics/dashboards/cloud.json>`__ for Mattermost Cloud deployments as a useful starting point. These dashboards are designed for use in Mattermost Cloud, and filter to a given ``namespace``.

.. image:: ../images/grafana-dashboard-msteams.png
:alt: Example of a Grafana monitoring dashboard for a Mattermost instance connected to Microsoft Teams.
Expand All @@ -159,13 +159,13 @@ Trobleshooting
If you encounter issues when connecting user accounts or linking channels, restart the plugin as a Mattermost system admin.

1. Go to **System Console > Plugins > Plugin Management**.
2. Under **Installed Plugins**, scroll to the **MSTeams Sync** section, select **Disable** then wait for the State to change to **Not running**.
2. Under **Installed Plugins**, scroll to the **MS Teams** section, select **Disable** then wait for the State to change to **Not running**.
3. Select **Enable** and wait for the State to change to **Running**.

Get help
--------

If you face issues while installing this plugin, gather relevant information, including reproduction steps to accelerate troubleshooting. You're welcome to open a new issue in the `Mattermost for Microsoft Teams GitHub repository <https://github.com/mattermost/mattermost-plugin-msteams-sync/issues/new>`__.
If you face issues while installing this plugin, gather relevant information, including reproduction steps to accelerate troubleshooting. You're welcome to open a new issue in the `Mattermost for Microsoft Teams GitHub repository <https://github.com/mattermost/mattermost-plugin-msteams/issues/new>`__.

- **Mattermost Commercial Customers (including Enterprise and Professional plans)**: Visit `Mattermost Support <https://mattermost.com/support/>`__ to `submit a support ticket <https://support.mattermost.com/hc/en-us/requests/new>`__.

Expand Down
62 changes: 29 additions & 33 deletions source/about/self-hosted-subscriptions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ From Mattermost v7.7 you can buy a Mattermost subscription from within Mattermos
1. In Mattermost, select **View Plans** in the global header or via **System Console > View plans**.
2. Select **Upgrade**. A minimum of ten users is required.
3. Provide payment details.
4. Enter the number of user seats you're purchasing. This number has to be equal to, or greater than, the current number of active users in your Mattermost deployment.
4. Enter the number of user seats you're purchasing. This number has to be equal to, or greater than, the current number of activated users in your Mattermost deployment.
5. Select **Upgrade**.

When your purchase is complete, a license is automatically applied to instance and your subscription is active immediately.
Expand Down Expand Up @@ -76,7 +76,7 @@ You can access your Customer Portal account to view information about your:
- Organization information
- Payment methods
- Renewals
- Active users (available in a future release)
- Activated users (available in a future release)

Subscription and licenses not purchased via the Customer Portal won't be listed.

Expand All @@ -95,58 +95,54 @@ This process adds additional users to your existing subscription and is not a ne

If you don't have a self-hosted license in the Customer Portal and want to add users, `contact us <https://mattermost.com/contact-us/>`__.

Quarterly true-up reports from v7.9
-----------------------------------
Quarterly true-up reports
-------------------------

When you buy an annual Mattermost subscription, you agree to provide Mattermost with quarterly reports of the actual number of activated users within your system. An activated user is a user who has a Mattermost account and doesn't show as **Deactivated** in **System Console > User Management > Users**.

From Mattermost v7.9, the reporting period is still the same, but we've introduced a process that no longer requires you to take screenshots.
We'll send you an email notice around the end of the quarter reminding you to send us your report.

.. image:: ../images/true-up-schedule.png
:alt: The timeframes followed for the true up notifications.
:alt: The timeframes followed for the true-up notifications.

If you have more total activated users than you purchased in your annual subscription, your Customer Success Manager will provide you with a true-up quote for the new users added. The additional invoice will be pro-rated based on the number of months left in your subscription term, including the months for the calendar quarter for the time you pull the report. Mattermost won't provide downward adjustments. Mattermost will invoice based on Mattermost’s `current list prices <https://mattermost.com/pricing/>`__.

To send the report, a system admin must navigate to the **System Console** and open either the **Site Statistics** or **Team Statistics** pages.
From Mattermost v7.9
~~~~~~~~~~~~~~~~~~~~

From Mattermost v7.9, we've introduced a process that no longer requires you to take screenshots. To send Mattermost the report, a system admin must go to the **System Console** and open either the **Site Statistics** or **Team Statistics** pages.

If the current date is within the true-up reporting period, a panel will be visible at the top of the page with a button to share your system's statistics directly to Mattermost.
When the current date is within the true-up reporting period, a panel will be visible at the top of the page with a button to share your system's statistics with Mattermost directly.

If your system is air-gapped (meaning it doesn't have access to the internet), the system admin can download the system statistcs which can then be shared with your Customer Success Manager from a device that's not air-gapped.
If your system is air-gapped (meaning it doesn't have access to the internet), the system admin can download the system statistcs which can then be shared with your Mattermost Customer Success Manager from a device that's not air-gapped.

.. tip::

Not sure where to find the site statistics or team statistics? Please reach out to your account executive, Customer Success Manager, orders@mattermost.com, or support@mattermost.com for help.

Quarterly true-up report prior to v7.9
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When you buy an annual Mattermost subscription, you agree to provide quarterly reports of the actual number of active users within your system. An active user is a user who has an account in a workspace and does not show as **Inactive** in **System Console > User Management > Users**.
Prior to Mattermost v7.9
~~~~~~~~~~~~~~~~~~~~~~~~~

We'll send you an email notice around the end of the quarter reminding you to send us your report.
If you have a Mattermost deployment prior to v7.9, a system admin needs to take a screenshot of the **System Console > Site Statistics** page and send it to Mattermost in an email.

.. image:: ../images/true-up-schedule.png
:alt: The timeframes followed for the true up notifications.

To send this report, take a screenshot of **System Console > Site Statistics** and send in a reply email back to us.

- Please ensure your screenshot is taken from the top of the page and includes the **Total Active Users** metric.
- Please ensure your screenshot is taken from the top of the page and includes both **Total Activated Users** and the **Monthly Active Users** metrics.
- Please include the date of the screenshot in the file name.
- We don't need your server address, so if it appears on your screenshot, you can redact it from the image.

.. tip::

Not sure where to take the screenshot? Please reach out to your account executive, Customer Success Manager, orders@mattermost.com, or support@mattermost.com for help.

If you have more total active users than you purchased in your annual subscription, your Customer Success Manager will provide you with a true-up quote for the new users added.

The additional invoice will be pro-rated based on the number of months left in your subscription term, including the months for the calendar quarter for the time you pull the report. We will not provide downward adjustments. Mattermost will invoice based on Mattermost’s `current list prices <https://mattermost.com/pricing/>`__.

Renew your subscription
-----------------------

From Mattermost Server v5.32, you can renew your self-hosted Mattermost subscription with a credit card if you have a standard Mattermost contract. When you renew your license, you can also increase the number of active users.
From Mattermost Server v5.32, you can renew your self-hosted Mattermost subscription with a credit card if you have a standard Mattermost contract. When you renew your license, you can also increase the number of activated users.

If you haven't upgraded to v5.32, contact Mattermost Support at support@mattermost.com to renew your license.

If you're a reseller, have a non-standard contract, or want to adjust the number of active users on your license during the license period, please contact Mattermost Sales at sales@mattermost.com.
If you're a reseller, have a non-standard contract, or want to adjust the number of activated users on your license during the license period, please contact Mattermost Sales at sales@mattermost.com.

System Admins will be alerted 60 days prior to license expiry via a banner in Mattermost. Select **Renew license now** to start the renewal process in the Customer Portal. You can also dismiss the banner and renew your license at a later date via **System Console > Edition and License**.
System admins will be alerted 60 days prior to license expiry via a banner in Mattermost. Select **Renew license now** to start the renewal process in the Customer Portal. You can also dismiss the banner and renew your license at a later date via **System Console > Edition and License**.

When you select **Renew license now**, you're taken to the renewal page in the Customer Portal, which lists your license information and account details. This is pre-populated based on the email address associated with your existing license subscription.

Expand All @@ -158,7 +154,7 @@ Process your license renewal

* You can upgrade within the Customer Portal, but it's not possible to downgrade.

3. Confirm the listed number of active users is correct.
3. Confirm the listed number of activated users is correct.

* You can increase the number of licensed users, but you can't decrease it.

Expand All @@ -175,14 +171,14 @@ You can watch a video overview of the renewal process on YouTube:
Frequently asked questions
--------------------------

What is a true up and why is the true up notice necessary?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
What is a true-up report and why is the true-up notice necessary?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A true up is our quarterly request for you to provide a screenshot of your instance data to determine if you have more active users now than when you bought your subscription.
A true-up report is our quarterly request for you to provide us with the actual number of activated users within your system to determine if you have more activated users now than when you bought your subscription.

As your organization grows, you may need to add additional users during your subscription period. Mattermost needs to have insight into changes in your active user count so that we can charge you appropriately for your self-hosted license usage. Additionally, we don’t want to over estimate/charge active users at your renewal time.
As your organization grows, you may need to add additional users during your subscription period. Mattermost needs to have insight into changes in your activated user count so that we can charge you appropriately for your self-hosted license usage. Additionally, we don’t want to over estimate/charge activated users at your renewal time.

When you receive the quarterly true up notice from Mattermost, please take a screenshot of your active user count which you can find in **System Console > Site Statistics**. Then reply to the email with the attached screenshot.
When you receive the quarterly true-up notice from Mattermost, please share your activated user count with us.

How do I renew my subscription if I don't have internet access?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
8 changes: 6 additions & 2 deletions source/about/subscription.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,16 @@ In this case, the "physical address" is the location where the individual, who w
How is a user defined for subscriptions?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

For the purpose of billing, a “user” is any account created in Mattermost that has not been deactivated by the System Administrator. You can see your user count for billing purposes from the System Console on the **Site Statistics** page under “Total Active Users”. Guests are also defined as users.
For the purpose of billing, a “user” is any account created in Mattermost that does not show as **Deactivated** in **System Console > User Management > Users**. Guests are also defined as users.

Bots, deactivated users, and synthetic users in `Microsoft Teams integrations </collaborate/collaborate-using-mattermost-for-microsoft-teams.html>`__ and `shared channels users </onboard/shared-channels.html>`__, aren't counted towards the total number of activated users.

You can review your user count, for billing purposes, by going to ** System Console > Site Statistics**, under **Total Activated Users**.

Do I need to pay for deactivated users?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

No. If you deactivate a user, that user is not counted as an active user during your annual renewal process. You can deactivate users manually via the System Console, and also via Active Directory/LDAP synchronization, the mmctl tool, and the server APIs.
No. If you deactivate a user, that user is not counted as an activated user during your annual renewal process. You can deactivate users manually via the System Console, and also via Active Directory/LDAP synchronization, the mmctl tool, and the server APIs.

If you choose to pull SQL reports from the database to monitor individual activity to make deactivation decisions, and you are running under high user load, we recommend the reports are pulled from a read replica of the database.

Expand Down
Loading

0 comments on commit 9700101

Please sign in to comment.