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
40 changes: 40 additions & 0 deletions source/administration-guide/admin-tools/admin-tools-index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Administration Tools & Utilities
================================

Use administrative tools and utilities to automate tasks, export data, and troubleshoot your deployment. This section centralizes command-line tools and operational utilities.

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

mmctl-command-line-tool
command-line-tools
generating-support-packet
../user-experience/system-wide-notifications
../user-experience/in-product-notices
feature-labels
../monitoring-observability/monitoring-and-performance
../monitoring-observability/statistics
request-server-health-check
telemetry

Streamline administration with automation tools, simplify troubleshooting, and maintain operational hygiene.

- `Use mmctl or the CLI for automation <admin-tools/admin-tools-index>`_
- `Generate and review support packets <admin-tools/admin-tools-index>`_
- `Manage system notices <admin-tools/admin-tools-index>`_
- `Track product limits and usage statistics <admin-tools/admin-tools-index>`_
- `Configure automated health checks <admin-tools/admin-tools-index>`_
- `Manage teams and channels <admin-tools/admin-tools-index>`_

- :doc:`Cloud data export </administration-guide/admin-tools/cloud-data-export>`
- :doc:`Command line tools </administration-guide/admin-tools/command-line-tools>`
- :doc:`Configure health check probes </administration-guide/admin-tools/configure-health-check-probes>`
- :doc:`Error codes </administration-guide/admin-tools/error-codes>`
- :doc:`Feature labels </administration-guide/admin-tools/feature-labels>`
- :doc:`Generating support packet </administration-guide/admin-tools/generating-support-packet>`
- :doc:`mmctl command line tool </administration-guide/admin-tools/mmctl-command-line-tool>`
- :doc:`Product limits </administration-guide/admin-tools/product-limits>`
- :doc:`Request server health check </administration-guide/admin-tools/request-server-health-check>`
- :doc:`Server maintenance </administration-guide/admin-tools/server-maintenance>`
- :doc:`Telemetry </administration-guide/admin-tools/telemetry>`
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,9 @@ How does the process work?

Before you export and migrate your data, you must :doc:`install Mattermost </deployment-guide/deployment-guide-index>` on the server you’ll be using to run Mattermost. The migration is done using the mmctl CLI tool, which is a remote CLI tool for Mattermost that's installed locally and uses the Mattermost API. ``mmctl`` is pre-installed.

The :ref:`mmctl usage notes <administration-guide/manage/mmctl-command-line-tool:mmctl usage notes>` provide some additional context and information which you can reference before and during the process.
The :ref:`mmctl usage notes <administration-guide/admin-tools/mmctl-command-line-tool:mmctl usage notes>` provide some additional context and information which you can reference before and during the process.

You'll be using the :ref:`mmctl export <administration-guide/manage/mmctl-command-line-tool:mmctl export>` commands to export your Cloud data for channels, messages, users, etc. The export file is downloaded to a location specified in the export commands. Once the export is complete, you'll import the data into your self-hosted instance.
You'll be using the :ref:`mmctl export <administration-guide/admin-tools/mmctl-command-line-tool:mmctl export>` commands to export your Cloud data for channels, messages, users, etc. The export file is downloaded to a location specified in the export commands. Once the export is complete, you'll import the data into your self-hosted instance.

Alternatively, you can export the data to an Amazon S3 cloud storage location in cases where an export is quite large and challenging to download from the Mattermost server. See the `create the export <#create-the-export>`__ section below for details.

Expand Down Expand Up @@ -188,21 +188,21 @@ Finally, it's time to take our export from the source server and use it as an im
| **Mattermost configuration setting** | **Large file import recommendation** |
+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Maximum Users Per Team | Increase this value to a number that **exceeds** the maximum number of users, per team, in the import file. |
| <administration-guide/configure/site-configuration-settings:max users per team>` | |
| <administration-guide/configuration-reference/site-configuration-settings:max users per team>` | |
+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Maximum File Size | Temporarily increase this value to be **larger** than the size of the import file. |
| <administration-guide/configure/environment-configuration-settings:maximum file size>` | Following a successful import, we strongly recommend reverting this value to a reasonable limit for daily expected usage. |
| <administration-guide/getting-started/environment-configuration-settings:maximum file size>` | Following a successful import, we strongly recommend reverting this value to a reasonable limit for daily expected usage. |
+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Write Timeout | Temporarily adjust this value based on import file speed and network path to enable the file to upload without timeouts. |
| <administration-guide/configure/environment-configuration-settings:write timeout>` | Start with a value of **3600** and adjust if needed. |
| <administration-guide/getting-started/environment-configuration-settings:write timeout>` | Start with a value of **3600** and adjust if needed. |
| | Following a successful import, we strongly recommend reverting this setting to its initial or previous value. |
+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Read Timeout | Temporarily adjust this value based on import file speed and network path to enable the file to upload without timeouts. |
| <administration-guide/configure/environment-configuration-settings:read timeout>` | Start with a value of **3600** and adjust if needed. |
| <administration-guide/getting-started/environment-configuration-settings:read timeout>` | Start with a value of **3600** and adjust if needed. |
| | Following a successful import, we strongly recommend reverting this setting to its initial or previous value. |
+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Amazon S3 Request Timeout | If using cloud-based file storage, adjust this value to ensure your storage requests don't time out too soon. |
| <administration-guide/configure/environment-configuration-settings:amazon s3 request timeout>` | |
| <administration-guide/getting-started/environment-configuration-settings:amazon s3 request timeout>` | |
+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+

