mirror of
https://github.com/hanzoai/team.git
synced 2026-09-30 01:57:35 +00:00
5fe06ac4d0
Ports content drift from the legacy Sphinx docs repo (mattermost/docs) since the P13 migration fork point into the corresponding Administration Guide > Manage MDX pages: - ABAC v11.7/v11.8: public channel membership policies (advisory vs. hard-gate behavior), channel-level permission policies, policy simulation, and team-scoped membership policies in Team Settings (abac-channel-access-rules, abac-system-wide-policies, attribute-based-access-control) - User Attributes: separate Display Name/Attribute name fields, backfill note, terminology updates - Content flagging: quarantined message report generation and post deletion report documentation - Autotranslation: translation target language and language-pair clarifications - Generating support packet: sanitize typo fixes, removed stale ElasticsearchSettings.ClientKey reference - Installing license key: Site Statistics -> System Statistics rename - Team/channel members: SetChannelMembers bulk API note - Telemetry: removed Rudder/Segment-specific reporting details following the telemetry stack migration - Statistics: Site Statistics -> System Statistics rename - Health check probes: corrected Go import path example - mmctl: documented --workers flag for import process, renamed Custom Profile Attribute -> User Attribute in cpa command docs - Logging: removed unused audit log file rotation settings from the Cloud defaults note Co-authored-by: Hanzo Dev <[email protected]>
69 lines
4.1 KiB
Plaintext
69 lines
4.1 KiB
Plaintext
---
|
|
title: "Install a license key"
|
|
---
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<PlanAvailability slug="all-commercial" />
|
|
|
|
You can use the System Console or the mmctl tools to add or change a Mattermost license key.
|
|
|
|
<Tabs>
|
|
<TabItem value="use-system-console" label="Use System Console">
|
|
|
|
1. Go to **System Console \> About \> Edition and License**.
|
|
2. Upload your license key file.
|
|
|
|
Once the key is uploaded and installed, the details of your license are displayed.
|
|
|
|
</TabItem>
|
|
<TabItem value="use-mmctl" label="Use mmctl">
|
|
|
|
Use the [mmctl license upload](/administration-guide/manage/mmctl-command-line-tool#mmctl-license-upload) command to upload a new license or replace an existing license file with a new one. When complete, restart the Mattermost server. If you're running in a [High Availability](/administration-guide/scale/high-availability-cluster-based-deployment) environment, the new license file must be updated to every node.
|
|
|
|
``` sh
|
|
mmctl license upload [license] [flags]
|
|
```
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
|
|
<Note>
|
|
|
|
- From Mattermost v10.11, the option to add a license is disabled when the license is set using an [environment variable](/administration-guide/configure/environment-configuration-settings#license-file-location).
|
|
- Enterprise customers with the Premier Support add-on can request a staging license for testing.
|
|
- Removing a Mattermost Enterprise or Professional license key won't remove the configuration for Enterprise settings; however, these features won't function until an Enterprise or Professional license key is applied.
|
|
- When you're using [High Availability](/administration-guide/scale/high-availability-cluster-based-deployment), it's critical to ensure that all servers in the cluster have same Enterprise license properly installed to prevent multi-node clusters from failing. An Enterprise license is required for High Availability to work.
|
|
- When you apply an Enterprise license key to a server previously licensed for Professional, Professional features retain their configuration settings in Enterprise.
|
|
- When you apply a Professional license to a server previously licensed for Enterprise, Enterprise features retain their configuration but will no longer be accessible for use.
|
|
|
|
</Note>
|
|
|
|
## Change an existing license key
|
|
|
|
You don't need to wait for your current license key to expire before replacing it with a new license from Mattermost. The server only checks for seat count and license end date, not the start date, so you can apply a new license as soon as you receive it. However, ensure your new license is for a seat count that's greater than or equal to your current total number of Mattermost users.
|
|
|
|
<Tip>
|
|
|
|
To review license usage before uploading a new key, go to **System Console \> Reporting \> System Statistics**. The **Total Activated Users** field shows the primary paid seat count used for license validation. Review **Single-channel Guests** separately because guests in exactly one channel are tracked outside the primary paid seat count, are free up to a 1:1 ratio with licensed seats, and generate warnings instead of hard enforcement when that allowance is exceeded.
|
|
|
|
</Tip>
|
|
|
|
Follow these steps to change your license key:
|
|
|
|
1. Go to **System Console \> About \> Edition and License**.
|
|
2. From Mattermost v6.7, simply upload your new license key file.
|
|
|
|
<Note>
|
|
|
|
If you're running a Mattermost release older than v6.7, select **Remove Enterprise License and Downgrade Server** to clear the license from the server and refresh the System Console first before uploading the new key.
|
|
|
|
</Note>
|
|
|
|
## License key storage
|
|
|
|
Once you've uploaded your license key to your Mattermost server, it's stored in your SQL database at `mattermost.Licenses`. You can check what keys are on your server by running `select * from mattermost.Licenses;`.
|
|
|
|
[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.
|