Skip to content
Merged
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
20 changes: 9 additions & 11 deletions docs/main/administration-guide/administration-guide-index.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
---
title: "Administration Guide"
---
Welcome to the Mattermost Administration Guide. This guide is organized into sections based on administrative tasks and scenarios to help you effectively manage and optimize your Mattermost workspace.
Welcome to the Mattermost Administration Guide. This guide is organized around what you're doing — setting the server up, getting users in, running it day to day, keeping it healthy, meeting your compliance obligations, upgrading it, and migrating data in and out.

Whether you’re configuring server settings, managing users, monitoring performance, or ensuring compliance, this guide provides all the information you need. Use the navigation below to access detailed instructions and best practices for each topic.
- [Configure](/administration-guide/configure/configure-index) - System Console settings, search, email, file storage, branding, agents, and plugins.
- [Onboard users](/administration-guide/onboard/onboard-index) - Single sign-on, AD/LDAP, provisioning, and guest accounts.
- [Manage](/administration-guide/manage/admin/server-maintenance) - Access control, server operations, licensing, Cloud workspaces, and notices.
- [Monitor and troubleshoot](/administration-guide/manage/admin/monitoring-and-performance) - Metrics and dashboards, logging, health checks, support packets, and error codes.
- [Comply](/administration-guide/comply/comply-index) - Compliance export and monitoring, eDiscovery, data retention, legal hold, and audit logs.
- [Upgrade](/administration-guide/upgrade/upgrade-index) - Upgrade notes, upgrade and downgrade procedures, and post-upgrade rollout tasks.
- [Migrate](/administration-guide/manage/admin/migration) - Bulk import and export, MySQL to PostgreSQL, FIPS migration, and moving from another platform.

- [Self-hosted billing](/administration-guide/manage/admin/self-hosted-billing) - Billing and payment options for Mattermost self-hosted deployments.
- [Cloud workspace management](/administration-guide/manage/cloud-workspace-management) - Learn how to manage cloud workspaces in Mattermost.
- [Server maintenance](/administration-guide/manage/admin/server-maintenance) - Learn about Mattermost server maintenance and best practices.
- [Server configuration](/administration-guide/manage/admin/server-configuration) - Learn about server configuration and settings.
- [User provisioning](/administration-guide/manage/admin/user-provisioning) - Learn about user provisioning and management.
- [User management](/administration-guide/manage/admin/user-management) - Learn about user management and best practices.
- [Monitoring and performance](/administration-guide/manage/admin/monitoring-and-performance) - Learn about monitoring and performance optimization.
- [Compliance](/administration-guide/comply/comply-index) - Learn about compliance and security best practices.
- [Migration](/administration-guide/manage/admin/migration) - Learn about migrating to Mattermost.
If you're deploying Mattermost for the first time, start with the [deployment guide](/deployment-guide/deployment-guide-index) instead.
5 changes: 3 additions & 2 deletions docs/main/administration-guide/comply/comply-index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ Mattermost is purpose-built to help enterprises keep sensitive data safe and com
- [Electronic discovery](/administration-guide/comply/electronic-discovery) - Extract data from Mattermost for eDiscovery.
- [Data retention](/administration-guide/comply/data-retention-policy) - Control how long data is stored in Mattermost with global and custom retention policies to meet data retention compliance requirements.
- [Export channel data](/administration-guide/comply/export-mattermost-channel-data) - Migrate data between systems and back data up for operational continuity.
- [Legal Hold](/administration-guide/comply/legal-hold) - Preserve relevant Mattermost information when litigation is anticipated.
- [JSON audit log schema](/administration-guide/comply/embedded-json-audit-log-schema) - Learn how to configure Mattermost audit logging using a JSON object.
- [Legal hold](/administration-guide/comply/legal-hold) - Preserve relevant Mattermost information when litigation is anticipated.
- [Custom terms of service](/administration-guide/comply/custom-terms-of-service) - Require users to accept your own terms before they can access Mattermost.
- [Audit log JSON schema](/administration-guide/comply/embedded-json-audit-log-schema) - Learn how to configure Mattermost audit logging using a JSON object.
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ You can also run the deletion job manually at any time by selecting **Run Deleti

<Note>