Next, log into the destination server using ``mmctl`` the same way you logged into the source server:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In self-managed deployments, a ``mattermost`` command is available for configuri

.. important::

From Mattermost v6.0, the majority of these CLI commands have been replaced with equivalents available using the :doc:`mmctl command line tool </administration-guide/manage/mmctl-command-line-tool>`. However, :ref:`mattermost import <administration-guide/manage/command-line-tools:mattermost import>` commands, :ref:`mattermost export <administration-guide/manage/command-line-tools:mattermost export>` commands, and related subcommands, remain available and fully supported from Mattermost v6.0.
From Mattermost v6.0, the majority of these CLI commands have been replaced with equivalents available using the :doc:`mmctl command line tool </administration-guide/admin-tools/mmctl-command-line-tool>`. However, :ref:`mattermost import <administration-guide/admin-tools/command-line-tools:mattermost import>` commands, :ref:`mattermost export <administration-guide/admin-tools/command-line-tools:mattermost export>` commands, and related subcommands, remain available and fully supported from Mattermost v6.0.

These ``mattermost`` commands include the following functionality:

Expand Down Expand Up @@ -84,7 +84,7 @@ Use the CLI
The Docker Install tab details and command references below also apply to the `Mattermost docker preview image <https://github.com/mattermost/mattermost-docker-preview>`_.

