Files
upstream-mattermost/docs/main/administration-guide/upgrade/admin-onboarding-tasks.mdx
upstream-mirror 240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)
2026-09-16 00:29:55 +05:00

145 lines
13 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: "Administrator onboarding tasks"
---
<PlanAvailability slug="all-commercial" />
This document provides instructions for common administrator tasks, including some recommendations on tasks to prepare your Mattermost deployment to onboard users.
## Getting started tasks
1. Once you've installed and deployed Mattermost, ensure all configuration settings are appropriately set under **System Console \> Environment** including:
> - Web server
> - Database
> - File storage
> - SMTP
> - Push Notification server
These settings can also be set in the `config.json` file. Please see our [configuration settings documentation](/administration-guide/configure/configuration-settings) for a full listing of all configuration settings.
2. Adjust settings under **System Console \> Site Configuration** to brand and customize how users will interact with the site. Be sure to update the Support Email and Help Link in Mattermost under **System Console \> Site Configuration \> Customization** to provide your users a resource for password resets or questions on their Mattermost account.
> - The Support email is used on email notifications and during tutorial for users to ask support questions.
> - The Help Link is on the Mattermost login page, sign-up pages, and Main Menu and can be used to to link to your help desk ticketing system.
These settings can also be set in the `config.json` file. Please see our [configuration settings documentation](/administration-guide/configure/configuration-settings) for a full listing of all configuration settings.
3. Begin to onboard users by enabling account creation or by connecting an authentication service to assist with user provisioning.
- Users can be pre-provisioned with migration and bulk import processes based on prior collaboration systems. Please see our [migration guide](/administration-guide/onboard/migrating-to-mattermost#migration-guide) and [bulk import documentation](/administration-guide/onboard/bulk-loading-data) for additional details.
- [AD/LDAP authentication](/administration-guide/onboard/ad-ldap) and [SAML authentication](/administration-guide/onboard/sso-saml) are available for some subscription plans, providing identity management, single sign-on, and automatic account provisioning.
If your organization requires more structure and project management artifacts for the implementation of Mattermost, please see our [Enterprise roll out checklist](/administration-guide/upgrade/enterprise-roll-out-checklist).
## 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 [mmctl user delete](/administration-guide/manage/mmctl-command-line-tool#mmctl-user-delete) command or the [mmctl user deleteall](/administration-guide/manage/mmctl-command-line-tool#mmctl-user-deleteall) command.
## Common tasks
**Creating System admin account from the command line**
- If the System admin leaves the organization or is otherwise unavailable, you can use the [mmctl roles](/administration-guide/manage/mmctl-command-line-tool#mmctl-roles) commands to assign the *system_admin* role to an existing user.
- The user needs to log out and log back in before the *system_admin* role is applied.
**Migrating to AD/LDAP or SAML from email-based authentication**
- If you have a Mattermost Enterprise or Professional plan, you can migrate from email authentication to Active Directory/LDAP or to SAML Single Sign-on. To set up Active Directory/LDAP, see [Active Directory/LDAP Setup](/administration-guide/onboard/ad-ldap). To set up SAML Single Sign-on, see [SAML Single-Sign-On](/administration-guide/onboard/sso-saml).
- After the new authentication method is enabled, existing users cannot use the new method until they go to **Settings \> Security \> Sign-in method** and select **Switch to using AD/LDAP** or **Switch to using SAML Single Sign-on**. After they have switched, they can no longer use their email and password to log in.
**Deactivating a user**
- System admins can go to **System Console \> Users** for a list of all users on the server. The list can be searched and filtered to make finding the user easier. Click the user's role and in the menu that opens, click **Deactivate**.
- To preserve audit history, users are typically never deleted from the system. If permanently deleting a user is necessary (e.g. for the purposes of [GDPR](https://gdpr-info.eu/)), an [mmctl command](/administration-guide/manage/mmctl-command-line-tool) can be used to do so.
- Note that AD/LDAP user accounts cannot be deactivated from Mattermost; they must be deactivated from your Active Directory.
**Checking for a valid license in Enterprise Edition without logging in**
- Open the log file `mattermost.log`. It's usually in the `mattermost/logs/` directory but might be elsewhere on your system. Find the last occurrence of a log entry that starts with the text `[INFO] License key`. If the license key is valid, the complete line should be similar to the following example:
``` text
[2017/05/19 16:51:40 UTC] [INFO] License key valid unlocking enterprise features.
```
## User experience optimizations
We highly recommend the following best practices, configuration options, and features for an optimal Mattermost user experience.
**1. Upgrade your Mattermost server**
When you upgrade your Mattermost server frequently, your users can access new features, improved user experiences, bug fixes, security fixes, and mobile app compatibility.
Mattermost releases regular updates to [Mattermost Team Edition](https://mattermost.com/) and [Mattermost Enterprise Edition](https://mattermost.com/pricing/). See the [release life cycle](/product-overview/releases-lifecycle) documentation for component life cycle details details.
Upgrading your Mattermost server only takes a few minutes. See the [Upgrade Guide](/administration-guide/upgrade/upgrading-mattermost-server) for step-by-step instructions.
**2. Install plugins**
You can enable plugins and integrations to connect your team's workflows and toolsets into Mattermost. Plugins and integrations customize and extend the Mattermost platform.
**Install and manage plugins**
To enable and manage plugins, go to **System Console \> Plugins**. Next, install plugins from **Product menu \> Marketplace**. See the [Marketplace](https://developers.mattermost.com/integrate/admin-guide/admin-plugins-beta/#marketplace) documentation for details.
Consider installing, configuring, and enabling the following community integrations for your users:
- Create polls with [Matterpoll](https://mattermost.com/marketplace/matterpoll/).
- Share GIFs with [GIF Commands](https://mattermost.com/marketplace/giphy-plugin/).
- Create and share memes with [Memes](https://mattermost.com/marketplace/memes-plugin/).
- Set personal reminders with [Remind](https://mattermost.com/marketplace/remind-plugin/).
- Create and share to do items with [Todo](https://github.com/mattermost/mattermost-plugin-todo).
- Customize welcome messages for new users with [WelcomeBot](https://mattermost.com/marketplace/welcomebot-plugin/).
Explore all plugins and integrations available in the [Mattermost Marketplace](https://mattermost.com/marketplace/).
**Enable and manage integrations**
To enable integrations such as webhooks, slash commands, OAuth2.0, and bots, to go **System Console \> Integrations**. More information on these integrations can be found [here](https://developers.mattermost.com/integrate/other-integrations/).
**3. Enable automatically extended sessions**
Keep your desktop and mobile users logged in and [extend user sessions automatically](https://mattermost.com/blog/session-expiry-experience/) by setting **System Console \> Sessions \> Extend session length with activity** to **true**. See the [Extend session length with activity](/administration-guide/configure/environment-configuration-settings#extend-session-length-with-activity) configuration settings documentation for details.
**4. Enable full content push notifications**
Enable push notifications on mobile devices to deliver messages in real time by setting **System Console \> Push Notification Server \> Enable Push Notifications** to **Use TPNS**. See the [Push notification server](/administration-guide/configure/environment-configuration-settings#push-notification-server) configuration settings documentation for details.
Enable full content push notifications, including the sender’s name, the channel name, and the message text, by setting **System Console \> Notifications \> Push Notification Contents** to **Full message contents**. See the [Push notification contents](/administration-guide/configure/site-configuration-settings#push-notification-contents) configuration settings documentation for details.
<Note>
- Mattermost subscription plans allow you to enable HPNS that includes production-level uptime SLAs.
- Mattermost Enterprise customers can [enable ID-Only push notifications](/administration-guide/configure/site-configuration-settings#push-notification-contents) so push notification content is not passed through Apple Push Notification Service (APNS) or Google Firebase Cloud Messaging (FCM) before reaching the device. The ID-only push notification setting [offers a high level of privacy](https://mattermost.com/blog/id-only-push-notifications/) while allowing team members to benefit from mobile push notifications.
</Note>
**5. Enable custom emoji**
[Emojis](/end-user-guide/collaborate/react-with-emojis-gifs) enable users to express concepts such as emotions and physical gestures in messages. Enable the emoji picker by setting **System Console \> Emoji \> Enable Emoji Picker** to **true**. See the [Enable emoji picker](/administration-guide/configure/site-configuration-settings#enable-emoji-picker) configuration settings documentation for details.
Empower users to create and share their own custom emojis by setting **System Console \> Emoji \> Enable Custom Emoji** to **true**. See the [Enable custom emoji](/administration-guide/configure/site-configuration-settings#enable-custom-emoji) configuration settings documentation for details.
**6. Enable GIF picker**
GIFs are animated images that can make messaging more fun and engaging. Enable users to access the Mattermost GIF picker from the message draft area by setting **System Console \> GIF (Beta) \> Enable GIF Picker** to **true**. See the [Enable GIF picker](/administration-guide/configure/integrations-configuration-settings#enable-gif-picker) configuration settings documentation for details.
**7. Enable link previews**
Link previews provide a visual glimpse of relevant content for links shared in messages. Enable link previews by setting **System Console \> Posts \> Enable Link Previews** to **true**. See the [Enable link previews](/administration-guide/configure/site-configuration-settings#enable-website-link-previews) configuration settings documentation for details.
**8. Enable batched email notifications**
Email notifications can be batched together so users don’t get overwhelmed with too many emails.
Enable email notifications first by setting **System Console \> Notifications \> Enable Email Notifications** to **true**. See the [Enable email notifications](/administration-guide/configure/site-configuration-settings#enable-email-notifications) configuration settings documentation for details. Note that email notifications require an [SMTP email server](/administration-guide/configure/environment-configuration-settings#smtp-server) to be configured.
Then, enable batched email notifications by setting **System Console \> Notifications \> Enable Email Batching** to **true**. See the [Enable email batching](/administration-guide/configure/site-configuration-settings#enable-email-batching) configuration settings documentation for details. Note that email batching is not available if you are running your deployment in [High Availability](/deployment-guide/server/high-availability-cluster-based-deployment).
**9. Enable Elasticsearch**
Mattermost Enterprise customers can enable [enterprise search](/deployment-guide/scale/enterprise-search) for optimized search performance at enterprise-scale. Both Elasticsearch and AWS OpenSearch solve many known issues with full-text message search in the database, such as dots, dashes, and email addresses returning unexpected results. Before enabling, review the [enterprise search limitations](/deployment-guide/scale/common-configure-mattermost-for-enterprise-search#enterprise-search-limitations), as some user search behavior differs from database search.
Enable Elasticsearch by setting **System Console \> Elasticsearch \> Enable Indexing** to **true**. See the [Elasticsearch](/administration-guide/configure/environment-configuration-settings#enterprise-search) configuration settings documentation for details. Enabling Elasticsearch requires [setting up an Elasticsearch server](/deployment-guide/scale/elasticsearch-setup#set-up-elasticsearch).