If using data retention with [ElasticSearch](/deployment-guide/reference-architecture/scale/elasticsearch-setup), ensure the [ElasticSearch aggregate search indexes](/administration-guide/configure/environment-configuration-settings#aggregate-search-indexes) setting is set to a value that is greater than your data retention policy in days.
If using data retention with [ElasticSearch](/deployment-guide/scale/elasticsearch-setup), ensure the [ElasticSearch aggregate search indexes](/administration-guide/configure/environment-configuration-settings#aggregate-search-indexes) setting is set to a value that is greater than your data retention policy in days.

</Note>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Audit Log JSON Schema"
title: "Audit log JSON schema"
---
<PlanAvailability slug="entry-ent" />

Expand Down
2 changes: 1 addition & 1 deletion docs/main/administration-guide/comply/legal-hold.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Legal Hold"
title: "Legal hold"
---
import useBaseUrl from '@docusaurus/useBaseUrl';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ Access the following configuration settings in the System Console by going to **

<Note>

\- LDAP and SAML users can always create a Mattermost account by logging in using LDAP or SAML user credentials, regardless of whether this configuration setting is enabled. - From Mattermost v10.9, email addresses enclosed in angle brackets (e.g., `[billy@example.com](mailto:billy@example.com)`) will be rejected. To avoid issues, ensure all user emails comply with the plain address format (e.g., `billy@example.com`). In addition, we strongly recommend taking proactive steps to audit and update Mattermost user data to align with this product change, as impacted users may face issues accessing Mattermost or managing their user profile. You can update these user emails manually using [mmctl user email](/administration-guide/manage/mmctl-command-line-tool#mmctl-user-email). - See the encryption options documentation for details on what [encryption methods](/deployment-guide/encryption-options#saml-encryption-support) Mattermost supports for SAML.
- LDAP and SAML users can always create a Mattermost account by logging in using LDAP or SAML user credentials, regardless of whether this configuration setting is enabled.
- From Mattermost v10.9, email addresses enclosed in angle brackets (e.g., `[billy@example.com](mailto:billy@example.com)`) will be rejected. To avoid issues, ensure all user emails comply with the plain address format (e.g., `billy@example.com`). In addition, we strongly recommend taking proactive steps to audit and update Mattermost user data to align with this product change, as impacted users may face issues accessing Mattermost or managing their user profile. You can update these user emails manually using [mmctl user email](/administration-guide/manage/mmctl-command-line-tool#mmctl-user-email).
- See the [supported SAML encryption methods](#supported-saml-encryption-methods).

</Note>

Expand Down Expand Up @@ -994,7 +996,7 @@ The [mmctl ldap sync](/administration-guide/manage/mmctl-command-line-tool#mmctl

Access the following configuration settings in the System Console by going to **Authentication \> SAML 2.0**.

See the encryption options documentation for details on what [encryption methods](/deployment-guide/encryption-options#saml-encryption-support) Mattermost supports for SAML.
See the [supported SAML encryption methods](#supported-saml-encryption-methods).

<Important>

Expand Down Expand Up @@ -1200,6 +1202,18 @@ For more information, see [AD/LDAP Setup](/administration-guide/onboard/ad-ldap)
</tbody>
</table>

#### Supported SAML encryption methods

Mattermost supports the following encryption methods for SAML:

- aes128-gcm
- aes192-gcm
- aes256-gcm
- aes128-cbc
- aes256-cbc

AES-192-GCM and AES-256-GCM support was introduced in Mattermost v10.9.

### Service provider private key

<table>
Expand Down
4 changes: 2 additions & 2 deletions docs/main/administration-guide/configure/bleve-search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: "Bleve search"

**From Mattermost v11, Bleve search has been deprecated.**

- **For v11.0 and later**: Use [Elasticsearch](/deployment-guide/reference-architecture/scale/elasticsearch-setup) or [OpenSearch](/deployment-guide/reference-architecture/scale/opensearch-setup) for [enterprise search](/deployment-guide/reference-architecture/scale/enterprise-search) capabilities
- **For v11.0 and later**: Use [Elasticsearch](/deployment-guide/scale/elasticsearch-setup) or [OpenSearch](/deployment-guide/scale/opensearch-setup) for [enterprise search](/deployment-guide/scale/enterprise-search) capabilities
- **For pre-v11.0 deployments**: This documentation remains relevant for existing installations that continue using Bleve.

</Important>
Expand Down Expand Up @@ -61,4 +61,4 @@ The following conditions are applied when using Bleve search:

## How does search work with Bleve disabled?

Mattermost performs full text searches against the database unless you have an [Enterprise license](/product-overview/editions-and-offerings#mattermost-enterprise) and [enterprise search](/deployment-guide/reference-architecture/scale/enterprise-search) configured.
Mattermost performs full text searches against the database unless you have an [Enterprise license](/product-overview/editions-and-offerings#mattermost-enterprise) and [enterprise search](/deployment-guide/scale/enterprise-search) configured.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Store configuration in your database"
---
<PlanAvailability slug="all-commercial" />

If you have a self-hosted Mattermost deployment, you can use your database as the single source of truth for the active configuration of your Mattermost installation. This changes the Mattermost binary from reading the default `config.json` file to reading the configuration settings stored within a configuration table in the database. Mattermost has been running our [community server](https://community.mattermost.com) on this option since the feature was released, and recommends its use for those on [High Availability deployments](/deployment-guide/reference-architecture/scale/high-availability-cluster-based-deployment).
If you have a self-hosted Mattermost deployment, you can use your database as the single source of truth for the active configuration of your Mattermost installation. This changes the Mattermost binary from reading the default `config.json` file to reading the configuration settings stored within a configuration table in the database. Mattermost has been running our [community server](https://community.mattermost.com) on this option since the feature was released, and recommends its use for those on [High Availability deployments](/deployment-guide/server/high-availability-cluster-based-deployment).

Benefits to using this option:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,21 @@ System admins for both self-hosted and Cloud Mattermost deployments can manage M

Mattermost configuration settings are organized into the following categories within the System Console:

- [Self-hosted workspace edition and license settings](/administration-guide/configure/self-hosted-account-settings)
- [Cloud workspace subscription, billing, and account settings](/administration-guide/configure/cloud-billing-account-settings)
- [Reporting configuration settings](/administration-guide/configure/reporting-configuration-settings)
- [Site configuration settings](/administration-guide/configure/site-configuration-settings)
- [Authentication configuration settings](/administration-guide/configure/authentication-configuration-settings)
- [User management configuration settings](/administration-guide/configure/user-management-configuration-settings)
- [System attributes](/administration-guide/configure/system-attributes)
- [Environment configuration settings](/administration-guide/configure/environment-configuration-settings)
- [Site configuration settings](/administration-guide/configure/site-configuration-settings)
- [Authentication configuration settings](/administration-guide/configure/authentication-configuration-settings)
- [Plugins configuration settings](/administration-guide/configure/plugins-configuration-settings)
- [Integrations configuration settings](/administration-guide/configure/integrations-configuration-settings)
- [Reporting configuration settings](/administration-guide/configure/reporting-configuration-settings)
- [Compliance configuration settings](/administration-guide/configure/compliance-configuration-settings)
- [Integrations configuration settings](/administration-guide/configure/integrations-configuration-settings)
- [Plugins configuration settings](/administration-guide/configure/plugins-configuration-settings)
- [Self-hosted workspace edition and license settings](/administration-guide/configure/self-hosted-account-settings)
- [Cloud workspace subscription, billing, and account settings](/administration-guide/configure/cloud-billing-account-settings)
- [Experimental configuration settings](/administration-guide/configure/experimental-configuration-settings)
- [Deprecated configuration settings](/administration-guide/configure/deprecated-configuration-settings)
- [Bleve search](/administration-guide/configure/bleve-search)

Search is configured outside the System Console settings pages above. See [Bleve search](/administration-guide/configure/bleve-search) for the built-in search engine, and the [deployment guide](/deployment-guide/scale/elasticsearch-setup) for Elasticsearch and OpenSearch.

## Configuration in database

Expand Down
29 changes: 29 additions & 0 deletions docs/main/administration-guide/configure/configure-index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Configure Mattermost"
sidebar_label: "Configure"
---
Configuration covers everything you set before and after your server is running: the System Console settings themselves, the subsystems Mattermost connects to, and the capabilities you turn on for your users.

## System Console settings reference

- [System Console settings](/administration-guide/configure/configuration-settings) - Every System Console setting, one page per section, with its `config.json` key and environment variable.
- [Store configuration in your database](/administration-guide/configure/configuration-in-your-database) - Store configuration in your Mattermost database rather than as a JSON file.
- [Environment variables](/administration-guide/configure/environment-variables) - Override configuration settings using environment variables.

## Subsystems

- [Search](/administration-guide/configure/bleve-search) - Enable Bleve search, and Chinese, Japanese, and Korean search.
- [Email](/administration-guide/configure/smtp-email) - Set up SMTP email, and customize email templates.
- [Configure Azure Blob Storage as the Mattermost file store](/administration-guide/configure/azure-blob-storage) - Use Azure Blob Storage instead of local or S3-compatible storage.

For enterprise search with Elasticsearch or OpenSearch, see the [deployment guide](/deployment-guide/scale/elasticsearch-setup).

## Capabilities

- [Branding and customization](/administration-guide/manage/admin/customize-branding) - Apply your organization's branding, and sign custom builds.
- [Mattermost Agents](/administration-guide/configure/agents-admin-guide) - Enable AI-powered Agents and connect an LLM provider.
- [Install and manage plugins](/administration-guide/configure/manage-plugins) - Install, enable, configure, update, and remove plugins.
- [Install Mattermost Boards](/administration-guide/configure/install-boards) - Install and configure the Boards plugin.
- [Set up auto-translation](/administration-guide/manage/admin/autotranslation) - Enable and configure automatic message translation.
- [Set up content flagging](/administration-guide/manage/admin/content-flagging) - Let users flag messages for review, and handle data spillage.
- [Connected workspaces](/administration-guide/onboard/connected-workspaces) - Connect your workspace to another Mattermost deployment.
Loading
Loading