.. note::
- The CLI is run in a single node which bypasses the mechanisms that a :doc:`High Availability environment </administration-guide/scale/high-availability-cluster-based-deployment>` uses to perform actions across all nodes in the cluster. As a result, when running :doc:`CLI commands </administration-guide/manage/command-line-tools>` in a High Availability environment, tasks that change configuration settings require a server restart.
- The CLI is run in a single node which bypasses the mechanisms that a :doc:`High Availability environment </administration-guide/operations-scaling/high-availability-cluster-based-deployment>` uses to perform actions across all nodes in the cluster. As a result, when running :doc:`CLI commands </administration-guide/admin-tools/command-line-tools>` in a High Availability environment, tasks that change configuration settings require a server restart.
- Parameters in CLI commands are order-specific.
- If special characters (``!``, ``|``, ``(``, ``)``, ``\``, ``'``, or ``"``) are used, the entire argument needs to be surrounded by single quotes, or the individual characters need to be escaped out.

Expand Down Expand Up @@ -248,7 +248,7 @@ Child Commands
- `mattermost export csv`_ - Deprecated from Mattermost v10.5.
- `mattermost export global-relay-zip`_ - Deprecated from Mattermost v10.5.
- `mattermost export schedule`_ - Schedule a compliance export job.
- `mattermost export bulk`_ - Export data to a file compatible with the Mattermost :doc:`Bulk Import format </administration-guide/onboard/bulk-loading-data>`. Deprecated in favor of :ref:`mmctl export commands <administration-guide/manage/mmctl-command-line-tool:mmctl export>`.
- `mattermost export bulk`_ - Export data to a file compatible with the Mattermost :doc:`Bulk Import format </administration-guide/getting-started/bulk-loading-data>`. Deprecated in favor of :ref:`mmctl export commands <administration-guide/admin-tools/mmctl-command-line-tool:mmctl export>`.

mattermost export actiance
~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -290,7 +290,7 @@ Options
mattermost export bulk
~~~~~~~~~~~~~~~~~~~~~~

From Mattermost v6.0, this command has been deprecated in favor of :ref:`mmctl export commands <administration-guide/manage/mmctl-command-line-tool:mmctl export>` as the supported way to export data out of Mattermost.
From Mattermost v6.0, this command has been deprecated in favor of :ref:`mmctl export commands <administration-guide/admin-tools/mmctl-command-line-tool:mmctl export>` as the supported way to export data out of Mattermost.

----

Expand All @@ -316,18 +316,18 @@ Description
Import data into Mattermost.

Child Command
- `mattermost import bulk`_ - Import a Mattermost Bulk Import File. Deprecated in favor of :ref:`mmctl import commands <administration-guide/manage/mmctl-command-line-tool:mmctl import>`.
- `mattermost import bulk`_ - Import a Mattermost Bulk Import File. Deprecated in favor of :ref:`mmctl import commands <administration-guide/admin-tools/mmctl-command-line-tool:mmctl import>`.
- `mattermost import slack`_ - Import a team from Slack.

mattermost import bulk
~~~~~~~~~~~~~~~~~~~~~~

From Mattermost v6.0, this command has been deprecated in favor of :ref:`mmctl import commands <administration-guide/manage/mmctl-command-line-tool:mmctl import>` as the supported way to import data into Mattermost.
From Mattermost v6.0, this command has been deprecated in favor of :ref:`mmctl import commands <administration-guide/admin-tools/mmctl-command-line-tool:mmctl import>` as the supported way to import data into Mattermost.

mattermost import slack
~~~~~~~~~~~~~~~~~~~~~~~

See the :ref:`mmctl import commands <administration-guide/manage/mmctl-command-line-tool:mmctl import>` documentation as the preferred way to import Slack data into Mattermost.
See the :ref:`mmctl import commands <administration-guide/admin-tools/mmctl-command-line-tool:mmctl import>` documentation as the preferred way to import Slack data into Mattermost.

Description
Import a team from a Slack export zip file.
Expand Down Expand Up @@ -380,7 +380,7 @@ mattermost version

.. note::

From Mattermost v6.5, this CLI command no longer interacts with the database. The :ref:`mattermost db migrate <administration-guide/manage/command-line-tools:mattermost db migrate>` CLI command has been introduced to trigger schema migrations.
From Mattermost v6.5, this CLI command no longer interacts with the database. The :ref:`mattermost db migrate <administration-guide/admin-tools/command-line-tools:mattermost db migrate>` CLI command has been introduced to trigger schema migrations.

Desription
Displays Mattermost version information.
Expand All @@ -398,7 +398,7 @@ Troubleshooting
Executing a command hangs and doesn't complete
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you have Bleve search indexing enabled, temporarily disable it in **System Console > Experimental > Bleve** and run the command again. You can also optionally use the new :doc:`mmctl Command Line Tool </administration-guide/manage/mmctl-command-line-tool>`.
If you have Bleve search indexing enabled, temporarily disable it in **System Console > Experimental > Bleve** and run the command again. You can also optionally use the new :doc:`mmctl Command Line Tool </administration-guide/admin-tools/mmctl-command-line-tool>`.

Bleve does not support multiple processes opening and manipulating the same index. Therefore, if the Mattermost server is running, an attempt to run the CLI will lock when trying to open the indeces.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Before you begin, you should have a running Mattermost server. If you don't, you

.. note::

:doc:`Highly available Mattermost cluster support </administration-guide/scale/high-availability-cluster-based-deployment>` requires Mattermost Enterprise.
:doc:`Highly available Mattermost cluster support </administration-guide/operations-scaling/high-availability-cluster-based-deployment>` requires Mattermost Enterprise.

You can perform a health check with the following 2 methods:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Mattermost error codes
======================

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

Mattermost is designed to deploy in private networks which may be disconnected or “air-gapped” from the internet. In these deployments, links to Mattermost’s online documentation may be unavailable.
Expand All @@ -19,7 +19,7 @@ A safety limits exceeded error (``ERROR_SAFETY_LIMITS_EXCEEDED``) displays in th

2,500 users represents a “high upper limit” for deployments that are approximately 100 times the recommended size, which is far beyond the intended design of the product.

The free version of Mattermost is intended for approximately 50 users. If your Mattermost materially exceeds this recommended size, system admins should seek to either `purchase a commercial license <https://mattermost.com/pricing/>`_, or apply for a :doc:`non-profit subscription </product-overview/non-profit-subscriptions>` license. Alternatively, admins can :ref:`deactivate users <administration-guide/configure/user-management-configuration-settings:deactivate users>` until the user count falls below the high upper limit.
The free version of Mattermost is intended for approximately 50 users. If your Mattermost materially exceeds this recommended size, system admins should seek to either `purchase a commercial license <https://mattermost.com/pricing/>`_, or apply for a :doc:`non-profit subscription </product-overview/non-profit-subscriptions>` license. Alternatively, admins can :ref:`deactivate users <administration-guide/configuration-reference/user-management-configuration-settings:deactivate users>` until the user count falls below the high upper limit.

ERROR_LICENSED_USERS_LIMIT_EXCEEDED
-----------------------------------
Expand All @@ -33,7 +33,7 @@ This error occurs when:

To resolve this error, system administrators can:

- :ref:`Deactivate users <administration-guide/configure/user-management-configuration-settings:deactivate users>` to reduce the active user count below the license limit.
- :ref:`Deactivate users <administration-guide/configuration-reference/user-management-configuration-settings:deactivate users>` to reduce the active user count below the license limit.
- Contact `Mattermost Sales <https://mattermost.com/contact-sales/>`_ to discuss license options.

`Book a live demo <https://mattermost.com/request-demo/>`_ or `talk to a Mattermost expert <https://mattermost.com/contact-sales/>`_ to explore tailored solutions for your organization's secure collaboration needs. Or try Mattermost yourself with a `1-hour preview <https://mattermost.com/sign-up/>`_ for instant access to a live sandbox environment.
Loading