Skip to content
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Include the ``token`` value sent in the response as part of the Authorization he

.. code-block:: sh

curl -i -H 'Authorization: Bearer yi94pwci6ibjfc9phbikhqutbe http://yourmattermosturl/api/v4/users/me'
curl -i -H 'Authorization: Bearer yi94pwci6ibjfc9phbikhqutbe' http://yourmattermosturl/api/v4/users/me

Once you're authenticated into Mattermost, you can use the `Compliance API to create a new compliance report <https://api.mattermost.com/#tag/compliance%2Fpaths%2F~1compliance~1reports%2Fpost>`__. The curl based example below demonstrates how to send a request that bases the authentication token and asks Mattermost to create a report that spans posts from Dec 31, 2017 - 8:15 PM to Dec 31, 2018 - 8:15 PM for a user with the email address craig@mattermost.com:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Below is additional information on how to configure the database for different l
.. code-block:: sql

-- 创建 extension
CREATE EXTENSION zhparser
CREATE EXTENSION zhparser;
-- 创建 text search configuration
CREATE TEXT SEARCH CONFIGURATION simple_zh_cfg (PARSER = zhparser);
-- 配置 token mapping
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This endpoint can also be provided to schedulers like `Kubernetes <https://kuber

.. code-block:: go

import github.com/mattermost/mattermost/tree/master/server/public/model"
import "github.com/mattermost/mattermost/server/public/model"

Client := model.NewAPIv4Client("https://your-mattermost-url.com")
Client.Login("email@domain.com", "Password1")
Expand Down
2 changes: 1 addition & 1 deletion source/administration-guide/onboard/sso-entraid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Step 3: Configure Mattermost for Entra ID SSO
Note about Microsoft Active Directory Tenants
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A Microsoft Active Directory (AD) tenant is a dedicated instance of Azure Active Directory (Azure AD) that you own and would have received when signing up for a Microsoft cloud service, such as Azure or Entra ID. Tenants are commonly used by organizations who want to store information about their users, such as passwords, user profile data, and permissions. See the Microsoft Entra ID <https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-create-new-tenant>`_ documentation to learn more about getting an Azure AD tenant.
A Microsoft Active Directory (AD) tenant is a dedicated instance of Azure Active Directory (Azure AD) that you own and would have received when signing up for a Microsoft cloud service, such as Azure or Entra ID. Tenants are commonly used by organizations who want to store information about their users, such as passwords, user profile data, and permissions. See the `Microsoft Entra ID <https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-create-new-tenant>`_ documentation to learn more about getting an Azure AD tenant.

To allow your Azure AD users to log in to Mattermost using Entra ID SSO, you must register Mattermost in the Microsoft Azure AD tenant that contains the users' information. The registration can be done from the `Microsoft Azure portal <https://portal.azure.com>`__. The steps to register the Mattermost account in the tenant should be similar to those provided above, and you can find more information about `integrating apps with Azure AD here <https://learn.microsoft.com/en-us/azure/active-directory/develop/quickstart-create-new-tenant>`_.

Expand Down
2 changes: 1 addition & 1 deletion source/administration-guide/scale/enterprise-search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Review the following support paths for enterprise search based on the version yo

1. Disable "compatibility mode" in OpenSearch.
2. Upgrade Mattermost server.
3. Update the Mattermost ``ElasticsearchSettings.Backend`` configuration setting value from ``elasticsearch`` to ```opensearch``` manually or using :ref:`mmctl <administration-guide/manage/mmctl-command-line-tool:mmctl config set>`. This value cannot be changed using the System Console. See the Mattermost search :ref:`backend type <administration-guide/configure/environment-configuration-settings:backend type>` configuration setting documentation for additional details.
3. Update the Mattermost ``ElasticsearchSettings.Backend`` configuration setting value from ``elasticsearch`` to ``opensearch`` manually or using :ref:`mmctl <administration-guide/manage/mmctl-command-line-tool:mmctl config set>`. This value cannot be changed using the System Console. See the Mattermost search :ref:`backend type <administration-guide/configure/environment-configuration-settings:backend type>` configuration setting documentation for additional details.
4. Restart the Mattermost server.

Frequently asked questions (FAQ)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Important administration notes
**DO NOT manipulate the Mattermost database**

- In particular, DO NOT manually delete data from the database directly. Mattermost is designed as a continuous archive and cannot be supported after manual manipulation.
- If you need to permanently delete a team or user, use the :ref:`mmctl user delete <administration-guide/manage/mmctl-command-line-tool:mmctl user delete>` command or the :ref:`mmctl user deletall <administration-guide/manage/mmctl-command-line-tool:mmctl user deleteall>` command.
- If you need to permanently delete a team or user, use the :ref:`mmctl user delete <administration-guide/manage/mmctl-command-line-tool:mmctl user delete>` command or the :ref:`mmctl user deleteall <administration-guide/manage/mmctl-command-line-tool:mmctl user deleteall>` command.

Common tasks
------------
Expand Down
2 changes: 1 addition & 1 deletion source/administration-guide/upgrade/upgrading-postgres.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ When running PostgreSQL in Docker, ``pg_dump``/``pg_restore`` is the recommended
After the upgrade
------------------

After upgrading PostgreSQL, run ``ANALYZE VERBOSE`` on the Mattermost database. This re-populates the ``pg_statistics`` table used by PostgreSQL to generate optimal query plans. Skipping this step can result in degraded database performance.
After upgrading PostgreSQL, run ``ANALYZE VERBOSE`` on the Mattermost database. This re-populates the ``pg_statistic`` table used by PostgreSQL to generate optimal query plans. Skipping this step can result in degraded database performance.

.. code-block:: sh

Expand Down
2 changes: 1 addition & 1 deletion source/deployment-guide/desktop/linux-desktop-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ This page describes how to install the Mattermost desktop app on Linux.

.. code-block:: sh

sudo rpm -u mattermost-desktop-6.2.0-linux-x86_64.rpm
sudo rpm -U mattermost-desktop-6.2.0-linux-x86_64.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 Down
2 changes: 1 addition & 1 deletion source/deployment-guide/server/linux/deploy-tar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ To remove the Mattermost Server for any reason, you must stop the Mattermost Ser

.. code-block:: sh

sudo rm - rf /opt/mattermost
sudo rm -rf /opt/mattermost

.. note::

Expand Down