snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)
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

This commit is contained in:
upstream-mirror
2026-09-16 00:29:55 +05:00
commit 240db4e2a7
15309 changed files with 2173406 additions and 0 deletions

View File

@@ -0,0 +1,301 @@
---
title: "Access your workspace"
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
Access your Mattermost instance with your credentials using a web browser, the desktop app, or the mobile app for iOS or Android. Depending on how Mattermost is configured, you'll log in using your email address, username, or single sign-on (SSO) username, and your password. See the [Client availability](/end-user-guide/access/client-availability) documentation to learn which features are available on different Mattermost clients.
<Tip>
Can't find your Mattermost link? Ask your company's IT department or your Mattermost system admin for your organization's **Mattermost Site URL**. It'll look something like `https://example.com/company/mattermost`, `mattermost.yourcompanydomain.com`, or `chat.yourcompanydomain.com`. These URLs could also end in `.net`.
</Tip>
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
## Web browser
1. Open a supported [web browser](/deployment-guide/software-hardware-requirements#pc-web).
2. Copy and paste the Mattermost server link into the browser's address field.
3. Enter your user credentials to log into Mattermost.
4. Bookmark the Mattermost URL in your web browser of choice so logging into Mattermost is easy in the future.
## Desktop app
1. Download and install the Mattermost desktop app from the App Store (macOS), Microsoft Store (Windows), or by [using a package manager (Linux)](/deployment-guide/desktop/linux-desktop-install).
2. When prompted, enter the Mattermost server link and a display name for the Mattermost instance. The display name is helpful in cases where you connect to multiple Mattermost instances. See the [server connections](/end-user-guide/preferences/connect-multiple-workspaces) documentation for details.
3. Enter your user credentials to log into Mattermost.
4. If the server requires an authentication secret, you'll be prompted to enter it when you connect. Enter the secret provided by your system admin and select **OK**. See the [troubleshooting](#troubleshooting-authentication-secrets) section below for help if you're having issues.
5. The team that displays first in the team sidebar opens. If you're not a member of a team yet, you're prompted to select a team to join.
<Note>
When you log into Mattermost using external user credentials, such as Google or Entra ID, you'll temporarily leave the desktop app during login while authenticating your credentials. Once you're successfully logged in to Mattermost, you'll be returned to the desktop app. See the [Single Sign-On (SSO)](#single-sign-on-sso) section below for details on the external providers that Mattermosts supports.
</Note>
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Download and install the Mattermost mobile app from the [Apple App Store (iOS)](https://www.apple.com/app-store/) or [Google Play Store (Android)](https://play.google.com/store/games?hl=en).
2. When prompted, enter the Mattermost server link and a display name for the Mattermost instance. Server URLs must begin with either `http://` or `https://`. The display name is helpful in cases where you connect to multiple Mattermost instances. See the [server connections](/end-user-guide/preferences/connect-multiple-workspaces) documentation for details.
3. Enter your user credentials to log into Mattermost.
4. Optionally toggle the **Advanced Options** section to enter an **Authentication secret**. This is an additional security measure that some organizations use. Your system admin can provide you with the secret if required. See the [troubleshooting](#troubleshooting-authentication-secrets) section below for help if you're having issues.
5. The team that displays first in the team sidebar opens. If you're not a member of a team yet, you're prompted to select a team to join.
</TabItem>
<TabItem value="mobile-via-microsoft-intune" label="Mobile via Microsoft Intune">
When your organization uses Microsoft Intune App Protection to secure Mattermost on iOS mobile devices, you must enroll to access Mattermost on mobile. Enrollment adds extra protection to work data while keeping your personal device and apps private.
## What to Expect
Each time you sign in, Mattermost checks the Intune App Protection Policy applied to your account and automatically enroll your account before you can access your workspace. After enrollment, your Mattermost experience generally stays the same, but some restrictions may be enforced.
Intune protections apply **per Mattermost workspace** (the Mattermost server you sign in to). If you have access to multiple Mattermost workspaces, each workspace may have different protections and requirements in place. This guide explains what to expect when the workspace you are connecting to is protected by Intune.
<Note>
- Intune protections are based on your **user account**, not your Mattermost role or permissions.
- Intune policies are controlled by your organization, not by Mattermost.
- Intune enrollment applies only when you sign in using your organization’s **Microsoft/Entra ID** sign-in method (for example, **Sign in with Microsoft**). If you sign in using a different method (such as email/password or another SSO provider), Intune App Protection may not be applied for that workspace.
- If you’re unsure which sign-in option to use, contact your IT support team.
</Note>
## Sign In to Enroll
To sign in and enroll your iOS device:
1. Open the Mattermost mobile app on your iOS device.
2. Sign in with Microsoft (your organization’s sign-in option).
3. Enter your credentials.
4. When enrollment completes, you are notified.
5. If your organization’s Intune App Protection Policy requires it, you’ll be prompted to set a PIN to protect your work data. Once the PIN is confirmed, the Mattermost Mobile App unlocks access to your workspace.
Enrollment happens automatically during sign-in. If you cancel the sign-in flow before it completes, return to the sign-in flow and finish signing in to continue using Mattermost on that device.
## Mid-Session Enrollment
If enrollment is triggered while you're already signed in, you may be prompted to confirm your Microsoft sign-in again. This is expected and typically takes only a few seconds.
If you tap **Cancel**, you won’t be able to continue using Mattermost on that device until enrollment succeeds. You can retry immediately, or [log out](#what-happens-when-i-log-out-manually) and retry later.
## What Changes After Enrollment?
Your organization’s Intune App Protection Policy may restrict how you copy, capture, save, and share data from Mattermost. The exact behavior depends on the specific policy settings your organization has configured.
### Screenshot and Screen Recording Restrictions
Depending on your organization’s policy, you may not be able to take screenshots or record your screen while using Mattermost. If screenshot or screen recording is blocked, your device may still show the screenshot or recording UI, but the content may not be captured.
### File Save Restrictions
Depending on policy, you may not be able to save files from Mattermost to personal or unmanaged locations. Files may be limited to locations approved by your organization.
### Browser and Sharing Restrictions
Depending on policy, links may open only in an approved browser and sharing may be restricted to managed apps. If you try to open a link in an unapproved browser or share content to an unmanaged app, the action may be blocked.
## Frequently Asked Questions
### What Happens If I Leave the Organization or Lose My Device?
If you leave the organization, or your device is lost or compromised, your IT support team can wipe Mattermost work data from your iOS device. This is called a **selective wipe**.
A selective wipe means that:
- Only Mattermost work data is removed from your device.
- Personal apps, photos, and files are untouched.
- You are logged out of the affected Mattermost workspace.
- Other Mattermost workspaces on your device remain unaffected.
### Why Can’t I Access Mattermost After Enrollment?
Mattermost may restrict access after enrollment if Intune detects a risk, such as:
- Your device operating system is out of date
- The device is too old to meet security requirements
- A jailbroken device is detected
- Malware is detected
- Re-authentication is required
If this occurs, Intune blocks access and displays an error message in the Mattermost mobile app explaining what action is required. Contact your IT support team for help.
### What Happens When I Log Out Manually?
When you log out of Mattermost:
- All workspace data is securely removed from the device.
- Intune protection for that workspace is removed.
You can sign back in with Microsoft if you need access again.
</TabItem>
</Tabs>
## Reset your password
If you've forgotten your password, you can reset it on the login screen by selecting **Forgot your password?**, or by contacting your system admin for assistance.
## Magic link login for guests
<PlanAvailability slug="entry-ent" />
From Mattermost v11.3, guests can log in to Mattermost without a password using a secure link sent to their email address when [enabled by the system admin](/administration-guide/onboard/guest-accounts#configure-magic-links-for-guests). The magic link login provides a streamlined passwordless authentication option for guest users.
If you've been invited as a guest to a Mattermost workspace, enter your email address on the login screen. You'll receive an email with a link to log in without a password. The link expires in 48 hours for security purposes. To log in again at a later time, enter your email address on login to receive a new login link by email that expires in 5 minutes.
<Important>
- Magic link security depends on your email account security.
- Never share your magic link with anyone else, as doing so would give that person full access to your account.
</Important>
## Email address or username
When [account creation with email](/administration-guide/configure/authentication-configuration-settings#enable-account-creation-with-email) is enabled by your system admin, you can log in with the username or email address used to create a Mattermost account.
![Log in to Mattermost with your username or email address, or reset your password.](/images/login-email-username.png)
## Single Sign-On (SSO)
When enabled by your system admin, you may log in using your GitLab, Google, Entra ID, AD/LDAP, or SAML credentials.
<Tabs>
<TabItem value="gitlab" label="GitLab">
When enabled by your system admin, you can log in with your GitLab account using a one-click login option.
![Log in to Mattermost using your GitLab credentials.](/images/login-gitlab.png)
</TabItem>
<TabItem value="google" label="Google">
When enabled by your system admin, you can log in with your Google account using a one-click login option.
![Log in to Mattermost using your Google Apps credentials.](/images/login-google.png)
</TabItem>
<TabItem value="entra-id" label="Entra ID">
When enabled by your system admin, you can log in with your Entra ID account using a one-click login option.
![Log in to Mattermost with your Entra ID credentials.](/images/sign-in-entraid.png)
</TabItem>
<TabItem value="ad-ldap" label="AD/LDAP">
When enabled by your system admin, you can log in with your AD/LDAP credentials. This lets you use the same username and password for Mattermost that you use for various other company services.
![Log in to Mattermost with your AD/LDAP credentials.](/images/login-ad.png)
</TabItem>
<TabItem value="saml" label="SAML">
When enabled by your system admin, you can log in with your SAML credentials. This lets you use the same username and password for Mattermost that you use for various other company services.
Mattermost officially supports [Okta](/administration-guide/onboard/sso-saml-okta), [OneLogin](/administration-guide/onboard/sso-saml-onelogin), and Microsoft ADFS as an identity provider (IDP) for SAML, but you may use other SAML IDPs as well. See our [SAML Single Sign-On documentation](/administration-guide/onboard/sso-saml) to learn more about configuring SAML for Mattermost.
![Log in to Mattermost with SAML credentials, such as OneLogin.](/images/login-onelogin.png)
</TabItem>
</Tabs>
## Multi-factor authentication
If your system admin [enables multi-factor authentication](/administration-guide/onboard/multi-factor-authentication#enabling-mfa) for your Mattermost instance, you can [optionally set up multi-factor authentication](/end-user-guide/preferences/manage-your-security-preferences) for your Mattermost user account by selecting your profile picture located in the top-right corner of Mattermost, and going to **Security \> Multi-Factor Authentication**.
If your system admin [enforces multi-factor authentication](/administration-guide/onboard/multi-factor-authentication#enforcing-mfa), you are required to [set up multi-factor authentication](/end-user-guide/preferences/manage-your-security-preferences) for your Mattermost account. When you attempt to log in to Mattermost, you're directed to the multi-factor authentication setup page. You won't be able to access Mattermost until multi-factor setup is complete. If you encounter issues setting up multi-factor authentication, contact your Mattermost system admin for assistance.
## Troubleshooting authentication secrets
If you're having trouble connecting to a Mattermost server that requires an authentication secret, consider the following troubleshooting tips:
- **Authentication secrets are case-sensitive**: Ensure you're entering the secret exactly as provided, including any uppercase letters, numbers, or special characters.
- **Spaces matter**: Don't add extra spaces before or after the secret.
- **Copy/paste issues**: If copying the secret from a document, ensure you're not accidentally copying extra characters. It may be safer to type it manually.
- **Contact your administrator**: If you continue experiencing issues, contact your IT department or Mattermost system administrator. They can verify the secret is configured correctly on the server side.
<Tabs>
<TabItem value="desktop" label="Desktop">
If you're having trouble connecting to a server with an authentication secret:
<table>
<colgroup>
<col style={{width: '40%'}} />
<col style={{width: '60%'}} />
</colgroup>
<thead>
<tr>
<th>Issue</th>
<th>What To Do</th>
</tr>
</thead>
<tbody>
<tr>
<td>Error: <strong>Server authentication required</strong></td>
<td>Your server requires an authentication secret. Enter the secret provided by your system administrator in the modal that appears.</td>
</tr>
<tr>
<td>Error: <strong>The provided authentication secret is incorrect</strong></td>
<td>The secret you entered doesn't match the server's configuration. Verify with your system admin that you have the correct secret (secrets are case-sensitive).</td>
</tr>
<tr>
<td><strong>Connection works but then stops</strong></td>
<td>Your organization may have rotated the authentication secret. Try connecting again. The app will automatically prompt you to enter the new secret.</td>
</tr>
<tr>
<td><strong>Modal doesn't appear</strong></td>
<td>If you're not seeing the authentication prompt, try removing the server and adding it again. This will reset all stored credentials.</td>
</tr>
</tbody>
</table>
</TabItem>
<TabItem value="mobile" label="Mobile">
If you're having trouble connecting to a server with an authentication secret:
<table>
<colgroup>
<col style={{width: '40%'}} />
<col style={{width: '60%'}} />
</colgroup>
<thead>
<tr>
<th>Issue</th>
<th>What To Do</th>
</tr>
</thead>
<tbody>
<tr>
<td>Error: <strong>"Authentication secret is invalid"</strong></td>
<td>Tap on the server entry, tap <strong>Edit</strong>, expand <strong>Advanced Options</strong>, verify the secret is entered correctly, and tap <strong>Save</strong> to retry.</td>
</tr>
<tr>
<td><strong>Forgot to enter secret during setup</strong></td>
<td>Tap on the server entry, tap <strong>Edit</strong>, expand <strong>Advanced Options</strong>, enter the secret in the <strong>Authentication secret</strong> field, and tap <strong>Save</strong>.</td>
</tr>
<tr>
<td><strong>Need to update secret after rotation</strong></td>
<td>Swipe left on the server, tap <strong>Edit</strong>, expand <strong>Advanced Options</strong>, update the <strong>Authentication secret</strong> field with the new value, and tap <strong>Save</strong>.</td>
</tr>
<tr>
<td><strong>Error persists with correct secret</strong></td>
<td>Try removing the server completely and adding it again with the authentication secret entered during initial setup.</td>
</tr>
</tbody>
</table>
</TabItem>
</Tabs>

View File

@@ -0,0 +1,550 @@
---
title: "Client availability"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
The following tables highlight the end user features of Mattermost and their support across Web, Desktop, and Mobile applications (iOS and Android).
## Messages
<table>
<colgroup>
<col style={{width: '40%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
</colgroup>
<thead>
<tr>
<th>Feature</th>
<th>Web</th>
<th>Desktop</th>
<th>Mobile</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/end-user-guide/collaborate/organize-conversations">Threaded discussions</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/format-messages#use-markdown">Format messages with Markdown</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td>Partial Support</td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/react-with-emojis-gifs">Emojis</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/react-with-emojis-gifs#quick-emoji-reactions">Emoji reactions</a></td>
<td></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/share-files-in-messages">File sharing</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/mention-people">@mentions</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/search-for-messages#hashtags">Search hashtags</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/search-for-messages#search-modifiers">Search modifiers</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td>Search highlighting</td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/save-pin-messages">Pin and save messages</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/share-files-in-messages#preview-file-attachments">Preview image links</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/administration-guide/configure/site-configuration-settings#enable-website-link-previews">Preview websites</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/preferences/manage-your-notifications">Notifications</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/manage-channel-bookmarks">Bookmark channels</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
</tbody>
</table>
## Channels
<table>
<colgroup>
<col style={{width: '40%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
</colgroup>
<thead>
<tr>
<th>Feature</th>
<th>Web</th>
<th>Desktop</th>
<th>Mobile</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/end-user-guide/collaborate/create-channels">Create a new channel</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/join-leave-channels#join-a-channel">Join a channel</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/join-leave-channels#leave-a-channel">Leave a channel</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/favorite-channels">Favorite a channel</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/preferences/manage-your-channel-specific-notifications#mute-channels">Mute a channel</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/manage-channel-members">Manage members</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/manage-channel-members#add-members-to-a-channel">Add members</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/rename-channels">Rename channels</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/administration-guide/configure/user-management-configuration-settings#deactivate-users">Deactivate members</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td></td>
</tr>
</tbody>
</table>
## Teams
<table>
<colgroup>
<col style={{width: '40%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
</colgroup>
<thead>
<tr>
<th>Feature</th>
<th>Web</th>
<th>Desktop</th>
<th>Mobile</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/end-user-guide/preferences/manage-your-notifications">Multi-team support for notifications</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/organize-using-teams">Team switching</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/preferences/customize-your-theme">Team-based theming</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/team-settings">Team settings</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/organize-using-teams#join-a-team">Join existing team</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/organize-using-teams#create-a-team">Create a new team</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/invite-people">Share an invite link</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/invite-people">Invite people</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/administration-guide/manage/team-channel-members#teams">Manage team members</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/organize-using-teams#leave-a-team">Leave team</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
</tbody>
</table>
## Collaborative playbooks
<table>
<colgroup>
<col style={{width: '40%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
</colgroup>
<thead>
<tr>
<th>Feature</th>
<th>Web</th>
<th>Desktop</th>
<th>Mobile</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/end-user-guide/workflow-automation/work-with-playbooks">Collaborative playbooks</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td></td>
</tr>
</tbody>
</table>
## Calls
<table>
<colgroup>
<col style={{width: '40%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
</colgroup>
<thead>
<tr>
<th>Feature</th>
<th>Web</th>
<th>Desktop</th>
<th>Mobile</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/end-user-guide/collaborate/make-calls#join-a-call">Join call</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/make-calls#share-your-screen">Share screen</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/make-calls#chat-in-a-call">Chat in thread</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/make-calls#react-using-emojis">React with emoji</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/collaborate/make-calls#record-a-call">Record a call</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
</tbody>
</table>
## Integrations
<table>
<colgroup>
<col style={{width: '40%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
</colgroup>
<thead>
<tr>
<th>Feature</th>
<th>Web</th>
<th>Desktop</th>
<th>Mobile</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/end-user-guide/workflow-automation/interact-with-playbooks#slash-commands">Slash commands</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td>Partial Support</td>
</tr>
<tr>
<td><a href="/integrations-guide/popular-integrations">Server-side plugins</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="https://developers.mattermost.com/integrate/plugins/interactive-dialogs/">Interactive dialogs</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td></td>
</tr>
<tr>
<td><a href="https://developers.mattermost.com/integrate/apps/authentication/oauth2/">OAuth 2.0</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="https://developers.mattermost.com/integrate/webhooks/incoming/">Incoming webhooks</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="https://developers.mattermost.com/integrate/webhooks/outgoing/">Outgoing webhooks</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="https://developers.mattermost.com/integrate/reference/mm-blocks/">Mattermost Blocks</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Included" width="16" height="16" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Included" width="16" height="16" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Included" width="16" height="16" /></td>
</tr>
<tr>
<td><a href="https://developers.mattermost.com/integrate/reference/message-attachments/">Message attachments</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="https://developers.mattermost.com/integrate/plugins/interactive-messages/#message-buttons">Message buttons</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="https://developers.mattermost.com/integrate/plugins/interactive-messages/#message-menus">Message menus</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="https://developers.mattermost.com/integrate/plugins/components/webapp/actions/">Message actions</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td></td>
</tr>
<tr>
<td><a href="https://developers.mattermost.com/integrate/reference/server/">Right-hand sidebar</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td></td>
</tr>
</tbody>
</table>
## Authentication
<table>
<colgroup>
<col style={{width: '40%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
</colgroup>
<thead>
<tr>
<th>Feature</th>
<th>Web</th>
<th>Desktop</th>
<th>Mobile</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/end-user-guide/access/access-your-workspace#email-address-or-username">Email password login</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/administration-guide/onboard/ad-ldap">AD/LDAP</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/administration-guide/onboard/sso-saml">SAML SSO</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/administration-guide/onboard/sso-gitlab">GitLab SSO</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/administration-guide/onboard/sso-entraid">Entra ID SSO</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/administration-guide/onboard/sso-google">Google SSO</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
</tbody>
</table>
## Other
<table>
<colgroup>
<col style={{width: '40%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
<col style={{width: '20%'}} />
</colgroup>
<thead>
<tr>
<th>Feature</th>
<th>Web</th>
<th>Desktop</th>
<th>Mobile</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/end-user-guide/preferences/manage-your-display-options#language">Localization for 22 languages</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/preferences/customize-your-theme">Custom user interface themes</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/preferences/manage-your-profile">User profile settings</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
<tr>
<td><a href="/end-user-guide/preferences/manage-your-channel-specific-notifications">Channel notification settings</a></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Supported" className="theme-icon" /></td>
</tr>
</tbody>
</table>
### What feature quality levels does Mattermost have?
We strive to release viable features. This means that we put in a significant amount of effort to ensure we solve a use case with a high bar for quality. A feature that's viable and meets our criteria for our production quality levels will be released to production.
However, when working on large and complex features or new products, we may need to test them with a high volume of customers and users. For these scenarios, we'll release them as [Experimental](/administration-guide/manage/feature-labels#experimental) or [Beta](/administration-guide/manage/feature-labels#beta), and implement feature flags and/or A/B testing to validate the effectiveness of features prior to production-level release. Additionally, we [dogfood our features](https://en.wikipedia.org/wiki/Eating_your_own_dog_food) on our community server, and provide many configuration options that ensure customers can opt-in when trying experimental or beta features.
See the [Mattermost feature labels](/administration-guide/manage/feature-labels) documentation for details on the status, maturity, and support level of each feature, and what you can expect at each level.

View File

@@ -0,0 +1,24 @@
---
title: "Install the Mattermost Android mobile app"
---
<PlanAvailability slug="all-commercial" />
Take Mattermost wherever you go by [installing the Mattermost mobile app](https://play.google.com/store/apps/details?id=com.mattermost.rn) on your Android mobile device running Android 7.0 or later.
1. On your device, visit the Play Store.
2. Search for "Mattermost" and select **INSTALL** to download the app.
3. Open Mattermost from your homescreen and enter your team and account information to login:
1. **Enter Server URL:** This is the web address you go to when you want to access Mattermost. See the [access your workspace](/end-user-guide/access/access-your-workspace) documentation for additional details.
2. Enter your credentials as specified by your Mattermost system admin. Select **Log in**.
<Tip>
You can set up multi-factor authentication for Mattermost if your system admin has [enabled your ability to do so](/administration-guide/configure/authentication-configuration-settings#enable-multi-factor-authentication). See the [manage security preferences](/end-user-guide/preferences/manage-your-security-preferences) documentation for details.
</Tip>
## Mattermost on Chromebooks
Mattermost Android mobile app for Android isn't supported on Chromebooks. While some Android applications can run on ChromeOS devices, the Mattermost app isn't optimized for this environment and may not function as expected.
For the best experience on Chromebooks, we recommend accessing Mattermost through the web app using the Chrome browser. Alternatively, ChromeOS users can also choose to install the web app as a Progressive Web App (PWA) directly from the browser for an app-like experience with a desktop icon and windowed view.

View File

@@ -0,0 +1,60 @@
---
title: "Install the Mattermost desktop app"
---
<PlanAvailability slug="all-commercial" />
Download and install the Mattermost desktop app [for macOS from the App Store](https://apps.apple.com/us/app/mattermost-desktop/id1614666244?mt=12), [for Windows from the Microsoft Store](https://apps.microsoft.com/detail/xp8br8mh3lpklt?hl=en-US&gl=US), or by [using a package manager (Linux)](/deployment-guide/desktop/linux-desktop-install).
We strongly recommend installing the desktop app on a local drive. Network shares aren't supported.
1. When prompted, enter the Mattermost server link and a display name for the Mattermost instance. The display name is helpful in cases where you connect to multiple Mattermost instances. See the [server connections](/end-user-guide/preferences/connect-multiple-workspaces) documentation for details.
2. Enter your user credentials to log into Mattermost.
3. The team that displays first in the team sidebar opens. If you're not a member of a team yet, you're prompted to select a team to join.
<Note>
When you log into Mattermost using external user credentials, such as Google or Entra ID, you'll temporarily leave the desktop app during login while authenticating your credentials. Once you're successfully logged in to Mattermost, you'll be returned to the desktop app. See the [Single Sign-On (SSO)](#single-sign-on-sso) section below for details on the external providers that Mattermosts supports.
</Note>
## Upgrade the desktop app
From v6.1.0, Mattermost Desktop uses in-app notifications to alert you when new releases are available. You'll see a notification in the **Downloads** dropdown with platform-specific options:
- **macOS (App Store)**: Select **Open Mac App Store** to update through the App Store.
- **macOS (DMG)**: Select **Download Update** to download the new DMG file from your browser. Open the DMG and drag Mattermost to your Applications folder.
- **Windows (Microsoft Store)**: Select **Use Windows Store** to update through the Microsoft Store.
- **Windows (MSI)**: Select **Download Manually** to download the MSI installer from your browser, then run the installer.
- **Linux**: Select the notification to open the GitHub releases page, download the appropriate package for your system (AppImage, deb, rpm, Flatpak), and install it.
**Manual update check**
You can manually check for updates at any time by:
- Selecting **Help \> Check for Updates** from the menu bar, or
- Going to **Settings \> Updates** and selecting **Check Now**
**Skip a version**
If you don't want to see notifications for a specific version, select **Skip This Version** in the notification. You won't see notifications for that version, but you'll be notified when a newer version is released.
<Note>
In enterprise deployments, your system administrator may disable update notifications via Group Policy. If you're not seeing update notifications, contact your IT department.
</Note>
### Upgrading to v6.1.0 using Windows MSI installer
If you're upgrading from a version earlier than v6.1.0 using the Windows MSI installer, you may need to recreate your taskbar shortcut once after upgrading. This one-time change improves shortcut reliability and prevents shortcuts from breaking during future upgrades.
Prior to v6.1.0, installing over an older Desktop App version could break shortcuts. The v6.1.0 MSI installer uses a more reliable method for shortcut icons that prevents this issue in future upgrades. This only affects Windows MSI installer upgrades. The Windows Store version is not affected, and future upgrades to v6.1.1 and later won't require shortcut recreation.
If your taskbar shortcut shows the wrong icon or fails to launch after upgrading to v6.1.0:
1. Right-click the broken shortcut on your taskbar and select **Unpin from taskbar**.
2. Launch Mattermost Desktop from the Start Menu or desktop shortcut.
3. Right-click the Mattermost icon in the taskbar while it's running.
4. Select **Pin to taskbar**.
Your new shortcut will work correctly for all future updates.

View File

@@ -0,0 +1,23 @@
---
title: "Install the Mattermost iOS mobile app"
---
<PlanAvailability slug="all-commercial" />
Take Mattermost wherever you go by [installing the Mattermost mobile app](https://apps.apple.com/us/app/mattermost/id1257222717) on your iOS mobile device running iOS 12.1 or later.
1. On your device, visit the App Store.
2. Search for "Mattermost" and select **GET** to download the app.
3. Enter your Apple ID Password or use Face or Touch ID to proceed with the installation. You may also be asked to provide an Apple Verification Code received through text/phone call, login notification, or **Settings** on your trusted device.
4. Open the Mattermost app and tap **Sign in** below the **Next** button.
5. On the next screen, tap **Allow** when prompted to approve notifications for the Mattermost app.
6. Now follow the steps below to log in:
1. **Enter Server URL:** This is the web address you go to when you want to access Mattermost.
2. **Display Name:** This is a name for your server so that you can identify it in case you have multiple servers set up in your app. Tap **Connect** to continue.
3. Enter your credentials as specified by your Mattermost system admin in the next screen. Tap **Log in**.
<Tip>
- See the [access your workspace](/end-user-guide/access/access-your-workspace) documentation for additional details.
- You can set up multi-factor authentication for Mattermost if your system admin has [enabled your ability to do so](/administration-guide/configure/authentication-configuration-settings#enable-multi-factor-authentication). See the [manage security preferences](/end-user-guide/preferences/manage-your-security-preferences) documentation for details.
</Tip>

View File

@@ -0,0 +1,46 @@
---
title: "Log out of Mattermost"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
You can log out of Mattermost from your profile picture. Select **Log Out** to log out of all teams on the server.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
![Log out of Mattermost from your profile picture.](/images/profile-log-out.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
<img src={useBaseUrl('/images/profile-log-out-mobile.png')} width="300" alt="Log out of Mattermost from your profile picture." />
</TabItem>
</Tabs>
## Frequently asked questions
### What happens when I log out of Mattermost?
When you log out of Mattermost, all data related to your session is removed except a record in the app database of the server you accessed and general activity state information, such as the onboarding checklist. Your user data stored within the server database is deleted when you log out. If you were to delete the Mattermost desktop and the mobile app, the most recent server URL and state data would also be deleted.
When you log out, the following additional data is also deleted:
- All push notifications from that server.
- The websocket, network, and analytics clients stored locally in memory.
- All cookies for the server URL.
- The image cache for all servers (not just the server you've logged out of).
- All files saved in the cache directory for that server.
- All thumbnails and data saved to the clipboard for all servers (not just the server you've logged out of).
- The `image_cache` cache directory (Android mobile app)
If you have multiple Mattermost accounts on the same server, logging out of one account will not log you out of the other accounts.
### What happens if I log out while my device is enrolled in Intune MAM?
If your device is enrolled in Intune MAM (Mobile Application Management), logging out of Mattermost will remove all workspace data and Intune protection for that workspace from your iOS device. You can sign back in with Microsoft if you need access again. Learn more about [accessing your workspace with Intune MAM](https://docs.mattermost.com/end-user-guide/access/access-your-workspace.html#itab--Mobile-via-Microsoft-Intune-MaM--0_1-Mobile-via-Microsoft-Intune-MaM).

View File

@@ -0,0 +1,19 @@
---
title: "AI Agents"
---
import AgentsUserGuideBody from '../agents/docs/_user_guide_partial.mdx';
<PlanAvailability slug="all-commercial" />
<AgentsUserGuideBody />
<Note>
Mattermost Agents is formerly known as Mattermost Copilot.
</Note>
## Learn more
- [Agents usage tips and best practices](/agents/docs/usage_tips) - Get more out of your interactions with Mattermost Agents.
- [Agents context management](/end-user-guide/collaborate/agents-context-management) - Learn what information Agents sends to the LLM, and how your data stays private.

View File

@@ -0,0 +1,62 @@
---
title: "Agents context management"
---
<PlanAvailability slug="all-commercial" />
Mattermost Agents are designed to handle context efficiently, ensuring that only necessary information is sent to the Large Language Model (LLM) for generating accurate responses. This document outlines how Agents process and include relevant context. The company name, the server name, and the time are always passed to the LLM to ensure accurate and contextually relevant responses.
<Note>
**Ensure data privacy**
We recommend that customers with strict privacy requirements run the LLM locally to prevent sensitive data, including personally identifiable information (PII) and message content, from being shared with an external LLM hosting vendor. This ensures data privacy while enabling Agent functionality.
</Note>
## Direct messages to Agent bots
When you send a direct message to an Agent bot, the context sent to the LLM includes:
- The profile information of the user sending the prompt.
- Chat messages exchanged between the user and the bot.
**Additional context in direct messages**
By default, some tool use is enabled to allow for features such as integrations with JIRA, and additional context may be sent to the LLM, depending on the prompt that includes:
- Jira tickets (public tickets)
- Example: Summarize the Jira ticket: \<LINK TO TICKET\>
- GitHub issues
- Example: Summarize the GitHub issue: \<LINK TO ISSUE\>
- User data
- Example: What is @Bob's position?
## @-Mentions in channels
When you `@mention` Agents in a channel, the context sent to the LLM includes:
**Standalone messages (@-mentions in a channel)**
- The message containing the @-mention, including any attachments.
- The channel name and display name.
- The team name and display name.
- The profile information of the user sending the prompt.
**Threaded messages (@-mentions in a thread)**
- Everything sent when used in a standalone message.
- Messages within the thread, including the usernames of the users involved, as well as any attachments and their filenames.
**Context differences between standalone and threaded messages:**
- For @-mentions in standalone messages, the context includes only the mentioned message.
- For @-mentions in threads, the entire thread's messages are included, along with usernames of the authors of the messages.
## Built-in ways to trigger Agents
In addition to regular chat interactions, Agents provide specialized features where extra context is sent to the LLM. Each feature provides specialized context tailored to the task being performed. Below are the scenarios where extra context is sent to the LLM:
- **Thread summarization**: Includes thread messages and the usernames of the authors
- **Meeting summary**: Incorporates transcriptions from calls
- **Channel summary since last visit**: Uses channel posts along with their authors to create summaries.
- **Finding action items & open questions**: Analyzes thread and channel messages to identify action items or open questions.

View File

@@ -0,0 +1,108 @@
---
title: "Archive and unarchive channels"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
## Archive a channel
Delete [public channels](/end-user-guide/collaborate/channel-types#public-channels) and [private channels](/end-user-guide/collaborate/channel-types#private-channels) when they're no longer needed by archiving them. Archiving channels removes them from the channel sidebar and marks them as read-only. Anyone can archive a public or private channel they're a member of, unless your system admin has [disabled](/administration-guide/onboard/advanced-permissions) your ability to do so.
<Tip>
You can continue to access archived channels, unless your system admin has [disabled](/administration-guide/configure/site-configuration-settings#allow-users-to-view-archived-channels) your ability to do so.
</Tip>
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
To archive a channel, select the channel name at the top of the center pane to access the drop-down menu, then select **Archive Channel**.
</TabItem>
<TabItem value="mobile" label="Mobile">
To archive a channel:
1. Tap the channel you want to delete.
![Select a channel that you want to edit.](/images/mobile-select-a-channel.jpg)
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
![Tap on More options to access available options for the channel.](/images/mobile-select-more-options-for-a-channel.jpg)
3. Tap **View info**.
![Tap on View info to see the basic channel info.](/images/mobile-select-view-info-for-a-channel.jpg)
4. Tap **Archive Channel**.
![Tap on Archive channel to archive the current channel.](/images/mobile-edit-channel.jpg)
5. Tap **Yes** to confirm.
![Tap on Yes to confirm your choice.](/images/mobile-confirm-archive-a-channel.jpg)
</TabItem>
</Tabs>
<Note>
- When a Mattermost user is deactivated in the system, your [direct message channel](/end-user-guide/collaborate/channel-types#direct-message-channels) with that user are archived and marked as read-only. An **Archived** icon <img src={useBaseUrl('/img/ui/archive-outline_F120E.svg')} alt="Archived channels are identified with a File Box icon." className="theme-icon" /> displays next to archived channels. From Mattermost v11.5, archived private channels display a distinct **Archive Lock** icon to differentiate them from other archived channels.
- [Group message channels](/end-user-guide/collaborate/channel-types#group-message-channels) can't be archived, but they can be closed to hide them from the channel sidebar.
- The default **Town Square** channel can't be archived.
- System admins can archive channels without needing to be a channel member by using the System Console.
- Because a copy of the channel exists on the server, you can't reuse the URL of an archived channel when [creating a new channel](/end-user-guide/collaborate/create-channels).
</Note>
## Unarchive a channel
System admins and Team admins can restore archived channels. When a channel is unarchived, channel membership and all its content is restored, unless messages and files have been deleted based on a [data retention policy](/administration-guide/configure/compliance-configuration-settings#data-retention-policies).
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Search for the channel if required. Then, open the channel, select the channel name at the top of the center pane to access the drop-down menu and select **Unarchive Channel**.
![Unarchive a channel.](/images/unarchive-channel.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
To unarchive a channel:
1. Tap the channel you want to unarchive.
![Select a channel that you want to edit.](/images/mobile-select-a-channel.jpg)
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
![Tap on More options to access available options for the channel.](/images/mobile-select-more-options-for-a-channel.jpg)
3. Tap **View info**.
![Tap on View info to see the basic channel info.](/images/mobile-select-view-info-for-a-channel.jpg)
4. Tap **Unarchive Channel**.
![Tap on Unarchive channel to unarchive the current channel.](/images/mobile-unarchive-a-channel.jpg)
5. Tap **Yes** to confirm.
![Tap on Yes to confirm your choice.](/images/mobile-confirm-unarchive-a-channel.jpg)
</TabItem>
</Tabs>
<Tip>
Alternatively, system admins can unarchive channels [via the mmctl](/administration-guide/manage/mmctl-command-line-tool#mmctl-channel-unarchive), and Team admins can unarchive channels [via the API](https://api.mattermost.com/#operation/RestoreChannel).
</Tip>

View File

@@ -0,0 +1,40 @@
---
title: "Audio and screen sharing"
---
<PlanAvailability slug="all-commercial" />
Mattermost Calls offers native real-time chat, self-hosted audio calls, and screen sharing within your own network, enabling secure, effective team communication and collaboration. Learn more about [deploying Mattermost Calls](/deployment-guide/calls/calls-deployment-guide) in a self-hosted environment and [making calls](/end-user-guide/collaborate/make-calls) with Mattermost.
With calls and screen sharing, Mattermost ensures that communications remain uninterrupted, even during maintenance or outages, and scales effortlessly to meet your team’s growing needs, safeguarding the integrity of mission-critical operations.
Functionality includes:
- **1:1 Audio Calls**: Initiate direct, real-time voice communication between two participants for quick resolution and sensitive discussions.
- **Audio Conference Calls**: Host multi-party voice calls to coordinate teams and resolve issues faster across distributed environments.
- **Screen Share**: Share your screen during calls to collaborate visually on tasks, review documents, or troubleshoot live issues.
- **Chat/Messaging During Calls**: Exchange messages alongside audio communication to enhance clarity, drop links, and provide visual context.
- **Search Chat History Post-Call**: Access in-call messages later to retain decision trails, links, and key points discussed.
- **Host Controls**: Manage participants, mute/unmute, and control the flow of conversations during conferences for structured engagements.
- **Call Recording**: Record voice sessions for review, compliance, or sharing with unavailable team members. *(Enterprise, Enterprise Advanced)*
- **Call Transcription**: Convert spoken content into text to support documentation, compliance, and improved accessibility. *(Enterprise, Enterprise Advanced)*
- **Live Captioning**: Provide real-time subtitles for inclusivity, accessibility, and support in noisy or multilingual environments. *(Enterprise, Enterprise Advanced)*
- **AI Call Summarization**: Automatically generate concise summaries of calls to save time and preserve key outcomes. *(Enterprise, Enterprise Advanced)*
- **Advanced Security Controls**: Enforce stricter encryption, access policies, and controls for high-assurance environments. *(Enterprise, Enterprise Advanced)*
- **High Availability**: Maintain service continuity through system failover and backup call paths. *(Enterprise, Enterprise Advanced)*
## Video conferencing integrations
For video conferencing, Mattermost integrates seamlessly with leading self-hosted and cloud providers, giving users the flexibility to easily transition from chat to video:
- [Pexip](https://mattermost.com/marketplace/pexip-video-connect/): An enterprise-grade video conferencing solution with advanced security features, tailored for secure and scalable video collaboration.
- [Zoom](/integrations-guide/zoom): A widely used, cloud-based video conferencing platform known for its ease of use and wide range of collaboration tools, including screen sharing and breakout rooms.
- [Webex](https://mattermost.com/marketplace/webex-cloud/): A comprehensive video conferencing solution designed for enterprise-grade security, offering features like file sharing, virtual backgrounds, and meeting recordings.
- [Microsoft Teams](/integrations-guide/microsoft-teams-sync): A cloud-based collaboration platform that integrates with Microsoft 365, with text, voice, video, and file-sharing features.
<Note>
- Webex is community supported and not maintained by Mattermost. Please see the [GitHub repository](https://github.com/mattermost-community/mattermost-plugin-webex#readme) for the latest releases and documentation.
- Community supported integrations are not available to Cloud deployments of Mattermost.
- Looking for a [Skype for Business replacement](https://mattermost.com/skype-for-business-datasheet/)? Learn why Mattermost is the best solution to upgrade your collaboration strategy.
</Note>

View File

@@ -0,0 +1,48 @@
---
title: "Auto-translate messages"
---
<PlanAvailability slug="ent-adv" />
From Mattermost v11.5, messages in channels with auto-translation enabled are automatically translated into your preferred language. This enables seamless multilingual collaboration — you can read and respond in your own language while teammates do the same in theirs.
## How auto-translation works
Your system admin must first [enable auto-translation](/administration-guide/manage/admin/autotranslation) for your Mattermost instance. Then, a system admin or channel admin can enable it for individual channels. When autotranslation is enabled in a channel:
- The language of each message is automatically detected.
- Messages are translated into your preferred display language and shown in place of the original text.
- Code blocks, URLs, and @mentions are preserved and not translated.
- Translations happen asynchronously — there may be a brief delay before the translated text appears.
- Messages written in your preferred language are not translated.
## View translated messages
Translated messages display in place of the original text. To view the original untranslated message, select the **translation** icon on the message.
## Set your preferred language
Auto-translation translates messages into your Mattermost display language. To change your display language:
1. Select the gear icon to open **Settings**.
2. Select **Display \> Language**.
3. Choose your preferred language.
4. Select **Save**.
See the [language](/end-user-guide/preferences/manage-your-display-options#language) documentation for more details.
## Opt out of auto-translation in a channel
You can opt out of auto-translation on a per-channel basis if you prefer to see original messages in a specific channel. To opt out:
1. Open the channel where you want to disable auto-translation.
2. Select the channel name at the top to open the channel menu.
3. Disable the auto-translation option for this channel.
You'll see original, untranslated messages in that channel going forward. You can re-enable auto-translation at any time using the same steps.
## Limitations
- **Direct and group messages**: Your system admin may have restricted auto-translation in direct and group messages. If auto-translation isn't available in a direct or group message, contact your system admin.
- **Short or mixed-language messages**: Very short messages or messages that mix multiple languages may not be reliably detected and translated.
- **Code-only messages**: Messages that contain only code blocks are not translated, as code is preserved in its original form.
- **Translation accuracy**: Translation quality depends on the translation provider configured by your system admin. Some languages or specialized terminology may produce less accurate results.

View File

@@ -0,0 +1,68 @@
---
title: "Browse channels"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Select the **Plus** <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> icon at the top of the channel sidebar to see all available public channels you can join that you're not already a member of.
2. Select **Browse Channels**.
3. Search for channels by name or scroll through the list.
4. Select **Join** next to any channel to become a member of that channel.
<Tip>
From Mattermost v9.1, you can filter the list of channels by public, private, or archived channels, and you can hide all channels you're already a member of.
</Tip>
<Note>
From Mattermost v11.8.0, if your organization uses membership policies, **Browse Channels** may include a **Recommended** filter. Recommended channels are public channels your attributes match. You can still browse and join public channels according to your organization's normal channel permissions.
</Note>
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap the **Plus** <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> icon located in the top right corner of the app.
![Tap the plus icon to view additional options.](/images/mobile-select-a-channel.jpg)
2. Tap **Browse Channels**.
![Click on Browse Channels to view the list of public channels.](/images/create-channel-or-open-direct-message-on-mobile.jpg)
3. Search for channels by name or filter the list of channels to show only public, archived or shared channels.
![Type the name of a channel in search to find it from the list.](/images/mobile-browse-public-channels-using-search.jpg)
![Tap on Show to select from available filters such as Public channels, Archived channels, etc.](/images/mobile-browse-public-channels-using-filters.jpg)
4. Tap a channel to become a member of that channel.
![Tap on the public channel name that you want to join.](/images/mobile-browse-public-channels.jpg)
<Tip>
You can filter the list of channels by public, archived, or shared channels.
</Tip>
</TabItem>
</Tabs>
Want to see all of the channels you're already a member of, or can't find a specific private channel? Using a browser or the desktop app, select **Find Channel** in the channel sidebar to see all of the channels you're currently a member of across all of your teams, including public and private channels, direct and group messages, channels with unread messages, and threads. Channels you have muted aren't included in results.
## Revisit recent channels
Using a browser or the desktop app, use the **History** arrows at the top of the sidebar to move back and forth through your channel history.
- Select the left arrow to go back one page.
- Select the right arrow to go forward one page.

View File

@@ -0,0 +1,109 @@
---
title: "Communicate a channel's focus and scope"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
Every channel in Mattermost serves a purpose and exists for a reason. You can communicate a channel's focus and scope in 3 ways:
- a descriptive [channel name](#channel-name)
- a [channel purpose](#channel-purpose) description
- [channel header](#channel-header) details
## Channel name
You're prompted to provide a channel name when [creating a new channel in Mattermost](/end-user-guide/collaborate/create-channels). Channel names must be at least 2 characters, and can be up to 64 characters in length. See the [channel naming conventions](/end-user-guide/collaborate/channel-naming-conventions) documentation for additional details and guidance on why channel naming is important.
<Note>
[Some unicode characters](https://www.w3.org/TR/unicode-xml/#Charlist) aren't supported in channel names.
</Note>
Looking to rename an existing channel? See the [rename channels](/end-user-guide/collaborate/rename-channels) documentation for details.
## Channel purpose
You're prompted to provide an optional channel purpose description when [creating a channel](/end-user-guide/collaborate/create-channels) or [renaming a channel](/end-user-guide/collaborate/rename-channels). A channel purpose can be up to 250 characters in length, and is often used to help users decide whether to join that channel.
A channel's purpose is visible in the right pane when you select the **View Info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon for the channel. Any member of a channel can change a channel's purpose description, unless the system admin has [disabled the ability to do so](/administration-guide/onboard/advanced-permissions).
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
![Channel purpose helps users decide if they want to join the channel based on its scope or focus.](/images/channel-purpose-info.png)
1. Select the channel name at the top of the center pane to access the drop-down menu, then select **Channel Settings**.
2. Enter or update the channel purpose.
3. Select **Save**.
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap the channel you want to edit.
![Select a channel that you want to edit.](/images/mobile-select-a-channel.jpg)
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
![Tap on More options to access available options for the channel.](/images/mobile-select-more-options-for-a-channel.jpg)
3. Tap **View info**.
![Tap on View info to see the basic channel info.](/images/mobile-select-view-info-for-a-channel.jpg)
4. Tap **Edit Channel**.
![Click on Edit channel to update the purpose of the channel.](/images/mobile-edit-channel.jpg)
5. Type the new purpose of the channel and tap on **Save** to update the purpose.
![Click on Edit channel to rename the channel.](/images/mobile-update-channel-purpose.jpg)
</TabItem>
</Tabs>
## Channel header
A channel header is text that displays directly under a channel name at the top of the channel. Any channel member can change a channel header, unless the system admin has [disabled the ability to do so](/administration-guide/onboard/advanced-permissions)
A channel header can be up to 1024 characters in length, include Markdown formatting, and is often used to summarize the channel's focus or to provide links to frequently accessed documents, tools, or websites.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Select the channel name at the top of the center pane to access the drop-down menu, then select **Channel Settings**.
2. Enter or change channel header details. You can use the same [Markdown formatting](/end-user-guide/collaborate/format-messages#use-markdown) in the channel header as you would when composing a message.
![Channel headers can include links to documents, tools, or websites.](/images/channel-header.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap the channel you want to edit.
![Select a channel that you want to edit.](/images/mobile-select-a-channel.jpg)
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
![Tap on More options to access available options for the channel.](/images/mobile-select-more-options-for-a-channel.jpg)
3. Tap **View info**.
![Tap on View info to see the basic channel info.](/images/mobile-select-view-info-for-a-channel.jpg)
4. Tap **Edit Channel**.
![Click on Edit channel to to update the header of the channel.](/images/mobile-edit-channel.jpg)
5. Type the new header of the channel and tap on **Save** to update the header.
![Click on Edit channel to rename the channel.](/images/mobile-update-channel-header.jpg)
</TabItem>
</Tabs>

View File

@@ -0,0 +1,176 @@
---
title: "Channel naming conventions"
---
<PlanAvailability slug="all-commercial" />
All organizations are different and have different communication needs. The importance of organizing your conversations increases as your user base grows. The following are ideas for how you might want to name, group, and structure your channels. If you change your mind about a channel's name, you can [rename it](/end-user-guide/collaborate/rename-channels).
## Basic structure
- Channel names appear in menus where users select which conversations to join.
- Channel names are unique.
- Channel names have a 64-character limit to ensure readability on both desktop and mobile devices.
- An additional 1024 characters are available for describing the channel's focus in the channel header and channel information pane.
- An additional 128 characters are available for a **Channel Purpose** that's visible in the channel header and the channel information pane.
- Channel names can include standard Unicode emojis that are universally supported emojis that look the same (or similar) across platforms. Specify a Unicode emoji by positioning your cursor in the channel **Display Name** field and accessing the Unicode emoji picker for your operating system, as follows:
> - On Windows press <kbd>Windows</kbd> + <kbd>.</kbd> or <kbd>;</kbd> to open the Unicode emoji picker.
> - On macOS, press <kbd>Ctrl</kbd> + <kbd>⌘</kbd> + <kbd>Space</kbd> to open the Unicode emoji picker.
We recommend prefixing channel names with emojis for the following reasons:
> - Emojis can make it easier for users to quickly identify and manage channels, particularly in large workspaces with many channels.
> - Sharing the same emoji across channels related to a specific category or function helps maintain organization and consistency across the workspace.
> - Making channels more visually distinct with emojis helps users find the channels they need more quickly and easily at a glance, reducing the time spent searching for the right channel.
> - New users can quickly understand the purpose of various channels based on their emoji prefixes without needing extensive explanations.
> - As users grasp channel structure through emojis, the time and effort needed to train new members on navigating the workspace is reduced.
> - A well-organized and visually appealing workspace can encourage users to participate more actively, which can lead to more effective communication and collaboration.
## Scope channel names
It's natural to start with broadly defined channels and let them divide into narrower topics as discussions progress.
For example, you might begin with a general "Marketing" channel. As conversations progress, you might divide that channel into: "Marketing: Website", "Marketing: Social Media", "Marketing: General".
<Tip>
Use colons to separate sections of channel names, rather than `-` or `>` which require more spaces to display.
</Tip>
As the organization grows, disciplines might split across business units, products and geographies, with channel names like "US: Marketing" and "UK: Marketing".
<Tip>
If you need to shorten country names, use standard [2-letter country codes](https://www.nationsonline.org/oneworld/country_code_list.htm).
</Tip>
You can combine the hierarchies, with formats like `[SUB-TEAM]: [TOPIC]: [SUB-TOPIC]`. For example: `US: Mrkt: Website` and `UK: Mrkt: Social Media`.
<Tip>
Shorten words, particularly categories, by removing vowels, endings, and redundant letter sounds. Example: Turn "Marketing" into "Mrkt", and "Project" into "Prjt".
</Tip>
Good naming can take a team up to several thousand channels without significant confusion. Eventually every organization hits a limit and an additional team might need to be created on the server to accommodate the large number of channels. Keeping names clear and short lets users navigate large collections of channels quickly.
Here are different navigation options and types of channels to consider.
### Navigate channels using the keyboard
Keyboard shortcuts allow users to jump between channels. See the [keyboard shortcuts](/end-user-guide/collaborate/keyboard-shortcuts) documentation for all available keyboard shortcuts.
### Topic channels
Topics are broad categories for organizing discussions. Topics are similar to how a user might create a folder for organizing emails or documents. Examples: Recruiting, Interviews, Legal Reviews, Documentation.
Users can join and leave topic-based channels, as well as add colleagues to have topic-based discussions.
As teams get larger and the number of channels increase, you may start naming topics in a hierarchy to make them easier to find. Examples: Legal: Trademarks, Legal: Contracts, Legal: Licensing.
### Meeting channels
Meeting channels are often used to organize regular meetings. Members can add topics as messages to be discussed during the regular meeting time. Examples: Monday Sales Update, All Hands Meeting.
There are three built-in features to make meetings easier:
1. Numbered agenda items in title text
You can number and format messages as agenda items to discuss for the next meeting.
<Tip>
Try pasting the following as an example in a channel designated for meetings:
#### 1) Agenda item example
#### Commentary about agenda item to be discussed.
</Tip>
2. Threaded messaging
On an agenda item message, you can select `[...] > Reply` to leave comments about an agenda item before or after a meeting to extended discussion.
3. Header links
When meeting remotely, add persistent links to your video or audio conferencing solution, like Zoom, Google Hangouts, or BlueJeans in the channel header. See our [documentation](/end-user-guide/collaborate/channel-header-purpose) to learn more about working with channel headers.
When it's time to meet, your team can select the conference link to connect.
### Sub-team channels
Sub-teams can include people from the same discipline, project teams, people with the same manager or other groups brought together for a shared purpose. Examples: Developers, Marketers, Offsite Organizing Committee, SusanK's Directs
As sub-teams grow beyond a manageable size for one channel, they can sub-divide. Examples: US: Developers, UK: Developers, SusanK's Directs, SusanK's Extended Directs.
### Project channels
Project channels discuss how groups of people come together to achieve specific outcomes. Examples: Logo Design, Localization, Product Launch.
Projects are often private channels rather than public channels and are used to organize a small team around a project brought up in a larger channel. The Project Channel is used to do detailed work, and updates are typically communicated back to larger channels.
### Location channels
If your teams are in different buildings, cities or regions, you can create Location channels to help people coordinate meetings and get-togethers. Examples: Building 10, Palo Alto, Toronto, Delaware.
This helps share announcements and discussions relevant to only those locations.
### Data channels
Data channels allow automatic integration. Information like new or updated support tickets or bug reports, Twitter updates or mentions of your company name in the news can all be made available in channels your team chooses to monitor. There is a wide array of options. Examples: Bugs, Support Tickets, Twitter, News Mentions.
People might use these channels like a daily newspaper, reading about everything that's happened in the last day, while other configurations allow notifications to alert only when their username or certain key words are mentioned.
## Channel naming examples
Here is an example of what a marketer's channels might look like in a small team:
CHANNELS
- Recruiting
- Interviews
- Marketing
- Sales
- All Hands Meeting
- Town Square
- Off-Topic
PRIVATE CHANNELS
- Website
- Twitter Marketing
- Logo Design
DIRECT MESSAGES
- \[Sales People\]
- \[Marketers\]
- \[Recruiter\]
- \[Manager\]
Here's an example of what a marketer's channels might look like if she was working in the Palo Alto, California office of a large enterprise, working on a product called "Pontoon":
CHANNELS
- Geo: PA: Recruiting
- Geo: PA: Interviews
- US: Mrkt: General
- US: Sales: West Coast
- US: All Hands
- Town Square
- Off-Topic
PRIVATE CHANNELS
- Pontoon: Mkrt: Website
- Pontoon: Mkrt: Twitter
- Pontoon: Mkrt: Logo Design
DIRECT MESSAGES
- \[West Coast Sales People\]
- \[Marketing Peers\]
- \[Recruiter for PA office\]
- \[Manager\]

View File

@@ -0,0 +1,74 @@
---
title: "Channel types"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
Channels are used to organize conversations across different topics. The channels you're a member of display in the left pane. Learn how to create channels by visiting the [create channels](/end-user-guide/collaborate/create-channels) documentation.
There are 5 types of channels in Mattermost:
- [Public channels](#public-channels)
- [Private channels](#private-channels)
- [Direct message channels](#direct-message-channels)
- [Group message channels](#group-message-channels)
- [Archived channels](#archived-channels)
<Tip>
Enterprise customers can additionally configure [read-only](/administration-guide/onboard/advanced-permissions#read-only-channels) broadcast channels.
</Tip>
## Public channels
Public channels are open to everyone on a team and are identified with a **Globe** <img src={useBaseUrl('/img/ui/globe_E805.svg')} alt="Public channels are identified with a Globe icon." className="theme-icon" /> icon. New team members are automatically added to the **Town Square** channel.
See the [Join and leave channels](/end-user-guide/collaborate/join-leave-channels) documentation for details on discovering, joining, and leaving other channels.
## Private channels
Private channels are channels for sensitive topics and are only visible to selected team members. Private channels are identified with a **Lock** <img src={useBaseUrl('/img/ui/lock-outline_F0341.svg')} alt="Private channels are identified with a Lock icon." className="theme-icon" /> icon. Channel members can choose to leave private channels at any time.
<Note>
- Mattermost Enterprise and Professional customers can restrict channel management to system and channel admins.
- In a Mattermost Team Edition instance, any member of a private channel can add or remove other members from private channels.
</Note>
## Direct message channels
Direct message channels are for conversations between 2 people. Only members of the conversation can see direct messages and channel heading information, including the last active status of the other user.
You can start a direct message with people on other teams [unless the system admin has disabled your ability to do so](/administration-guide/configure/site-configuration-settings#enable-users-to-open-direct-message-channels-with).
Direct messages update the numbered badge count and trigger a notification unless the direct message is muted, or your notifications are disabled. See the [notification documentation](/end-user-guide/preferences/manage-your-notifications) for details on customizing notifications based on your preferences.
<Note>
- From Mattermost v10, when sending a direct message, Mattermost warns you that the recipient's availability is set to [Do Not Disturb](/end-user-guide/preferences/set-your-status-availability#set-your-availability), and when the recipient's local time is outside of regular business hours (between 10PM and 6AM). This warning displays directly above the message text field.
- When a Mattermost user is deactivated in the system, your [direct message channel](/end-user-guide/collaborate/channel-types#direct-message-channels) with that user are [archived](#archived-channels) and marked as read-only. An **Archived** icon <img src={useBaseUrl('/img/ui/archive-outline_F120E.svg')} alt="Archived channels are identified with a File Box icon." className="theme-icon" /> displays next to archived channels.
</Note>
## Group message channels
Group message channels are for conversations between 3 to 7 people. Only members of the conversation can see group messages. Group messages always display a new message badge.
Want to have a group conversation with more than 7 people? [Create a private channel](/end-user-guide/collaborate/create-channels). Alternatively, from Mattermost v9.1, you can [convert group messages to a private channel](/end-user-guide/collaborate/convert-group-messages).
<Note>
- You can start a group message with people on other teams when [unless the system admin has disabled your ability to do so](/administration-guide/configure/site-configuration-settings#enable-users-to-open-direct-message-channels-with).
- From Mattermost v9.1, group messages increase the numbered badge count and trigger a notification unless the direct message is muted, or your notifications are disabled. Control how you're notified about group message conversations by going to **Settings \> Notifications**. See the [notification documentation](/end-user-guide/preferences/manage-your-notifications) to learn more.
- Any group message history you have with a deactivated user remains available [unless your system admin disables your ability to do so](/administration-guide/configure/site-configuration-settings#allow-users-to-view-archived-channels).
</Note>
## Archived channels
Archived channels are deactivated public, private, direct message, or group message channels that are no longer used. Archived channels are identified with a **File Box** <img src={useBaseUrl('/img/ui/archive-outline_F120E.svg')} alt="Archived channels are identified with a File Box icon." className="theme-icon" /> icon. From Mattermost v11.5, archived private channels are identified with a distinct **Archive Lock** icon to visually differentiate them from archived public channels.
[Archiving a channel](/end-user-guide/collaborate/archive-unarchive-channels#archive-a-channel) marks it read-only to prevent new messages from being sent and preserve channel history. You can continue to access archived channels, unless your system admin has [disabled](/administration-guide/configure/site-configuration-settings#allow-users-to-view-archived-channels) your ability to do so.

View File

@@ -0,0 +1,19 @@
---
title: "Messaging Collaboration"
sidebar_label: "Collaborate"
---
<PlanAvailability slug="all-commercial" />
Mattermost provides 1:1 and group messaging that features integrated voice/video conferencing, file, image, and link sharing, rich markdown formatting, and a fully searchable message history. With Mattermost, you can keep all of your team's communications in one place and remove information and organizational silos.
This Mattermost end user documentation is designed for anyone who wants guidance on using Mattermost to collaborate.
## Getting Started
- [Invite people to your workspace](/end-user-guide/collaborate/invite-people) - Learn how to add new users to Mattermost and add users to existing teams and channels.
- [Channels](/end-user-guide/collaborate/collaborate-within-channels) - Learn how channels work, and how to create, join, organize, and manage them.
- [Messages and threads](/end-user-guide/collaborate/communicate-with-messages) - Learn how to send, format, and find messages, and how to keep conversations organized in threads.
- [Calls and screen sharing](/end-user-guide/collaborate/audio-and-screensharing) - Learn about Mattermost's self-hosted audio calls with screen sharing, and the video conferencing integrations Mattermost supports.
- [Teams, groups, and roles](/end-user-guide/collaborate/organize-using-teams) - Learn about team-based organization, custom user groups, and what each Mattermost user role can do.
- [Integrations and connected apps](/end-user-guide/collaborate/extend-mattermost-with-integrations) - Find open-source integrations to common tools in the Mattermost Marketplace, and learn how to collaborate from within Microsoft Teams.
- [Keyboard shortcuts and accessibility](/end-user-guide/collaborate/keyboard-shortcuts) - Make more efficient use of your keyboard, and learn how to navigate Mattermost without a mouse.

View File

@@ -0,0 +1,44 @@
---
title: "Collaborate within channels"
---
<PlanAvailability slug="all-commercial" />
Channels are where you connect, collaborate, and communicate with your team about various topics or projects. Use channels to organize conversations across different topics. as you're [sending messages](/end-user-guide/collaborate/send-messages), [replying to messages](/end-user-guide/collaborate/reply-to-messages), and [participating in conversation threads](/end-user-guide/collaborate/organize-conversations#start-or-reply-to-threads).
## You're added to default channels automatically
Everyone who joins a Mattermost [workspace](/end-user-guide/end-user-guide-index) is automatically added to the **Town Square** channel. See our [Channel Types](/end-user-guide/collaborate/channel-types) documentation for details.
<Note>
The Town Square channel can't be [archived](/end-user-guide/collaborate/archive-unarchive-channels#archive-a-channel) or [converted to a private channel](/end-user-guide/collaborate/convert-public-channels), and users can't [leave](/end-user-guide/collaborate/join-leave-channels#leave-a-channel) this default channel. However, [guests](/administration-guide/onboard/guest-accounts) who are manually invited to **Town Square** can leave the channel.
</Note>
## Channel sidebar
In the channel sidebar on the left, you'll find all of the the channels you're a member of as well as useful channel management tools. See the [channel types](/end-user-guide/collaborate/channel-types) to learn about the types of channels available, how they work, and how to identify them in the channel sidebar. Learn how to create channels by visiting the [create channels](/end-user-guide/collaborate/create-channels) documentation.
As your channel sidebar fills up with channels you've joined, you can organize your channels into categories based on how you work. See the [customize your channel sidebar](/end-user-guide/preferences/customize-your-channel-sidebar) documentation for details.
## Learn more
Learn more about collaborating within Mattermost channels:
- [Channel naming conventions](/end-user-guide/collaborate/channel-naming-conventions) - Learn why channel names are important.
- [Communicate a channel's focus and scope](/end-user-guide/collaborate/channel-header-purpose) - Learn how to communicate a channel's scope and focus.
- [Browse channels](/end-user-guide/collaborate/browse-channels) - Browse all available public channels you can join, and all channels you're a member of.
- [Join and leave channels](/end-user-guide/collaborate/join-leave-channels) - Learn how to start or stop being a channel member.
- [Make calls in Mattermost](/end-user-guide/collaborate/make-calls) - Learn how to start, join, and attend calls in Mattermost, as well as screen share.
- [Navigate between channels](/end-user-guide/collaborate/navigate-between-channels) - Learn how to navigate between channels.
- [Create channels](/end-user-guide/collaborate/create-channels) - Create channels to organize discussion by topic, project, or focus.
- [Rename a channel](/end-user-guide/collaborate/rename-channels) - Rename channels to make them more discoverable.
- [Display channel banners](/end-user-guide/collaborate/display-channel-banners) - Display a fixed banner at the top of channels to warn users about the presence of classified or sensitive information.
- [Auto-translate messages](/end-user-guide/collaborate/autotranslate-messages) - Automatically translate channel messages into your preferred language.
- [Convert public channels to private channels](/end-user-guide/collaborate/convert-public-channels) - Learn how to convert channel access and visibility.
- [Convert group messages to private channels](/end-user-guide/collaborate/convert-group-messages) - Learn how to convert group messages to private channels.
- [Manage channel members](/end-user-guide/collaborate/manage-channel-members) - Add and remove users from channels.
- [Mark channels as favorites](/end-user-guide/collaborate/favorite-channels) - Mark commonly visited channels as favorites.
- [Manage channel bookmarks](/end-user-guide/collaborate/manage-channel-bookmarks) - Manage quick access links or files pinned to the top of channels.
- [Mark channels as unread](/end-user-guide/collaborate/mark-channels-unread) - Mark channels unread to return to messages later.
- [Archive and unarchive channels](/end-user-guide/collaborate/archive-unarchive-channels) - Keep the number of available channels manageable.

View File

@@ -0,0 +1,58 @@
---
title: "Collaborate within Microsoft Teams"
---
<PlanAvailability slug="entry-ent" />
The Mattermost for Microsoft Teams integration enables you to break through siloes in a mixed Mattermost and Teams environment by forwarding real-time chat notifications from Teams to Mattermost.
![Mattermost for Microsoft Teams integration forwards real-time chat notifications from Teams to Mattermost.](/images/microsoft-teams-chat-notifications.gif)
<PlanAvailability slug="academy-msteams" />
## Connect your Mattermost account to your Microsoft Teams account
<Note>
Your System Administrator must install and enable the [Mattermost for Microsoft Teams integration](/integrations-guide/microsoft-teams-sync) and ensure [support for notifications is enabled](/administration-guide/configure/plugins-configuration-settings#sync-notifications) in order for you to connect your account and recieve chat notifications.
</Note>
Once the integration is installed and configured by a System Administrator, you can connect your Mattermost user account to your Microsoft Teams account. You only need to complete this step once.
1. Log into Mattermost using your credentials.
2. In any channel, run the `/msteams connect` slash command, and select the resulting link.
3. Authenticate with Microsoft Teams using the email address matching your account in Mattermost.
Mattermost will confirm when your account is connected.
Once you've connected your Mattermost account to your Microsoft Teams account, when you're offline or away from Microsoft Teams, any messages you receive in a chat or group chat in Microsoft Teams will display in Mattermost as a notification and include a link to open the chat in Microsoft Teams to continue the conversation. These notifications won't appear if you've been recently active in Teams.
![An example of a chat message notification.](/images/microsoft-teams-chat-notifications.png)
### Manage notification settings
Manage your Mattermost notification settings for the Microsoft Teams integration at any time in **Settings** \> **Plugin Preferences**
![Manage notification settings for the Microsoft Teams integration in Account Settings \> Plugin Preferences](/images/teams_plugin_notification_settings.png)
<Tip>
You can run the following [slash commands](/integrations-guide/run-slash-commands) to manage your integration settings by typing the commands into the Mattermost message text box, and selecting **Send**:
- `/msteams connect`: Connect your Mattermost account to Microsoft Teams account.
- `/msteams disconnect`: Disconnect your Mattermost account from Microsoft Teams account.
- `/msteams status`: Show your current connection status.
- `/msteams notifications on|off`: Change your current notifications settings.
</Tip>
## Frequently asked questions
### How does the integration determine when to send chat notifications?
Chat notifications are sent in real-time whenever you're not active in Microsoft Teams and receive a chat or group chat. Mattermost uses your online status in Teams to determine if a chat notification should be delivered. Mattermost delivers notifications if you appear **Away** or **Offline** in Microsoft Teams, so the default behavior for when notifications will be delivered depends on the client you typically use to access Microsoft Teams:
- Web browser: Mattermost delivers notifications when you've not had activity in your Microsoft Teams browser tab for 5 minutes or more, when the browser tab is closed, or when you mark yourself as **Offline** in Microsoft Teams.
- Desktop app: Mattermost delivers notifications when you've not had activity at your computer for 5 minutes or more, when the Microsoft Teams desktop app is closed, or when you mark yourself as **Offline** in Microsoft Teams.
In order to avoid double notifications, Mattermost won't deliver chat notifications when your availability is set to **Available**, **Busy**, **Do not disturb**, or **Be right back** in Microsoft Teams.

View File

@@ -0,0 +1,32 @@
---
title: "Communicate with messages and threads"
---
<PlanAvailability slug="all-commercial" />
[Sending messages](/end-user-guide/collaborate/send-messages), [replying to messages](/end-user-guide/collaborate/reply-to-messages), and [participating in discussion threads](/end-user-guide/collaborate/organize-conversations#start-or-reply-to-threads) are important ways to keep conversations active with your team.
## Work with messages and threads
Learn more about messages and threads:
- [Send messages](/end-user-guide/collaborate/send-messages) - Send messages to other Mattermost users.
- [Reply to messages](/end-user-guide/collaborate/reply-to-messages) - Communicate with your team in Mattermost.
- [React with emojis and GIFs](/end-user-guide/collaborate/react-with-emojis-gifs) - Use emojis and GIFs to react to messages and to express concepts, humor, emotions, and physical gestures in your own messages.
- [Organize conversations with threaded discussions](/end-user-guide/collaborate/organize-conversations) - An enhanced communication thread experience is available in Mattermost.
- [Mark messages as unread](/end-user-guide/collaborate/mark-messages-unread) - Change messages to an unread state for easy follow-up.
- [Forward messages](/end-user-guide/collaborate/forward-messages) - Quickly and easily forward messages with previews.
- [Share links to messages](/end-user-guide/collaborate/share-links) - Share links to messages across channels.
- [Save and pin messages](/end-user-guide/collaborate/save-pin-messages) - Mark useful messages for easy retrieval in the future.
- [Set message reminders](/end-user-guide/collaborate/message-reminders) - Set reminders to follow up on messages.
- [Search for messages](/end-user-guide/collaborate/search-for-messages) - Use search to find messages, replies, and file contents across Mattermost channels.
- [Schedule messages](/end-user-guide/collaborate/schedule-messages) - Schedule messages to be sent in the future.
- [Flag messages](/end-user-guide/collaborate/flag-messages) - Flag messages that may contain sensitive or restricted information for review by authorized moderators.
## Make your messages stand out
Learn more about making your messages stand out:
- [Format messages](/end-user-guide/collaborate/format-messages) - Use markdown to format message content.
- [Set message priority](/end-user-guide/collaborate/message-priority) - Ensure important and urgent messages stand out clearly by adding priority labels, and requesting message acknowledgements.
- [Mention people](/end-user-guide/collaborate/mention-people) - Get the attention of specific people.
- [Share files in messages](/end-user-guide/collaborate/share-files-in-messages) - Share videos, voice recordings, and images in your Mattermost messages.

View File

@@ -0,0 +1,55 @@
---
title: "Convert group messages to private channels"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
From Mattermost v9.1, you can change the members of your group conversation by converting the group message to a private channel. When a group message is converted to private, its history and membership are preserved. Membership in a private channel remains as invitation only.
<Note>
- Any member of an existing group message, except [guests](/administration-guide/onboard/guest-accounts), can convert that group message to a private channel.
- Conversation history will be visible to all channel members.
- All group message participants must share at least one team membership.
</Note>
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Select the group message name at the top of the center pane to access the drop-down menu, then select **Convert to Private Channel**.
2. Specify the team where the new private channel will be created. You're prompted to specify a team when all group message members share more than one team membership.
3. Enter a channel name.
4. Select **Convert to private channel**.
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap the group message you want to convert to a private channel.
![Select a group that you want to convert.](/images/mobile-select-a-group-message.jpg)
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
![Tap on More options to access available options for the group.](/images/mobile-select-more-options-for-a-group.jpg)
3. Tap **View info**.
![Tap on View info to see the basic group info.](/images/mobile-select-view-info-for-a-group.jpg)
4. Tap **Convert to a Private Channel**.
![Tap on Convert to a Private Channel to convert the group.](/images/mobile-convert-group-to-private-channel.jpg)
5. Enter the private channel name.
![Type a name for the Private channel.](/images/mobile-provide-private-channel-name-for-the-group.jpg)
6. Tap **Convert to Private Channel** to confirm.
</TabItem>
</Tabs>

View File

@@ -0,0 +1,69 @@
---
title: "Convert public channels to private channels"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
You must be a system admin or team admin to convert public channels to private channels. When a channel is converted from public to private, its history and membership are preserved. Membership in a private channel remains as invitation only. Publicly-shared files remain accessible to anyone with the link.
<Note>
The default channel `Town Square` can't be converted to a private channel.
</Note>
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
To convert a public channel to a private channel, select the public channel name at the top of the center pane to access the drop-down menu, then select **Convert to Private Channel**.
![From the channel name, you can convert a public channel to a private channel if you're an admin.](/images/convert-public-channel-to-private.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
To convert a public channel to a private channel:
1. Tap the channel you want to convert.
![Select a channel that you want to rename.](/images/mobile-select-a-channel.jpg)
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
![Tap on More options to access available options for the channel.](/images/mobile-select-more-options-for-a-channel.jpg)
3. Tap **View info**.
![Tap on View info to see the basic channel info.](/images/mobile-select-view-info-for-a-channel.jpg)
4. Tap **Convert to private channel**.
![Tap on Convert to private channel to make the channel private.](/images/mobile-convert-to-private-channel.jpg)
5. Tap **Yes** to confirm.
![Tap on Yes to confirm your choice.](/images/mobile-confirm-convert-to-private-channel.jpg)
</TabItem>
</Tabs>
## Convert private channels to public channels
Due to potential security concerns with sharing private channel history, only system admins can convert private channels to public channels using the System Console.
<Note>
- The ability to convert private channels to public channels using the [API](https://api.mattermost.com/#tag/channels/operation/UpdateChannelPrivacy) or [mmctl channel modify command](/administration-guide/manage/mmctl-command-line-tool#mmctl-channel-modify) is limited to system admins, team admins, and users with specific granular admin roles. Team admins have this permission by default, but system admins can restrict it or assign it to other roles.
- Granular roles require permissions for managing User Management Channels and Groups, including `sysconsole_write_user_management_channels` and `sysconsole_write_user_management_groups`. Manage permissions through the [permission scheme](/administration-guide/onboard/advanced-permissions#permissions-structure).
- If [Sync Group channel management](/administration-guide/manage/team-channel-members#channel-management) is enabled, private channels can't be converted to public channels.
</Note>
1. Go to **System Console \> Channels**.
2. Select **Edit** for an existing private channel. You can also filter the list of channels to private channels only.
3. Under **Channel Management \> Public channel or private channel**, select **Private**.
4. Select **Save**.

View File

@@ -0,0 +1,76 @@
---
title: "Create channels"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
Anyone can create public channels, private channels, direct messages, and group messages unless the system admin has [restricted permissions to do so using advanced permissions](/administration-guide/onboard/advanced-permissions). Enterprise system administrators can also configure channels as [read-only](/administration-guide/onboard/advanced-permissions#read-only-channels).
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
## Create a public or private channel
1. Select the **Add channels** button in the channel sidebar, then select **Create New Channel**. Alternatively, you can select <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> at the top of the channel sidebar, then select **Create New Channel**.
> <img src={useBaseUrl('/images/add-channels-button.png')} width="400" alt="You can create a channel using the Add channels button" />
2. Enter a channel name.
3. Choose whether this is a public or private channel. See the [channel types](/end-user-guide/collaborate/channel-types) documentation to learn more about public and private channels.
4. (Optional) Describe the channel's focus or purpose. This text is visible to all channel members in the channel header.
5. (Optional) Assign the channel to a category. When [channel category sorting](/administration-guide/configure/experimental-configuration-settings#enable-channel-category-sorting) is enabled (the default from Mattermost v11.8), channel admins see a **Default category (optional)** field when creating or editing a channel. You can select an existing category, type a new category name, or clear the default category from channel settings. Members who join the channel see it under that category in their sidebar. If this option isn't available, you can [customize your channel sidebar](/end-user-guide/preferences/customize-your-channel-sidebar).
## Start a direct or group message
1. Select the <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> next to the **Direct Messages** category in the channel sidebar.
> ![Access recent direct messages and group messages.](/images/write-dm.png)
2. Select up to seven users by searching or browsing. If your organization uses [connected workspaces](/administration-guide/onboard/connected-workspaces), you can also select remote users from shared channels for direct and group messages.
<Tip>
- Alternatively, select <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> at the top of the channel sidebar, then select **Open a Direct Message**. In the **Direct Messages** list, you'll see your most recent conversations.
- To add more people to the conversation select the channel name, then select **Add Members**. Adding members to a group message creates a new channel and starts a new conversation.
- You can't remove members of a group message; however, you can start a new group channel and conversation with different members.
- If you want to add more than 7 users to a group message, create a private channel instead.
</Tip>
</TabItem>
<TabItem value="mobile" label="Mobile">
## Create a public or private channel
Tap <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> in the top right corner of the app, then select **Create New Channel**. Channels are created as public by default. If you want to create a private channel, tap the **Make Private** option.
> ![You can create a new channel by tapping the plus in the top right corner.](/images/create-channel-or-open-direct-message-on-mobile.jpg)
>
> ![You can make a channel private by tapping the Make Private option.](/images/private-channel-create.jpg)
## Start a direct or group message
Tap <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> in the top right corner of the app, then select **Open a Direct Message**. You can select one person for a direct message or up to seven people for a group message. If your organization uses [connected workspaces](/administration-guide/onboard/connected-workspaces), remote users from shared channels are also available to select. Tap **Start** to start the conversation.
> ![You can start a direct or group message by tapping the plus in the top right corner.](/images/create-channel-or-open-direct-message-on-mobile.jpg)
>
> ![You can stat a group conversation by selecting up to 7 members.](/images/start-group-conversation.jpg)
</TabItem>
</Tabs>
## Automate with channel actions
The person who creates a channel automatically becomes the channel admin. Channel admins using Mattermost in a web browser or the desktop app can access **Channel Actions** from the channel name drop-down menu in the center pane to set up automatic actions when users [join the channel](/end-user-guide/collaborate/join-leave-channels#join-a-channel) or [post a message](/end-user-guide/collaborate/send-messages) to the channel.
Automatic actions include:
- Displaying a temporary welcome message for new channel members.
- Automatically adding the channel to a [category in the user's channel sidebar](/end-user-guide/preferences/customize-your-channel-sidebar).
- Prompting to run a playbook based on the contents of a message.
The [collaborative playbooks must be enabled](/administration-guide/configure/plugins-configuration-settings#collaborative-playbooks) for channel admins to use channel actions.

View File

@@ -0,0 +1,45 @@
---
title: "Display channel banners"
---
<PlanAvailability slug="entry-adv" />
From Mattermost v10.9, users with admin permissions can enable channel banners to remind channel members about being diligent to avoid data spillage in channels that aren't intended for classified or sensitive information. These non-dismissible banners can be styled using Markdown and are visible across all Mattermost clients, including web browsers, the desktop app, and the mobile app.
Channel banner use cases include the following:
- Security classifications, such as **SENSITIVE INFORMATION: IMPACT LEVEL 5** with a distinctive color to alert members of the required security level.
- Important notices, such as **Reminder: Code complete deadlines are Fridays at 3 PM**, for recurring reminders.
- Policy or terms, such as **All discussion in this channel is private and restricted** with a red color to signal caution.
Mattermost [channel admins](/end-user-guide/collaborate/learn-about-roles#channel-admin), [team admins](/end-user-guide/collaborate/learn-about-roles#team-admin), and [system admins](/end-user-guide/collaborate/learn-about-roles#system-admin) can enable a banner with custom text at the top of Mattermost public or private channels.
Create a channel banner:
1. Open a channel where you have administrative permissions.
2. Select the channel name at the top of the center pane to access the drop-down menu, then select **Channel Settings**.
3. Select **Configuration** and enable the **Channel Banner** option.
4. Specify the banner text you want to display at the top of the channel. You can style the text using [Markdown](/end-user-guide/collaborate/format-messages#use-markdown), if desired.
5. Select the banner color.
6. Select **Save** to apply the changes. The banner displays immediately.
## Change a channel banner
You can change the banner text or color at any time by following the same steps above. The new banner text or color displays immediately.
## Remove a channel banner
Disable the **Channel Banner** option in the channel settings to remove the banner from the channel.
<Tip>
System admins can grant any user the ability to create and manage channel banners by assigning the **Manage Channel Banners** permission in the System Console. See the [advanced permissions](/administration-guide/onboard/advanced-permissions) documentation for details.
</Tip>
## Classification markings
From Mattermost v11.8, system admins can configure classification markings that display as global or channel-level banners in the web and desktop apps. See the [Classification Markings](/administration-guide/configure/site-configuration-settings#classification-markings) configuration documentation for setup details.
Classification markings use predefined or custom classification levels, including the classification name and banner color. These markings are informational only and don't control access to channels, messages, files, or other Mattermost resources.
When a channel classification is applied, Mattermost displays the selected classification as the channel banner. Classification markings take priority over a custom channel banner when both are configured for the same channel.

View File

@@ -0,0 +1,31 @@
---
title: "Extend Mattermost with integrations"
---
Ensure your teams are are always informed about important events, status changes, deadlines, or priorities with Mattermost operational and DevOps integrations. Enhance communication, streamline Mattermost with external workflows, ensure security and compliance, and foster a more efficient and collaborative work environment with major communication tools and services featuring real-time alerts, updates, and notifications directly within channels.
## Interoperability with pre-built integrations
Your system admin can install the following pre-packaged integrations through the Mattermost Marketplace, and enable and configure them in the Mattermost System Console.
### Mattermost features
- [AI Agents](/end-user-guide/agents#access-ai-features)
- [Export Mattermost channel data](/administration-guide/comply/export-mattermost-channel-data#usage)
- [Monitor performance metrics](/administration-guide/scale/collect-performance-metrics#usage)
- [Perform legal holds](/administration-guide/comply/legal-hold)
### Mattermost interoperability
- [GitHub](/integrations-guide/github#use)
- [GitLab](/integrations-guide/gitlab#use)
- [Jira](/integrations-guide/jira#use)
- [Microsoft Teams](/integrations-guide/microsoft-teams-sync#use)
- [ServiceNow](/integrations-guide/servicenow#use)
- [Zoom](/integrations-guide/zoom#usage)
<Tip>
- [Visit the Mattermost Marketplace](https://mattermost.com/marketplace/) to find open source, community-supported integrations to common developer tools like [CircleCI](https://mattermost.com/marketplace/circleci/), [Opsgenie](https://mattermost.com/marketplace/opsgenie/), [PagerDuty Notifier](https://mattermost.com/marketplace/pagerduty/); productivity tools like [Autolink](https://mattermost.com/marketplace/autolink-plugin/), [ToDo](https://mattermost.com/marketplace/todo/), and [WelcomeBot](https://mattermost.com/marketplace/welcomebot-plugin/); as well as social tools like [Memes](https://mattermost.com/marketplace/memes-plugin/) and [GIFs](https://mattermost.com/marketplace/giphy-plugin/) that are freely available for use and customization.
- Looking for a way to get notifications of new Mattermost Marketplace integrations in your Mattermost channels? See the [integrations FAQ](/integrations-guide/faq) documentation for details.
</Tip>

View File

@@ -0,0 +1,62 @@
---
title: "Mark channels as favorites"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
You can mark public and private channels, as well as direct and group messages as favorites so they're easy to access later. Favorite channels display in the **Favorites** category in the channel sidebar.
![Favorite channels display in the channel sidebar.](/images/favorites-list-sidebar.png)
To mark a channel as a **Favorite**:
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Open a channel.
2. Select on the star icon next to the channel name.
At the top of the page, select the <img src={useBaseUrl('/img/ui/star-outline_F04D2.svg')} alt="Use the Star icon to mark a channel as a favorite." className="theme-icon" /> icon next to the channel name.
![Mark a channel as a favorite.](/images/favorite-channel-desktop.png)
To remove a channel from your **Favorites** list, select the <img src={useBaseUrl('/img/ui/star-outline_F04D2.svg')} alt="Use the Star icon to mark a channel as a favorite." className="theme-icon" /> icon again.
Alternatively to mark channels as favorites, select the channel name, select the **View Info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon, then select **Favorite** in the right pane. Select **Favorited** to remove the channel from your list of favorites.
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap the channel you want to mark as a favorite.
![Select a channel that you want to mark as favorite.](/images/mobile-select-a-channel.jpg)
2. Tap the <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
![Tap on More options to access available options for the channel.](/images/mobile-select-more-options-for-a-channel.jpg)
3. Tap **Favorite**.
![Tap on Favorite to mark the channel as one of the favorites.](/images/mobile-select-view-info-for-a-channel.jpg)
Alternatively, you can mark a favorite channel as follows:
1. In a channel, tap the channel name at the top of the screen.
![Tap on the channel name to view available options for the channel.](/images/mobile-select-more-options-for-a-channel.jpg)
2. Tap on **Favorite**
![Tap on Favorite to mark the channel as one of the favorites.](/images/mobile-favorite-a-channel-within-channel.jpg)
To remove a channel from the **Favorites** list, tap the **Favorited** option.
![Tap on Favorited to unfavorite the channel.](/images/mobile-unfavorite-a-channel.jpg)
![Tap on Favorited to unfavorite the channel.](/images/mobile-unfavorite-a-channel-from-within-the-channel.jpg)
</TabItem>
</Tabs>

View File

@@ -0,0 +1,37 @@
---
title: "Quarantine messages for review"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="entry-adv" />
Every Mattermost user contributes to data security. From Mattermost v11.1, you can help keep your workspace secure and prevent data spillage by quarantining messages that may contain sensitive or restricted information for review by authorized moderators. Your quick actions can prevent accidental leaks before they spread, and build a culture of shared responsibility for secure communication.
## Quarantine a message
For example, you notice a public post in a channel that contains internal project details that not all users should have access to. You can quarantine that message as **Sensitive data** to alert designated content reviewers right away.
<Note>
You can only quarantine messages posted in public or private channels. The **Quarantine for Review** action isn't available in direct messages or group messages.
</Note>
1. Hover over the message, select the **More actions** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon, and then select **Quarantine for Review**.
2. Select a **reason** for quarantining the message, and add a comment explaining why you're quarantining it, when required.
3. Select **Submit**.
You’ll see a confirmation that your message was quarantined. Mattermost may hide the quarantined message based on how your system admin has configured Data Spillage Handling workflows. You can’t quarantine the same message twice.
## If your message is quarantined
A message being quarantined isn’t a disciplinary action. Quarantined messages help to protect sensitive data across your organization.
If another user quarantines one of your messages, you’ll receive a direct message from the **Data Spillage Bot** explaining which message was quarantined and why. If Mattermost has hidden your message, the direct message won’t contain the quarantined message content.
You'll receive another direct message once reviewers take action.
- If your message is removed, review the reason why it was quarantined, and adjust how you share information in the future.
- If your message is kept, no further action is required of you.
Contact your reviewer or system admin if you need clarification about actions taken or next steps.

View File

@@ -0,0 +1,691 @@
---
title: "Format messages"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
## Use the messaging formatting toolbar
From Mattermost v7.0, you can format your messages in Mattermost using the message formatting toolbar without having to specify any Markdown syntax.
![The message formatting toolbar, available from Mattermost v7.0, doesn't require Markdown syntax, and makes formatting message text fast and easy.](/images/message-formatting-toolbar.gif)
The message formatting toolbar offers the following formatting options:
<table>
<colgroup>
<col style={{width: '53%'}} />
<col style={{width: '46%'}} />
</colgroup>
<thead>
<tr>
<th>Formatting option</th>
<th>Icon</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="#use-markdown">Bold, italicize, or strike out text</a></td>
<td>
<img src={useBaseUrl('/img/ui/format-bold_F0264.svg')} alt="Bold" className="theme-icon" />
<img src={useBaseUrl('/img/ui/format-italic_F0277.svg')} alt="Italicize" className="theme-icon" />
<img src={useBaseUrl('/img/ui/format-strikethrough-variant_F0281.svg')} alt="Strikeout" className="theme-icon" />
</td>
</tr>
<tr>
<td>Add <a href="#headings">headings</a>, <a href="#links">links</a>, or attachments</td>
<td>
<img src={useBaseUrl('/img/ui/format-header_E81D.svg')} alt="Headings" className="theme-icon" />
<img src={useBaseUrl('/img/ui/link-variant_F0339.svg')} alt="Copy link" className="theme-icon" />
<img src={useBaseUrl('/img/ui/paperclip_F03E2.svg')} alt="Attachments" className="theme-icon" />
</td>
</tr>
<tr>
<td>Format a numbered list, a bulleted list, quoted text, or text as code</td>
<td>
<img src={useBaseUrl('/img/ui/format-list-numbered_F027B.svg')} alt="Numbered list" className="theme-icon" />
<img src={useBaseUrl('/img/ui/format-list-bulleted_F0279.svg')} alt="Bulleted list" className="theme-icon" />
<img src={useBaseUrl('/img/ui/format-quote-open_F0757.svg')} alt="Quoted text" className="theme-icon" />
<img src={useBaseUrl('/img/ui/code-tags_F0174.svg')} alt="Code" className="theme-icon" />
</td>
</tr>
<tr>
<td colspan="2"><a href="/end-user-guide/collaborate/react-with-emojis-gifs">Add emojis or GIFs</a> <img src={useBaseUrl('/img/ui/emoticon-outline_F01F2.svg')} alt="Emoji" className="theme-icon" /></td>
</tr>
<tr>
<td colspan="2"><a href="/end-user-guide/collaborate/message-priority">Set message priority</a> <img src={useBaseUrl('/img/ui/alert-circle-outline_F05D6.svg')} alt="Message priority" className="theme-icon" /></td>
</tr>
</tbody>
</table>
Review how your message formatting will look when the message is sent by selecting the **Show/Hide Preview** <img src={useBaseUrl('/img/ui/eye-outline_F06D0.svg')} alt="Review your message text formatting using the Show/Hide preview icon in the message formatting toolbar." className="theme-icon" /> icon. Return to your draft message by selecting the icon again.
<Tip>
- Hide the formatting options by selecting the **Show/Hide Formatting** <img src={useBaseUrl('/img/ui/format-letter-case_F0B34.svg')} alt="Hide formatting options in the message formatting toolbar using the Show/Hide Formatting icon." className="theme-icon" /> icon. Select the icon again to show the formatting options.
- You can control whether post formatting is rendered within the message formatting editor. When disabled, raw text is shown. See the [Channels customization](/end-user-guide/preferences/manage-advanced-options) documentation for details.
</Tip>
## Use Markdown
You can also format your messages in Mattermost using Markdown to control [text styling](#text-style), [links](#links), [headings](#headings), [lists](#lists), [code blocks](#code-blocks), [in-line code](#in-line-code), [in-line images](#in-line-images), [horizontal lines](#horizontal-lines), [block quotes](#block-quotes), [tables](#tables), and [math formulas](#math-formulas). Markdown makes it easy to format messages: type a message as you normally would, then use formatting syntax to render the message a specific way. For a guide to using Markdown in Mattermost, [see this blog post](https://mattermost.com/blog/laymans-guide-to-markdown-on-mattermost/).
![Formatting markdown controls the look and feel of text messages.](/images/messagesTable1.png)
### Text style
You can use either `_` or `*` around a word or phrase to make it italic, or `__` or `**` around a word or phrase to make it bold.
<Tip>
Common formatting keyboard shortcuts are supported. Bold text by pressing <kbd>Ctrl</kbd> <kbd>B</kbd> on Windows and Linux, or <kbd>⌘</kbd> <kbd>B</kbd> on Mac. Italicize text by pressing <kbd>Ctrl</kbd> <kbd>I</kbd> on Windows or Linux, or <kbd>⌘</kbd> <kbd>I</kbd> on Mac.
</Tip>
- `*italics*` (or `_italics_`) renders as *italics*
- `**bold**` renders as **bold**
- `***bold-italic***` renders as <img src={useBaseUrl('/images/bold_italics.png')} width="100" alt="Bold Italics" />
- `~~strikethrough~~` renders as <img src={useBaseUrl('/images/strikethrough.png')} width="100" alt="Strike Through" />
### Links
<Tip>
Format selected message text as a link by pressing <kbd>Ctrl</kbd> <kbd>K</kbd> on Windows and Linux, or by pressing <kbd>⌘</kbd> <kbd>K</kbd> on Mac.
</Tip>
#### Channel links
Create a link to a public channel in a message by typing `~` followed by the channel name (e.g. `~roadmap`). Channel members see private channel names returned.
#### Labeled links
Create labeled links by putting the desired text in square brackets `[ ]` and the associated link in round brackets `( )`.
`[Check out Mattermost!](https://.mattermost.com/)`
Renders as: [Check out Mattermost!](https://mattermost.com/)
### Headings
Make a heading by typing `#` and a space before your title. For smaller headings, use more `#`'s.
``` text
## Large Heading
### Smaller Heading
#### Even Smaller Heading
```
Renders as:
![Large Heading](/images/Headings1.png)
Alternatively, you can underline the text using equal signs `===` or hyphens `---` to create headings.
``` text
Large Heading
-------------
```
Renders as:
![Smaller Heading](/images/Headings2.png)
### Lists
Create a list by using asterisks `*`, hyphens `-`, and/or plus signs `+` interchangeably as bullets. Indent bullet points by adding two spaces in front each one.
``` text
* item one
- item two
+ item two sub-point
```
Renders as:
- item one
- item two
- item two sub-point
Make an ordered list by using numbers instead:
``` text
1. Item one
1. Item two
1. item three
```
Renders as:
1. Item one
2. Item two
3. Item three
You can also start a list at any number:
``` text
4. The first list number is 4.
1. The second list number is 5.
1. The third list number is 6.
```
Renders as:
4. The first list number is 4.
5. The second list number is 5.
6. The third list number is 6.
Make a task list by including square brackets `[ ]`. Mark a task as complete by adding an `x`.
``` text
- [ ] Item one
- [ ] Item two
- [x] Completed item
```
Renders as:
![List](/images/checklist.png)
### Code blocks
Creating a fixed-width code block is recommended for pasting multi-line blocks of code or other text output because it's easier to read with fixed-width font alignment. Examples include block text snippets, ASCII tables, and log files. Rendered code blocks include a **Copy** option to copy the contents of the code block.
This can be accomplished by placing three backticks (```` ``` ````) on the line directly above and directly below your code:
````text
```
this is my
code block
```
````
<Tip>
Type three backticks (```` ``` ````), press <kbd>Shift</kbd> <kbd>Enter</kbd> on Windows or Linux, or <kbd>⇧</kbd> <kbd>↵</kbd> on Mac, `<type_your_code>`, press <kbd>Shift</kbd> <kbd>Enter</kbd> on Windows or Linux, or <kbd>⇧</kbd> <kbd>↵</kbd> on Mac again, then type three more backticks (```` ``` ````).
</Tip>
Or by indenting each line by four spaces:
```text
this is my
code block
```
### Syntax highlighting
To add syntax highlighting, type the language to be highlighted after the ```` ``` ```` at the beginning of the code block. Mattermost also offers four different code themes (GitHub, Solarized Dark, Solarized Light, and Monokai) that can be changed in **Settings \> Display \> Theme \> Custom Theme \> Center Channel Styles**.
Supported languages and their aliases include:
<table width="100%" border="1" cellpadding="5px" style={{marginBottom: '20px'}}>
<tr class="row-odd">
<th class="head">Language</th>
<th class="head">Aliases</th>
</tr>
<tr class="row-odd">
<td valign="middle">ActionScript</td>
<td valign="middle">actionscript, as, as3</td>
</tr>
<tr class="row-odd">
<td valign="middle">AppleScript</td>
<td valign="middle">applescript</td>
</tr>
<tr class="row-odd">
<td valign="middle">Bash</td>
<td valign="middle">bash, sh</td>
</tr>
<tr class="row-odd">
<td valign="middle">Clojure</td>
<td valign="middle">clojure</td>
</tr>
<tr class="row-odd">
<td valign="middle">CoffeeScript</td>
<td valign="middle">coffescript, coffee, coffee-script</td>
</tr>
<tr class="row-odd">
<td valign="middle">C/C++</td>
<td valign="middle">cpp, c++, c</td>
</tr>
<tr class="row-odd">
<td valign="middle">C#</td>
<td valign="middle">cs, c#, csharp</td>
</tr>
<tr class="row-odd">
<td valign="middle">CSS</td>
<td valign="middle">css</td>
</tr>
<tr class="row-odd">
<td valign="middle">D</td>
<td valign="middle">d, dlang</td>
</tr>
<tr class="row-odd">
<td valign="middle">Dart</td>
<td valign="middle">dart</td>
</tr>
<tr class="row-odd">
<td valign="middle">Delphi</td>
<td valign="middle">delphi</td>
</tr>
<tr class="row-odd">
<td valign="middle">Diff</td>
<td valign="middle">diff, patch, udiff</td>
</tr>
<tr class="row-odd">
<td valign="middle">Django</td>
<td valign="middle">django</td>
</tr>
<tr class="row-odd">
<td valign="middle">Dockerfile</td>
<td valign="middle">dockerfile, docker</td>
</tr>
<tr class="row-odd">
<td valign="middle">Elixir</td>
<td valign="middle">elixir, ex, exs</td>
</tr>
<tr class="row-odd">
<td valign="middle">Erlang</td>
<td valign="middle">erlang, erl</td>
</tr>
<tr class="row-odd">
<td valign="middle">Fortran</td>
<td valign="middle">fortran</td>
</tr>
<tr class="row-odd">
<td valign="middle">F#</td>
<td valign="middle">fsharp</td>
</tr>
<tr class="row-odd">
<td valign="middle">G-Code</td>
<td valign="middle">gcode</td>
</tr>
<tr class="row-odd">
<td valign="middle">Go</td>
<td valign="middle">go, golang</td>
</tr>
<tr class="row-odd">
<td valign="middle">Groovy</td>
<td valign="middle">groovy</td>
</tr>
<tr class="row-odd">
<td valign="middle">Handlebars</td>
<td valign="middle">handlebars, hbs, mustache</td>
</tr>
<tr class="row-odd">
<td valign="middle">Haskell</td>
<td valign="middle">haskell, hs</td>
</tr>
<tr class="row-odd">
<td valign="middle">Haxe</td>
<td valign="middle">haxe</td>
</tr>
<tr class="row-odd">
<td valign="middle">Java</td>
<td valign="middle">java</td>
</tr>
<tr class="row-odd">
<td valign="middle">JavaScript</td>
<td valign="middle">javascript, js</td>
</tr>
<tr class="row-odd">
<td valign="middle">JSON</td>
<td valign="middle">json</td>
</tr>
<tr class="row-odd">
<td valign="middle">Julia</td>
<td valign="middle">julia, jl</td>
</tr>
<tr class="row-odd">
<td valign="middle">Kotlin</td>
<td valign="middle">kotlin</td>
</tr>
<tr class="row-odd">
<td valign="middle">LaTeX</td>
<td valign="middle">latex, tex</td>
</tr>
<tr class="row-odd">
<td valign="middle">Less</td>
<td valign="middle">less</td>
</tr>
<tr class="row-odd">
<td valign="middle">Lisp</td>
<td valign="middle">lisp</td>
</tr>
<tr class="row-odd">
<td valign="middle">Lua</td>
<td valign="middle">lua</td>
</tr>
<tr class="row-odd">
<td valign="middle">Makefile</td>
<td valign="middle">makefile, make, mf, gnumake, bsdmake</td>
</tr>
<tr class="row-odd">
<td valign="middle">Markdown</td>
<td valign="middle">markdown, md, mkd</td>
</tr>
<tr class="row-odd">
<td valign="middle">Matlab</td>
<td valign="middle">matlab, m</td>
</tr>
<tr class="row-odd">
<td valign="middle">Objective C</td>
<td valign="middle">objectivec, objective_c, objc</td>
</tr>
<tr class="row-odd">
<td valign="middle">OCaml</td>
<td valign="middle">ocaml</td>
</tr>
<tr class="row-odd">
<td valign="middle">Perl</td>
<td valign="middle">perl, pl</td>
</tr>
<tr class="row-odd">
<td valign="middle">Pascal</td>
<td valign="middle">pascal, pas</td>
</tr>
<tr class="row-odd">
<td valign="middle">PostgreSQL</td>
<td valign="middle">pgsql, postgres, postgresql</td>
</tr>
<tr class="row-odd">
<td valign="middle">PHP</td>
<td valign="middle">php, php3, php4, php5</td>
</tr>
<tr class="row-odd">
<td valign="middle">PowerShell</td>
<td valign="middle">powershell, posh</td>
</tr>
<tr class="row-odd">
<td valign="middle">Puppet</td>
<td valign="middle">puppet, pp</td>
</tr>
<tr class="row-odd">
<td valign="middle">Python</td>
<td valign="middle">python, py</td>
</tr>
<tr class="row-odd">
<td valign="middle">R</td>
<td valign="middle">r, s</td>
</tr>
<tr class="row-odd">
<td valign="middle">Ruby</td>
<td valign="middle">ruby, rb</td>
</tr>
<tr class="row-odd">
<td valign="middle">Rust</td>
<td valign="middle">rust, rs</td>
</tr>
<tr class="row-odd">
<td valign="middle">Scala</td>
<td valign="middle">scala</td>
</tr>
<tr class="row-odd">
<td valign="middle">Scheme</td>
<td valign="middle">scheme</td>
</tr>
<tr class="row-odd">
<td valign="middle">SCSS</td>
<td valign="middle">scss</td>
</tr>
<tr class="row-odd">
<td valign="middle">Smalltalk</td>
<td valign="middle">smalltalk, st, squeak</td>
</tr>
<tr class="row-odd">
<td valign="middle">SQL</td>
<td valign="middle">sql</td>
</tr>
<tr class="row-odd">
<td valign="middle">Stylus</td>
<td valign="middle">stylus, styl</td>
</tr>
<tr class="row-odd">
<td valign="middle">Swift</td>
<td valign="middle">swift</td>
</tr>
<tr class="row-odd">
<td valign="middle">Text</td>
<td valign="middle">text</td>
</tr>
<tr class="row-odd">
<td valign="middle">TypeScript</td>
<td valign="middle">typescript, ts, tsx</td>
</tr>
<tr class="row-odd">
<td valign="middle">VB.Net</td>
<td valign="middle">vbnet, vb, visualbasic</td>
</tr>
<tr class="row-odd">
<td valign="middle">VBScript</td>
<td valign="middle">vbscript</td>
</tr>
<tr class="row-odd">
<td valign="middle">Verilog</td>
<td valign="middle">verilog</td>
</tr>
<tr class="row-odd">
<td valign="middle">VHDL</td>
<td valign="middle">vhdl</td>
</tr>
<tr class="row-odd">
<td valign="middle">HTML, XML</td>
<td valign="middle">html, xml</td>
</tr>
<tr class="row-odd">
<td valign="middle">YAML</td>
<td valign="middle">yaml, yml</td>
</tr>
</table>
Example:
```` text
``` go
package main
import "fmt"
func main() {
fmt.Println("Hello, 世界")
}
```
````
Renders as:
**GitHub Theme**
![Syntax Highlighting in GitHub](/images/syntax-highlighting-github.png)
**Solarized Dark Theme**
![Syntax Highlighting Dark](/images/syntax-highlighting-sol-dark.png)
**Solarized Light Theme**
![Syntax Highlighting Light](/images/syntax-highlighting-sol-light.png)
**Monokai Theme**
![Syntax Highlighting Monokai](/images/syntax-highlighting-monokai.png)
### In-line code
Create in-line monospaced code text by surrounding it with backticks ``<code>. Don't use single quotes </code><code>'</code>\`.
``` text
`monospace`
```
Renders as: `monospace`.
### In-line images
In-line images are images added within lines of text. You can control whether all in-line images over 100px in height are automatically collapsed or expanded in messages by setting a [user preference](/end-user-guide/preferences/manage-your-display-options), or by using the `/collapse` and `/expand` slash commands.
To add in-line images to text, use an exclamation mark `!` followed by the `alt text` in square brackets `[ ]`, then the `image URL` in round brackets `( )`. You can add hover text after the link by placing the text in quotes `" "`.
Example:
``` text
![alt text](URL of image "Hover text")
```
If the height of the original image is more than 500 pixels, Mattermost sets the image height at 500 pixels and adjusts the width to maintain the original aspect ratio.
You can set the width and height of the displayed image after the URL of the image by using an equals sign `=` followed by values for both width and height `##x##`. If you set only the width, Mattermost adjusts the height to maintain the original aspect ratio.
<Warning>
The native apps do not support fixed width and height and will display the full-size image.
</Warning>
Examples:
``` text
.. |mattermost-icon-76x76| image:: ../images/icon-76x76.png
.. |mattermost-icon-50x76| image:: ../images/icon-50x76.png
```
#### In-line image with hover text
``` text
![Mattermost](/images/icon-76x76.png "Mattermost Icon")
```
Renders as:
> ![Mattermost](/images/icon-76x76.png)
#### In-line image with link
<Note>
An extra set of square brackets `[ ]` is required around the alt text, and round brackets `( )` are required around the image link.
</Note>
``` text
[![Mattermost](/images/icon-76x76.png)](https://github.com/mattermost/mattermost)
```
Renders as:
> [![image](/images/icon-76x76.png)](https://github.com/mattermost/mattermost)
#### In-line image displayed with fixed width and height
Example: An in-line image that's 50 pixels wide and 76 pixels high.
``` text
![Mattermost](/images/icon-76x76.png =50x76 "Mattermost Icon")
```
Renders as:
> <img src={useBaseUrl('/images/icon-50x76.png')} id="Mattermost Icon" alt="Mattermost" />
#### In-line image displayed with fixed width
Example: An in-line image that's 50 pixels wide where the system adjusts the height to maintain the original aspect ratio.
``` text
![Mattermost](/images/icon-76x76.png =50 "Mattermost Icon")
```
Renders as:
> <img src={useBaseUrl('/images/icon-76x76.png')} width="50" alt="Mattermost" />
### Horizontal lines
Create a line by using three `*`, `_`, or `-`.
`***`
Renders as:
------------------------------------------------------------------------------------------------------------------------
### Block quotes
Create block quotes using `>`.
`> block quotes` renders as:
![image](/images/blockQuotes.png)
### Tables
Create a table by placing a dashed line `---` under the header row, then separating each column with using pipes `|`. The columns don’t need to line up exactly. Choose how to align table columns by including colons `:` within the header row.
``` text
| Left-Aligned | Center Aligned | Right Aligned |
| :------------ |:---------------:| -----:|
| Left column 1 | this text | $100 |
| Left column 2 | is | $10 |
| Left column 3 | centered | $1 |
```
Renders as:
![Markdown Table Sample](/images/markdownTable1.png)
<Note>
Multi-line text in a table cell isn't supported using HTML tags such as `<br />` or `<br/>`.
</Note>
### Math Formulas
<Tabs>
<TabItem value="using-inline-latex" label="Using Inline LaTeX">
You can create formulas that display inline using LaTeX. Use the dollar sign ($) symbol at the beginning and end of each formula.
<Note>
This feature is [disabled by default](/administration-guide/configure/site-configuration-settings#enable-inline-latex-rendering). Contact your system admin to enable this setting in **System Console \> Site Configuration \> Posts** to use this feature.
</Note>
``` text
$X_k = \sum_{n=0}^{2N-1} x_n \cos \left[\frac{\pi}{N} \left(n+\frac{1}{2}+\frac{N}{2}\right) \left(k+\frac{1}{2}\right) \right]$
```
Renders as:
![An inline LaTeX math equation sample.](/images/latex-inline.png)
</TabItem>
<TabItem value="using-latex-in-code-blocks" label="Using LaTeX in Code Blocks">
Create formulas as code blocks by using LaTeX in a `latex` [code blocks](#code-blocks).
<Note>
This feature is [disabled by default](/administration-guide/configure/site-configuration-settings#enable-latex-code-block-rendering). Contact your system admin to enable this setting in **System Console \> Site Configuration \> Posts** to use this feature.
</Note>
```` text
```latex
X_k = \sum_{n=0}^{2N-1} x_n \cos \left[\frac{\pi}{N} \left(n+\frac{1}{2}+\frac{N}{2}\right) \left(k+\frac{1}{2}\right) \right]
```
````
Renders as:
![A LaTeX code block math equation sample.](/images/latex-codeblock.png)
</TabItem>
</Tabs>
<PlanAvailability slug="academy-message-formatting" />

View File

@@ -0,0 +1,32 @@
---
title: "Forward messages"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
From Mattermost v7.2, using a web browser or the desktop app, you can forward messages in public channels to other public channels. From Mattermost v7.5, you can also forward messages from bots and webhooks.
<Note>
Private channels, direct messages, and group messages intended for specific people can't be forwarded.
</Note>
To forward a message:
1. Select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a message, then select **Forward**.
> ![You can forward messages to others using the More option.](/images/forward-message.png)
2. Specify where you want to forward the message, and include an optional comment.
Forwarding a message also generates a preview of the message.
![Mattermost generates previews of links shared in Channels.](/images/permalink-previews.png)
<Note>
Previews respect channel membership permissions, so they’re only visible to users who have access to the original message. If the link is to a message in a public channel, any member of the team can see the message preview. If the link is to a message in a private channel or direct message, only members in that channel can see the message preview.
</Note>

View File

@@ -0,0 +1,60 @@
---
title: "Invite people to your workspace"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
Anyone can invite people to Mattermost teams and channels, unless your system admin has [disabled](/administration-guide/onboard/advanced-permissions) your ability to do so.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Select the team name at the top of the channel sidebar, and then select **Invite People**.
> ![Select the team name in the sidebar and select Invite People.](/images/invite-people.png)
2. Choose how to invite people:
> - **Copy invite link**: Share an invitation link with others using apps on your mobile device.
> - **Invite as member**: Send an invitation by email to people who don't have an account on your Mattermost workspace by specifying their email address and selecting **Invite**.
> - **Add existing users**: Add existing workspace users as members of the current team by specifying their username and selecting **Invite**.
> - **Invite as guest**: Invite a guest temporarily with limited workspace access. Specify their email address, select the channels they can access, and optionally add a custom message. See the [guest accounts](/administration-guide/onboard/guest-accounts) documentation to learn more about guest accounts.
> - **Use magic link**: Invite guests to log in without a password using a magic link when [enabled by your system admin](/administration-guide/onboard/guest-accounts#configure-magic-links-for-guests). See the [magic link login for guests](/end-user-guide/access/access-your-workspace#magic-link-login-for-guests) documentation for login details.
>
> ![You can invite users through the web or desktop app in a number of ways.](/images/web-desktop-invite-people-to-the-team.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap the <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> icon in the top right corner of the screen and tap **Invite people to the team**.
> ![When you select +, you can access more options from the popup window.](/images/mobile-invite-people-to-the-team.png)
2. Choose how to invite people:
> - **Share link**: Share an invitation link with others using apps on your mobile device.
> - **Invite as member**: Send an invitation by email to people who don't have an account on your Mattermost workspace by specifying their email address and tap **Send**.
> - **Add existing users**: Add existing workspace users as members of the current team by specifying their username and tap **Send**.
> - **Invite as guest**: Invite a guest temporarily with limited workspace access. See the [guest accounts](/administration-guide/onboard/guest-accounts) documentation to learn more about guest accounts. Specify their email address, select the channels they can access, and optionally add a custom message. Tap **Send** when ready.
> - **Use magic link**: Invite guests to log in without a password using a magic link when [enabled by your system admin](/administration-guide/onboard/guest-accounts#configure-magic-links-for-guests). See the [magic link login for guests](/end-user-guide/access/access-your-workspace#magic-link-login-for-guests) documentation for login details.
>
> ![You can invite users through the mobile app in a number of ways.](/images/mobile-send-invite-to.png)
</TabItem>
</Tabs>
<Note>
- Can't share invitation links? Contact your Mattermost system admin for assistance. An [SSL certificate (or a self-signed certificate)](/administration-guide/onboard/ssl-client-certificate) may be required for link-based invitations to work.
- When inviting guests, you must select at least one channel they can access. Guests are limited to the channels you specify and cannot discover other channels.
- An invite link can be used by anyone and doesn’t change unless it’s re-generated or revoked by a system admin or team admin via **Team Settings \> Access \> Invite Code**.
- Your system admin must [enable email invitations](/administration-guide/configure/authentication-configuration-settings#enable-email-invitations) and configure [email](/administration-guide/configure/environment-configuration-settings#smtp) for Mattermost to send email-based invitations.
- Invitation links sent by email expire after 48 hours and can only be used once.
- When profile fields are managed by your system admin, email invitations may include fields to preset the invitee's name and username. These values are applied during signup and become admin-managed.
- Your system admin can [cancel all email invitations](/administration-guide/configure/authentication-configuration-settings#invalidate-pending-email-invites) that haven't yet been accepted within the System Console.
</Note>

View File

@@ -0,0 +1,118 @@
---
title: "Join and leave channels"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
## Join a channel
Channels are either **public** or **private**.
- **Public** channels are identified with a **Globe** <img src={useBaseUrl('/img/ui/globe_E805.svg')} alt="Public channels are identified with a Globe icon." className="theme-icon" /> icon. Anyone on the team can join a public channel.
- **Private** channels are typically used for sensitive topics, and are identified with a **Lock** <img src={useBaseUrl('/img/ui/lock-outline_F0341.svg')} alt="Private channels are identified with a Lock icon." className="theme-icon" /> icon. You must be invited to private channels by another channel member.
<Note>
To join a private channel, you need to be added to the channel by a member of that channel.
</Note>
To join a public channel:
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Select the **Add channels** button in the channel sidebar, then select **Browse Channels**.
> <img src={useBaseUrl('/images/add-channels-button.png')} width="400" alt="You can browse channels using the Add channels button" />
>
> Alternatively, you can select <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> at the top of the channel sidebar, then select **Browse Channels**.
>
> ![You can browse available channels to join using the + option at the top of the channel sidebar.](/images/browse-channels.png)
2. Select **Join** next to the public channel you want to join.
> ![When browsing available channels, select the join option next to any channel to become a member.](/images/join-channels.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> located in the top right corner the app.
![Tap the plus icon to view additional options.](/images/mobile-select-a-channel.jpg)
2. Tap **Browse Channels**.
![Click on Browse Channels to view the list of public channels.](/images/create-channel-or-open-direct-message-on-mobile.jpg)
3. Tap the public channel you want to join.
![Tap on the public channel name that you want to join.](/images/mobile-browse-public-channels.jpg)
</TabItem>
</Tabs>
<Tip>
When you join channels, depending on the [channel actions configured](/end-user-guide/collaborate/create-channels), you may see a welcome message, and channels may be added to [a category in your channel sidebar](/end-user-guide/preferences/customize-your-channel-sidebar) automatically. Using Mattermost in a web browser or the desktop app, access **Channel Actions** from the channel name drop-down menu in the center pane to see what automatic actions have been configured.
</Tip>
See the following documentation to learn more about working with channels:
- [Create channels](/end-user-guide/collaborate/create-channels)
- [Browse channels](/end-user-guide/collaborate/browse-channels)
- [Customize your channel sidebar](/end-user-guide/preferences/customize-your-channel-sidebar)
## Leave a channel
When you leave a private channel, you must be re-added by another channel member to rejoin. You won't receive mention notifications from a channel if you're not a member of that channel.
<Note>
All users are added to the **Town Square** channel automatically. This means that users can't [archive](/end-user-guide/collaborate/archive-unarchive-channels#archive-a-channel), [unarchive](/end-user-guide/collaborate/archive-unarchive-channels#unarchive-a-channel), or leave the **Town Square** channel. However, [guests](/administration-guide/onboard/guest-accounts) who are manually invited to **Town Square** can leave the channel.
</Note>
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select the channel name at the top of the center pane to access the drop-down menu, then select **Leave Channel**.
![You can use channel options available from the channel name to leave a channel.](/images/leave-channels.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap the channel you want to leave.
![Select the channel that you want to leave.](/images/mobile-select-a-channel.jpg)
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
![Tap on More options to access available options for the channel you want to leave.](/images/mobile-select-more-options-for-a-channel.jpg)
3. Tap **Leave channel**.
![Tap on Leave channel to leave the current channel.](/images/mobile-select-view-info-for-a-channel.jpg)
4. Tap on **Leave** to confirm you choice.
![Tap on Leave to confirm your choice.](/images/mobile-confirm-leave-a-channel.jpg)
</TabItem>
</Tabs>
### Leave a public channel added by a membership policy
From Mattermost v11.8.0, when you leave a public channel you were added to by a membership policy, Mattermost asks you to confirm:
- Choosing **Leave channel** removes you from the channel.
- Choosing **Mute instead** keeps you in the channel and mutes its notifications.
If the channel is already muted, Mattermost shows **Cancel** and **Leave channel** instead of **Mute instead**.

View File

@@ -0,0 +1,88 @@
---
title: "Keyboard accessibility"
---
<PlanAvailability slug="all-commercial" />
Navigational keyboard shortcuts help you use Mattermost in a web browser or the desktop app without needing a mouse. Below is a list of supported accessibility shortcuts.
<table>
<colgroup>
<col style={{width: '40%'}} />
<col style={{width: '60%'}} />
</colgroup>
<thead>
<tr>
<th>Keyboard shortcut</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Desktop App: <kbd>F6</kbd><br/>Browser: <kbd>Ctrl</kbd> <kbd>F6</kbd></td>
<td>Move focus to the next section</td>
</tr>
<tr>
<td>Desktop App: <kbd>Shift</kbd> <kbd>F6</kbd><br/>Browser: <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>F6</kbd></td>
<td>Move focus to the previous section</td>
</tr>
<tr>
<td><kbd>Tab</kbd></td>
<td>Move focus to the next element</td>
</tr>
<tr>
<td><kbd>Shift</kbd> <kbd>Tab</kbd></td>
<td>Move focus to the previous element</td>
</tr>
<tr>
<td><kbd>↑</kbd> or <kbd>↓</kbd></td>
<td>Move focus between messages in the post list or sections in the channel sidebar</td>
</tr>
<tr>
<td><kbd>Enter</kbd></td>
<td>Take action on the focused element</td>
</tr>
</tbody>
</table>
## Region navigation
Mattermost has eight regions that can be focused for navigation. Use <kbd>F6</kbd> in the desktop app, or use <kbd>Ctrl</kbd> <kbd>F6</kbd> in a browser repeatedly to move focus and loop through the regions in this order:
1. Message list region
2. Message input region
3. Right-hand side message list region
4. Right-hand side message input region
5. Team menu region
6. Channel sidebar region
7. Channel header region
8. Search
![Navigate through the sections of Mattermost using a keyboard.](/images/navigation.gif)
## Message navigation
When the message list region is focused, use the <kbd>↑</kbd> or <kbd>↓</kbd> arrow keys to navigate through messages and reply threads. Press <kbd>Tab</kbd> to navigate through message actions.
![Navigate through Mattermost messages using a keyboard.](/images/message-navigation.gif)
### Message composition
Mattermost is compatible with most popular screen readers, such as [Apple VoiceOver](https://www.apple.com/ca/accessibility/vision/) or [JAWS for Windows](https://www.freedomscientific.com/products/software/jaws/). A custom readout is composed for each message by combining the message elements and reading them together in full sentences. Message elements will read in the following order:
1. Header: Author, timestamp, message type (i.e. parent post or reply)
2. Main Content: The message content typed by the author
3. Attachments: The number of attachments (if applicable)
4. Emoji Reactions: The number of unique emoji reactions (if applicable)
5. Saves/Pins: If a message is saved or pinned (if applicable)
For example, a message read by a screen reader may sound like the following:
``` text
Eric Sethna at 12:57pm Thursday June 13th wrote a reply "Thanks for the review", 3 attachments, 2 reactions, message is saved and pinned.
```
## Channel sidebar navigation
When the channel sidebar region is focused, use the <kbd>↑</kbd> or <kbd>↓</kbd> arrow keys to focus individual sidebar sections, such as Insights, Threads, Favorites, custom categories, public channels, private channels, and direct messages. Press <kbd>Tab</kbd> to navigate through channels or other buttons within a sidebar section.
![Navigate the Mattermost channel sidebar using a keyboard.](/images/channel-sidebar-navigation.gif)

View File

@@ -0,0 +1,506 @@
---
title: "Mattermost keyboard shortcuts"
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
Mattermost keyboard shortcuts help you make a more efficient use of your keyboard when using Mattermost in a web browser or the desktop app.
<Tip>
- More keyboard shortcuts are available. See the [team keyboard shortcuts](/end-user-guide/collaborate/team-keyboard-shortcuts) and [text style](/end-user-guide/collaborate/format-messages#text-style) documentation for details.
- In Mattermost, display a list of available keyboard shortcuts by pressing <kbd>Ctrl</kbd> <kbd>/</kbd> on Windows or Linux, pressing <kbd>⌘</kbd> <kbd>/</kbd> on macOS, or using the `/shortcuts` slash command.
![Review a list of available keyboard shortcuts by using the \`\`/shortcuts\`\` slash command.](/images/keyboard-shortcuts.png)
</Tip>
## Channel navigation
The following keyboard shortcuts for channels are supported in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app.
<table>
<thead>
<tr>
<th>On Windows &amp; Linux</th>
<th>On Mac</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><kbd>Alt</kbd> <kbd>↑</kbd></td>
<td><kbd>⌥</kbd> <kbd>↑</kbd></td>
<td>Previous channel or direct message in the channel sidebar.</td>
</tr>
<tr>
<td><kbd>Alt</kbd> <kbd>↓</kbd></td>
<td><kbd>⌥</kbd> <kbd>↓</kbd></td>
<td>Next channel or direct message in the channel sidebar.</td>
</tr>
<tr>
<td><kbd>Alt</kbd> <kbd>Shift</kbd> <kbd>↑</kbd></td>
<td><kbd>⌥</kbd> <kbd>⇧</kbd> <kbd>↑</kbd></td>
<td>Previous channel or direct message in the channel sidebar with unread messages.</td>
</tr>
<tr>
<td><kbd>Alt</kbd> <kbd>Shift</kbd> <kbd>↓</kbd></td>
<td><kbd>⌥</kbd> <kbd>⇧</kbd> <kbd>↓</kbd></td>
<td>Next channel or direct message in the channel sidebar with unread messages.</td>
</tr>
<tr>
<td><kbd>Alt</kbd> + select channel</td>
<td><kbd>⌥</kbd> + select channel</td>
<td>Mark the last post in the channel as unread.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>K</kbd></td>
<td><kbd>⌘</kbd> <kbd>K</kbd></td>
<td><ul><li>If text isn't selected: Open the <strong>Find Channels</strong> dialog.</li><li>If text is selected: Create a hyperlink in the format <code>&#91;linktext&#93;(URL)</code>.</li></ul></td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>K</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>K</kbd></td>
<td>Open the <strong>Direct Messages</strong> dialog.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>A</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>A</kbd></td>
<td>Open the <strong>Settings</strong> dialog.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>M</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>M</kbd></td>
<td>Open recent mentions.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>L</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>L</kbd></td>
<td>Set focus to center channel input field.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>.</kbd></td>
<td><kbd>⌘</kbd> <kbd>.</kbd></td>
<td>Open or close the right-hand sidebar.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>.</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>.</kbd></td>
<td>Expand or shrink the width of the open right-hand sidebar.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>F</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>F</kbd></td>
<td>Move focus to the <strong>Search</strong> field and search the current channel.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>U</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>U</kbd></td>
<td>Find unread channels or search through all channels.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>I</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>I</kbd></td>
<td>Open or close <strong>Channel Info</strong> details in the right-hand sidebar.</td>
</tr>
</tbody>
</table>
## File uploads
The following keyboard shortcuts are supported in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app.
<table>
<thead>
<tr>
<th>On Windows &amp; Linux</th>
<th>On Mac</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><kbd>Ctrl</kbd> <kbd>U</kbd></td>
<td><kbd>⌘</kbd> <kbd>U</kbd></td>
<td>Upload a file.</td>
</tr>
</tbody>
</table>
## Messages
The following keyboard shortcuts are supported in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app.
<table>
<thead>
<tr>
<th>On Windows &amp; Linux</th>
<th>On Mac</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><kbd>Ctrl</kbd> <kbd>↑</kbd> (in empty input field)</td>
<td><kbd>⌘</kbd> <kbd>↑</kbd> (in empty input field)</td>
<td>Reprint previous message or slash command you entered.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>↓</kbd> (in empty input field)</td>
<td><kbd>⌘</kbd> <kbd>↓</kbd> (in empty input field)</td>
<td>Reprint next message or slash command you entered.</td>
</tr>
<tr>
<td><kbd>Shift</kbd> <kbd>↑</kbd> (in empty input field)</td>
<td><kbd>⇧</kbd> <kbd>↑</kbd> (in empty input field)</td>
<td>Reply to the most recent message in the current channel.</td>
</tr>
<tr>
<td><kbd>↑</kbd> (in empty input field)</td>
<td><kbd>↑</kbd> (in empty input field)</td>
<td>Edit your last message in the current channel.</td>
</tr>
<tr>
<td><kbd>@[character]</kbd> <kbd>Tab</kbd></td>
<td><kbd>@[character]</kbd> <kbd>Tab</kbd></td>
<td>Autocomplete @username beginning with [character].</td>
</tr>
<tr>
<td><kbd>&#126;[character]</kbd> <kbd>Tab</kbd></td>
<td><kbd>&#126;[character]</kbd> <kbd>Tab</kbd></td>
<td>Autocomplete channel beginning with [character].</td>
</tr>
<tr>
<td><kbd>:[character]</kbd> <kbd>Tab</kbd></td>
<td><kbd>:[character]</kbd> <kbd>Tab</kbd></td>
<td>Autocomplete emoji beginning with [character].</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>&#92;</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>&#92;</kbd></td>
<td>React to last message in channel or thread.</td>
</tr>
</tbody>
</table>
## Message formatting
The following keyboard shortcuts are supported in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app.
<table>
<thead>
<tr>
<th>On Windows &amp; Linux</th>
<th>On Mac</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><kbd>Ctrl</kbd> <kbd>B</kbd></td>
<td><kbd>⌘</kbd> <kbd>B</kbd></td>
<td>Bold text.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>I</kbd></td>
<td><kbd>⌘</kbd> <kbd>I</kbd></td>
<td>Italicize text.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Alt</kbd> <kbd>K</kbd></td>
<td><kbd>⌘</kbd> <kbd>⌥</kbd> <kbd>K</kbd></td>
<td>Format text as a link.</td>
</tr>
</tbody>
</table>
## Accessibility nagivation
The following keyboard shortcuts work in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app.
<table>
<thead>
<tr>
<th>On Windows &amp; Linux</th>
<th>On Mac</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><kbd>Alt</kbd> <kbd>←</kbd></td>
<td><kbd>⌘</kbd> <kbd>[</kbd></td>
<td>Go to the previous channel in your history.</td>
</tr>
<tr>
<td><kbd>Alt</kbd> <kbd>→</kbd></td>
<td><kbd>⌘</kbd> <kbd>]</kbd></td>
<td>Go to the next channel in your history.</td>
</tr>
<tr>
<td><kbd>Shift</kbd> <kbd>↑</kbd> (in input field)</td>
<td><kbd>⇧</kbd> <kbd>↑</kbd> (in input field)</td>
<td>Highlight text to the previous line.</td>
</tr>
<tr>
<td><kbd>Shift</kbd> <kbd>↓</kbd> (in input field)</td>
<td><kbd>⇧</kbd> <kbd>↓</kbd> (in input field)</td>
<td>Highlight text to the next line.</td>
</tr>
<tr>
<td><kbd>Shift</kbd> <kbd>Enter</kbd> (in input field)</td>
<td><kbd>⇧</kbd> <kbd>Enter</kbd> (in input field)</td>
<td>Create a new line.</td>
</tr>
</tbody>
</table>
<Note>
Though Mattermost keyboard shortcuts support standard languages and keyboard layouts, they may not work if you use keymapping that overwrites default browser shortcuts.
</Note>
## Calls
The following keyboard shortcuts are supported in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app when [calls](/end-user-guide/collaborate/make-calls) are enabled.
<table>
<thead>
<tr>
<th>On Windows &amp; Linux</th>
<th>On Mac</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Alt</kbd> <kbd>S</kbd></td>
<td><kbd>⌘</kbd> <kbd>⌥</kbd> <kbd>S</kbd></td>
<td>Start or join call in current channel.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>Space</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>Space</kbd></td>
<td>Mute or unmute.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>Y</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>Y</kbd></td>
<td>Raise or lower hand.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>E</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>E</kbd></td>
<td>Share or unshare screen.</td>
</tr>
<tr>
<td><kbd>Alt</kbd> <kbd>P</kbd> or <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>P</kbd></td>
<td><kbd>⌥</kbd> <kbd>P</kbd> or <kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>P</kbd></td>
<td>Show or hide participants list.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>L</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>L</kbd></td>
<td>Leave current call.</td>
</tr>
<tr>
<td><kbd>Space</kbd></td>
<td><kbd>Space</kbd></td>
<td>Hold to unmute (push to talk) <code>Note</code>: works in the expanded view/popout window only.</td>
</tr>
</tbody>
</table>
## Navigation in the desktop app
The following navigation keyboard shortcuts are supported only in the Mattermost desktop app.
<Tabs>
<TabItem value="desktop-app-v6-x" label="Desktop app v6.x">
Mattermost desktop app v6.0 introduces the ability to keep multiple workspaces open at the same time and work across them without constant switching contexts. The following keyboard shortcuts help you navigate multiple views:
<table>
<thead>
<tr>
<th>On Windows &amp; Linux</th>
<th>On macOS</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><kbd>Ctrl</kbd> <kbd>N</kbd></td>
<td><kbd>⌘</kbd> <kbd>N</kbd></td>
<td>Open a new window for the current server</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>T</kbd></td>
<td><kbd>⌘</kbd> <kbd>T</kbd></td>
<td>Open a new tab for the current server</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Tab</kbd></td>
<td><kbd>⌘</kbd> <kbd>Tab</kbd></td>
<td>Go to the next tab</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>Tab</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>Tab</kbd></td>
<td>Go to the previous tab</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>1-9</kbd></td>
<td><kbd>⌘</kbd> <kbd>1-9</kbd></td>
<td>Jump to a specific tab based on its position</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>W</kbd></td>
<td><kbd>⌘</kbd> <kbd>W</kbd></td>
<td>Close current tab when multiple tabs are open</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>W</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>W</kbd></td>
<td>Close main window</td>
</tr>
</tbody>
</table>
</TabItem>
<TabItem value="desktop-app-v5-x" label="Desktop app v5.x">
Mattermost desktop app v5.0 introduces additional ways to navigate your Mattermost interface, including server selections, as well as tabs for channels, collaborative playbooks, and boards.
<table>
<thead>
<tr>
<th>On Windows &amp; Linux</th>
<th>On macOS</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><kbd>Ctrl</kbd> <kbd>F</kbd></td>
<td><kbd>⌘</kbd> <kbd>F</kbd></td>
<td>Move focus to the <strong>Search</strong> field and search the current channel.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>S</kbd></td>
<td><kbd>⌘</kbd> <kbd>⌃</kbd> <kbd>S</kbd></td>
<td>Open the <strong>Servers</strong> selector, press <kbd>↑</kbd> or <kbd>↓</kbd> to navigate between servers, then press <kbd>Enter</kbd> on Windows or Linux, or <kbd>↵</kbd> on macOS, to select a server.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>1</kbd><br/><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>2</kbd></td>
<td><kbd>⌘</kbd> <kbd>⌃</kbd> <kbd>1</kbd><br/><kbd>⌘</kbd> <kbd>⌃</kbd> <kbd>2</kbd></td>
<td>Navigate to the first server in the <strong>Servers</strong> list.<br/>Replace the number with the server's position within the server in the list.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Tab</kbd></td>
<td><kbd>⌘</kbd> <kbd>Tab</kbd></td>
<td>Navigate to the next product tab based on the current product selected.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>Tab</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>Tab</kbd></td>
<td>Navigate to the previous product tab based on the current product selected.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>1</kbd></td>
<td><kbd>⌘</kbd> <kbd>1</kbd></td>
<td>Navigate to the <strong>Channels</strong> tab.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>2</kbd></td>
<td><kbd>⌘</kbd> <kbd>2</kbd></td>
<td>Navigate to the <strong>Boards</strong> tab.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>3</kbd></td>
<td><kbd>⌘</kbd> <kbd>3</kbd></td>
<td>Navigate to the <strong>Playbooks</strong> tab.</td>
</tr>
</tbody>
</table>
</TabItem>
<TabItem value="desktop-app-v4-7-and-earlier" label="Desktop app v4.7 and earlier">
Mattermost desktop app v4.7 and earlier releases support the following navigation keyboard shortcuts:
<table>
<thead>
<tr>
<th>On Windows &amp; Linux</th>
<th>On macOS</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><kbd>Ctrl</kbd> <kbd>F</kbd></td>
<td><kbd>⌘</kbd> <kbd>F</kbd></td>
<td>Move focus to the <strong>Search</strong> field and search the current channel.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>1</kbd><br/><kbd>Ctrl</kbd> <kbd>2</kbd><br/><kbd>Ctrl</kbd> <kbd>3</kbd></td>
<td><kbd>⌘</kbd> <kbd>1</kbd><br/><kbd>⌘</kbd> <kbd>2</kbd><br/><kbd>⌘</kbd> <kbd>3</kbd></td>
<td>Navigate to the first server in the <strong>Servers</strong> list.<br/>Replace the number with the server's tab position.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Tab</kbd></td>
<td><kbd>⌘</kbd> <kbd>Tab</kbd></td>
<td>Navigate to the next server tab based on the current server selected.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>Tab</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>Tab</kbd></td>
<td>Navigate to the previous server tab based on the current server selected.</td>
</tr>
<tr>
<td><kbd>Alt</kbd> <kbd>↓</kbd></td>
<td><kbd>⌥</kbd> <kbd>↓</kbd></td>
<td>Next channel or direct message in the channel sidebar.</td>
</tr>
</tbody>
</table>
</TabItem>
</Tabs>
## Zoom in & zoom out display
The following display keyboard shortcuts work in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app.
<table>
<thead>
<tr>
<th>On Windows &amp; Linux</th>
<th>On macOS</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>+</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>+</kbd></td>
<td>Increase font size (zoom in).</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>-</kbd></td>
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>-</kbd></td>
<td>Decrease font size (zoom out).</td>
</tr>
</tbody>
</table>
<Note>
Though Mattermost keyboard shortcuts support standard languages and keyboard layouts, they may not work if you use keymapping that overwrites default browser shortcuts.
</Note>

View File

@@ -0,0 +1,82 @@
---
title: "Learn about Mattermost roles"
---
<PlanAvailability slug="all-commercial" />
There are 6 types of user roles with different permission levels in Mattermost: [system admin](#system-admin), [team admin](#team-admin), [channel admin](#channel-admin), [member](#member), [guest](#guest), and [deactivated](#deactivated).
<Tip>
To view a list of users on the team and what their roles are, you need to be A team admin using Mattermost in a web browser or the desktop app. Open the Team menu and select **Manage Members**.
</Tip>
## System admin
The first user added to a newly-installed Mattermost system is assigned the system admin role. System admins are allowed to perform any actions on the system, and only a system admin can make changes to another system admin user account in Mattermost.
The system admin is typically a member of the IT staff and has all the privileges of a team admin, along with the following additional privileges:
- Access to the System Console in any team site.
- Ability to change any setting on the Mattermost server available in the System Console.
- Ability to promote and demote other users from Member role to system admin role (and vice versa).
- Ability to promote and demote other users to and from Guest role.
- Ability to deactivate user accounts and to reactivate them.
- Access to private channels, but only if given the link to the private channel.
A system admin can view and manage users in **System Console \> User Management \> Users**. They can search users by name, filter users by teams, and filter to view other system admins, guests, as well as activated and deactivated users.
### Grant personal access tokens
System admin also can enable [personal access tokens](https://developers.mattermost.com/integrate/admin-guide/admin-personal-access-token/) for user accounts. This gives specific users permissions to create personal access tokens via **System Console \> Users**.
In addition, a system admin can optionally set the following permissions for the account, which are useful for integrations and bot accounts:
- **post:all**: Allows the account to post to all Mattermost channels including direct messages.
- **post:channels**: Allows the account to post to all Mattermost public channels.
## Team admin
When a team is first created, the person who set it up is made a team admin. It is a team-specific role, meaning that someone can be a team admin for one team but only a member on another team. Team admins have the following privileges:
- Access to the **Team Settings** menu.
- Ability to change the team name and import data from Slack export files.
- Access to the **Manage Members** menu, where they can control whether team members are a **Member** or a **Team Admin**.
- Ability to manage all aspects of a team, such as joining and managing private channels they're not a member of.
- Ability to create and manage [attribute-based channel membership policies](/administration-guide/manage/admin/abac-team-channel-policies) for channels within the team, from the **Channel Membership** tab in Team Settings, when ABAC is enabled by a System Admin (Enterprise Advanced).
- From Mattermost v11.10, ability to define [attribute-based team membership rules](/administration-guide/manage/admin/abac-team-membership) that control who can be a member of the team itself, from the **Team Membership** tab in Team Settings, when ABAC is enabled by a System Admin (Enterprise Advanced).
## Channel admin
The person who creates a channel is assigned the channel admin role for that channel. People with the channel admin role have the following privileges:
- Ability to assign the channel admin role to other members of the channel.
- Ability to remove the channel admin role from other holders of the channel admin role.
- Ability to remove members from the channel.
- Ability to configure channel actions that automate tasks based on trigger conditions, such as [joining a channel](/end-user-guide/collaborate/join-leave-channels#join-a-channel) or [sending a message](/end-user-guide/collaborate/send-messages) in a channel.
Depending on your system configuration, channel admins can be granted special permissions by the system admin to rename and delete channels.
## Member
This is the default role given to users when they join a team. Members have basic permissions on a Mattermost team. See the [advanced permissions backend infrastructure](/administration-guide/onboard/advanced-permissions-backend-infrastructure) documentation for details.
## Guest
A guest is a role with restricted permissions. Guests enable organizations to collaborate with users outside of their organization, and control what channels they are in and who they can collaborate with. See the [guest accounts](/administration-guide/onboard/guest-accounts) documentation for details on working with guest accounts.
## Deactivated
A system admin can deactivate user accounts via **System Console \> Users**. A list of all users on the server can be searched and filtered to make finding users easier. Select the user's role and in the menu that opens, then select **Deactivate**. See the [deactivate user accounts admin](/administration-guide/configure/user-management-configuration-settings#deactivate-users) documentation for details.
When **Deactivate** is selected, the user is logged out of the system, and receives an error message if they try to log back in. The user no longer appears in channel member lists, and they are removed from the team members list. A deactivated account can also be reactivated from the System Console, in which case the user rejoins channels and teams that they previously belonged to.
Direct message channels with deactivated users are hidden in users' sidebars, but can be reopened using the **More...** button or by pressing <kbd>Ctrl</kbd> <kbd>K</kbd> on Windows or Linux, or <kbd>⌘</kbd> <kbd>K</kbd> on Mac.
Mattermost is designed as a system-of-record, so there isn't an option to delete users from the Mattermost system, as such an operation could compromise the integrity of message archives.
<Note>
AD/LDAP user accounts can't be deactivated from Mattermost; they must be deactivated from your Active Directory.
</Note>

View File

@@ -0,0 +1,368 @@
---
title: "Make calls"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
Using a web browser, the desktop app, or the mobile app, you can [join a call](#join-a-call) or [start a call](#start-a-call), [share your screen](#share-your-screen), raise your hand, [react using emojis](#react-using-emojis) during a call, [chat in a thread](#chat-in-a-call), and continue working in Mattermost during a call.
<Note>
- All Mattermost customers can start, join, and participate in 1:1 audio calls with optional screen sharing.
- For group calls up to 50 concurrent users, Mattermost Enterprise, Professional, or Mattermost Cloud is required.
- Enterprise customers can also [record calls](#record-a-call), enable [live text captions](/end-user-guide/collaborate/make-calls#live-captions-during-calls) during calls, and [transcribe recorded calls](#transcribe-recorded-calls). We recommend that Enterprise self-hosted customers looking for group calls beyond 50 concurrent users consider using the [dedicated RTCD service](/deployment-guide/calls/calls-deployment-guide).
- Mattermost Cloud users can start calling right out of the box. For Mattermost self-hosted deployments, System admins need to enable and configure the plugin [using the System Console](/administration-guide/configure/plugins-configuration-settings#calls).
</Note>
<PlanAvailability slug="academy-calls" />
## Join a call
To join a call, select **Join call** in a channel, group message, or direct message. Any active team member in a channel or message can join a call, whether it's a public or private channel, or a group or direct message.
<Tip>
- You can share a call's link to use in a meeting request or share with other people. The link is unique to each channel, and contains the channel's ID, so it doesn't change between calls. Use the `/call link` slash command to generate a shareable link. The call link is valid for long as the channel is active. When a channel is archived or deleted, the share link becomes invalid.
- If someone from outside of the organization wants to join a call, you need to provide them with a guest account, and add them to the channel. Users who are archived or not registered can't join a call.
</Tip>
From Mattermost v9.4:
- You can join the same call using a web browser, the desktop app, and the mobile app. You can mute, unmute, react, share your screen, and configure voice settings independently for each Mattermost client you're using. You'll appear multiple times as a call participant in the call widget when you join one call on multiple clients.
- You'll see incoming call notifications for direct and group messages when a new call is started. Multiple calls will result in multiple incoming call notifications. If you're already in a call, and you receive a new incoming call notification, Mattermost prompts you to **Join** the incoming call, or dismiss the notification.
## Start a call
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
To start a call, select **Start call** in the channel header. When you start a call, you become the call host by default. See the [host controls](#host-controls) section below for details on host controls available to ensure calls run smoothly.
<Tip>
- When you start a call in a channel, you're muted by default. In a direct or group message you're unmuted by default.
- You can move the call widget to a different area of your screen.
- Alternatively, you can start a call using the `/call start` slash command.
</Tip>
</TabItem>
<TabItem value="mobile" label="Mobile">
To start a call, go the channel info menu. Then tap **Start Call**.
![Tap on Start Call to start a call in the channel.](/images/mobile-start-a-call-in-a-channel.gif)
After starting the call, audio will come through the device's speaker or a Bluetooth device, if connected. On Android, audio output will automatically switch to a Bluetooth device if one is connected during a call. You can tap the **Speaker** icon to manually select the output device.
On iOS, audio will automatically come through a connected device. You can override this behavior by tapping the **Speaker** button. Audio will then come through the speaker. However, you cannot manually select an output device on iOS at this time.
</TabItem>
</Tabs>
## Host controls
From Mattermost v9.9, and Mattermost mobile v2.17, call host controls are available and include the ability to [transfer host duties](#transfer-host-duties), [remove call participants](#remove-call-participants), [stop a screen share](#stop-a-screen-share), [mute or unmute participants](#mute-participants), [lower raised hands](#lower-raised-hands), and [end the call for everyone](#end-the-call-for-everyone).
Host controls are available to call hosts and admins in both the call widget by selecting the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a participant's name, and in the expanded the call window as hosts hover over a call participant in the list.
### Transfer host duties
Transfer host duties to another call participant by accessing the host controls and selecting **Make host**. Once host duties are transferred to someone else, you can't access host controls unless they're transferred back to you. System admins can change the host at any time.
### Remove call participants
Remove a call participant from an active call by accessing the host controls and selecting **Remove from call**, then confirm by selecting **Yes, remove**. The call participant is notified that they've been removed from the call by the host.
### Stop a screen share
Stop a call participant's screen share by accessing the host controls and selecting **Stop screen share**.
### Mute participants
Invite muted participants to unmute their microphone by accessing the host controls and selecting **Ask to unmute**. The call particpant is prompted to decide whether unmute or stay muted.
You can mute the microphone of specific particpants by accessing the host controls and toggling the particpant's mute icon. Mute all call particpants by selecting **Mute all**.
### Lower raised hands
Lower a raised hand by accessing the host controls and selecting **Lower hand**. The participant is notified that their hand was lowered by the host.
### End the call for everyone
From Mattermost v10.2 and mobile v2.19, call hosts who choose to leave a call are prompted to confirm whether they want to leave or end the call for all participants.
## Share your screen
During a call, call participants can share their screen with other call participants, unless your system admin has [disabled your ability to do so](/administration-guide/configure/plugins-configuration-settings#allow-screen-sharing).
<Note>
Screensharing is available in the Mattermost desktop app or a web browser. The ability to screenshare using the mobile app isn't supported.
</Note>
To share your screen:
1. In the call widget, select **Start presenting**.
2. Select the screen you want to share.
3. To stop sharing, select the **Stop presenting** icon or the **Stop sharing** option.
### Share audio during screen sharing
From Mattermost Calls plugin v1.9.0, you can share audio along with your screen during screen sharing. To enable this feature, you must first turn on the **Share sound with screen** preference in your Calls settings by going to **Settings \> Plugin Preferences \> Calls**. This setting is stored locally on each client and is not synchronized across devices.
<Note>
Audio sharing support varies by platform and browser:
**Web browsers:**
- **Chrome-based browsers only** (Google Chrome, Chromium, Microsoft Edge): When sharing a browser tab, you'll have the option to include audio from that tab. On Windows only, you can also share system sounds when sharing the entire screen.
- **Other browsers**: Audio sharing is not supported.
**Desktop app:**
- **Windows and Linux**: System audio is shared when sharing the entire screen.
- **macOS**: Audio sharing is not supported due to system limitations.
</Note>
## React using emojis
All call participants can use emojis to react during a call.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Expand the call window using the arrows in the top-right of the call widget. From there, select the emoji icon to access frequently-used emojis or select additional emojis from the emoji picker.
</TabItem>
<TabItem value="mobile" label="Mobile">
Expand the call window using the arrows in the top-right of the active call banner. From there, select **React**.
![Tap on React to use emojis reactions during a call.](/images/mobile-react-using-emojis-in-a-call.gif)
</TabItem>
</Tabs>
## Chat in a call
A chat thread is created automatically for every new call.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Open the chat thread in the widget by selecting the **Gear** <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> icon, then select **Show chat thread**. Alternatively, expand the call window using the arrows in the top-right of the call widget. From there, select the chat icon to access the chat thread.
</TabItem>
<TabItem value="mobile" label="Mobile">
Expand the call window using the arrows in the top-right of the active call banner. Then select **More \> Call Thread**.
![Tap on Call Thread to chat while being in a call.](/images/mobile-chat-in-a-call.gif)
</TabItem>
</Tabs>
## Record a call
<PlanAvailability slug="ent-plus" />
From Mattermost v7.7, if you're the host of a meeting, you can record the call, unless your system admin has [disabled the host's ability to do so](/administration-guide/configure/plugins-configuration-settings#enable-call-recordings).
Call recordings include audio, any screen sharing during the call, and text transcriptions, when [enabled](/administration-guide/configure/plugins-configuration-settings#enable-call-transcriptions).
The default setting for a recording is 60 minutes, but your system admin may [change the recording duration](/administration-guide/configure/plugins-configuration-settings#maximum-call-recording-duration) as needed. You'll receive a reminder 10 minutes before the recording limit is reached. If your call is going to continue beyond the recording limit, allow the first recording to complete, then start a new recording immediately after.
When you stop recording, the recording file is posted in the call thread as an MP4 file attachment. It's available to all users in the channel both during the call, and after the call has ended.
To record a call:
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Select **Start call** in the header of the channel, group message, or direct message.
2. Select the pop-out icon.
3. In the call widget, select the **Record** button.
4. To stop recording, select the **Record** button again.
</TabItem>
<TabItem value="mobile" label="Mobile">
To start recording, use the `/call recording start` slash command. When you're finished recording, use the `/call recording stop` slash command.
![Use '/call recording start' to start recording a call](/images/mobile-start-a-call-recording-using-slash-commands.gif)
![Use '/call recording stop' to stop recording the call.](/images/mobile-stop-a-call-recording-using-slash-commands.gif)
Alternatively, expand the call window using the arrows in the top-right of the active call banner. Then select the **Record** button. To finish, tap on **Stop Recording** button.
![Tap on Record to start recording a call.](/images/mobile-start-a-call-recording-using-call-banner.gif)
![Tap on Stop Recording to stop recording the call.](/images/mobile-stop-a-call-recording-using-call-banner.gif)
</TabItem>
</Tabs>
## Live captions during calls
<PlanAvailability slug="ent-plus" />
From Mattermost v9.7, and Mattermost mobile app v.2.16, all call participants can display real-time text captions by selecting the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon and **Show live captions** when the call is being recorded, and when [live captions are enabled](/administration-guide/configure/plugins-configuration-settings#enable-live-captions). Live captions can be helpful in cases where noise is preventing you from hearing the audio of participants clearly.
By default, live captions display in English. Your Mattermost system admin can [specify a different language for live captions](/administration-guide/configure/plugins-configuration-settings#live-captions-language) in the System Console.
<Note>
- The ability to enable live captions during Mattermost calls is currently in [Beta](/administration-guide/manage/feature-labels#beta).
- Your system admin must enable [call recordings](/administration-guide/configure/plugins-configuration-settings#enable-call-recordings) to enable live captions.
</Note>
## Transcribe recorded calls
<PlanAvailability slug="ent-plus" />
From Mattermost v9.4, and Mattermost mobile app v.2.13, call recordings can include text captions, and a transcription text file can be generated, unless your system admin has [disabled the ability to transcribe call recordings](/administration-guide/configure/plugins-configuration-settings#enable-call-transcriptions).
When call recording stops, the transcription file is posted in the call thread as a TXT file attachment. It's available to all users in the channel both during the call, and after the call has ended. Additionally, users viewing the call recording can show or hide text captions using the Closed Captioning option in the video player.
<Note>
- The ability to enable recorded call transcriptions is currently in [Beta](/administration-guide/manage/feature-labels#beta).
- Your system admin must enable [call recordings](/administration-guide/configure/plugins-configuration-settings#enable-call-recordings) to enable recorded call transcriptions.
</Note>
## Frequently asked questions
### Can I set a ring tone for incoming calls?
Yes! From Mattermost v8.0 and Calls v0.17.0, desktop app and web users can go to **Settings \> Notifications \> Desktop Notifications** to enable Mattermost to alert you to incoming calls through direct or group messages with a specific ring tone and a desktop notification, unless the system admin has [disabled your ability to do so](/administration-guide/configure/plugins-configuration-settings#enable-call-ringing).
### Is video supported?
From Mattermost Calls plugin v1.12.0, experimental video support is available in direct message (DM) calls on the desktop and web apps. It's disabled by default; a system admin can enable it using the [Enable video calls in DMs (Experimental)](/administration-guide/configure/plugins-configuration-settings#enable-video-calls-in-dms-experimental) plugin setting in the System Console. The following limitations apply:
- Video is available in DM calls only. All other calls continue to support voice calling and screen sharing only.
- Video isn't available on the mobile app. Mobile users can't start a video call, and when they join a DM call that includes video, it behaves like an audio call — they hear voice and see shared screens, but don't see video.
- Call recordings don't capture video. Recordings include voice and screen sharing only.
### Can I password-protect a call?
No. Any member with sufficient permission to access the channel can join the call.
### Is there encryption?
Media (audio/video) is encrypted using security standards as part of WebRTC. It's mainly a combination of DTLS and SRTP. It's not e2e encrypted in the sense that in the current design all media needs to go through Mattermost which acts as a media router and has complete access to it. Media is then encrypted back to the clients so it's secured during transit. In short: only the participant clients and the Mattermost server have access to unencrypted call data.
### Are there any third-party services involved?
The only external service used is Mattermost official STUN server (`stun.global.calls.mattermost.com`) which is configured as default. This is primarily used to find the public address of the Mattermost server. The only information sent to this service is the IP addresses of clients connecting as no other traffic goes through it. It can be removed in the System Console if you want to provide an `ICE Host Override` setting instead.
## Troubleshooting
### My audio doesn't work when I join a call
If you can hear the other participants in the call but they can't hear you, select the Gear icon <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> next to the call end button in the widget. From there, you can check and change your audio output and microphone settings. Select <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> again to close the menu. Alternatively, you can [manage your audio and microphone preferences](/end-user-guide/preferences/manage-your-plugin-preferences) in **Settings**.
### My call is disconnected after a few seconds
This is usually a sign that the underlying UDP channel has not been established and the connection times out after ~10 seconds. When the connection has been established correctly an `rtc connected` line should appear in the client-side logs (JS console). There isn't a single solution as it depends on your infrastructure/deployment specifics. However, if you're a system or network admin, you may need to open up the UDP port or configure the network accordingly.
### I can't screen share using Mattermost desktop on macOS
There's a known bug on macOS with some versions of Chrome (which is used by Mattermost desktop). If you've given screen sharing permissions to Mattermost desktop, and are still unable to screen share, do the following:
1. Quit Mattermost.
2. Open Terminal.
3. In the terminal, run: `tccutil reset ScreenCapture Mattermost.Desktop`
4. Restart Mattermost and start a call.
5. Select **Screen share** and give it permissions again.
6. Restart Mattermost again.
If the issue persists please post on the Mattermost Community Server in the [Developer: Calls](https://community.mattermost.com/core/channels/developers-channel-call) channel to troubleshoot further.
## Debugging
If you experience issues with calls, collecting information is helpful as you can share it with us for debugging purposes.
As with any other issue, but more importantly with calls, it’s very useful to let us know the date and time that the problem occurred, with as much detail as possible so that information can be cross-checked with server logs. Also please include any reproduction steps if applicable. Other important information includes:
- Browser/app version
- Operating system type and version
### JS console logs
#### Web app
<table>
<colgroup>
<col style={{width: '13%'}} />
<col style={{width: '86%'}} />
</colgroup>
<thead>
<tr>
<th>Browser</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Chrome</strong></td>
<td>CMD+OPTION+J (macOS) CTRL+SHIFT+J (Windows, Linux, ChromeOS)</td>
</tr>
<tr>
<td><strong>Firefox</strong></td>
<td>CMD+SHIFT+J (macOS)/CTRL+SHIFT+J (Windows, Linux, ChromeOS)</td>
</tr>
<tr>
<td><strong>Safari</strong></td>
<td>Enable Developer Menu in <strong>Safari &gt; Preferences &gt; Advanced &gt; Show Develop Menu in Menu Bar</strong>. Then <strong>Develop &gt; Show Javascript Console</strong>. Right-click on the console and select <strong>Save to file</strong> to download the logs.</td>
</tr>
</tbody>
</table>
#### Desktop app
In the top menu bar of the app, select **View \> Developer Tools \> Developer Tools for Current Tab**. In the logs that are generated, right-click and select **Save as** to download the logs.
#### Mobile app
You can access and share debug logs from **Account screen \> Settings \> Report a problem**.
### Call stats dump
In cases where there are audio/video issues, difficulty in hearing other participants, and/or stuttering video and/or choppy audio, run the `/call stats` slash command in the channel where the call is currently active. This returns a JSON object via an ephemeral message. Additionally, run the `/call logs` command to review the client logs for the last call session.
You can run this command in an active call or after leaving the call in question. However, we will only save data for the last joined call so joining again will delete the previous call's feedback.
### WebRTC internals (Chrome and Firefox only)
This is an additional method for Chrome and Firefox users in cases where there are audio/video issues, difficulty in hearing other participants, and/or stuttering video and/or choppy audio.
#### Chrome browser (recommended)
Open `chrome://webrtc-internals/` in the browser that you're using for the active call.
#### Firefox browser
Open `about://webrtc` in the browser that you're using for the active call.
### Share information
Debug information is helpful to our community as there may be other community members having the same issue as you. We recommend that debug information be shared in either of the two options below:
- Post in [Developers: Calls](https://community.mattermost.com/core/channels/developers-channel-call) channel: prefer this method when possible but keep in mind the channel is public.
- Post in [Team: Calls](https://community.mattermost.com/private-core/channels/calls-team) channel: use this channel if posting sensitive information.

View File

@@ -0,0 +1,139 @@
---
title: "Manage channel bookmarks"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
From Mattermost v10.1, you can bookmark up to 50 links or files to the top of channels for quick and easy access, unless your system admin has disabled your ability to do so. Bookmarks display directly under channel headers. Files added as channel bookmarks are also [searchable](/end-user-guide/collaborate/search-for-messages) in Mattermost.
## Open a bookmark
Opening a channel bookmark works the same way as selecting a file link or attachment in a message. Select or tap a bookmark to view the file or link.
From Mattermost v10.11, bookmarks containing `mattermost://` links open directly in the desktop app using deep linking. This turns bookmarks into one-click shortcuts to channels, threads, or messages, letting you jump straight to key assets in Mattermost quickly and easily.
## Add a bookmark
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. From Mattermost v10.5, select the channel name at the top of the center pane to access the drop-down menu, and select **Bookmarks Bar** to add a link or attach a file. In Mattermost versions prior to v10.5, select **Add a bookmark** in the bookmarks bar instead.
> - Select **Add a link** to specify the link URL, specify bookmark text, and an optional bookmark icon.
> - Select **Attach a file** to select a file, specify bookmark text, and an optional bookmark icon.
</TabItem>
<TabItem value="mobile" label="Mobile">
The bookmarks bar is hidden when a channel has no bookmarks.
1. In a channel, select the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon.
![Tap on More options to access available options for the channel.](/images/mobile-select-more-options-for-a-channel.jpg)
2. Select **View info**.
![Tap on View info to view additional information about the channel.](/images/mobile-select-view-info-for-a-channel.jpg)
3. Tap on **Add a bookmark** to add the first bookmark.
![Tap on Add a bookmark to add the first bookmark.](/images/mobile-add-first-channel-bookmark.jpg)
For subsequent bookmarks, select the **Plus** <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> icon in the bookmarks bar.
![Tap on the Plus icon to add more bookmarks to the channel.](/images/mobile-add-subsequent-channel-bookmarks.jpg)
4. You can either select **Add a link** to specify the link URL, specify bookmark text, and an optional bookmark icon.
![Tap on Add a link to add a Bookmark link.](/images/mobile-attach-a-channel-bookmark-link.jpg)
Or you can select **Add a file** to select a file, specify bookmark text, and an optional bookmark icon.
![Tap on Add a file to add a file as Bookmark.](/images/mobile-attach-a-channel-bookmark-file.jpg)
5. Tap on **Save**.
</TabItem>
</Tabs>
## Manage bookmarks
You can [edit](#edit-bookmarks) and [delete](#delete-bookmarks) bookmarks, as well as [copy bookmark links](#copy-bookmark-links). Additionally, web and desktop users can [reorder bookmarks](#reorder-bookmarks), and mobile users can [share bookmarks](#share-bookmarks). Changes to bookmarks are visible to all channel members.
### Reorder bookmarks
Using Mattermost in a web browser or the desktop app, drag bookmarks to reorder them in the bookmarks bar. Reordering channel bookmarks changes the display order for all channel members.
<Note>
You can't reorder channel bookmarks using the mobile app.
</Note>
### Edit bookmarks
You can make changes to the bookmark link or file, the bookmark title, or the optional bookmark icon. Editing a bookmark changes the bookmark for all channel members.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a bookmark and select **Edit**.
</TabItem>
<TabItem value="mobile" label="Mobile">
Long-press on a bookmark and select **Edit**.
![Tap and hold a bookmark name to explore more options.](/images/mobile-edit-a-channel-bookmark.gif)
</TabItem>
</Tabs>
### Share bookmarks
Using the mobile app, long-press on a bookmark and select **Share**.
### Copy bookmark links
You can copy bookmark links when your system admin has [enabled your ability to do so](/administration-guide/configure/site-configuration-settings#enable-public-file-links).
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a bookmark and select **Copy link**.
</TabItem>
<TabItem value="mobile" label="Mobile">
Long-press on a bookmark and select **Copy link**.
![Tap and hold a bookmark name to explore more options.](/images/mobile-copy-a-channel-bookmark-link.gif)
</TabItem>
</Tabs>
### Delete bookmarks
Deleting a channel bookmark deletes it for all channel members.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a bookmark and select **Delete**.
</TabItem>
<TabItem value="mobile" label="Mobile">
Long-press on a bookmark and select **Delete**.
![Tap and hold a bookmark name to explore more options.](/images/mobile-delete-a-channel-bookmark.gif)
</TabItem>
</Tabs>

View File

@@ -0,0 +1,165 @@
---
title: "Manage channel members"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
## Add members to a channel
Any member of a channel can add other members to public or private channels, unless your system admin has restricted access to do so.
When a channel has [attribute-based access controls](/administration-guide/manage/admin/attribute-based-access-control) enabled, you'll see details about which user attributes are permitted access to the channel. Behavior differs by channel type:
- **Private channels**: Only users who meet the requirements appear in search results when adding members, and only those users can be added.
- **Public channels**: All eligible team members appear in search results, and users who meet the recommended attributes are labeled **Recommended**. Anyone can still be added because public-channel access controls are advisory and never remove existing members.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
To add members to a channel:
1. Select the channel name at the top of the center pane to access the drop-down menu, then select **Add Members**.
![Use options available through the channel name to add a member to a channel.](/images/add-member-to-channel.png)
2. Search for users, select users, then select **Add** to add users to the current channel. Mattermost notifies you when a user is already a member of the channel.
<div class="tip">
<div class="title">
Tip
</div>
- From Mattermost v7.8, people you've messaged directly are listed first, followed by all users in alphabetical order.
- Alternatively, to add members to a channel, select the channel name, select the **View Info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon, select **Members** in the right pane, and then select **Add**. If the channel has access control restrictions, you'll see details about required attributes at the top of the right pane.
</div>
</TabItem>
<TabItem value="mobile" label="Mobile">
To add members to a channel:
1. Tap the channel name at the top of the screen.
![Click on the channel name to explore available options.](/images/mobile-channel-name-click.jpg)
2. Tap **Add members**.
![Tap on Add members to add members to the channel.](/images/mobile-edit-channel.jpg)
3. Select members to add to the channel. You can scroll through the alphabetical list of members, or search for members in the Search field.
![Select a user from the list and search one using the search field that you want to add to the channel.](/images/mobile-select-members-to-add-to-a-channel.jpg)
4. Tap **Add Members**.
![Click on Add Members to add the member(s) to the current channel.](/images/mobile-add-selected-member-to-a-channel.jpg)
</TabItem>
</Tabs>
### Mention users
You can also [@mention users](/end-user-guide/collaborate/mention-people) to add them to a channel. If they're not a channel member, Mattermost prompts you to add them.
![If a user mentioned in a channel is not a member already, then Mattermost prompts to add the user.](/images/mobile-add-user-to-a-channel-by-mentioning.jpg)
### Add users from their profile
Using a web browser or the desktop app, you can also add users to channels within their profile pop-over.
1. Select a user's profile image.
2. Tap on <img src={useBaseUrl('/img/ui/account-plus-outline_F0801.svg')} alt="Account plus outline icon used to add user to a channel." className="theme-icon" /> icon.
![Use options on a user's profile pop-over to add a member to a channel.](/images/add-member-pop.jpg)
3. Type to find a channel name, then select a channel and choose **Add**.
![Type the channel name and tap on Add to add the user to it.](/images/mobile-add-user-from-profile.jpg)
## Leave a channel
You can leave public or private channels any time.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select the channel name at the top of the center pane to access the drop-down menu, then select **Leave Channel**. When you have permission to manage channel members, you can also leave a channel by going to **View Info \> Members \> Manage** and selecting your own name.
</TabItem>
<TabItem value="mobile" label="Mobile">
1. In a channel, tap <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> in the top right corner.
![Tap on More options to access available options for the channel you want to leave.](/images/mobile-select-more-options-for-a-channel.jpg)
2. Tap **Leave channel**.
![Tap on Leave channel to leave the current channel.](/images/mobile-select-view-info-for-a-channel.jpg)
3. Tap on **Leave** to confirm you choice.
![Tap on Leave to confirm your choice.](/images/mobile-confirm-leave-a-channel.jpg)
</TabItem>
</Tabs>
## Remove other members from a channel
Any member of a channel can remove other members from a channel.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
You have two ways to remove members from a channel:
- Select the channel name at the top of the center pane to access the drop-down menu, then select **Manage Members**. Select the member's [user role](/end-user-guide/collaborate/learn-about-roles), then select **Remove from Channel**.
- Select the channel's **View Info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon, and select **Members** in the right pane. From there, select **Manage**, select a user's role, then select **Remove from Channel**.
![Use options available through the channel name to remove a member from a channel.](/images/remove-member-from-channel.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
1. In a channel, tap <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> in the top right corner.
![Tap on More options to access available options for the channel you want to leave.](/images/mobile-select-more-options-for-a-channel.jpg)
2. Tap **View Info**.
![Tap on View info to view additional information about the channel.](/images/mobile-select-view-info-for-a-channel.jpg)
3. Tap **Members**.
![Tap on View info to view additional information about the channel.](/images/mobile-edit-channel.jpg)
4. Tap **Manage** in the top right corner of the screen.
![Tap on Manage to access the user role of the members.](/images/mobile-view-members-of-a-channel.jpg)
5. Tap a user role to change it, and tap **Remove from Channel**.
![Tap on Manage to access the user role of the members.](/images/mobile-manage-channel-members-list.jpg)
![Tap on Remove from channel to remove the selected user.](/images/mobile-remove-user-from-a-channel.jpg)
6. Tap **Remove**.
![Tap on Remove to confirm your choice.](/images/mobile-confirm-remove-user-from-channel.jpg)
7. Tap **Done**.
![Tap on Done to exit and return to the channel.](/images/mobile-exit-after-removing-user-from-a-channel.jpg)
</TabItem>
</Tabs>

View File

@@ -0,0 +1,16 @@
---
title: "Mark channels as unread"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
If you read messages in a channel, but don't have time to address them right away, you can mark that channel as unread. Hover over the channel name in the channel sidebar, select the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> option, then select **Mark as Unread**.
![When you hover over channels in the channel sidebar, you can access more message options from the More icon.](/images/channel-more.png)
<Tip>
Marking messages as unread displays those channels as bold in the channel sidebar.
</Tip>

View File

@@ -0,0 +1,30 @@
---
title: "Mark messages as unread"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
If you read a message, but don't have time to address it right away, you can mark that message as unread. Marking a message as unread displays the channel as bold in the channel sidebar, and groups the message with all other unread messages.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Hover over the message, select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> option, then select **Mark as Unread**.
![When you hover over messages, you can access more message options from the More icon.](/images/message-more.png)
![You can mark messages as unread to return to them later.](/images/mark-message-as-unread.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
Long press a message, and then tap **Mark as Unread**.
![Tap and hold on a message to access the available options.](/images/mobile-mark-a-message-as-unread.gif)
</TabItem>
</Tabs>

View File

@@ -0,0 +1,126 @@
---
title: "Mention people in messages"
---
<PlanAvailability slug="all-commercial" />
When you want to get the attention of specific Mattermost users, you can use @mentions. Mattermost supports the following types of @mentions:
- [@username](#username)
- [@channel](#channel-and-all)
- [@all](#channel-and-all)
- [@here](#here)
- [@groupname](#groupname)
- [@customusergroupname](#customusergroupname)
<Note>
- If you forget to mention someone in a message, editing the existing message to add an @mention won't trigger new @mention notifications, desktop notifications, or notification sounds.
- Mattermost supports mentions for names that include accents (also known as diacritics). Names like Zoë, Jesús, Sørina, François, André, Jokūbas, Siân, KŠthe, or Fañch are returned in autocomplete results.
</Note>
## @username
You can mention a teammate by using the *@* symbol plus their username to send them a mention notification.
Type *@* or the full-width "@" (U+FF20) to bring up a list of team members who can be mentioned. To filter the list, type the first few letters of any username, first name, last name, or nickname.
<Note>
Mattermost v11.3 added support for full-width @, improving the experience for Japanese IME and other international keyboard users. Existing @ mentions are unaffected. See the :doc:v11.3 release notes \</product-overview/mattermost-v11-changelog\> for details.
</Note>
<Tip>
Using Mattermost in a web browser or the desktop app, you can also press the <kbd>↑</kbd> and <kbd>↓</kbd> arrow keys to scroll through entries in the list, and press <kbd>ENTER</kbd> on Windows or Linux, or <kbd>↵</kbd> on Mac, to select the person to mention. When selected, the username replaces the full name or nickname.
</Tip>
The following example sends a special mention notification to Alice, whose username is **alice**. The notification alerts her of the channel and message where she was mentioned. If Alice is away from Mattermost and has email notifications turned on, she'll receive an email alert of her mention along with the message text.
``` text
@alice how did your interview go with the new candidate?
```
If the person you mentioned doesn't belong to the channel or the team, a system message is posted to let you know, and you're given the option to add the person to the channel. You are the only one who can see this message.
## @channel and @all
You can mention an entire channel by typing `@channel` or `@all`. All members of the channel receive a mention notification that behaves the same way as if the members had been mentioned personally. If used in Town Square, it notifies all members of your team.
You can ignore channel-wide mentions in specific channels in the **Channel Menu \> Notification Preferences \> Ignore mentions for @channel, @here and @all**.
``` text
@channel great work on interviews this week. I think we found some excellent potential candidates!
```
If a channel has five or more members, you may be prompted to confirm that you want notifications sent to everyone in the channel.
## @here
You can mention everyone who is online in a channel by typing `@here`. This sends a desktop notification and push notification to members of the channel who are online. It's counted as a mention in the sidebar. Members who are offline don't receive a notification. When they return to Mattermost they won't see a mention counted in the channel sidebar. Members who are away receive a desktop notification only if they have notifications set to **For all activity**, and they won't see a mention counted in the sidebar.
``` text
@here can someone complete a quick review of this?
```
If a channel has five or more members, you may be prompted to confirm that you want notifications sent to everyone in the channel.
You can ignore channel-wide mentions in specific channels by enabling the **Channel Menu \> Notification Preferences \> Ignore mentions for @channel, @here, and @all** option.
## @groupname
<PlanAvailability slug="ent-plus" />
This feature enables system admins to configure custom mentions for [LDAP synced groups](/administration-guide/onboard/ad-ldap-groups-synchronization) via the Group Configuration page. This functionality is also supported on the mobile app (from v1.34) if the AD/LDAP groups feature is enabled. The mobile app supports auto-suggesting groups, highlights group member mentions, and also provides a warning dialog when a mention will notify more than five users.
Once enabled for a specific group, users can mention and notify the entire group in a channel (similar to `@channel` or `@all`). Members of the group in that channel will receive a notification. If members of the group mentioned aren't members of the channel, the user who posted the mention is prompted to invite them.
Group mention identifiers (slugs) use the LDAP group name by default. To customize/rename the slug:
1. Open **System Console \> User Management \> Groups**.
2. Select **Edit** next to the group you want to edit.
3. In **Group Profile \> Group Mention** enter the new slug.
4. Select **Save**.
As with `@username` mentions, use *@* to bring up a list of groups that can be mentioned. To filter the list, type the first few letters of any group. Press the <kbd>↑</kbd> and <kbd>↓</kbd> arrow keys to scroll through entries in the list, and then press <kbd>Enter</kbd> on Windows or Linux, or pressing <kbd>↵</kbd> on Mac to select the group you want to mention.
``` text
@dev-managers great work hitting all of our code coverage goals this quarter!
```
## @customusergroupname
You can add groups of users to a channel or team by [creating a custom group](/end-user-guide/collaborate/organize-using-custom-user-groups) and @mentioning that custom group in a channel.
- Mattermost prompts to you to add any users who aren't already members of that channel to the channel.
- From Mattermost v9.1, you're given the option to add any users who aren't already members of that team to the team, if you have the permissions to do so.
## Words that trigger mentions
You can customize words that trigger mention notifications in **Settings \> Notifications \> Words That Trigger Mentions**. By default, you receive mention notifications for your username and for `@channel`, `@all` and `@here`. You can choose to have your first name be a word that triggers mentions.
You can add a list of customized words to get mention notifications for by typing them into the input box, separated by commas. This is useful if you want to be notified of all posts on certain topics, such as "interviewing" or "marketing".
## See all recent mentions
Select **@** to the right of the **Search** box to query for your most recent @mentions and words that trigger mentions (excluding LDAP group mentions).
![See your most recent @mentions](/images/recent-mentions.png)
Your recent mentions are shown for all of your teams.
Select **Jump** next to a search result in the right-hand sidebar to jump the center pane to the channel and location of the message with the mention.
## Confirmation dialog warnings
When your system admin has configured Mattermost to require confirmations for @mentions, you must confirm any mention that will trigger notifications for more than five users before sending the notification.
This confirmation dialog only appears when your system admin has configured this setting in the System Console. See our [configuration settings](/administration-guide/configure/site-configuration-settings#show-channel-all-or-here-confirmation-dialog) product documentation for details. This configuration setting is supported on the Mattermost Mobile App (from v1.34) if the [AD/LDAP groups](/administration-guide/onboard/ad-ldap-groups-synchronization) feature is enabled.
## Mention highlights
Valid mentions will have highlighted font text with some exceptions, for example if mentions are disabled at the channel level. The highlighted text becomes a hyperlink when a username is displayed. When the username is selected, the profile popover is displayed.
When mentions trigger a notification, the user being notified will see highlighted font text and highlighted font background. This functions as an identifier of which mentions in the post triggered a notification for the user.

View File

@@ -0,0 +1,60 @@
---
title: "Set message priority"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
From Mattermost v7.7 and mobile v2.4, you can add a message priority label to root messages to make important messages requiring timely action or response more visible and less likely to be overlooked.
<img src={useBaseUrl('/images/MPA-Animated-GIF-Update-2023-08-15.gif')} width="700" alt="Ensure important and urgent messages stand out clearly by adding priority labels to root messages." />
To set the priority of a new root message:
1. Select the **Message Priority** <img src={useBaseUrl('/img/ui/alert-circle-outline_F05D6.svg')} alt="Mark a message as important or urgent using the Priority Message icon." className="theme-icon" /> icon in the message formatting toolbar. Select from Standard, Important, or Urgent.
2. Select the priority for the message. Messages have a standard priority by default.
3. Select **Apply**
When you send a priority message, the priority label displays next to your name in the channel, as well as the **Threads** view when others reply to the thread.
## Send persistent notifications
From Mattermost v8.0, messages marked as urgent with a priority label and containing an @mention can trigger persistent notifications that repeat until the recipient acknowledges, reacts, or replies.
To enable persistent notifications for a message:
1. Compose a root message with at least one @mention.
2. Select the **Message Priority** <img src={useBaseUrl('/img/ui/alert-circle-outline_F05D6.svg')} alt="Mark a message as important or urgent using the Priority Message icon." className="theme-icon" /> icon in the message formatting toolbar.
3. Select **Urgent**.
4. Select **Send persistent notifications**.
5. Select **Apply**.
<Note>
- @channel, @all and @here mentions don't send persistent notifications.
- System admins can customize the maximum number of @mentions permitted, how frequently and how many persistent notifications are sent, as well as disable persistent notifications for all users, if preferred. By default, users are notified every 5 minutes for a total of 30 minutes. See the [configuration](/administration-guide/configure/site-configuration-settings#persistent-notifications) documentation for details.
</Note>
## Receive persistent notifications
You must have desktop and/or mobile push notifications enabled to receive persistent notifications. How you're notified depends on your [notifications preferences](/end-user-guide/preferences/manage-your-notifications) for desktop and mobile push notifications. You won't be notified when your availability is set to **Do Not Disturb**, or if you're [Out of Office](/end-user-guide/preferences/set-your-status-availability#set-your-availability). Learn more about managing and customizing how you receive [Mattermost notifications](/end-user-guide/preferences/manage-your-notifications).
Urgent messages show a red mention badge which remains visibible until you view the message. Selecting the **Acknowledge** icon (when present) won't impact the urgent red mention badge.
![Example of the channel sidebar with both regular and urgent unread messages.](/images/urgent-message.png)
To stop receiving persistent notifications, you can reply to the thread, select the **Acknowlege** icon (when present), or react to the thread with an emoji. Persistent notifications also stop if the original message is deleted, or if the maximum number of persistent notifications are sent.
## Request acknowledgements
You can additionally request that recipients actively acknowledge the message to track that messages have been seen and actioned. By default, marking a message as Urgent priority automatically requests an acknowledgement.
When you request acknowledgement of a message, an **Acknowledge** <img src={useBaseUrl('/img/ui/Ack-Button-Default.svg')} alt="Select the Acknowledge button to indicate that you've read it and taken necessary action." /> button is added below the sent message. You can mark the message as acknowledged by selecting the button, and you can hover over the **Acknowledged** <img src={useBaseUrl('/img/ui/Ack-Button-Default.svg')} alt="Select the Acknowledge button to indicate that you've read it and taken necessary action." /> icon to review who has acknowledged the message.
<Tip>
- When you have push notifications enabled on mobile, you'll be notified every five minutes until you acknowledge or reply to the message.
- After acknowledging a message, you have up to five minutes to change your mind. Select the **Acknowledged** <img src={useBaseUrl('/img/ui/Ack-Button-Default.svg')} alt="Select the Acknowledge button to indicate that you've read it and taken necessary action." /> button again to remove your name from the list of acknowledged users.
</Tip>

View File

@@ -0,0 +1,18 @@
---
title: "Set a reminder"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
From Mattermost v7.10, using Mattermost in a web browser or the desktop app, you can set 1 timed reminder on a post made in a channel, direct message, and group message. The ability to set up recurring reminders isn't supported.
Hover over the message you want to remember, select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> option, then select **Remind**. Select a time period or enter a custom date and time. You'll receive a direct message at the time you've chosen, with the body of the message you wanted to be reminded about.
Once you've been reminded about a message, you won't receive another reminder unless you set one.
<Tip>
From Mattermost v10.3, you can also schedule reminder messages to be sent in the future. See the [schedule messages](/end-user-guide/collaborate/schedule-messages) documentation for details.
</Tip>

View File

@@ -0,0 +1,17 @@
---
title: "Navigate channels"
---
<PlanAvailability slug="all-commercial" />
## Navigate between channels
Using Mattermost in a web browser or the desktop app, you can navigate between channels by selecting the **Find channel** option in the channel sidebar, or by pressing <kbd>Ctrl</kbd> <kbd>K</kbd> on Windows or Linux, or <kbd>⌘</kbd> <kbd>K</kbd> on Mac. The Find channels screen also displays [member availability](/end-user-guide/preferences/set-your-status-availability) at a glance.
> ![Navigate between channels and review member availability.](/images/switch-channels.png)
## Return to recently viewed channels
Using a web browser or the desktop app, use the **History** arrows at the top of the sidebar to move back and forth through your channel history.
- Select the left arrow to go back one page.
- Select the right arrow to go forward one page.

View File

@@ -0,0 +1,113 @@
---
title: "Organize conversations using threaded discussions"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
Threads are a key part of the messaging experience in Mattermost. They're used to organize conversations and enable users to discuss topics without adding noise to channels or direct messages.
Threaded discussions offers an enhanced experience for users communicating in threads and replying to messages that includes a unified threads inbox to read all conversations in one view. Threads improve the ability to process channel content, find, follow, and resume conversations more easily, and keep threaded conversations focused.
![Organize conversations using threaded discussions.](/images/collapsed-reply-threads.gif)
<Note>
- From Mattermost v7.0, threaded discussions are enabled by default for all new Mattermost deployments. All Mattermost users can create new threads, unless the system admin has [disabled the ability to do so](/administration-guide/configure/site-configuration-settings#threaded-discussions).
- System admins can [configure default availability and user opt-in](/administration-guide/configure/site-configuration-settings#threaded-discussions) of threaded discussions.
</Note>
## Start or reply to threads
[Replies to messages](/end-user-guide/collaborate/reply-to-messages) are collapsed under the first message of a thread. Open a thread by selecting the message or reply count.
From Mattermost v11.2, when using Mattermost in a web browser, you can open threads in separate browser windows by selecting the **New Window** <img src={useBaseUrl('/img/ui/dock-window_F10AC.svg')} alt="Open thread in a new browser window icon." /> icon in the thread header. This allows you to view and participate in multiple threads simultaneously without losing context.
## Follow threads and messages
You'll automatically follow every thread you participate or are mentioned in. You can manually follow particular messages and threads so that any reply activity triggers [notifications](/end-user-guide/preferences/manage-your-notifications). Follow or unfollow any thread, at any time. In channels, a dot next to thread participants means there are unread replies for the threads you're following.
![Follow threads to stay updated on replies to messages.](/images/crt-following-thread.png)
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Toggle the thread’s **Follow** option, or select **Follow thread** from the **More Actions** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon.
![Unfollow threads from the More Actions icon.](/images/crt-following-thread.jpg)
<Tip>
- Follow messages with no replies from the **More Actions** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon to be notified if someone replies to the message later based on your notification preferences.
- You can also use keyboard arrow keys to navigate threads in the **Threads** view.
</Tip>
</TabItem>
<TabItem value="mobile" label="Mobile">
Long-press on a message to access message options, then tap **Follow Thread**.
![Tap and hold on a message thread to select Follow Thread.](/images/mobile-follow-a-message-thread-with-follow-option.gif)
Alternatively, you can also tap on the **Follow** indicator below a message thread to follow it.
![Toggle the Follow indicator to start folowing a thread.](/images/mobile-follow-a-message-thread-by-tapping-follow.gif)
<Tip>
Follow messages with no replies from the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon to be notified if someone replies to the message later based on your notification preferences.
![Tap and hold on a message with no replies to select Follow Message.](/images/mobile-follow-a-message-with-no-replies.gif)
</Tip>
</TabItem>
</Tabs>
## Unfollow threads
If you’re no longer interested in a or message thread, unfollow it to stop receiving notifications. Viewing a thread without responding to it doesn’t automatically follow that thread.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Toggle the thread’s **Following** indicator, or select **Unfollow thread** from the **More Actions** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon to unfollow it.
![Unfollow threads from the More Actions icon.](/images/desktop-unfollow-message-thread.jpg)
</TabItem>
<TabItem value="mobile" label="Mobile">
Long-press on a message to access message options, then tap **Unfollow Thread**.
![Tap and hold on a message thread you're following to select Unfollow Thread.](/images/mobile-unfollow-a-message-thread-with-unfollow-option.gif)
Alternatively, you can tap on the **Following** indicator below the message thread to unfollow it.
![Toggle the Following indicator to stop following a thread.](/images/mobile-unfollow-a-message-thread-by-tapping-following.gif)
</TabItem>
</Tabs>
## View all threads
Select **Threads** at the top of the channel sidebar to see all your followed threads on the currently selected team. Threads with the most recent replies display at the top of the list.
Select **Unreads** to filter your followed threads by only those with unread replies.
![Select Threads in the channel sidebar to see all thread updates in your Threads View.](/images/crt-thread-view.jpg)
## Tutorial video
<script src="https://fast.wistia.com/embed/medias/5gjgi10rr0.jsonp" async></script><script src="https://fast.wistia.com/assets/external/E-v1.js" async></script><div class="wistia_responsive_padding" style={{padding: '56.25% 0 0 0', position: 'relative'}}><div class="wistia_responsive_wrapper" style={{height: '100%', left: '0', position: 'absolute', top: '0', width: '100%'}}><div class="wistia_embed wistia_async_5gjgi10rr0 videoFoam=true" style={{height: '100%', position: 'relative', width: '100%'}}><div class="wistia_swatch" style={{height: '100%', left: '0', opacity: '0', overflow: 'hidden', position: 'absolute', top: '0', transition: 'opacity 200ms', width: '100%'}}><img src="https://fast.wistia.com/embed/medias/5gjgi10rr0/swatch" style={{filter: 'blur(5px)', height: '100%', objectFit: 'contain', width: '100%'}} alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div>
<br />
## Known issues
Threaded discussions were released as generally available in Mattermost v7.0, including significant server performance improvements and more flexible configuration options for system admins to enable the feature by default. We highly recommended [upgrading Mattermost](/administration-guide/upgrade/upgrading-mattermost-server) to take advantage of configuration and performance enhancements.

View File

@@ -0,0 +1,87 @@
---
title: "Manage custom groups"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
Custom groups reduce noise and improve focus by notifying the right people in a channel at the right time, while maintaining transparency for all members in that channel. Custom user groups let you notify up to 256 users at a time rather than notifying users individually.
For example, perhaps you want to @mention a cross-functional team about a bug fixes needed for an upcoming feature release, without notifying everyone else in the channel. Using a custom group notifies the cross-functional team immediately, while keeping important stakeholders in the loop on the status of the feature release.
Or perhaps you want to add a group of users to a team and a channel. When you @mention a custom group in a channel, Mattermost prompts you to add anyone from that custom group who isn't already a channel and team member. See the [invite people to your workspace](/end-user-guide/collaborate/invite-people) documentation for details.
Once a custom user group has been created, you can mention that group the same way you @mention another Mattermost member. See the [mention people in messages](/end-user-guide/collaborate/mention-people) documentation for details.
<Note>
- System admins need to enable this feature. See our [Mattermost Configuration Settings](/administration-guide/configure/site-configuration-settings#enable-custom-user-groups) documentation for details.
- From Mattermost v7.2, system admins can limit who can manage custom user groups through the Custom Group Manager system admin role. See the [delegated granular administration](/administration-guide/onboard/delegated-granular-administration) documentation for details.
- The ability to create custom user groups on mobile will be available in a future release. @mentions for custom user groups on mobile work the same as [LDAP-synced groups](/end-user-guide/collaborate/mention-people#groupname).
</Note>
## Create a custom group
1. Using Mattermost in a web browser or the desktop app, select <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> at the top of the channel sidebar, then select **Create New User Group**.
2. Specify a name and mention. The mention is the handle you use to @mention a notification to the group. Group names must be unique across the Mattermost [workspace](/end-user-guide/end-user-guide-index). If a name is in use as a channel name, display name, or another custom group's name, it won't be available.
3. Search for and select members to add to the custom user group, then select **Create Group**.
## Review group members
From Mattermost v7.8, using Mattermost in a web browser or the desktop app, select a group mention in a thread to display a list of group members.
## Manage custom user groups
You can review and filter the list of custom groups, add people to an existing group, edit the group name or mention, leave the group, or archive the group.
To manage a custom user group in a web browser or the desktop app, select **User Groups** from the Products menu, then select the group you want to modify.
![Access tools to manage user groups.](/images/access-user-groups.png)
### Review available groups
Review a list of all available custom user groups, search for specific groups by name.
<Tip>
You can filter the list of groups to display only groups you're a member of, or only archived groups.
</Tip>
### Change name or mention
1. From the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon to the right of any custom group, select **View Group**.
> ![Access tools to manage your custom user groups.](/images/manage-user-groups.png)
2. From the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon, select **Edit Details**.
> ![Edit details of a custom user group.](/images/edit-custom-group.png)
3. Update the **Name** or **Mention**, then select **Save Details**.
### Add people
1. Select **Add People**.
2. Search for and select people to add to the group, then select **Add People**.
### Remove people
Hover over a member, then select the **Trash** icon to remove them from the group.
### Join a group
While viewing the members of a group, from the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon, select **Join Group**.
### Leave a group
From the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon, select **Leave Group**.
### Archive group
From the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon, select **Archive Group**. When you archive a custom user group, you won’t be able to mention the group’s handle or view its members. However, the group isn't deleted from the list, and all members remain in the group unless they're manually removed.
### Unarchive group
From Mattermost v9.1, you can restore an archived group. From the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon, filter the list of groups to show only archived groups. Select an archived group to view details about the group, if preferred, and then select **Restore Group**.

View File

@@ -0,0 +1,109 @@
---
title: "Organize using teams"
---
<PlanAvailability slug="all-commercial" />
A team is a digital [workspace](/end-user-guide/end-user-guide-index) where you and your teammates can collaborate in Mattermost. Depending on how Mattermost is [set up](/administration-guide/configure/experimental-configuration-settings#primary-team) in your organization, you can belong to one team or multiple teams, and [access to the team](/end-user-guide/collaborate/team-settings#access-settings) can be open or restricted.
Users with the **Create Teams** permission can [create new teams](#create-a-team) and [manage team settings](/end-user-guide/collaborate/team-settings) for existing teams. System admins can grant the **Create Team** permission to roles via the [System scheme](/administration-guide/onboard/advanced-permissions#system-scheme) or the [Team override scheme](/administration-guide/onboard/advanced-permissions#team-override-scheme).
## Single team versus multiple teams
Mattermost can be deployed both to a single team and to multiple teams. Currently, we recommend deploying to a single team for the following reasons:
- Single team deployments promote communication across the organization. When you add multiple teams, groups can become isolated.
- Integrations (e.g., webhooks and slash commands) are only persistent across single team deployments.
However, some Mattermost customers prefer multiple team deployments for the following reasons:
- Teams are useful when there is a purpose for each of them. For example, one team is used for staff members and another team for external users.
- Performance is better when users are scattered across multiple teams instead of all in the same one. With multiple teams, there is less content to load per team or channel switch and database queries are faster.
- Creating a shared team for all users, and using advanced permissions to control who can create channels and add members to the shared team, improves cross-team collaboration when using multiple teams. Additionally, an annoucement banner can be used to provide system-wide announcements.
- The platform supports multiple team functionalities including general search, saved posts, and recent mentions across teams.
## Team sidebar
If you belong to more than one team, a team sidebar displays to the left of the channel sidebar. Drag teams to reorder them in the sidebar. You can also use keyboard shortcuts to navigate between teams.
![Navigating between teams in Mattermost.](/images/teams.gif)
## Create a team
You can create a team using a web browser or the desktop app by selecting a team name, and then selecting **Create a Team**, unless your system admin has disabled your ability to do so.
![Create a new team by selecting the team name.](/images/create-team.gif)
### Team name and URL selection
There are a few details and restrictions to consider when selecting a team name and team URL.
<Note>
If your system admin has enabled anonymous team and channel URLs (available in Mattermost Enterprise Advanced from v11.6.0), team creation becomes a single-step flow and you will not be prompted to choose a team URL. The URL is assigned automatically.
</Note>
#### Team name
This is the display name of your team that appears in menus and headings.
- Team names can contain any letters, numbers, or symbols.
- Team names are case sensitive.
- Team names must be 2 - 64 characters in length.
#### Team URL
If your system admin has not enabled anonymous URLs, you choose a team URL during team creation. The team URL is part of the web address that navigates to your team on the system domain, `https://domain.com/teamurl/`.
- Teams may contain only lowercase letters, numbers, and dashes.
- Teams must start with a letter and cannot end in a dash.
- Teams must be 2 - 64 characters in length.
- Team names cannot start with the following restricted words: `admin`, `api`, `channel`, `claim`, `error`, `files`, `help`, `landing`, `login`, `mfa`, `oauth`, `plug`, `plugins`, `post`, `signup`, or `playbooks`.
## Join a team
You can join any open teams, or join any team you receive an invitation to join.
If you haven't yet joined any teams in Mattermost, you're prompted to join available teams when you [log in to Mattermost](/end-user-guide/access/access-your-workspace).
You can be a member of multiple teams at the same time. To join additional teams, select the current team name, choose **Join Another Team**, and select the name of the team you want to join.
![Select a team name to join another team.](/images/join-team.png)
<Note>
When your organization uses [team membership access policies](/administration-guide/manage/admin/abac-team-membership), the list of teams you can join depends on your user attributes. Public teams whose requirements you meet are marked **Recommended**, and private teams whose requirements you don't meet aren't listed at all.
</Note>
From Mattermost Mobile v2.40.0, you can join another team from the mobile app by tapping the team name in the channel list header, then tapping **Join Another Team**.
## Leave a team
Users can also choose to remove themselves from a team, from **Team menu \> Leave Team**. This will remove the user from the team, and from all public channels and private channels on the team.
From Mattermost Mobile v2.40.0, you can leave a team from the mobile app when you belong to more than one team. In the channel list, tap the team name, tap **Leave team**, then confirm.
They will only be able to rejoin the team if it's open, or if they receive a new invitation. If they do rejoin, they will no longer be a part of their old channels.
## Remove people from teams
Team admins can remove users from a team via **Team menu \> Manage Members \> Remove From Team** in the dropdown menu beside a user entry.
When a user is removed from a team, the team will no longer be visible or accessible in their team sidebar. If they currently have the team open, they are redirected to the first team that appears in their team sidebar. If they didn't belong to any other teams, the user is sent to the team selection page.
Removing a user from the team does not deactivate the account. The user will still be able to log in to the site, and join other teams. They will also be able to rejoin the team they were removed from if they receive another invite. When a private team has a team membership access policy, invited users must also satisfy that policy. Users can also rejoin if the team is set to [Public Team](/end-user-guide/collaborate/team-settings#discoverability) and they meet any other join restrictions, such as approved email domains. Team membership access policies on public teams are advisory and don't prevent users from rejoining. If the user does rejoin the team, they will no longer belong to the channels they were previously a part of, and they will lose all Admin privileges if they had them previously.
A system admin can also remove users from teams via **System Console \> Users**, and selecting the dropdown beside a user entry and selecting **Manage Teams**. The list of teams an individual user belongs to can be viewed on the user's profile page via **System Console \> Users** and selecting the member's name from the list provided in the **User Configuration** screen.
## Archive a team
A Mattermost system admin can archive teams they no longer need by going to **System Console \> Teams**, selecting a team, and selecting **Archive Team**. Archived teams can be unarchived if needed.
When a team is archived, the team will no longer be visible or accessible in the team sidebar for any user. If users currently have the team open when it's being archived, users are redirected to the first time that appears in their team sidebar. If users didn't belong to any other teams, users are sent to the team selection page.
<Note>
Archiving a team doesn't remove the team data from the Mattermost database. Teams may still be accessible by using the Mattermost API.
</Note>

View File

@@ -0,0 +1,100 @@
---
title: "React with emojis and GIFs"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
Emojis and GIFs are small, digital images, animated images, or icons you can use to communicate or express concepts such as emotions, humor, and physical gestures in your messages.
From Mattermost v10.10, text emoticons (such as `:)` or `:D`) are automatically converted to emoji characters in your messages by default. You can [disable this auto-rendering](/end-user-guide/preferences/manage-your-display-options#render-emoticons-as-emojis) if you prefer to keep emoticons as text.
## Quick emoji reactions
You can react with up to 50 emojis per message. Recently used emojis are sorted based on how often you've used them. Don't see your most recently used emojis? Enable quick reactions by going to **Settings \> Display** and enabling **Quick reactions on messages**.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Hover over a message to select a recently used emoji.
> ![React to messages quickly by selecting one of your most recently used emojis.](/images/recent-emojis.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
Long press on a message, and then select a recently used emoji.
</TabItem>
</Tabs>
## Include emojis and GIFs in messages
<Tip>
Can't find the perfect emoji? [Upload your own custom emoji](#upload-custom-emojis).
</Tip>
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select the **Smile** icon <img src={useBaseUrl('/img/ui/emoticon-plus-outline_E80F.svg')} alt="Use the Smile icon to add emojis to your message." className="theme-icon" /> inside the Mattermost message input box to open the emoji and GIF picker.
Select an emoji from the **Emojis** tab, or switch to the **GIFs** tab to search for a GIF.
You can also specify emojis based on their name. Type `:` followed by at least two characters of the word describing the emoji. This opens an emoji autocomplete. Descriptions include skin tone details for people-based emojis, where supported.
![Emoji autocomplete](/images/emojiautocomplete.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
Select the <img src={useBaseUrl('/img/ui/emoticon-plus-outline_E80F.svg')} alt="Use the Smile icon to add emojis to your message." className="theme-icon" /> to add an emoji. Mattermost accesses the emojis and GIFs available on your mobile device. You can also specify emojis based on their name. Type at least two characters of the word describing the emoji. This opens an emoji autocomplete.
![Tap and hold on a message to access the recent emojis or even choose other ones.](/images/mobile-include-emojis-for-a-message-reaction.gif)
</TabItem>
</Tabs>
## Manage emojis
Using Mattermost in a web browser or the desktop app, you can select recently used emojis, select a default skin tone for people-based emojis, as well as manage custom emojis. From Mattermost mobile v2.37.0, you can select custom emojis and apply custom skin tones on mobile devices.
### Select default skin tone
Select the **Skin tone** icon in the top right corner of the emoji picker to specify the skin tone you prefer to use for people-based emojis by default. You can select an alternate skin tone at any time.
![Select a default skin tone preference for people-based emojis.](/images/emoji-skin-tone.png)
## Upload custom emojis
Using Mattermost in a web browser or the desktop app, you can upload new emojis that everyone in your Mattermost [workspace](/end-user-guide/end-user-guide-index) can access to react to messages, unless your system admin has [disabled your ability to do so](/administration-guide/configure/site-configuration-settings#enable-custom-emoji).
1. From the emoji picker, select **Custom Emoji**.
![Select Custom Emoji to upload custom emojis to Mattermost.](/images/add-custom-emoji1.png)
2. Enter a name for your custom emoji. This is the name that shows up in the emoji autocomplete.
3. Choose **Select**, then select the image to use for the emoji. Small, square pictures work best when selecting an image to upload. The file can be any JPG, GIF, or PNG that's up to 512 KiB in size. Mattermost limits the number of frames allowed in animated GIF emojis.
4. Select **Save**. Once saved, your emoji is added to the list of custom emoji.
![Name and upload custom emojis to Mattermost.](/images/add_custom_emoji.png)
4. To use your custom emoji in a message, select it from the emoji picker, or type `:` followed by your emoji name to bring it up in the emoji autocomplete.
### Remove custom emojis
Using Mattermost in a web browser or the desktop app, you can remove custom emojis that you uploaded to Mattermost.
1. Open the emoji picker.
2. Select **Custom Emoji**.
3. If required, use the Search bar to find your custom emoji in the list.
4. Under **Actions** select **Delete**.
5. Choose **Delete** to confirm.
![Remove custom emoji](/images/delete_custom_emoji.png)

View File

@@ -0,0 +1,55 @@
---
title: "Rename channels"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
Anyone can rename the channels they belong to, unless the system admin has [restricted the permissions to do so using advanced permissions](/administration-guide/onboard/advanced-permissions).
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select the channel name at the top of the center pane to access the drop-down menu, then select **Channel Settings**. You'll be prompted to provide two pieces of information:
- **Channel name:** The channel name that displays in the Mattermost user interface for all users. Enter a different channel name if needed or preferred.
- **Channel URL:** The web URL used to access the channel in a web browser. Select **Edit** to change the URL, and select **Done** to save your changes. If your system admin has enabled anonymous URLs (available in Mattermost from v11.6.0), channel and team URLs are assigned automatically and do not reflect the channel or team name.
When [channel category sorting](/administration-guide/configure/experimental-configuration-settings#enable-channel-category-sorting) is enabled (the default from Mattermost v11.8), channel admins can set a **Default category (optional)** for the channel. You can select an existing category, type a new category name, or clear the default category. Members who join the channel see it under that category in their sidebar.
For example, a channel could be named `UX Design` and have a URL of `https://community.mattermost.com/core/channels/ux-design` (or an anonymous URL if enabled by your system admin).
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap the channel you want to rename.
> ![Select a channel that you want to rename.](/images/mobile-select-a-channel.jpg)
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
> ![Tap on More options to access available options for the channel.](/images/mobile-select-more-options-for-a-channel.jpg)
3. Tap **View info**.
> ![Tap on View info to see the basic channel info.](/images/mobile-select-view-info-for-a-channel.jpg)
4. Tap **Edit Channel**.
> ![Click on Edit channel to rename the channel.](/images/mobile-edit-channel.jpg)
5. You're prompted to provide three pieces of information:
> - **Name:** This appears in the Mattermost user interface.
> - **Purpose:** (Optional) Used to describe the channel's function or goal.
> - **Header:** (Optional) Used to include information relevant to the channel, such as key contacts or document links.
>
> Tap on **Save** to save the new channel name.
>
> ![Type the new channel name and click on Save to rename the channel.](/images/mobile-rename-channel-name-and-save.jpg)
</TabItem>
</Tabs>

View File

@@ -0,0 +1,48 @@
---
title: "Reply to messages"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Reply to messages by selecting the **Reply** <img src={useBaseUrl('/img/ui/reply-outline_F0F20.svg')} alt="Reply icon." className="theme-icon" /> icon next to the message text.
![Reply to Mattermost messages](/images/reply-to-message.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
Long press on a message and select **Reply** or simply tap on it to reply.
![Tap and hold on text to select reply.](/images/mobile-reply-to-a-message-using-reply.gif)
![Tap on a Message to send a reply.](/images/mobile-reply-to-a-message-by-tapping-on-it.gif)
</TabItem>
</Tabs>
Depending on how your system admin has configured Mattermost, you may be able to [edit](/end-user-guide/collaborate/send-messages#edit-messages), [restore](/end-user-guide/collaborate/send-messages#restore-a-previous-version-of-an-edited-message), and [delete](/end-user-guide/collaborate/send-messages#delete-messages) messages after you've sent them.
<Tip>
It's easy to return to a message in progress with global message drafts. Find all of your draft messages in the **Drafts** view available at the top of the channel sidebar. See the [draft messages](/end-user-guide/collaborate/send-messages#draft-messages) documentation for details.
</Tip>
## Organize discussions into threads
When you reply to messages, those replies are [organized into a discussion thread](/end-user-guide/collaborate/organize-conversations). Threaded discussions are easy to follow and allow multiple parallel conversations to occur at the same time without confusion.
Using Mattermost in a web browser or the desktop app, replies appear indented slightly in the center pane to indicate that they are child messages of a parent message. Selecting the reply link opens a sidebar in the right-hand sidebar in a web browser and the desktop app. To expand the right-hand sidebar to its full width, select the **Expand** icon with two arrows at the top of the sidebar.
![Expand right-hand sidebar to its full width](/images/expand-sidebar.png)
To shrink the right-hand sidebar to its original width, select the same **Collapse** icon.
![Collapse the right-hand sidebar to its original width](/images/collapse-sidebar.png)

View File

@@ -0,0 +1,121 @@
---
title: "Save and pin messages"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
You have two ways to mark a post to make it easy to find later:
- [Saving a message](#save-messages) saves it for only you.
- [Pinning a message](#pin-messages) marks it for an entire channel.
## Save messages
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Save messages for later follow up by selecting the **Save** <img src={useBaseUrl('/img/ui/bookmark-outline_F00C3.svg')} alt="Save icon." className="theme-icon" /> icon next to a message.
![Save messages for later follow up using the Save option.](/images/save-message.png)
To see all of your saved messages, select the **Bookmark** icon to the left of your profile picture. The right-hand sidebar opens to show the list of saved messages.
Remove an item from your **Saved Posts** list by selecting the **Save** icon next to message to clear it.
![Remove saved messages by toggling the Save option.](/images/remove-from-saved-posts.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
Long press a message, and then select **Save**.
![Tap and hold on a message in the channel to explore available options to save it.](/images/mobile-save-a-message.gif)
To see all of your saved messages, tap the **Save** <img src={useBaseUrl('/img/ui/bookmark-outline_F00C3.svg')} alt="Save icon." className="theme-icon" /> icon at the bottom of the app.
![Tap on Save icon at the bottom of the app to access the Saved Messages list.](/images/mobile-view-saved-messages.gif)
Remove an item from your **Saved Messages** list by long pressing a message and selecting **Unsave**.
![Tap and hold on a message in the saved messages list to explore available options to unsave it.](/images/mobile-unsave-a-message-from-saved-messages.gif)
Alternatively, you can also tap on the saved message in a channel and then tap the <img src={useBaseUrl('/img/ui/bookmark_F00C0.svg')} alt="Saved icon." className="theme-icon" /> icon below it to unsave.
![Tap and hold on a saved message in the channel to explore available options to unsave it.](/images/mobile-unsave-a-message-from-the-channel.gif)
</TabItem>
</Tabs>
## Pin messages
All members of a channel can pin important or useful messages to that channel. The list of pinned messages is visible to all channel members. There is no limit to the number of pinned posts in a channel. From Mattermost v10.2, the **Pinned** <img src={useBaseUrl('/img/ui/pin-outline_F0931.svg')} alt="Pin icon used to indicate when there are pinned messages in a given channel." /> icon is hidden when no messages are pinned.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Hover over the message that you want to pin. The **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon link appears.
2. Select the **More** option, then select **Pin to channel**.
![You can pin messages to make them easy to return to later.](/images/pin-message-to-channel.png)
Pinned messages are marked with the pinned icon. For example:
![An example of a pinned message in a channel marked with a pin icon.](/images/pinned-example-channel.png)
To see all pinned messages in a channel, select the **Pinned posts** icon in the channel header.
![Open pinned messages in the right-hand sidebar.](/images/pinned-posts.png)
The right-hand sidebar opens to show the list of pinned messages. For example:
![Review the list of pinned messages.](/images/pinned-example-rhs.png)
To unpin a message:
1. Mouse over the message that you want to unpin. The **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon link appears.
2. Select the **More** icon, then select **Unpin from channel**
![You can unpin messages from a channel when they're no longer needed or become outdated.](/images/unpin-message-from-channel.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
Long press a message, and then select **Pin to Channel**.
![Tap and hold on a message in the channel to explore available options to pin it.](/images/mobile-pin-a-message-to-the-channel.gif)
To see all of your pinned messages in a channel:
1. Tap the channel whose pinned messages you want to review.
![Select a channel whose pinned messages you want to view.](/images/mobile-select-a-channel.jpg)
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
![Tap on More options to access available options for the channel.](/images/mobile-select-more-options-for-a-channel.jpg)
3. Tap **View Info**.
![Tap on View info to view additional information about the channel.](/images/mobile-select-view-info-for-a-channel.jpg)
4. Tap **Pinned Messages**.
![Tap on Pinned Messages to view the list of pinned messages.](/images/mobile-edit-channel.jpg)
![View the specific pinned message you want to see from the list.](/images/mobile-view-the-pinned-message-in-the-pinned-messages-list.jpg)
Remove an item from your **Pinned Messages** list by long pressing a message and selecting **Unpin from Channel**.
![Tap and hold on a message in the pinned messages list to explore available options to unpin it.](/images/mobile-unpin-a-message-from-pinned-messages.gif)
Alternatively, you can long press on a pinned message in the channel and then tap on **Unpin from Channel** to unpin it.
![Tap and hold on a pinned message in the channel to explore available options to unpin it.](/images/mobile-unpin-a-message-from-the-channel.gif)
</TabItem>
</Tabs>

View File

@@ -0,0 +1,68 @@
---
title: "Schedule messages"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
There are times when you want to send a message, but you don’t want it sent immediately. For example, it may be after working hours for the recipient. Scheduled messages can include a [priority](/end-user-guide/collaborate/message-priority), [request acknowledgements](/end-user-guide/collaborate/message-priority#request-acknowledgements), include [file attachments](/end-user-guide/collaborate/share-files-in-messages), and include anything that a non-scheduled message can contain, except [slash commands](/integrations-guide/run-slash-commands).
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
From Mattermost v10.3, you can schedule messages to send in the future. Compose a message, then select the right side of **Send** to schedule when the message will be sent. You can choose from a fixed time or set a custom time, and Mattermost displays both your local time and the recipient’s local time.
![Compose a message and select the right side of the \*\*Send\*\* button to schedule when the message will be sent.](/images/schedule-a-message.png)
</TabItem>
<TabItem value="mobile" label="Mobile">
From Mattermost mobile v2.28, you can schedule messages to send in the future. Compose a message, then long press on **Send** to schedule when the message will be sent. You can choose from a fixed time or set a custom time, and Mattermost displays both your local time and the recipient’s local time.
</TabItem>
</Tabs>
## Manage scheduled messages
Once you schedule a message to send in the future, that message is available within the [Drafts view](/end-user-guide/collaborate/send-messages#draft-messages), under the **Scheduled** tab.
You can manage scheduled messages with the following actions:
- **Delete scheduled post**: Confirm that you want to delete the message.
- **Edit scheduled post**: Make changes to the draft inline before its sent.
- **Copy text**: Copy the draft text.
- **Reschedule message**: Change when the message should be sent.
- **Send now**: Confirm that you want to send the message immediately.
<img src={useBaseUrl('/images/manage-scheduled-message.png')} width="600" alt="Once a message is scheduled, you can delete, edit, and reschedule it, copy the message text, or send it immediately." />
<Note>
Once you schedule a message, file attachments are read-only and can't be changed.
</Note>
## Troubleshoot scheduled messages
Scheduled messages may fail for the following reasons:
- You're no longer a member of the channel.
- The channel is archived.
- The channel is read-only.
- The Mattermost server was down for more than 24 hours. Mattermost processes scheduled posts up to 24 hours old, so in cases where the server is down for short time, scheduled messages will be processed. Scheduled messages older than 24 hours may fail to send.
If a scheduled message fails to send, you'll be alerted 2 ways:
- A red badge displays a total scheduled post count in the left pane next to **Drafts**. <img src={useBaseUrl('/img/ui/schedule-count-red-badge.png')} alt="Total count of scheduled messages." />
- An alert banner displays on the **Scheduled** tab
<img src={useBaseUrl('/images/troubleshoot-scheduled-message.png')} width="600" alt="If a scheduled draft message can&#39;t be sent, Mattermost provides context about why it can&#39;t be sent on the Scheduled tab under Drafts." />
<Note>
You can't reschedule a failed message, but you can schedule a new replacement message.
</Note>

View File

@@ -0,0 +1,224 @@
---
title: "Search for messages"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
Use Mattermost search to find messages, replies, and the contents of files. You can also search by [hashtags](#hashtags), perform more advanced searches using [search modifiers](#search-modifiers), or adjust search results to show messages from the current team, a specific team, or all teams.
## Search for message
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Select the Search field, select **Messages**, enter your search criteria.
> ![Use the Search field to search for messages.](/images/search-messages.png)
>
> ![Use the expanded Search field to search for messages.](/images/search-messages-expanded.png)
2. By default, your search results include messages from all channels within your current team. From Mattermost v10.8, you can select **All Teams** to search all channels across all teams, select a specific team instead, or continue searching within the current team.
> ![Select All Teams to search all channels across all teams.](/images/search-all-teams.png)
>
> <div class="tip">
>
> <div class="title">
>
> Tip
>
> </div>
>
> From Mattermost v10.10, the `from:` search modifier is available for cross-team searches. When searching all teams, you must manually add the `from:` modifier as part of your search criteria to search by specific users across teams.
>
> </div>
3. When message results display in the Search Results pane, select **Jump** to view a full message in context.
> ![From search results, you can go to the full message by selecting Jump.](/images/jump-to-message.png)
<Tip>
From Mattermost v10.8, you can also adjust your search results to show messages from the current team, a specific team, or all teams.
</Tip>
<Tip>
When using Mattermost in a web browser or the desktop app, you can open your current search results in a separate popout window by selecting the **Open in new window** <img src={useBaseUrl('/img/ui/dock-window_F10AC.svg')} alt="Open thread in a new browser window icon." /> icon in the search results header.
</Tip>
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap the **Search** <img src={useBaseUrl('/img/ui/magnify_F0349.svg')} alt="Search for messages and files in Mattermost." className="theme-icon" /> icon at the bottom of the app to search for messages or files attached to messages.
> ![Tap on the Search icon to search for messages.](/images/mobile-search-for-messages.jpg)
2. By default, your search results include messages from all channels within your current team. From mobile v2.28, tap **All Teams** to search all channels across all teams, or select a specific team instead.
> ![Tap on the Team selector to select the team you want to search in.](/images/mobile-search-message-team-selection.jpg)
3. Enter your search criteria.
> ![Type your search criteria along with applicable hashtags.](/images/mobile-search-message-criteria-with-hashtags.jpg)
4. Tap to apply [search modifiers](#search-modifiers) to your search.
> ![Apply search modifiers to further refine your search.](/images/mobile-search-message-with-modifiers.jpg)
>
> ![Check the search results to find your required message or file from the list.](/images/mobile-search-message-results.jpg)
</TabItem>
</Tabs>
## Search for files
From the **Search** field, select **Files** to search for files attached to messages. From Mattermost v10.8 and mobile v2.28, you can specify whether you want to search all channels you're a member of in the current team, a specific team, or all channels across all teams.
![Use the Search field to serach for files attached to messages.](/images/search-files.png)
File contents that match on file name, or contain matching text content within supported document types, are returned in the Search Results pane. Each search result includes file name, extension, and size details, as well as details about when and where the file was originally shared. You can adjust search results to show messages from the current team, a specific team, or all teams.
- For Mattermost Cloud [workspaces](/end-user-guide/end-user-guide-index), supported document file formats include PDF, PPTX, DOCX, ODT, HTML, and plain text documents. DOC and RTF file formats, as well as the contents of ZIP files, are not supported.
- For Mattermost self-hosted deployments, supported document file formats include PDF, PPTX, DOCX, ODT, HTML, and plain text documents.
<Note>
7zip (`.7z`) files are not supported for file content search and are skipped during search indexing for security reasons. Only standard ZIP files are supported when ZIP file search is enabled.
</Note>
<Note>
System admins can extend file content search support for self-hosted deployments to include:
- [files shared before upgrading to Mattermost Server v5.35](/administration-guide/manage/mmctl-command-line-tool#mmctl-extract).
- [DOC and RTF file formats](/administration-guide/configure/environment-configuration-settings#enable-document-search-by-content).
- [documents within ZIP files](/administration-guide/configure/environment-configuration-settings#enable-searching-content-of-documents-within-zip-files).
</Note>
### Filter results by file type
Using Mattermost in a web browser or the desktop app, you can narrow search results further by selecting the **File Type Filter** option, then selecting specific file types, such as documents, spreadsheets, or images.
![You can filter search results by file type.](/images/file-search-filter.png)
### Access recently shared files
You can access files recently shared in a channel:
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select the <img src={useBaseUrl('/img/ui/file-text-outline_F09EE.svg')} alt="Use the Channel Files icon to search for files attached to messages in a given channel." className="theme-icon" /> icon to the right of the channel name to access files recently shared in that channel.
![Use the Channel Files option to access recently shared files in the current channel.](/images/channel-files-icon.png)
Alternatively, you can select the channel name, select the **View Info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon, then select **Files** in the right pane.
</TabItem>
<TabItem value="mobile" label="Mobile">
Tap the channel name to view channel options, then tap **Files**.
</TabItem>
</Tabs>
## Search modifiers
You can apply search modifiers to any search to reduce the number of results returned. Select a search modifier to add it to the Search field. Supported modifiers are described below. Your search results include messages from all of your teams.
### `from:` and `in:`
- Use `from:` to find messages or files from specific users.
- For example, searching `from:john.smith` only returns content from your direct message history with John Smith.
- From Mattermost v10.10, you can use `from:` in cross-team searches to find messages from specific users across all teams you're a member of.
- Use `in:` to find messages or files posted in specific public channels, private channels, direct messages, or group messages. You can specify channels by display name or channel ID.
- For example, searching `Mattermost in:town-square` only returns results in the Town Square public channel that contains the term `Mattermost`, while searching `Mattermost in:john.doe` only returns results that contains the term `Mattermost` in your direct message history with John Smith.
### `before:`, `after:`, and `on:`
- Use `before:` to find messages or files posted before a specified date.
- For example, searching `website before: 2018-09-01` returns messages or files containing the term `website` posted prior to September 1, 2018.
- Use `after:` to find messages or files posted after a specified date.
- For example, searching `website after: 2018-08-01` returns messages or files containing the term `website` posted after August 1, 2018.
- Use both `before:` and `after:` together to search in a specified date range.
- For example, searching `website before: 2018-09-01 after: 2018-08-01` returns all messages or files containing the term `website` posted between August 1, 2018 and September 1, 2018.
- Use `on:` to find messages or files posted on a specific date. Use the date picker to select a date, or type it in YYYY-MM-DD format.
- For example, searching `website on: 2018-09-01` returns messages or files containing the term `website` posted on September 1, 2018.
![Select the on modifier to specify messages or files for a specific a date.](/images/calendar2.png)
### Exclusions
Use the hyphen `-` symbol to exclude terms from your search results. For example, searching `test -release` only returns results that include the term `test` and exclude the term `release`.
This exclusion modifier can be used in combination with other modifiers to further refine search results. For example, searching `test -release -in:release-discussion -from:eric` returns all results with the term `test`, excludes posts with the term `release`, excludes posts made in the `release-discussion` channel, and excludes messages sent in direct messages by `eric`.
### Quotation marks
Use quotation marks `" "` to return search results for exact terms. For example, searching `"Mattermost website"` returns messages containing the exact phrase `Mattermost website`, but doesn't return results containing `Mattermost` and `website` as separate terms.
### Wildcards
Use the asterisk `*` symbol at the end of the word to perform a wildcard search. The wildcard search returns all words that begin with the specified letters. The wildcard in search cannot be used at the beginning or in the middle of a word. For example, searching `rea*` returns messages or files containing words like `reach`, `reason`, `reality`, `real`, and other words starting with `rea`. However, searches like `*each` and `re*ch` are invalid wildcard searches.
### Hashtags
Hashtags are searchable labels for messages. Anyone can create a hashtag in a message by using the pound sign `#` followed by alphanumeric or other unicode characters. Hashtag examples include: `#bug`, `#marketing`, `#user_testing`, `#per.iod`, `#check-in`, `#마케팅`.
Valid hashtags:
- Don't start with a number.
- Are at least three characters long, excluding the `#`.
- Are made up of alphanumeric or other unicode characters.
- May contain dots, dashes, or underscores.
To search for messages containing hashtags, select a hashtag in an existing post, or type the hashtag (including the pound `#` symbol) into the search bar.
<Note>
Hashtags don't link to channels. If you have a channel named “Marketing”, selecting a `#marketing` hashtag does not take you to the Marketing channel. To link to public channels, use the tilde `~` symbol followed by the channel name. For example `~marketing`.
</Note>
## Search public channels you haven't joined
<PlanAvailability slug="ent-plus" />
From Mattermost v11.6, when your system admin [enables searching public channels without membership](/administration-guide/configure/environment-configuration-settings#allow-searching-public-channels-without-membership), search results can include messages from public channels you haven't joined. Results are scoped to teams you belong to, so you'll only see messages from public channels in your teams. This setting doesn't affect private channels — you can only search private channels you're a member of.
## Notes about performing Mattermost searches
- Multiple-word searches return results that contain *all* of your search criteria.
- Search modifiers can help narrow down searches. See the [search modifiers](#search-modifiers) section for details.
- You can search Archived channels as long as you're a member of that channel.
- If you're unable to see messages or files in archived channels in your search results, ask your system admin if **Allow users to view archived channels** has been disabled via **System Console \> Site Configuration \> Users and Teams**.
- To remove archived channels from your search results, you can leave the Archived channels.
- Like many search engines, common words such as `the`, `which`, and `are` (known as "stop words"), as well as two-letter and one-letter search terms, are not shown in search results because they typically return too many results. See the [Technical notes about searching](#technical-notes-about-searching) section below for details.
- IP addresses (e.g. `10.100.200.101`) don't return results.
## Technical notes about searching
By default, Mattermost uses full text search support included in PostgreSQL. Select the **product menu** <img src={useBaseUrl('/img/ui/products_E82F.svg')} alt="Navigate between Channels, collaborative playbooks, and boards using the product menu icon." className="theme-icon" /> then select **About Mattermost** to see which database you’re using.
- Stop words are filtered out of search results. See [PostgreSQL](https://www.postgresql.org/docs/10/textsearch-dictionaries.html#TEXTSEARCH-STOPWORDS) database documentation for a full list of applicable stop words.
- URLs don’t return results.
- Hashtags or recent mentions of usernames containing a dash don't return results.
- Terms containing a dash return incorrect results since dashes are ignored in the search engine.
- From Mattermost v7.1, search results respect the `default_text_search_config` value instead of being hardcoded to English. We recommend that Mattermost system admins review this value to ensure it's set correctly.

View File

@@ -0,0 +1,238 @@
---
title: "Send messages"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
You can send messages in public and private channels as well as to other users in Mattermost. Depending on when you compose a message, you can send it immediately, [schedule it for later](/end-user-guide/collaborate/schedule-messages), or [set its priority](/end-user-guide/collaborate/message-priority).
Mattermost may notify you when a recipient's availability is set to [Do Not Disturb](/end-user-guide/preferences/set-your-status-availability#set-your-availability), and the recipient's local time is outside of regular business hours (between 10PM and 6AM). This warning displays directly above the message text field.
<Note>
From Mattermost v11.5, you can access help resources for message formatting by selecting the **Help** link below the message text field.
</Note>
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Enter a message in the text field, then select **Send** <img src={useBaseUrl('/img/ui/send_F048A.svg')} alt="Select the Send icon to post your message." className="theme-icon" /> to send the message.
<Tip>
You can also use a keyboard to send messages:
- Press <kbd>Enter</kbd> on Windows or Linux, or <kbd>↵</kbd> on Mac.
- You can configure Mattermost to require <kbd>Shift</kbd> <kbd>Enter</kbd> on Windows or Linux, or <kbd>⇧</kbd> <kbd>↵</kbd> on Mac to send multi-line messages. Select the **gear** <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> icon to go to **Settings**, then select **Advanced \> Send messages on CTRL+ENTER**.
</Tip>
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap the text field at the bottom of the Mattermost app to type a message.
![Type a message in the text box at the bottom of the mobile app.](/images/mobile-type-a-message-in-a-channel.jpg)
2. Tap **Send** <img src={useBaseUrl('/img/ui/send_F048A.svg')} alt="Select the Send icon to post your message." className="theme-icon" /> icon to send it in the channel.
![Tap on the send icon to send the message in the channel.](/images/mobile-sending-a-message.gif)
</TabItem>
</Tabs>
## Rewrite messages with AI
You can use AI to enhance your messages before sending them. This feature helps you improve writing quality, fix spelling, adjust message length, or transform your text based on specific needs.
From Mattermost v11.5, when you use AI Rewrite while composing a reply in a thread, the AI incorporates context from the thread to generate suggestions that better fit the ongoing conversation.
From Mattermost v11.7, Rewrite is accessed through the **AI Actions** <img src={useBaseUrl('/img/ui/creation-outline_F1C2B.svg')} alt="AI Actions icon." className="theme-icon" /> menu, alongside any custom prompts your system admin has made available.
On Web/Desktop or Mobile:
> 1. Type your message in the message compose field.
> 2. Open the **AI Actions** <img src={useBaseUrl('/img/ui/creation-outline_F1C2B.svg')} alt="AI Actions icon." className="theme-icon" /> menu from the message actions, then select **Rewrite**.
> 3. Select a bot from the list of available AI agents.
> 4. Choose from available rewrite options:
> - **Improve writing**: Enhance clarity and professionalism
> - **Fix spelling**: Correct spelling and grammar errors
> - **Shorten**: Make your message more concise
> - **Elaborate**: Add more detail and context
> - **Simplify**: Use clearer, easier-to-understand language
> - **Summarize**: Condense your message to key points
> - **Custom prompt**: Specify your own transformation instructions
> 5. Review the AI-generated suggestion. Select **Regenerate** to try again or **Discard** to return to your original message.
> 6. Select **Send** <img src={useBaseUrl('/img/ui/send_F048A.svg')} alt="Select the Send icon to post your message." className="theme-icon" />
<Tip>
From Mattermost v11.7, system admins can publish custom prompts that appear alongside Rewrite in the **AI Actions** <img src={useBaseUrl('/img/ui/creation-outline_F1C2B.svg')} alt="AI Actions icon." className="theme-icon" /> menu. If you don't see a custom prompt you expect, check with your system admin.
</Tip>
<Note>
Messages that have been rewritten using AI are automatically marked as AI-generated content for transparency. Your system admin must [configure AI agents](/administration-guide/configure/agents-admin-guide) for the rewrite feature to be available.
</Note>
## Send burn-on-read messages
<PlanAvailability slug="entry-adv" />
From Mattermost v11.3, burn-on-read messages stay concealed until recipients reveal them. After revealing, the message is deleted for that recipient when the timer expires. Burn-on-read messages can't be replied to or edited. You can send burn-on-read messages unless your system admin has [disabled the ability to do so](/administration-guide/configure/site-configuration-settings#enable-burn-on-read-messages) in your Mattermost instance.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Compose your message.
2. Select the **Burn-on-read** <img src={useBaseUrl('/img/ui/fire_F0238.svg')} alt="Burn on Read icon." className="theme-icon" /> icon in the message toolbar.
3. Select **Send** <img src={useBaseUrl('/img/ui/send_F048A.svg')} alt="Select the Send icon to post your message." className="theme-icon" />
</TabItem>
<TabItem value="mobile" label="Mobile">
From Mattermost mobile v2.38.0, you can send burn-on-read messages from the mobile app.
1. Compose your message.
2. Tap the **Burn-on-read** <img src={useBaseUrl('/img/ui/fire_F0238.svg')} alt="Burn on Read icon." className="theme-icon" /> icon in the message toolbar.
3. Tap **Send** <img src={useBaseUrl('/img/ui/send_F048A.svg')} alt="Select the Send icon to post your message." className="theme-icon" />
</TabItem>
</Tabs>
Recipients see a concealed placeholder with **Reveal**. After revealing, a timer shows when the message will be deleted.
As the message sender, hover over the **Burn-on-read** <img src={useBaseUrl('/img/ui/fire_F0238.svg')} alt="Burn on Read icon." className="theme-icon" /> icon above the sent message to see how many recipients have read the message. You can also delete the burn-on-read message for all recipients before the timer expires by selecting the **Burn-on-read** <img src={useBaseUrl('/img/ui/fire_F0238.svg')} alt="Burn on Read icon." className="theme-icon" /> icon above the sent message.
## Draft messages
From Mattermost v7.7, when composing new messages, it's easy to return to a message in progress later, unless your system admin has [disabled global drafts](/administration-guide/configure/site-configuration-settings#enable-server-syncing-of-message-drafts) in the System Console.
By default, message drafts are synchronized on the Mattermost server and are accessible everywhere you access Mattermost, including a web browser or the desktop app. Limit drafts to your current Mattermost client only by going to **Settings \> Advanced \> Allow message drafts to sync with the server** to disable draft synchronization.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Draft messages are added to a **Drafts** view available at the top of the channel sidebar.
<img src={useBaseUrl('/images/Global-Drafts-Animated-GIF.gif')} width="700" alt="Global drafts makes it easy for you to find all messages in progress." />
</TabItem>
<TabItem value="mobile" label="Mobile">
When composing a message, you can simply choose to complete it later. The partially composed message is kept in the text field and an **Edit** option <img src={useBaseUrl('/img/ui/pencil-outline_F0CB6.svg')} alt="Edit icon." className="theme-icon" /> displays next to the channel name.
From Mattermost v10.5, you'll find local draft messages under **Drafts**. Drafts synchronized to the Mattermost server will be listed under **Drafts** in a future mobile app release.
![You can sync a daft message by exiting the channel mid-way while composing the message.](/images/mobile-draft-a-message.gif)
</TabItem>
</Tabs>
## Edit messages
All users can edit their own sent messages, unless the system admin has [restricted the ability to do so](/administration-guide/onboard/advanced-permissions).
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Using Mattermost in a web browser or the desktop app, select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a message that you've sent.
> ![Select the More option to edit or delete a sent message.](/images/more-actions.png)
2. Select **Edit** to edit your own messages. Editing a message won't trigger new [@mention notifications](/end-user-guide/collaborate/mention-people), or [desktop notifications](/end-user-guide/preferences/manage-your-notifications).
<Tip>
From Mattermost v10.5, using a web browser or the Mattermost Desktop app, you can also change or remove message attachments when editing your sent messages.
</Tip>
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Long press on the message that you want to edit and tap on **Edit**.
![Tap and hold on a message that you want to edit.](/images/mobile-edit-a-message.gif)
2. Type the updated message and tap on **Save**.
![Type the updated message and tap save to save the edited message.](/images/mobile-editing-a-message.jpg)
<Tip>
From Mattermost v10.11 and mobile app v2.31.0, when editing messages on mobile, you can also view, delete, and save message attachments as you would when using Mattermost in a web browser or the desktop app.
</Tip>
</TabItem>
</Tabs>
### Restore a previous version of an edited message
From Mattermost v7.9, [Mattermost Enterprise or Professional](https://mattermost.com/pricing) customers can [edit or delete messages](#edit-or-delete-messages) after sending them if your system admin hasn't restricted the ability to do so using [advanced permissions](/administration-guide/onboard/advanced-permissions).
Message recipients can't see your message edit history, and restoring a previous message version won't trigger new [@mention notifications](/end-user-guide/collaborate/mention-people).
<Note>
Restoring a previous version of the message is available in the Mattermost desktop app or a web browser. The ability to restore using the mobile app isn't supported.
</Note>
1. Select the word **Edited** next to your message.
2. In the right pane, review all previous versions of the message.
3. Select the **Restore** <img src={useBaseUrl('/img/ui/restore_F099B.svg')} alt="Use the Restore icon to restore a previous version of an edited message." className="theme-icon" /> icon next to the version you want to restore.
4. Select **Confirm**.
![Select Edited next to an edited message, and then select the version you want to restore.](/images/restore-previous-edited-message.gif)
## Delete messages
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
All users can delete their own sent messages, unless the system admin has [restricted the ability to do so](/administration-guide/onboard/advanced-permissions).
1. Using Mattermost in a web browser or the desktop app, select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a message that you want to delete.
2. Select **Delete** to delete your own messages. Select **Delete** again to confirm.
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Long Press on the message you want to delete and tap on **Delete**.
![Tap and hold on the message that you want to delete.](/images/mobile-delete-a-message.gif)
2. Tap on **Delete** again to confirm your choice.
![Confirm your choice to delete the message.](/images/mobile-confirm-delete-a-message.jpg)
</TabItem>
</Tabs>
## Do more with your messages
<Tip>
Using a RTL plugin, Mattermost can automatically detect and display messages written using right-to-left scripts, such as Arabic, Hebrew, or Persian. Your system admin must install the [RTL Plugin](https://github.com/QueraTeam/mattermost-rtl) to enable this functionality.
</Tip>
Do more with your Mattermost messages using the following features:
- [Format messages](/end-user-guide/collaborate/format-messages)
- [Mention people](/end-user-guide/collaborate/mention-people)
- [Share files](/end-user-guide/collaborate/share-files-in-messages)
- [Share links to channels and messages](/end-user-guide/collaborate/share-links)

View File

@@ -0,0 +1,107 @@
---
title: "Share files in messages"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
With file attachments, you can share additional information that helps your team to visually understand your ideas. Sharing videos, voice recordings, screenshots, and photos can make your messages more effective and clear.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
You can share files with other Mattermost users or entire channels by:
- Dragging and dropping files into channels.
- Selecting the **Attachment** <img src={useBaseUrl('/img/ui/paperclip_F03E2.svg')} alt="Add a message attachment using the Upload files icon in the message formatting toolbar." className="theme-icon" /> icon in the message input box.
- Pasting from the clipboard.
## Share public links
Public links allow you to share message attachments with anyone outside your Mattermost [workspace](/end-user-guide/end-user-guide-index). To share an attachment, select the thumbnail of an attachment, then select **Get Public Link**.
<Tip>
If **Get Public Link** is not visible in the file previewer, ask your system admin to enable the feature from the System Console under **Site Configuration \> Public Links**.
</Tip>
## Download files
You can download an attached file by selecting the **Download** <img src={useBaseUrl('/img/ui/download-outline_F0B8F.svg')} alt="Use the Download icon to download an attached file to your local system." className="theme-icon" /> icon next to the file thumbnail.
<Tip>
From Mattermost desktop app v5.2, you can review download status, access downloads, and clear the list of downloads from a new **Downloads** <img src={useBaseUrl('/img/ui/arrow-down-bold-circle-outline_F0048.svg')} alt="Use the desktop app download icon to review download status, as well as access and clear the list of downloaded files." className="theme-icon" /> option located in the top-right corner of the desktop app window.
</Tip>
## Access files
Access all files shared in a channel by selecting the **Channel files** <img src={useBaseUrl('/img/ui/file-text-outline_F09EE.svg')} alt="Use the Channel Files icon to search for files attached to messages in a given channel." className="theme-icon" /> icon in the channel header.
</TabItem>
<TabItem value="mobile" label="Mobile">
You can share files with other Mattermost users or entire channels by tapping the **Attachment** <img src={useBaseUrl('/img/ui/paperclip_F03E2.svg')} alt="Add a message attachment using the Upload files icon in the message formatting toolbar." className="theme-icon" /> icon under the message input box when composing a message.
From Mattermost v10.7 and mobile v2.27, you can play and download audio files directly from the message thread.
![Tap on attachment icon to attach a file and send it in the channel.](/images/mobile-attach-a-file-to-send-in-a-channel.gif)
## Access files on mobile
1. Tap the channel name at the top of the screen.
![Click on the channel name to explore available options.](/images/mobile-channel-name-click.jpg)
2. Tap **Files**.
![Tap on Files to explore the available file attachments in the channel.](/images/mobile-edit-channel.jpg)
3. Tap a file to download it, open it, or copy a public link to the file.
![Tap on a file to download and open it.](/images/mobile-tap-a-file-name-to-download.jpg)
Or you can also click on <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> to download the file or open it in the channel.
![You can also use more options to download ot view the file in the channel.](/images/mobile-more-options-to-download-or-view-a-file.jpg)
</TabItem>
</Tabs>
## Attachment limits and sizes
Up to 10 files can be attached per post. The default maximum file size is 100 MB, but this can be changed by the system admin. See our [Configuration Settings](/administration-guide/configure/environment-configuration-settings#maximum-file-size) product documentation for details.
Image files can be a maximum size of 7680 pixels x 4320 pixels, with a maximum image resolution of 33 MP (mega pixels) or 8K resolution, and a maximum raw image file size of approximately 253 MB. System admins can customize the maximum image resolution size within the `config.json` file. See our [Configuration Settings](/administration-guide/configure/experimental-configuration-settings#maximum-image-resolution) product documentation for details.
## Preview file attachments
Mattermost has a built-in file previewer that you can use to:
- Download files
- Share public links
- View media
Select the thumbnail of an attached file to open it in the file previewer.
### View media
The following media formats are supported on most browsers:
- Images: BMP, GIF, JPG, JPEG, PNG, SVG, WEBP
- Video: browser supported video formats, including but not limited to MP4 and MOV
- Audio: MP3, M4A
- Files: PDF, TXT
Other document previews (such as Word, Excel, or PPT) are not yet supported.
## Restricted file attachments
If your administrator has configured attribute-based permission policies on your Mattermost instance, file uploads or downloads may be restricted based on your user attributes. Restricted attachments appear in messages with the placeholder **Files not available** and the subtitle **Access to files is restricted based on attributes**.
If you expect to have access to a restricted file and don't, contact your Mattermost administrator. For administrator-facing details, see [Permission policies](/administration-guide/manage/admin/abac-system-wide-policies#permission-policies).

View File

@@ -0,0 +1,77 @@
---
title: "Share links to channels and messages"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
You can share links to Mattermost [channels](#share-channel-links) and [messages](#share-message-links) with other Mattermost users.
## Share channel links
Sharing channel links makes it easy for others to find and join channels. To share a link to a channel, type `~` into the message text box, then select the channel you want to link to. If you're a member of multiple teams, only channels for the current team are listed.
<Tip>
Alternatively, you can select the **View info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon in the top right corner of the screen to access additional channel management options, including a **Copy Link** option you can share with others.
</Tip>
## Share message links
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Sharing message links displays a preview of the message in the post. To share links to messages in Mattermost, select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a message, then select **Copy Link**.
![When you hover over messages, you can access more message options from the More icon.](/images/message-more.png)
![You can share links to messages with others using the More option.](/images/copy-link.png)
Paste the link into a message to share the image link with others. Sharing links to messages generates a preview of the message.
![Mattermost generates previews of links shared in Channels.](/images/permalink-previews.png)
<Tip>
- You can also hover over an image and select the <img src={useBaseUrl('/img/ui/link-variant_F0339.svg')} alt="Use the Copy Link icon to copy the public URL link for an image in a message." className="theme-icon" /> icon in the top right corner.
- The timestamp next to the username of any message is also a permanent link to that conversation.
</Tip>
</TabItem>
<TabItem value="mobile" label="Mobile">
Long press a message, and then tap **Copy Link** to copy the link to the clipboard. Long press to paste the link as a message or reply. From mobile v2.23, sharing links to messages generates a preview of the message.
![Tap and hold on a message to access the available options.](/images/mobile-copy-a-link-to-the-message.gif)
</TabItem>
</Tabs>
<Note>
- Message previews respect channel membership permissions, so they’re only visible to users who have access to the original message. If the link is to a message in a public channel, any member of the team can see the message preview. If the link is to a message in a private channel or direct message, only members in that channel can see the message preview.
- If you're unable to share links, contact your Mattermost system admin for assistance. An [SSL certificate (or a self-signed certificate)](/administration-guide/onboard/ssl-client-certificate) may be required for this functionality to work.
</Note>
## Deep links
Deep links are a powerful feature in Mattermost that allow you to create direct links to specific teams, channels, messages, or threads. These links can be used to quickly navigate to important content within Mattermost, enhancing collaboration and efficiency.
Deep links can also be used, in combination with bots, scripts, and integrations, to trigger specific actions within Mattermost.
From Mattermost v10.11, [channel bookmarks](/end-user-guide/collaborate/manage-channel-bookmarks) containing `mattermost://` open directly in the desktop app using deep linking. This turns channel bookmarks into one-click shortcuts that enable you jump straight to key assets in Mattermost quickly and easily.
### Format deep links
Deep links must be formatted in Mattermost as follows:
- Deep link to a team: `mattermost://<your-Mattermost-server-URL>/<team-name>`
- Deep link to a channel: `mattermost://<your-Mattermost-server-URL>/<team-name>/channels/<channel-name>`
- Deep link to a channel message or thread: `mattermost://<your-Mattermost-server-URL>/<team-name>/pl/<post-id>`
- Deep link to a direct message: `mattermost://<your-Mattermost-server-URL>/<team-name>/messages/@<user-name>`

View File

@@ -0,0 +1,52 @@
---
title: "Team keyboard shortcuts"
---
<PlanAvailability slug="all-commercial" />
Keyboard shortcuts help you make a more efficient use of your keyboard when navigating Mattermost teams in a web browser or the desktop app.
<Tip>
See a list of available keyboard shortcuts any time by pressing <kbd>Ctrl</kbd> <kbd>/</kbd> on Windows or Linux, pressing <kbd>⌘</kbd> <kbd>/</kbd> on Mac, or using the `/shortcuts` slash command.
</Tip>
## Team navigation
The following keyboard shortcuts are supported in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost Desktop App.
<table>
<colgroup>
<col style={{width: '100%'}} />
</colgroup>
<thead>
<tr>
<th>On Windows &amp; Linux</th>
<th>On Mac</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Alt</kbd> <kbd>↑</kbd></td>
<td><kbd>⌘</kbd> <kbd>⌥</kbd> <kbd>↑</kbd></td>
<td>Navigate to the previous team.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Alt</kbd> <kbd>↓</kbd></td>
<td><kbd>⌘</kbd> <kbd>⌥</kbd> <kbd>↓</kbd></td>
<td>Navigate to the next team.</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd> <kbd>Alt</kbd> <kbd>1</kbd>-<kbd>9</kbd></td>
<td><kbd>⌘</kbd> <kbd>⌥</kbd> <kbd>1</kbd>-<kbd>9</kbd></td>
<td>Navigate to a specific team.</td>
</tr>
</tbody>
</table>
<Note>
Though Mattermost keyboard shortcuts support standard languages and keyboard layouts, they may not work if you use keymapping that overwrites default browser shortcuts.
</Note>

View File

@@ -0,0 +1,129 @@
---
title: "Team settings"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
Team settings enable system and team administrators to adjust settings applied to a specific team. Using Mattermost in a web browser or the desktop app, select the team name to access **Team Settings**.
![Access team settings from the team name.](/images/team-settings.png)
## Info settings
Info settings provide configuration options for how teams are displayed to users.
### Team name
Your **Team Name** is displayed on the login screen, and in the top of the channel sidebar for your team.
Team names can contain any letters, numbers, or symbols, must be 2 - 64 characters in length, and are case-sensitive.
<Note>
Team names don't support [some unicode characters](https://www.w3.org/TR/unicode-xml/#Charlist).
</Note>
### Team description
Your **Team Description** is displayed when viewing the list of teams available to join and in the tooltip when hovering over the team name in the team sidebar.
You can enter a description up to 50 characters in length.
<Note>
Team descriptions don't support [some unicode characters](https://www.w3.org/TR/unicode-xml/#Charlist).
</Note>
### Team icon
A **Team Icon** displays in the team sidebar. By default, the team icon contains the first two letters of the team name.
To customize the team icon:
1. Select **Team Settings**.
2. Select the Team Icon **Edit** option.
![Manage the team icon from Team Settings.](/images/edit-team-icon.png)
3. Select an icon image in BMP, JPG, or PNG format. We recommend using square images with a solid background color since transparency in PNG icons fills with a white background in the team sidebar.
4. Select **Save**.
<Tip>
When a team icon is configured, select **Remove image** to reset the team icon to the default icon containing the first two letters of the team name.
</Tip>
## Access settings
Access settings enable the ability to control who can join the team.
### Discoverability
System and team administrators control whether the team is public or private using two selection cards:
- **Public Team** — anyone on the server can find the team, and join it if they meet any other join restrictions, such as approved email domains. The team appears on the server landing page and in the **Teams you can join** page.
- **Private Team** — only invited members can join. The team isn't listed for users who aren't already members.
<Note>
From Mattermost v11.10, these cards replace the **Allow any user to join** checkbox. This change applies to every team on every deployment. **Public Team** is equivalent to the checkbox being enabled, and **Private Team** is equivalent to it being disabled.
</Note>
<Important>
Switching a team from **Public Team** to **Private Team** regenerates the team's invite code. This creates a new invitation link and invalidates any link shared previously.
</Important>
<Tip>
When a team is set to **Public Team**, users looking for more teams to join will also see this team in the list when they select the <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> icon in the team sidebar.
</Tip>
On teams managed by AD/LDAP group synchronization, the cards aren't shown. Instead, the Access tab displays a message noting that members of the team are added and removed by linked groups.
### Users with a specific email domain
System and team administrators can limit who can join the team based on their email domain. Enable this option to specify approved email domains. Separate multiple email domains using spaces, commas, pressing <kbd>Tab</kbd>, or pressing <kbd>Enter</kbd>.
When enabled, only users that have an email domain from the approved domain list is able to join the team. The setting's intent is solely to gate joining a team. Once joined, team members will be able to update their email to a non-approved domain without any restrictions. Additionally, team members who joined prior to approved domains being specified won't be removed from the team once approved email domains are configured and enforced.
<Important>
Mattermost deployments using [email authentication](/administration-guide/configure/authentication-configuration-settings#enable-sign-in-with-email) must also enable the [require email verification configuration setting](/administration-guide/configure/authentication-configuration-settings#require-email-verification) for domain restrictions to be effective.
</Important>
### Invite code
The **Invite Code** is used as part of the URL in team invitation links. Select **Regenerate** to create a new invitation link and invalidate any previous link.
## Team Membership
<PlanAvailability slug="entry-adv" />
From Mattermost v11.10, the **Team Membership** tab is available to Team Admins when [Attribute-Based Access Control (ABAC)](/administration-guide/manage/admin/attribute-based-access-control) is enabled by a System Admin. It allows Team Admins to view the system policy applied to their team and define attribute-based rules that control who can be a member of the team itself.
On private teams these rules are enforced: users who don't match can't join, and members who no longer match are removed at the next sync. On public teams the rules are advisory — qualifying users are highlighted as recommended, but anyone can still join.
See [Team membership access policies](/administration-guide/manage/admin/abac-team-membership) for full details.
## Channel Membership
<PlanAvailability slug="entry-adv" />
The **Channel Membership** tab is available to Team Admins when [Attribute-Based Access Control (ABAC)](/administration-guide/manage/admin/attribute-based-access-control) is enabled by a System Admin. It allows Team Admins to create and manage attribute-based membership policies for private and public channels within the team. On private channels the policies are enforced. On public channels they're advisory — matching users can be added automatically or shown the channel as recommended, but no one is removed.
<Note>
This tab was previously labelled **Membership Policies**. It was renamed in Mattermost v11.10 to distinguish it from the new **Team Membership** tab.
</Note>
See [Team-level channel membership policies](/administration-guide/manage/admin/abac-team-channel-policies) for full details.

View File

@@ -0,0 +1,22 @@
---
title: "End User Guide"
---
If you're using Mattermost to connect and collaborate, build repeatable, automated processes, and making Mattermost match your work preferences, this Mattermost end user product documentation is for you.
In this documentation, you'll learn about using Mattermost. Your Mattermost system admin has deployed Mattermost for your organization. A live Mattermost instance is ready for you to log into using your user credentials. Your Mattermost workspace is where you'll send and receive messages, see activity notifications, create, run, and participate in playbook runs, and where you'll customize look and feel through workspace preferences.
- [Access your workspace](/end-user-guide/access/access-your-workspace) - Learn how to access Mattermost using web, desktop, or mobile apps, and authenticate with your credentials.
- [Collaborate](/end-user-guide/collaborate/collaborate-index) - Learn how to use Mattermost to connect and collaborate with your teammates through channels, messages and threads, and audio calls with screen sharing.
- [Workflow Automation](/end-user-guide/workflow-automation/workflow-automation-index) - Learn how to use Mattermost Playbooks to build repeatable processes, move faster, and make fewer mistakes with checklist-based automations.
- [AI Agents](/end-user-guide/agents) - Learn how to use AI agents to help you make decisions, find information, and automate repetitive tasks.
- [Project Management](/end-user-guide/project-management/project-management-index) - Learn how to use Mattermost Boards to coordinate operational work with Kanban-style planning.
- [Preferences](/end-user-guide/preferences/preferences-index) - Learn how to make Mattermost match the way you prefer to work.
- [View system information](/end-user-guide/view-system-information) - Check your Mattermost version and server details when you need them for troubleshooting or a support request.
![An example of the Mattermost screen that includes teams, the channel sidebar, an active conversation in the center pane, reply threads in the right-hand pane.](/images/Channels_Hero.png)
<Tip>
From Mattermost v9.1, when using Mattermost in a browser or the desktop app, you can resize both the channel sidebar and right-hand sidebar panes!
</Tip>

View File

@@ -0,0 +1,164 @@
---
title: "Connect to multiple Mattermost workspaces"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
Using the Mattermost desktop or mobile app, you can connect to multiple Mattermost servers from a single interface, and manage system permissions.
## Add a server
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
The **Server** list is located in the top left corner of the window and displays all servers available. Drag to reorder the servers in the list. You can also navigate the server options using [keyboard shortcuts](/end-user-guide/collaborate/keyboard-shortcuts).
<Note>
If you're using the desktop app prior to release v5.0, individual servers display as separate tabs at the top of the window instead of the top left corner of the window as a list, and servers are managed by going to **… \> File \> Settings** on Windows and **Mattermost \> Preferences** on Mac.
</Note>
1. Select **Add a server**.
> ![Connect the desktop app to a Mattermost Server using options located in the top left corner of the Mattermost screen.](/images/desktop-server-add.png)
2. Enter the server URL. Server URLs must begin with either `http://` or `https://`.
> <div class="tip">
>
> <div class="title">
>
> Tip
>
> </div>
>
> Can't find your Mattermost server URL? Ask your company’s IT department or your Mattermost system admin for your organization’s **Mattermost Site URL**. It’ll look something like `https://example.com/company/mattermost`, `mattermost.yourcompanydomain.com`, or `chat.yourcompanydomain.com`. These URLs could also end in `.net`.
>
> </div>
3. Enter the server's Display Name.
4. \[Desktop only\] If your server requires an authentication secret, you'll be prompted to enter it when you connect. Enter the secret provided by your administrator and select **OK**.
5. Select **Add**.
</TabItem>
<TabItem value="mobile" label="Mobile">
Tap the **Servers** <img src={useBaseUrl('/img/ui/server-variant_E81F.svg')} alt="Access server connection options using the Servers icon." className="theme-icon" /> icon located in the top left corner of the window to access all available servers and to add new servers.
1. Tap **Add a server**.
2. Enter the server URL. Server URLs must begin with either `http://` or `https://`.
<Tip>
Can't find your Mattermost server URL? Ask your company’s IT department or your Mattermost system admin for your organization’s **Mattermost Site URL**. It’ll look something like `https://example.com/company/mattermost`, `mattermost.yourcompanydomain.com`, or `chat.yourcompanydomain.com`. These URLs could also end in `.net`.
</Tip>
3. Enter the server's Display Name.
4. Optionally toggle the **Advanced Options** section to enter an **Authentication secret**. This is an additional security measure that some organizations use. Your system admin can provide you with the secret if required.
> <img src={useBaseUrl('/images/mobile-server-add-psk.jpg')} width="300" alt="Mobile app server setup screen showing the optional authentication secret field." />
5. Tap **Done**.
</TabItem>
</Tabs>
## Edit a server
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Hover over a server and select the **Edit** icon.
> ![Edit an existing Mattermost server connection using options located in the top right corner of the Mattermost screen.](/images/desktop-edit-server.png)
2. Modify the server's display name or URL, then select **Save**.
> \[Desktop only\] To update an authentication secret, connect to the server. If the secret has changed, you'll be prompted to enter the new one provided by your system admin.
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Swipe left on an existing server entry to reveal additional options. Tap **Edit**.
> <img src={useBaseUrl('/images/swipe-left-to-remove.gif')} width="300" alt="In the Mattermost mobile app, swipe left on an existing server connection entry to edit the connection." />
2. Modify the server's display name or authentication secret, and then tap **Save**.
> <img src={useBaseUrl('/images/mobile-edit-server.jpg')} width="300" alt="Mobile app edit server screen showing display name fields." />
>
> To view or update the authentication secret, expand the **Advanced Options** section. If a secret is currently configured, it will be pre-filled in the field.
</TabItem>
</Tabs>
## Remove a server
Removing a server from your desktop app doesn't delete its data. You can add the server back any time.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Hover over a server and select **Remove**.
> ![Remove a Mattermost server connection using options located in the top right corner of the Mattermost screen.](/images/desktop-remove-server.png)
2. Select **Remove** when prompted to confirm.
</TabItem>
<TabItem value="mobile" label="Mobile">
Tap the **Servers** <img src={useBaseUrl('/img/ui/server-variant_E81F.svg')} alt="Access server connection options using the Servers icon." className="theme-icon" /> icon located in the top left corner of the window to access all available servers and to add new servers.
Swipe left on an existing server entry to reveal additional options. Tap **Remove**.
<img src={useBaseUrl('/images/swipe-left-to-remove.gif')} width="400" alt="In the Mattermost mobile app, swipe left on an existing server connection entry to delete the connection." />
</TabItem>
</Tabs>
## Switch between workspaces
Select a workspace from the **Servers** list in the top left of the desktop app. See [keyboard shortcuts](/end-user-guide/collaborate/keyboard-shortcuts) for more navigation options.
## Manage system permissions
From Mattermost desktop v5.9, you can manage system permissions when creating or managing existing Mattermost server connections, including: microphone access, camera access, notifications, and location.
Granting a system permission sets it to **Accept**, and revoking it sets it to **Always Deny**.
![A screenshot of the system permissions that Mattermost users can manage when creating new server connections or editing existing connections.](/images/desktop-system-permissions.png)
<Note>
- You can't manage system permissions when using the Mattermost mobile app.
- You'll be prompted to accept or deny notifications after adding a new server connection, and any time you open the desktop app if you haven't explicitly accepted or denied system permissions.
- You may also need to enable notifications for Mattermost within your operating system preferences.
</Note>
## Open multiple workspace contexts
From desktop v6.0, you can keep multiple workspaces open at the same time and work across them without constant switching to improve situational awareness and operational efficiency. This capability is especially useful for organizations that operate in distributed or multi-domain environments, as it enhances cross-system interoperability and command-level situational awareness.
Select the **New tab** <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> icon at the top of the desktop app to open a new tab for the current workspace. You can drag and drop to reorder the tabs in the main desktop window.
Open internal Mattermost links in a new tab or window by right-clicking on the link and selecting **Open in new tab** or **Open in new window**.
- Convert tabs to new windows by right-clicking the tab label and selecting **Move to new window**.
- Convert pop-out windows back to tabs in the main window by right-clicking on the window title and selecting **Move to main window**.
- Close pop-out windows by right-clicking on the window title and selecting **Close window**.
<Tip>
You can manage windows and tabs from the Desktop app's **File** menu, and review all open tabs from the **Windows** menu.
</Tip>

View File

@@ -0,0 +1,98 @@
---
title: "Customize your Desktop App experience"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
You can customize your desktop app further with additional settings. Select the tab below that matches your operating system to learn more about what's available.
<Tabs>
<TabItem value="macos" label="macOS">
With the Mattermost desktop app in focus, select **Mattermost \> Settings...**
![Access Desktop App customization settings by selecting Mattermost from the menu bar, then selecting Preferences.](/images/mac-desktop-app-settings.png)
## General
- **Download Location**: Specify where on your machine you want files to be downloaded from the desktop app.
- **Show icon in the notification area**: The Mattermost icon displays in the notification area. You can hide this icon if preferred. Restart the desktop app to apply changes to this setting.
- **Synchronize Desktop App theme with server**: The desktop app theme automatically matches the theme set on your primary Mattermost server. Disable this setting to manage desktop app themes independently.
- **Open app in full screen**: Configure the desktop app to open in fullscreen. Disable this setting to open the app in a windowed view.
- **Maximum number of open views**: From Desktop v6.0, set the maximum number of open tabs and windows per workspace. When a limit is set, Mattermost prompts you to close tabs or windows when the limit is exceeded. Leave this field blank for no maximum limit.
## Notifications
- **Show red badge on Dock icon to indicate unread messages**: A red badge on the Dock icon displays a count of unread messages and mentions. You can configure the desktop app to display a count of mentions only, if preferred.
- **Bounce the Dock icon**: When a new message is received on any of your active teams and servers, the Dock icon bounces once or bounces until you open the desktop app. You can configure the Mattermost Desktop App Dock icon to bounce more, less, or not at all.
## Language
- **App Language**: Specify your preferred language for the desktop app.
- **Check spelling**: Misspelled words detected in your messages are highlighted based on your app language preference. You can disable spell check if preferred.
- **Spell Checker Languages**: Specify additional spell check languages if needed. Restart the desktop app to change this setting. When multiple languages are configured:
- All selected languages show as spelled correctly when a word matches at least one selected language
- All selected languages show as spelled incorrectly when a word matches none of the selected languages.
- **Use an alternative dictionary URL**: Specify an alternate dictionary for spell check as a site URL.
## Servers
- **Add and manage server connections**: Learn more about [connecting your desktop app to multiple Mattermost workspaces](/end-user-guide/preferences/connect-multiple-workspaces).
## Advanced
- **Logging level**: Adjust logging levels to isolate and troubleshoot issues. Increasing the log level increases disk space usage and can impact performance.
- **Send anonymous usage data to your configured servers**: Send desktop app usage and performance data to your configured Mattermost servers set up to accept it.
- **Send error reports to help improve the app**: From Mattermost Desktop v6.1.0, error reports and crash information are automatically sent to Sentry (a third-party error tracking service) to help identify and fix issues. This setting is enabled by default. Error reports include crash information, app version, and platform details (OS, architecture, memory stats), but no personally identifiable information (PII) is included. You can disable error reporting if preferred. Restart the desktop app to apply changes to this setting.
- **Use GPU hardware acceleration**: GPU hardware acceleration renders the desktop app interface more efficiently. If you encounter decreased stability, disable GPU hardware acceleration. Restart the desktop app to apply changes to this setting.
</TabItem>
<TabItem value="windows-linux" label="Windows/Linux">
With the Mattermost desktop app in focus, select the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon in the top left of the menu bar and select **File \> Settings...**
![Access Desktop App customization settings by selecting More in the top left corner, then selecting File \> Settings.](/images/desktop-app-settings.jpg)
## General
- **Download Location**: Specify where on your machine you want files to be downloaded from the desktop app.
- **Start app on login**: The desktop app starts up automatically when you log in to your machine. You can disable this if preferred.
- **Launch app minimized**: Configure the desktop app to launch minimized in the system tray.
- **Icon color**: Display a light, dark, or system default-driven Mattermost icon.
- **Leave app running in notification area when application window is closed**: When closing the desktop app, you’re prompted to confirm whether you want to permanently close the app. Disable this confirmation by selecting **Don’t ask again**. Silence these notifications by selecting **Don’t show again**. Restart the desktop app to apply changes to this setting.
- **Open app in full screen**: Configure the desktop app to open in fullscreen. Disable this setting to open the app in a windowed view.
- **Synchronize Desktop App theme with server**: The desktop app theme automatically matches the theme set on your primary Mattermost server. Disable this setting to manage desktop app themes independently.
- **Maximum number of open views**: From Desktop v6.0, set the maximum number of open tabs and windows per workspace. When a limit is set, Mattermost prompts you to close tabs or windows when the limit is exceeded. Leave this field blank for no maximum limit.
- **Use native title bar** (Linux only): From Mattermost Desktop v6.2.0, render the desktop app with your Linux desktop environment's native title bar and window controls instead of the custom Mattermost title bar. Restart the desktop app to apply changes to this setting.
## Notifications
- **Show red badge on taskbar icon to indicate unread messages**:
- **Flash taskbar icon when a new message is received**: Your desktop app taskbar icon flashes when a new message is received on any of your active teams and servers. You can disable the flashing taskbar icon if preferred.
## Language
- **App Language**: Specify your preferred language for the desktop app.
- **Check spelling**: Misspelled words detected in your messages are highlighted based on your app language preference. You can disable spell check if preferred.
- **Spell Checker Languages**: Specify additional spell check languages if needed. Restart the desktop app to apply changes to this setting. When multiple languages are configured:
- All selected languages show as spelled correctly when a word matches at least one selected language
- All selected languages show as spelled incorrectly when a word matches none of the selected languages.
- **Use an alternative dictionary URL**: Specify an alternate dictionary for spell check as a site URL.
## Servers
- **Add and manage server connections**: Learn more about [connecting your desktop app to multiple Mattermost workspaces](/end-user-guide/preferences/connect-multiple-workspaces).
## Advanced
- **Logging level**: Adjust logging levels to isolate and troubleshoot issues. Increasing the log level increases disk space usage and can impact performance.
- **Send anonymous usage data to your configured servers**: Send desktop app usage and performance data to your configured Mattermost servers set up to accept it.
- **Send error reports to help improve the app**: From Mattermost Desktop v6.1.0, error reports and crash information are automatically sent to Sentry (a third-party error tracking service) to help identify and fix issues. This setting is enabled by default. Error reports include crash information, app version, and platform details (OS, architecture, memory stats), but no personally identifiable information (PII) is included. You can disable error reporting if preferred. Restart the desktop app to apply changes to this setting.
- **Use GPU hardware acceleration**: GPU hardware acceleration renders the desktop app interface more efficiently. If you encounter decreased stability, disable GPU hardware acceleration. Restart the desktop app to apply changes to this setting.
</TabItem>
</Tabs>

View File

@@ -0,0 +1,180 @@
---
title: "Customize your channel sidebar"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
Conversations in Mattermost are crucial to company productivity and success. Keeping conversations organized in the sidebar creates an efficient workplace. Using a web browser or the desktop app, you can customize your own channel sidebar based on how you prefer to use Mattermost. Customizations you make are only visible to you, are visible when using the mobile app, and won't affect what your teammates see in their sidebars.
Here's how your sidebar is set up by default:
- All public and private channels you've joined are listed in the **Channels** category, sorted alphabetically.
- All your direct messages and group messages are listed in the **Direct Messages** category, sorted by recent activity.
## What can you customize?
Using Mattermost in a web browser or the desktop app, you can customize your sidebar in the following ways:
- [Create custom categories](#create-custom-categories)
- [Group and order channels into your categories](#organize-channels-in-categories)
- [Mute and unmute entire categories](#mute-and-unmute-categories)
- [Mark entire categories as read](#mark-channel-categories-as-read)
- [Sort channels in each category](#sort-channels-in-categories) manually, alphabetically, or by recent activity
- [Filter your sidebar to view unread channels only](#group-unread-channels-separately), or choose to group unread messages into an **Unreads** category
- [Manage your direct messages](#manage-direct-messages) by sorting them alphabetically or by recent activity, and by setting how many to display in your sidebar
- [Make channel categories work for you](#make-categories-work-for-you) by prefixing category names with emojis, by collapsing and expanding categories, by reordering categories, and by adding direct message conversations to categories.
![Organize your channel sidebar with channel categories.](/images/channel_sidebar_updates.gif)
## Create custom categories
Create custom categories to group channels together for quicker and easier navigation. For example, you can create a category called "Design" or "Marketing".
To create categories, select the **+** symbol at the top of the sidebar. Or, select the **More options** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon in the sidebar on any category header, then select **Create New Category**.
<Note>
When [channel category sorting](/administration-guide/configure/experimental-configuration-settings#enable-channel-category-sorting) is enabled (the default from Mattermost v11.8), you can assign channels to new or existing channel categories when [creating channels](/end-user-guide/collaborate/create-channels) and [renaming channels](/end-user-guide/collaborate/rename-channels).
</Note>
Next, type a category name, select **Create**, then drag any channels or direct messages into this new category. You can also multi-select channels and direct messages to drag them together as a group by pressing <kbd>Ctrl</kbd> or <kbd>Shift</kbd> and selecting on Windows or Linux, or <kbd>⌘</kbd> or <kbd>⇧</kbd> and selecting on Mac. See the section [drag and drop selections](#drag-and-drop-selections) below for details.
Your custom categories can't be shared with other Mattermost users.
## Rename categories
1. Select the **Category options** icon in the sidebar, then select **Rename Category**.
2. Type a new category name, then select **Rename**.
## Delete categories
1. Select the **Category options** icon in the sidebar, then select **Delete Category**.
2. Select **Delete** to confirm or select **X** to cancel.
All channels and direct message conversations in the deleted category move back to their default **Channels** and **Direct Messages** categories. Deleting a category never removes you from channels you have joined.
## Organize channels in categories
Once you've created categories, you can move channels around to organize your sidebar by dragging and dropping, or by moving.
### Drag and drop selections
To select multiple channels:
- Select sequential channels and/or direct messages by pressing <kbd>Shift</kbd> while selecting on Windows or Linux, or <kbd>⇧</kbd> while selecting on Mac.
- Select non-sequential channels and/or direct messages by pressing <kbd>Ctrl</kbd> while selecting on Windows or Linux, or <kbd>⌘</kbd> while selecting on Mac
- Press <kbd>ESC</kbd> to clear channel or direct message selections.
Using the Mattermost web or desktop app, drag selected channels and/or direct messages between or within categories.
<Tip>
Multi-selected channels and direct messages move together as a group in the order they originally appeared.
</Tip>
![Move a group of selected channels by dragging them to a new location in the channel sidebar.](/images/multi-select-drag.gif)
### Move selections
In addition to selecting and dragging, you can specify a category destination for selected channels and/or direct messages. To do this, select the **Channel options** icon in the sidebar and then select **Move to**.
![Move a group of selected channels to a specified category destination.](/images/multi-select-move.gif)
You can also specify a category destination for the current channel or conversation using the **Move to** option directly from the channel header. Channels that have been moved to a category will display a checkmark next to the category name.
![Move channels or conversations directly from the channel header.](/images/channel-heading-categories.png)
## Mute and unmute categories
When you mute or unmute a category, all channels within that category are also muted or unmuted. You can selectively unmute specific channels within a muted category.
Select the **Category options** icon in the sidebar, then select **Mute Category**.
Once a category is muted:
- Email, desktop, and push notifications are disabled for all channels in the category.
- A mute icon displays next to each channel name in the category.
- The category and all of its channels appear at reduced opacity in the left-hand sidebar. Channels in the category aren't marked as unread unless you’re mentioned directly.
To unmute the category, select the **Category options** icon in the sidebar, then select **Unmute Category**.
![Mute or unmute a category to mute or unmute all channels within that category. You can also selectively unmute specific channels within a muted category.](/images/mute-categories.gif)
## Mark channel categories as read
When you mark a channel category as read, all channels within that category are marked as read. You can selectively mark specific channels as unread where preferred.
Select the **Category options** icon in the sidebar, then select **Mark category as read**.
## Sort channels in categories
Select the **Category options** icon in the sidebar, then select **Sort** and choose from **Alphabetically**, **Recent Activity**, or **Manually**.
![Sort channels within a category alphabetically, by recent activity, or manually.](/images/sort-categories.gif)
## Group unread channels separately
By default, Mattermost provides a one-click **Unreads** filter to only show channels with unread activity. Alternatively, you may choose to automatically group unread channels in their own category at the top of your sidebar.
Go to **Settings \> Sidebar**, set **Group unread channels separately** to **On**, then select **Save**.
- When this setting is enabled, all unread messages appear only in the **Unreads** category, sorted with mentions first.
- When this setting is disabled, all unread messages appear within their respective categories and channels. You can use the **Unread filter** to focus on only unread channels in the sidebar.
When enabled, unread channels with mentions will sort to the top of the category.
![The Unreads filter only shows channels with unread activity. You can also group unread channels into their own category at the top of the channel sidebar.](/images/unreads.gif)
<Tip>
If you prefer to see only unread channels in their respective categories, we recommend collapsing your custom categories and disabling **Group unread channels separately** under **Settings \> Sidebar**.
</Tip>
## Manage direct messages
To sort your direct messages, select the **Channel options** icon in the sidebar, then select **Sort** and choose from **Alphabetically** or **Recent Activity**.
### How many direct messages to display?
Control how many direct message conversations display in the **Direct Messages** category to keep your conversations manageable. You can choose to show all messages or a fixed number of messages.
To configure the number of direct messages to display, go to **Settings \> Sidebar**, then set **Number of direct messages to show**. Or select the **Channel options** icon in the sidebar, then select **Show**.
Choose to show **10**, **15**, **20**, or **40** messages. Once you exceed the number of direct messages configured, older messages are hidden from the **Direct Messages** category. You can always increase the number of conversations displayed to see older direct messages.
![alt: Control the number of direct message conversations to display under the Direct Messages category by showing all messages or a fixed number of messages.](/images/dm-display.gif)
<Note>
Direct message conversations that you add to custom categories don't count against the maximum number of conversations shown in the **Direct Messages** category.
</Note>
## Make categories work for you
### Prefix channel category names with emojis
Channel category names can include emojis. Specify the emoji by its name in the format `:smile:`. We recommend prefixing channel category names with emojis for the following reasons:
- Emojis can make it easier for users to quickly identify and manage channels and channel categories, particularly in large workspaces with many channels.
- Sharing the same emoji across channels and categories related to a specific category or function helps maintain organization and consistency across the workspace.
- Making channel categories more visually distinct with emojis helps users find what they need more quickly and easily at a glance, reducing the time spent searching for the right place to take action.
- New users can quickly understand the purpose of various channels and channel categories based on their emoji prefixes without needing extensive explanations.
- As users grasp channel structure through emojis, the time and effort needed to train new members on navigating the workspace is reduced.
- A well-organized and visually appealing workspace can encourage users to participate more actively, which can lead to more effective communication and collaboration.
### Categories are collapsible
When you collapse a channel category, only unread channels display to reduce unnecessary scrolling. When you expand a channel category, all channels in the category display, including channels with unread messages.
### Reorder categories
Drag to reorder entire categories to prioritize important conversations.
### Categories can contain direct message conversations
Select and drag direct messages into any category. You can also multi-select direct messages to drag them together as a group.

View File

@@ -0,0 +1,266 @@
---
title: "Customize your Mattermost theme"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
The colors of the Mattermost user interface are customizable. You can choose from [five standard themes](#standard-themes) designed by Mattermost, or design your own custom theme. Your theme changes apply to all teams you're a member of, and are visible across all Mattermost clients. Mattermost Enterprise customers can configure a different theme for every team they're a member of.
<Tabs>
<TabItem value="web-desktop" label="Web/desktop">
Select the **Settings** <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> icon, then go to **Display \> Theme**. Select **Theme Colors** to choose from five standard themes designed by the Mattermost team.
You can customize a standard theme further to truly make it your own. After selecting a standard theme, select **Custom Theme** and modify your color choices based on your preferences. See the [custom themes](#custom-themes) documentation to learn what's configurable, and see the [custom theme examples](#custom-theme-examples) documentation for inspiration.
</TabItem>
<TabItem value="mobile" label="Mobile">
Tap **Theme** to select one of 5 standard Mattermost themes.
<Note>
You can define a custom theme using Mattermost in a web browser or the desktop app.
</Note>
</TabItem>
</Tabs>
## Custom themes
Select **Custom Theme**, then expand the [Sidebar Styles](/end-user-guide/preferences/customize-your-theme#sidebar-styles), [Center Channel Styles](/end-user-guide/preferences/customize-your-theme#center-channel-styles), and [Link and Button Styles](/end-user-guide/preferences/customize-your-theme#link-and-button-styles) options to customize individual interface colors, such as backgrounds, links, text, and borders.
Your custom theme changes are applied in Mattermost as you make them. Select **Save** to confirm your theme changes. Discard your changes by exiting the **Display Settings** window and selecting **Yes, Discard**.
### Custom theme examples
Customize your theme colors and share them with others by copying and pasting theme values into the input box. Below are some example themes with their corresponding theme values.
#### Mattermost
![Mattermost Theme](/images/Mattermost.png)
Want this theme? Copy and paste the following code into Mattermost:
``` json
{"sidebarBg":"#145dbf","sidebarText":"#ffffff","sidebarUnreadText":"#ffffff","sidebarTextHoverBg":"#4578bf","sidebarTextActiveBorder":"#579eff","sidebarTextActiveColor":"#ffffff","sidebarHeaderBg":"#1153ab","sidebarTeamBarBg":"#0b428c","sidebarHeaderTextColor":"#ffffff","onlineIndicator":"#06d6a0","awayIndicator":"#ffbc42","dndIndicator":"#f74343","mentionBg":"#ffffff","mentionBj":"#ffffff","mentionColor":"#145dbf","centerChannelBg":"#ffffff","centerChannelColor":"#3d3c40","newMessageSeparator":"#ff8800","linkColor":"#2389d7","buttonBg":"#166de0","buttonColor":"#ffffff","errorTextColor":"#fd5960","mentionHighlightBg":"#ffe577","mentionHighlightLink":"#166de0","codeTheme":"github"}
```
#### Organization
![Organization Theme](/images/Organization.png)
Want this theme? Copy and paste the following code into Mattermost:
``` json
{"sidebarBg":"#2071a7","sidebarText":"#ffffff","sidebarUnreadText":"#ffffff","sidebarTextHoverBg":"#136197","sidebarTextActiveBorder":"#7ab0d6","sidebarTextActiveColor":"#ffffff","sidebarHeaderBg":"#2f81b7","sidebarTeamBarBg":"#256996","sidebarHeaderTextColor":"#ffffff","onlineIndicator":"#7dbe00","awayIndicator":"#dcbd4e","dndIndicator":"#ff6a6a","mentionBg":"#fbfbfb","mentionColor":"#2071f7","centerChannelBg":"#f2f4f8","centerChannelColor":"#333333","newMessageSeparator":"#ff8800","linkColor":"#2f81b7","buttonBg":"#1dacfc","buttonColor":"#ffffff","errorTextColor":"#a94442","mentionHighlightBg":"#f3e197","mentionHighlightLink":"#2f81b7","codeTheme":"github"}
```
#### Mattermost Dark
![Mattermost Dark Theme](/images/MattermostDark.png)
Want this theme? Copy and paste the following code into Mattermost:
``` json
{"sidebarBg":"#1b2c3e","sidebarText":"#ffffff","sidebarUnreadText":"#ffffff","sidebarTextHoverBg":"#4a5664","sidebarTextActiveBorder":"#66b9a7","sidebarTextActiveColor":"#ffffff","sidebarHeaderBg":"#1b2c3e","sidebarTeamBarBg":"#152231","sidebarHeaderTextColor":"#ffffff","onlineIndicator":"#65dcc8","awayIndicator":"#c1b966","dndIndicator":"#e81023","mentionBg":"#b74a4a","mentionColor":"#ffffff","centerChannelBg":"#2f3e4e","centerChannelColor":"#dddddd","newMessageSeparator":"#5de5da","linkColor":"#a4ffeb","buttonBg":"#4cbba4","buttonColor":"#ffffff","errorTextColor":"#ff6461","mentionHighlightBg":"#984063","mentionHighlightLink":"#a4ffeb","codeTheme":"solarized-dark"}
```
#### Windows Dark
![Windows Dark Theme](/images/WindowsDark.png)
Want this theme? Copy and paste the following code into Mattermost:
``` json
{"sidebarBg":"#171717","sidebarText":"#ffffff","sidebarUnreadText":"#ffffff","sidebarTextHoverBg":"#302e30","sidebarTextActiveBorder":"#196caf","sidebarTextActiveColor":"#ffffff","sidebarHeaderBg":"#1f1f1f","sidebarTeamBarBg":"#181818","sidebarHeaderTextColor":"#ffffff","onlineIndicator":"#399fff","awayIndicator":"#c1b966","dndIndicator":"#e81023","mentionBg":"#0177e7","mentionColor":"#ffffff","centerChannelBg":"#1f1f1f","centerChannelColor":"#dddddd","newMessageSeparator":"#cc992d","linkColor":"#0d93ff","buttonBg":"#0177e7","buttonColor":"#ffffff","errorTextColor":"#ff6461","mentionHighlightBg":"#784098","mentionHighlightLink":"#a4ffeb","codeTheme":"monokai"}
```
#### GitHub Theme
![GitHub Theme](/images/GitHub.png)
Want this theme? Copy and paste the following code into Mattermost:
``` json
{"awayIndicator":"#D4B579","buttonBg":"#66CCCC","buttonColor":"#FFFFFF","centerChannelBg":"#FFFFFF","centerChannelColor":"#444444","codeTheme":"github","linkColor":"#3DADAD","mentionBg":"#66CCCC","mentionColor":"#FFFFFF","mentionHighlightBg":"#3DADAD","mentionHighlightLink":"#FFFFFF","newMessageSeparator":"#F2777A","onlineIndicator":"#52ADAD","sidebarBg":"#F2F0EC","sidebarHeaderBg":"#E8E6DF","sidebarHeaderTextColor":"#424242","sidebarText":"#2E2E2E","sidebarTextActiveBorder":"#66CCCC","sidebarTextActiveColor":"#594545","sidebarTextHoverBg":"#E0E0E0","sidebarUnreadText":"#515151"}
```
#### Monokai Theme
![Monokai Theme](/images/Monokai.png)
Want this theme? Copy and paste the following code into Mattermost:
``` json
{"awayIndicator":"#B8B884","buttonBg":"#90AD58","buttonColor":"#FFFFFF","centerChannelBg":"#FFFFFF","centerChannelColor":"#444444","codeTheme":"monokai","linkColor":"#90AD58","mentionBg":"#7E9949","mentionColor":"#FFFFFF","mentionHighlightBg":"#54850C","mentionHighlightLink":"#FFFFFF","newMessageSeparator":"#90AD58","onlineIndicator":"#99CB3F","sidebarBg":"#262626","sidebarHeaderBg":"#363636","sidebarHeaderTextColor":"#FFFFFF","sidebarText":"#FFFFFF","sidebarTextActiveBorder":"#7E9949","sidebarTextActiveColor":"#FFFFFF","sidebarTextHoverBg":"#525252","sidebarUnreadText":"#CCCCCC"}
```
#### Solarized Dark Theme
![Solarized Dark Theme](/images/SolarizedDark.png)
Want this theme? Copy and paste the following code into Mattermost:
``` json
{"awayIndicator":"#E0B333","buttonBg":"#859900","buttonColor":"#fdf6e3","centerChannelBg":"#073642","centerChannelColor":"#93a1a1","codeTheme":"solarized-dark","linkColor":"#268bd2","mentionBg":"#dc322f","mentionColor":"#ffffff","mentionHighlightBg":"#d33682","mentionHighlightLink":"#268bd2","newMessageSeparator":"#cb4b16","onlineIndicator":"#2AA198","sidebarBg":"#073642","sidebarHeaderBg":"#002B36","sidebarHeaderTextColor":"#FDF6E3","sidebarText":"#FDF6E3","sidebarTextActiveBorder":"#d33682","sidebarTextActiveColor":"#FDF6E3","sidebarTextHoverBg":"#CB4B16","sidebarUnreadText":"#FDF6E3","errorTextColor":"#dc322f"}
```
#### Gruvbox Dark Theme
![Gruvbox Dark Theme](/images/GruvboxDark.png)
Want this theme? Copy and paste the following code into Mattermost:
``` json
{"awayIndicator":"#fabd2f","buttonBg":"#689d6a","buttonColor":"#ebdbb2","centerChannelBg":"#3c3836","centerChannelColor":"#ebdbb2","codeTheme":"monokai","errorTextColor":"#fb4934","linkColor":"#83a598","mentionBg":"#b16286","mentionColor":"#fbf1c7","mentionHighlightBg":"#d65d0e","mentionHighlightLink":"#fbf1c7","newMessageSeparator":"#d65d0e","onlineIndicator":"#b8bb26","sidebarBg":"#282828","sidebarHeaderBg":"#1d2021","sidebarHeaderTextColor":"#ebdbb2","sidebarText":"#ebdbb2","sidebarTextActiveBorder":"#d65d0e","sidebarTextActiveColor":"#fbf1c7","sidebarTextHoverBg":"#d65d0e","sidebarUnreadText":"#fe8019"}
```
#### One Dark Theme
![One Dark Theme](/images/OneDark.png)
[Visit the one-dark-mattermost GitHub repository online:](https://github.com/georgewitteman/one-dark-mattermost)
Want this theme? Copy and paste the following code into Mattermost:
``` json
{"sidebarBg":"#21252b","sidebarText":"#abb2bf","sidebarUnreadText":"#abb2bf","sidebarTextHoverBg":"#3a3f4b","sidebarTextActiveBorder":"#4d78cc","sidebarTextActiveColor":"#d7dae0","sidebarHeaderBg":"#282c34","sidebarHeaderTextColor":"#abb2bf","onlineIndicator":"#98c379","awayIndicator":"#d19a66","dndIndicator":"#be5046","mentionBg":"#98c379","mentionColor":"#ffffff","centerChannelBg":"#282c34","centerChannelColor":"#abb2bf","newMessageSeparator":"#c67add","linkColor":"#61afef","buttonBg":"#4d78cc","buttonColor":"#ffffff","errorTextColor":"#f44747","mentionHighlightBg":"#525a69","mentionHighlightLink":"#61afef","codeTheme":"monokai","mentionBg":"#98c379"}
```
#### Discord Dark Theme (New)
![Discord New Dark Theme](/images/DiscordNewDarkTheme.png)
[Visit the mattermost-discord-dark GitHub repository online:](https://github.com/melroy89/mattermost-discord-dark)
Want this theme? Copy and paste the following code into Mattermost:
``` json
{"sidebarBg": "#121214", "sidebarText": "#ffffff", "sidebarUnreadText": "#ffffff", "sidebarTextHoverBg": "#1d1d1e", "sidebarTextActiveBorder": "#ffffff", "sidebarTextActiveColor": "#ffffff", "sidebarHeaderBg": "#121214", "sidebarHeaderTextColor": "#ffffff", "sidebarTeamBarBg": "#121214", "onlineIndicator": "#43a25a", "awayIndicator": "#ca9654", "dndIndicator": "#d83a42", "mentionBg": "#6e84d2", "mentionBj": "#6e84d2", "mentionColor": "#ffffff", "centerChannelBg": "#1a1a1e", "centerChannelColor": "#efeff0", "newMessageSeparator": "#ff4d4d", "linkColor": "#2095e8", "buttonBg": "#5865f2", "buttonColor": "#ffffff", "errorTextColor": "#ff6461", "mentionHighlightBg": "#a4850f", "mentionHighlightLink": "#a4850f", "codeTheme": "monokai"}
```
#### Discord Dark Theme (Old)
![Discord Dark Theme (old)](/images/DiscordDarkTheme.png)
[Visit the mattermost-discord-dark-old GitHub repository online:](https://github.com/melroy89/mattermost-discord-dark)
Want this theme? Copy and paste the following code into Mattermost:
``` json
{"sidebarBg":"#2f3136","sidebarText":"#ffffff","sidebarUnreadText":"#ffffff","sidebarTextHoverBg":"#33363c","sidebarTextActiveBorder":"#66cfa0","sidebarTextActiveColor":"#ffffff","sidebarHeaderBg":"#27292c","sidebarHeaderTextColor":"#ffffff","onlineIndicator":"#43b581","awayIndicator":"#faa61a","dndIndicator":"#f04747","mentionBg":"#6e84d2","mentionBg":"#6e84d2","mentionColor":"#ffffff","centerChannelBg":"#36393f","centerChannelColor":"#dddddd","newMessageSeparator":"#6e84d2","linkColor":"#2095e8","buttonBg":"#43b581","buttonColor":"#ffffff","errorTextColor":"#ff6461","mentionHighlightBg":"#3d414f","mentionHighlightLink":"#6e84d2","codeTheme":"monokai"}
```
#### Night Owl Dark Theme
![Night Owl Dark Theme](/images/NightOwlDark.png)
Want this theme? Copy and paste the following code into Mattermost:
``` json
{"sidebarBg":"#011627","sidebarText":"#d6deeb","sidebarUnreadText":"#d6deeb","sidebarTextHoverBg":"#1d3b53","sidebarTextActiveBorder":"#ff2c83","sidebarTextActiveColor":"#82aaff","sidebarHeaderBg":"#1d3b53","sidebarHeaderTextColor":"#d6deeb","onlineIndicator":"#addb67","awayIndicator":"#ffbc42","dndIndicator":"#f74343","mentionBg":"#d6deeb","mentionBg":"#d6deeb","mentionColor":"#145dbf","centerChannelBg":"#011627","centerChannelColor":"#d6deeb","newMessageSeparator":"#ff8800","linkColor":"#2389d7","buttonBg":"#166de0","buttonColor":"#011627","errorTextColor":"#fd5960","mentionHighlightBg":"#0b2942","mentionHighlightLink":"#82aaff","codeTheme":"solarized-dark"}
```
#### Dark Theme (desktop app only)
On Windows and macOS, the system display preference that you set on your computer (e.g., Light Mode or Dark Mode) is also applied to the Mattermost desktop app. On Linux, manage this manually via the **View** menu.
![The system preference you set for Light Mode or Dark Mode on your computer is automatically applied to the Mattermost Desktop App.](/images/dark-theme-via-os.gif)
### Export your custom theme
Export a theme from Mattermost by copying the theme values from the Custom Theme menu.
### Import a custom theme
Import a theme into Mattermost by pasting the theme values into the Custom Theme menu. Copy existing theme values, then paste the theme values into the **Copy and paste to share theme colors** field. Select **Save** to confirm your theme changes.
### Sidebar styles
You can customize every aspect of your Mattermost theme, as described below:
Sidebar BG
Background color of the Channels pane, and Account and Team settings navigation sidebars.
Sidebar Text
Text color of read channels in the Channels pane, and tabs in the Account and Team settings navigation sidebar.
Sidebar Header BG
Background color of the header above the Channels pane and all dialog window headers.
Team Sidebar BG
Background color of the Global Header.
Sidebar Header Text
Text color of the header above the Channels pane and all dialog window headers.
Sidebar Unread Text
Text color of unread channels in the Channels pane.
Sidebar Text Hover BG
Background color behind channel names and settings tabs as you hover over them.
Sidebar Text Active Border
Color of the rectangular marker on the left side of the Channels pane or Settings sidebar indicating the active channel or tab.
Sidebar Text Active Color
Text color of the active channel or tab in the Channels pane or Settings sidebar.
Online Indicator
Color of the online indicator appearing next to team members names in the direct messages list.
Away Indicator
Color of the away indicator appearing next to team members names in the direct messages list when they have had no browser activity for 5 minutes.
Do Not Disturb Indicator
Color of the do not disturb indicator appearing next to team members names in the direct messages list.
Mention Jewel BG
Background color of the jewel indicating unread mentions that appears to the right of the channel name. This is also the background color of the “Unread Posts Below/Above” indicator appearing at the top or bottom of the Channels pane on shorter browser windows.
Mention Jewel Text
Text color on the mention jewel indicating the number of unread mentions. This is also the text color on the “Unread Posts Below/Above” indicator.
### Center channel styles
You can customize every aspect of your Mattermost theme, as described below:
Center Channel BG
Color of the center pane, right-hand sidebar and all dialog window backgrounds.
Center Channel Text
Color of all the text - with the exception of mentions, links, hashtags and code blocks - in the center pane, right-hand sidebar, and dialogs.
New Message Separator
The new message separator appears below the last read message when you navigate to a channel with unread messages.
Error Text Color
Color of all error text.
Mention Highlight BG
Highlight color behind your words that trigger mentions in the center pane and right-hand sidebar.
Mention Highlight Link
Text color of your words that trigger mentions in the center pane and right-hand sidebar.
Code Theme
Background and syntax colors for all code blocks.
### Link and button styles
You can customize every aspect of your Mattermost theme, as described below:
Link Color
Text color of all links, hashtags, teammate mentions, and low priority UI buttons.
Button BG
Color of the rectangular background behind all high priority UI buttons.
Button Text
Text color appearing on the rectangular background for all high priority UI buttons.

View File

@@ -0,0 +1,204 @@
---
title: "Manage advanced options"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
Using Mattermost in a web browser or the desktop app, you can customize advanced Mattermost options based on your preferences. Select the gear icon <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> next to your profile picture, then select **Advanced**.
## Send messages on CTRL/⌘+ENTER
By default, you send messages in Mattermost by composing a message in the message text box at the bottom of the Mattermost screen and selecting the **Send** <img src={useBaseUrl('/img/ui/send_F048A.svg')} alt="Select the Send icon to post your message." className="theme-icon" /> icon or by pressing <kbd>Enter</kbd> on Windows or Linux, or <kbd>↵</kbd> on Mac.
And you enter new text lines by pressing <kbd>Shift</kbd> <kbd>Enter</kbd> on Windows or Linux, or <kbd>⇧</kbd> <kbd>↵</kbd> on Mac before sending the message.
You can chance this message send behavior.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
If you find you're accidentally sending messages too soon, you can configure Mattermost to require an extra keystroke to send all messages, or for code blocks.
Select **Send Messages on CTRL/⌘ + ENTER \> Edit** to configure how messages are sent in Mattermost.
You can configure Mattermost to send messages by pressing <kbd>Ctrl</kbd> <kbd>Enter</kbd> on Windows or Linux, or <kbd>⌘</kbd> <kbd>↵</kbd> on Mac for all messages or only for code blocks that start with ``\`\`\`.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Enable post formatting
By default, Mattermost formats your messages with Markdown to show links, emojis, text styles, and line breaks. You can control whether your messages show the formatting or show text only.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Enable Post Formatting** to show your messages as raw text only that includes Markdown syntax.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Enable join/leave messages
By default, Mattermost shows you system messages when users join or leave channels you're a member of. You can hide these messages if preferred.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Enable Join/Leave Messages** to hide the system messages when users join or leave channels you're a member of. When users are added to or removed from a channel, a system message displays even when you've disabled this feature.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Deactivate account
You can deactivate your account if you access Mattermost using an email address and password, and when your system admin has [enabled your ability to do so](/administration-guide/configure/site-configuration-settings#enable-account-deactivation). Deactivating your account removes your ability to access Mattermost, and disables all email and mobile notifications.
<Important>
- If you deactive your account, you must contact your system admin to have it reactivated.
- If you access Mattermost using another authentication method, such as AD/LDAP or SAML, or use accounts that don't have this setting available, contact your system admin to deactivate your account in the System Console.
</Important>
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Deactivate Account** to deactivate your Mattermost user account.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't applicable to the mobile app.
</TabItem>
</Tabs>
## Delete account
From Mattermost v10.11, you can permanently delete your account if you access Mattermost using an email address and password, and when your system admin has [enabled your ability to do so](/administration-guide/configure/user-management-configuration-settings#delete-users). Deleting your account permanently removes your user account and profile information from Mattermost. This action cannot be undone.
<Important>
- **Account deletion is permanent and cannot be undone.** Once deleted, your account and profile data cannot be recovered.
- Your message history and file uploads will remain in channels but will show as "Deleted User" instead of your name.
- If you access Mattermost using another authentication method, such as AD/LDAP or SAML, this option may not be available. Contact your system admin for account deletion.
- Consider [deactivating your account](/end-user-guide/preferences/manage-advanced-options#deactivate-account) instead if you might want to reactivate it in the future.
</Important>
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Delete Account** to permanently delete your Mattermost user account. You'll be asked to confirm this action before proceeding.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't applicable to the mobile app.
</TabItem>
</Tabs>
## Performance debugging
You can disable key Mattermost features temporarily to help isolate issues while debugging Mattermost, if your system admin [enables your ability to do so](/administration-guide/configure/environment-configuration-settings#enable-client-debugging). We don't recommend leaving these settings enabled for an extended period of time as they can negatively impact your user experience.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Performance Debugging** to disable one or more of the following Mattermost features:
- Client-side plugins
- telemetry events sent from the client
- "User is typing..." messages
You may need to refresh Mattermost to see these settings take effect.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Scroll position when viewing unread channels
You can choose where to start viewing unread messages in all channels you're a member of.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Scroll position when viewing an unread channel** to choose your scroll position starting point as where you left off or at the newest message.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Allow message drafts to sync with the server
By default, [message drafts](/end-user-guide/collaborate/send-messages#draft-messages) are synchronized on the Mattermost server and accessible everywhere you access Mattermost using a web browser or the desktop app. You can disable server-synchronized drafts and limit drafts to your current Mattermost client, if preferred.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Allow message drafts to sync with the server** to disable server-synchronized drafts.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't applicable to the mobile app.
</TabItem>
</Tabs>
## Delete local files
You can delete local Mattermost files from your mobile device using the mobile app.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
This option isn't applicable to the web or desktop app instance of Mattermost.
</TabItem>
<TabItem value="mobile" label="Mobile">
Access **Settings** by tapping on your profile picture. Then, tap **Advanced Settings** and **Delete local files**.
Only data specific to the current Mattermost server is removed from your device. You'll need to repeat this process for each [Mattermost workspace you're connected to](/end-user-guide/preferences/connect-multiple-workspaces) on the mobile app.
</TabItem>
</Tabs>

View File

@@ -0,0 +1,72 @@
---
title: "Manage your channel-specific notifications"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
By default, your web and desktop notification preferences apply to all channels you’re a member of. You can customize your per-channel notification preferences for any channel you're a member of for the following actions:
- [Mute channels](#mute-channels)
- [Ignore channel-wide @mentions](#ignore-channel-wide-mentions)
- [Message notification sounds](#message-notification-sounds)
- [Auto-follow all new threads](#follow-all-new-channel-threads)
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
You have 2 ways to manage notification preferences per channel:
1. Select the channel name, then select **Notification Preferences** from the drop-down list.
![Select the channel name dropdown to access channel-specific notification preferences.](/images/channel-notification-settings.gif)
2. Alternatively, select the channel's **View Info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon, and then select **Notification Preferences** in the right pane.
</TabItem>
<TabItem value="mobile" label="Mobile">
Tap the channel name, and then tap **Mobile Notifications**.
</TabItem>
</Tabs>
## Mute channels
All channels are unmuted by default, including direct and group messages, as well as private and public channels.
You can choose to mute or unmute a channel at any time as follows:
- Select **Mute Conversation** or **Unmute Conversation** for direct and group messages.
- Select **Mute Channel** or **Unmute Channel** for private and public channels.
Once a channel is muted:
- All notifications for that channel are disabled, including email, desktop, incoming call ring tones, and push notifications.
- The muted channel displays a mute icon next to the channel name.
- The channel is greyed out in the channel sidebar, and doesn't appear bold to indicate unread messages unless you’re [@mentioned](/end-user-guide/collaborate/mention-people) in that channel directly.
## Ignore channel-wide @mentions
By default, you're notified every time someone uses channel-wide [@mentions](/end-user-guide/collaborate/mention-people) including [@channel and @all](/end-user-guide/collaborate/mention-people#channel-and-all), as well as [@here](/end-user-guide/collaborate/mention-people#here).
When you choose to ignore channel-wide @mentions in channels, the channel name is bolded in the channel sidebar for new unreads unless it's muted.
## Message notification sounds
From Mattermost v10.1, when you configure Mattermost to notify you about all new messages, or mentions, direct messages, and keywords only, on a per-channel basis, you can also specify an audible message notification sound to play for those notifications.
## Follow all new channel threads
By default, you don’t automatically follow new conversation threads in any channel unless you start a thread or reply to a thread, follow a thread, or are @mentioned in a thread.
When using Mattermost on your mobile device, you can configure Mattermost to automatically follow every thread in a channel.
1. In a channel, tap the **More** icon <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> to the right of the channel name.
2. Tap **View info**.
3. Tap **Follow all threads**.
Tap **Threads** in the channel list to access all threads you're following, and to unfollow threads you no longer want to follow.

View File

@@ -0,0 +1,73 @@
---
title: "Manage your desktop notifications"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
## Enable notifications
From Mattermost v9.9 and desktop app v5.5, Mattermost prompts you to enable notifications in the desktop app the first time you connect to a Mattermost server.
![An example of a Mattermost desktop app notification prompt.](/images/desktop-notification-prompt.png)
- When you select **Allow**, you won't be asked again. You'll start receiving notifications in the desktop app for all Mattermost activity with [badges](#badge-based-notifications), [banner alerts](#banner-alerts) and [sounds](#notification-sounds). See the section below on [customizing your notifications](#customize-your-notifications) based on how you prefer to be notified about Mattermost activity in the desktop app.
- If you dismiss this prompt, you won't receive Mattermost notifications in the desktop app, and you'll be prompted again the next time you open Mattermost in the desktop app, or go to **Settings \> Notifications \> Desktop and mobile notifications**.
- If you select **Deny** or **Deny Permanently**, you won't be asked again. You won't receive Mattermost notifications in the desktop app. You can change this preference by [editing the server connection](/end-user-guide/preferences/connect-multiple-workspaces#edit-a-server) to [manage your notification permissions](/end-user-guide/preferences/connect-multiple-workspaces#manage-system-permissions).
<Note>
You may also need to enable notifications in Windows, macOS, or Linux for Mattermost by changing your System Preferences.
</Note>
## Badge-based notifications
Mattermost desktop app icons display the following types of badges:
- A numbered badge for unread [direct](/end-user-guide/collaborate/channel-types#direct-message-channels) [group](/end-user-guide/collaborate/channel-types#group-message-channels) messages, [@mentions](/end-user-guide/preferences/manage-your-mentions-keywords-notifications), and [keywords](/end-user-guide/preferences/manage-your-mentions-keywords-notifications) you're actively watching. <img src={useBaseUrl('/images/numbered-badge.png')} width="50" alt="A numbered badge means you have at least 1 unread message, @mention, or one of your keywords has triggered a notification." />
- A dot badge for unread activity. <img src={useBaseUrl('/images/dot-badge.png')} width="50" alt="A dot on the badge means you have unread activity in at least one channel you&#39;re a member of." />
## Banner alerts
Banner alerts in the desktop app are popup windows that display for a limited time in the top right corner of your screen that summarizes the new activity.
## Notification sounds
By default, desktop app notifications include audible sounds.
## Customize your notifications
By default, you are notified when you're @mentioned, when you receive a direct or group message, or for matches to keywords you're following.
Want to receive notifications about replies to threads you’re following? Select **Notify me about replies to threads I’m following**.
Want notifications for all new messages? Select **Desktop and mobile notifications \> All new messages**
Desktop app users can also [customize their desktop app experience](/end-user-guide/preferences/customize-desktop-app-experience) further based on their platform operating system.
### Change or disable sounds
You can change or disable notification sounds by going to **Desktop notification sounds \> Message notification sound**.
### Incoming Call notifications
Want to hear a sound when a Mattermost call starts? If your Mattermost admin [enables this Beta feature](/administration-guide/configure/plugins-configuration-settings#enable-call-ringing), you can choose the sound that plays when a call is started within a direct or group message by going to **Desktop notification sounds \> Incoming call sound**.
### Disable all desktop notifications
Select **Desktop and mobile notifications \> Nothing** to disable all desktop and [web notifications](/end-user-guide/preferences/manage-your-web-notifications).
Clear the **Use different settings for my mobile devices** to additionally disable all Mattermost mobile notifications everywhere you use Mattermost.
Additionally, macOS users can disable notifications for all unread activity in the desktop app by [customizing your desktop app experience](/end-user-guide/preferences/customize-desktop-app-experience) to disable the **Show red badge on Dock icon to indicate unread messages** option.
## Frequently asked questions
### What does a Mattermost icon with an exclamation point mean?
![A Mattermost logo with an exclamation point means you're logged out of at least 1 Mattermost server you connect to using the desktop app.](/images/server-logout-indicator.png)
A Mattermost icon with an exclamation point means that you're logged out of at least 1 Mattermost server you connect to using the desktop app. Log back in to any servers as needed. See the [Connect to multiple workspaces](/end-user-guide/preferences/connect-multiple-workspaces) documentation for details.
If the icon continues to display, refresh the **Playbooks** and/or **Boards** tabs located at the top of the desktop app window.

View File

@@ -0,0 +1,338 @@
---
title: "Manage your display options"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
You can customize Mattermost display options based on your preferences.
- Using Mattermost in a web browser or the desktop app, select the gear icon <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> next to your profile picture, then go to **Display**.
- On the Mattermost mobile app, tap your profile picture, and then tap **Settings \> Display**.
## Theme
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Theme** to apply a different look and feel to Mattermost.
Select **Theme Colors** to select one of 5 standard themes designed by the Mattermost team. Or, select **Custom Theme** to customize a standard theme even further.
See the [customize your theme](/end-user-guide/preferences/customize-your-theme) documentation for more information.
</TabItem>
<TabItem value="mobile" label="Mobile">
Tap **Theme** to select one of 5 standard Mattermost themes.
<Note>
You can define a custom theme using Mattermost in a web browser or the desktop app. See the [customize your theme](/end-user-guide/preferences/customize-your-theme) documentation for more information.
</Note>
</TabItem>
</Tabs>
## Threaded discussions
Threaded discussions offers an enhanced experience for users communicating in threads and replying to messages. Threaded discussions are generally available in Mattermost Cloud and from self-hosted Mattermost v7.0, and are enabled by default for all new Mattermost deployments.
Depending on how your system admin has [configured threaded discussions](/administration-guide/configure/site-configuration-settings#threaded-discussions) for your [workspace](/end-user-guide/end-user-guide-index), it may already be enabled for you, or you may be able to enable this feature for your account. See our [organize conversations using threaded discussions](/end-user-guide/collaborate/organize-conversations) documentation to learn more about working with threaded discussions.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Threaded discussions \> Edit** to manage this option.
</TabItem>
<TabItem value="mobile" label="Mobile">
Tap **Threaded discussions** to manage this option.
</TabItem>
</Tabs>
## Clock display
You can customize how time is displayed in Mattermost.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Clock Display \> Edit** to display time in Mattermost using a 12-hour or 24-hour convention.
</TabItem>
<TabItem value="mobile" label="Mobile">
Tap **Clock Display** to display time in Mattermost using a 12-hour or 24-hour convention.
</TabItem>
</Tabs>
## Teammate name display
You can customize how names are displayed in Mattermost unless your system admin has [disabled your ability to do so](/administration-guide/configure/site-configuration-settings#lock-teammate-name-display-for-all-users).
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Teammate Name Display \> Edit** to control how names are displayed in Mattermost. Options include: username, nickname (if it exists), or first and last name.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Show online availability on profile images
You can show or hide [availability](/end-user-guide/preferences/set-your-status-availability#set-your-availability) on profile pictures in Mattermost.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Show online availability on profile images \> Edit** to show or hide availability in Mattermost.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Share last active time
By default, Mattermost shows when you were last online in your profile and in direct message channel headers, unless your system admin has [disabled this option](/administration-guide/configure/site-configuration-settings#enable-last-active-time).
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Share last active time \> Edit** to show or hide when you were last online in Mattermost.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Timezone
You can customize the timezone used for timestamps in Mattermost and in email notifications.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Timezone \> Edit** to select your timezone.
From Mattermost v10.10, you can also select **Automatic** to set your timezone automatically based on your computer's timezone settings. This option is enabled by default.
</TabItem>
<TabItem value="mobile" label="Mobile">
Tap **Timezone** to set your timezone automatically based on your mobile device preference.
</TabItem>
</Tabs>
## Website link previews
You can control whether website link previews in Mattermost show a preview of the website content directly below the message.
<Note>
Your system admin must [enable this feature](/administration-guide/configure/site-configuration-settings#enable-message-link-previews). It's disabled by default. Once enabled, only the first web link in a message creates a preview of the website.
</Note>
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Website Link Previews \> Edit** to show or hide website previews in messages.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Default appearance of image previews
When messages in Mattermost include images, you can control whether an image preview displays directly below the message for image attachments, image link previews, and [in-line images](/end-user-guide/collaborate/format-messages#in-line-images) over 100px in height.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Default Appearance of Image Previews \> Edit** to expand or collapse all image links and image attachments.
<Tip>
This setting can also be controlled using the [slash commands](/integrations-guide/run-slash-commands) `/expand` and `/collapse`.
</Tip>
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Message display
You can control how messages in a channel are displayed.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Message Display \> Edit** to display standard or compact messages.
<Tip>
**Compact** mode fits more messages on the screen by decreasing the spacing around posts, collapsing link previews, and hiding thumbnails so that only file names are shown. Some formatting types, such as block quotes and headings, are also reduced in size.
When you select **Compact**, usernames are colorized by default, and username colors are consistent for all users. Disable the **Colorize usernames** option to display all usernames in a single color instead.
</Tip>
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Click to open threads
By default, Mattermost opens reply threads in the right pane when you select any part of a message. You can change this default behavior.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Click to open threads \> Edit** to disable the default behavior of opening reply threads in the right pane automatically. You'll need to select the replies count to open a reply thread.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Channel display
You can control the width of the center channel area in Mattermost.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Channel Display \> Edit** to specify the center channel as fixed width and centered, or full width.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Quick reactions on messages
By default, you can hover over messages to react using recently-used emojis. You can hide your recently-used emojis instead if preferred.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Quick reactions on messages \> Edit** to hide your recently-used emojis.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app.
</TabItem>
</Tabs>
## Render emoticons as emojis
From Mattermost v10.10, you can choose whether to automatically convert text emoticons to emoji characters in your messages. This feature is enabled by default, so that text-based emoticons like `:)` or `:D` are displayed as their corresponding emoji images. Disable this auto-rendering if you prefer to keep emoticons as text.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Render emoticons as emojis \> Edit** to disable automatic conversion of emoticons to emojis in your messages.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't available in the mobile app.
</TabItem>
</Tabs>
## Language
You can control what language Mattermost displays in. Options include:
- Deutsch - German
- English (U.S.)
- English Australian
- Español - Spanish
- Français - French
- Italiano - Italian
- Magyar - Hungarian
- Nederlands - Dutch
- Polski - Polish
- Português (Brasil) - Portuguese
- Română - Romanian
- Svenska - Swedish
- Tiếng Việt - Vietnamese
- Türkçe - Turkish
- български - Bulgarian
- Pусский - Russian
- Yкраїнська - Ukrainian
- فارسی - Persian
- 한국어 - Korean
- 中文 (简体) - Simplified Chinese
- 中文 (繁體) - Traditional Chinese
- 日本語 - Japanese
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
Select **Language \> Edit** to set the display language in Mattermost.
</TabItem>
<TabItem value="mobile" label="Mobile">
This option isn't something you can set using the mobile app. However, when you change the display language using a web browser or the desktop app, that language selection is also applied to the mobile app.
</TabItem>
</Tabs>

View File

@@ -0,0 +1,32 @@
---
title: "Manage your @mention and keyword notifications"
---
<PlanAvailability slug="all-commercial" />
You're [notified](/end-user-guide/preferences/manage-your-notifications) in a [web browser](/end-user-guide/preferences/manage-your-web-notifications), the [desktop app](/end-user-guide/preferences/manage-your-desktop-notifications), and on your [mobile device](/end-user-guide/preferences/manage-your-mobile-notifications), when you're @mentioned by your username or first name, @mentioned as part of a user group, and for matches to keywords you're following.
You're also notified when someone uses channel-wide [@mentions](/end-user-guide/collaborate/mention-people) including [@channel and @all](/end-user-guide/collaborate/mention-people#channel-and-all), as well as [@here](/end-user-guide/collaborate/mention-people#here).
For all other messages, channels appear bolded to indicate unread activity.
## Customize notification keywords
Using a web browser or the desktop app, you can customize keywords to trigger notifications. Keywords aren't case-sensitive.
For example, you can receive notifications for all messages and threads related to a specific topic, project name, or customer.
![A walkthrough of setting keywords that trigger mentions in Mattermost.](/images/keywords-trigger-mentions.gif)
<Tip>
Separate multiple keywords using commas or by pressing <kbd>Tab</kbd>, and use <kbd>Backspace</kbd> to manage keywords.
</Tip>
## Passively track keywords (no notification)
From Mattermost v9.3, Mattermost Enterprise and Professional customers interested calling attention to specific topics of interest across channels can do so without sending notifications to a Mattermost client.
Using a web browser or the desktop app, you can passively track key terms by specifying single or multiple words to be highlighted in all channels you're a member of. Keywords and phrases are automatically highlighted using a color based on your [Mattermost theme](/end-user-guide/preferences/customize-your-theme).
![A walkthrough of setting keywords that are highlighted in Mattermost.](/images/keywords-highlighted.gif)

View File

@@ -0,0 +1,97 @@
---
title: "Manage your mobile notifications"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
## Enable notifications
From Mattermost mobile v2.34, the Mattermost **Settings \> Notifications** screen alerts you when notifications are disabled by your device. Follow the link in the notification to enable device-level notifications.
From Mattermost v9.9, Mattermost prompts you to enable notifications in the mobile app the first time you open the app.
Once Mattermost notifications are enabled at the device level and in the mobile app, you'll start receiving notifications for all Mattermost activity with [badges](#badge-based-notifications), and [push notifications](#push-notifications). See the section below on [customizing your notifications](#customize-your-notifications) based on how you prefer to be notified about Mattermost activity on your mobile device.
<Note>
You may also need to enable notifications in iOS or Android for Mattermost by changing your device preferences.
</Note>
## Badge-based notifications
Mattermost mobile app icons display numbered badges for unread [direct](/end-user-guide/collaborate/channel-types#direct-message-channels) and [group](/end-user-guide/collaborate/channel-types#group-message-channels) messages, and [@mentions](/end-user-guide/preferences/manage-your-mentions-keywords-notifications), [keywords](/end-user-guide/preferences/manage-your-mentions-keywords-notifications) you're actively watching.
<img src={useBaseUrl('/images/numbered-badge.png')} width="50" alt="A numbered badge means you have at least 1 unread message, @mention, or one of your keywords has triggered a notification." />
<Note>
- The Mattermost mobile app doesn't display dot badges indicating other unread activity by design. The activity you're directly involved in is prioritized over other activity.
- Android users may see Mattermost notifications in the Android Notification Shade while the Mattermost icon shows no badge. This is because the Android notification system may also display badges unread activity.
</Note>
## Push notifications
You'll see mobile push notification messages on your device as follows:
- **iOS**: On the Lock Screen, Notification Center, and as Banners/Alerts based on your iOS settings.
- **Android**: On the Lock Screen, Notification Shade, and as Banners/Heads-Up Notifications based on your Android settings.
## Customize your notifications
You can manage your mobile notifications in both the desktop app and the mobile app.
<Tabs>
<TabItem value="desktop-app" label="Desktop app">
In the desktop app, manage your mobile notification preferences by selecting the **Settings** <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> icon located in the top right corner of the screen, and select **Notifications \> Desktop and mobile notifications**.
By default, you receive mobile notifications for @mentions, direct messages, and group messages when your Mattermost availability is [Online, Away, or Offline](/end-user-guide/preferences/set-your-status-availability#set-your-availability). You won't receive Mattermost notifications on your device if you're actively using Mattermost in a web browser.
- Want to receive fewer mobile notifications? Under **Trigger mobile notifications when I am**, select **Away or Offline** or **Offline**.
- Want different desktop and mobile notifications? Select **Use different settings for my mobile devices**, and then select **All new messages**, or **Mentions, direct messages and group messages**.
</TabItem>
<TabItem value="mobile-app" label="Mobile app">
In the mobile app, tap your profile picture, then tap **Settings \> Notifications**.
- Tap **Mentions** to disable notifications based on keywords that trigger mentions, including first name, username, channel-wide @mentions, and keywords you've specified.
- Tap **Push Notifications** to choose what to be notified about.
You can also [manage email notifications](/end-user-guide/preferences/manage-your-notifications#email-notifications) and [send automatic replies to direct messages](/end-user-guide/preferences/manage-your-thread-reply-notifications#send-automatic-replies-to-direct-messages) directly from your device.
</TabItem>
</Tabs>
### Incoming Call notifications
Want to hear a sound on your mobile device when a Mattermost call starts? If your Mattermost admin [enables this Beta feature](/administration-guide/configure/plugins-configuration-settings#enable-call-ringing), select **Call Notifications** to choose the sound that plays when a call is started within a direct or group message you're participating in.
<Tip>
- From Mattermost mobile app v2.19, incoming call sounds also include device vibration, as well as vibration-only when your device is in silent mode.
- If you prefer a separate call sound on mobile, your mobile change applies only to your mobile device.
</Tip>
### Disable all mobile notifications
To disable all Mattermost mobile notifications, tap **Push Notifications \> Nothing**.
## Frequently asked questions
### Are mobile notification counts the same as other Mattermost clients?
No. You're only notified of unread threads with @mentions on your mobile device. You're not notified of general unread activity on mobile.
### What does a Mattermost icon with an exclamation point mean?
![A Mattermost logo with an exclamation point means you're logged out of at least 1 Mattermost server you connect to using the mobile app.](/images/server-logout-indicator.png)
A Mattermost icon with an exclamation point means that you're logged out of at least 1 Mattermost server you connect to using the mobile app. Log back in to any servers as needed. See the [Connect to multiple workspaces](/end-user-guide/preferences/connect-multiple-workspaces) documentation for details.

View File

@@ -0,0 +1,93 @@
---
title: "Manage your notifications"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
Mattermost notifies you of new activity you're directly involved in. How you're notified depends on what Mattermost client you're using, the type of Mattermost activity you're being notified about, and how you prefer to be notified.
<Tip>
**Missing notifications?**
- Your mobile device may have Mattermost notifications disabled. See the [manage your mobile notifications](/end-user-guide/preferences/manage-your-mobile-notifications#enable-notifications) for details.
- You may need to grant permissions in the Mattermost [desktop app](/end-user-guide/preferences/manage-your-desktop-notifications#enable-notifications) or [web browser](/end-user-guide/preferences/manage-your-web-notifications#enable-notifications) to show notifications.
- Visit our [troubleshoot notifications](/end-user-guide/preferences/troubleshoot-notifications) documentation for guidance on ensuring you receive Mattermost notifications.
</Tip>
## You're in control
You are in control of how, when, and where you're notified of activity that matters to you based on how you prefer to work and collaborate. To access notification preferences:
- In a web browser or the desktop app, select the **Settings** <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> icon located in the top right corner of the screen to manage your notification preferences.
- On mobile, tap your profile picture, then tap **Settings \> Notifications**.
See the [Default notifications](#default-notifications) table below for details on customizing your notification experience based on your preferred Mattermost client.
<Tip>
From Mattermost v9.8, your desktop and mobile notification preferences have been combined together under **Notifications**. If you're using an older Mattermost release and older Mattermost clients, you'll find separate preferences for desktop and mobile.
</Tip>
## Default notifications
Mattermost notifies you of new activity, including unread activity, [direct](/end-user-guide/collaborate/channel-types#direct-message-channels) and [group](/end-user-guide/collaborate/channel-types#group-message-channels) messages, and [@mentions](/end-user-guide/preferences/manage-your-mentions-keywords-notifications), [keywords](/end-user-guide/preferences/manage-your-mentions-keywords-notifications) you're actively watching, [thread replies](/end-user-guide/preferences/manage-your-thread-reply-notifications), and unread activity in [specific channels](/end-user-guide/preferences/manage-your-channel-specific-notifications).
The table below lists the types of notifications you can expect to see and hear in Mattermost. Select your preferred Mattermost clients to learn more about notifications for that client.
<table style={{width: '99%'}}>
<colgroup>
<col style={{width: '14%'}} />
<col style={{width: '30%'}} />
<col style={{width: '54%'}} />
</colgroup>
<thead>
<tr>
<th scope="col">Notification Type</th>
<th scope="col">What it Means</th>
<th scope="col">Which Mattermost Clients?</th>
</tr>
</thead>
<tbody>
<tr>
<td><p>Icon badge (dot)</p><p><img src={useBaseUrl('/images/dot-badge.png')} width="50" alt="A dot on the badge means you have unread activity in at least one channel you&#39;re a member of." /></p></td>
<td>You have unread activity in at least 1 channel you're a member of</td>
<td><a href="/end-user-guide/preferences/manage-your-web-notifications">Web</a>, <a href="/end-user-guide/preferences/manage-your-desktop-notifications">Desktop</a></td>
</tr>
<tr>
<td><p>Icon badge (number)</p><p><img src={useBaseUrl('/images/numbered-badge.png')} width="50" alt="A numbered badge means you have at least 1 unread message, @mention, or one of your keywords has triggered a notification." /></p></td>
<td rowspan="3">You have at least 1 unread message with an @mention, or a match to a keyword you're watching</td>
<td><a href="/end-user-guide/preferences/manage-your-web-notifications">Web</a> &amp; <a href="/end-user-guide/preferences/manage-your-desktop-notifications">Desktop</a> &amp; <a href="/end-user-guide/preferences/manage-your-mobile-notifications">Mobile</a></td>
</tr>
<tr>
<td>Banner alert popups</td>
<td><a href="/end-user-guide/preferences/manage-your-web-notifications">Web</a> &amp; <a href="/end-user-guide/preferences/manage-your-desktop-notifications">Desktop</a></td>
</tr>
<tr>
<td>Push notifications</td>
<td><a href="/end-user-guide/preferences/manage-your-mobile-notifications">Mobile</a></td>
</tr>
<tr>
<td>Alert sounds</td>
<td>You have at least 1 unread message with an @mention, a match to a keyword you're watching, or replies to a thread you're following</td>
<td><a href="/end-user-guide/preferences/manage-your-web-notifications">Web</a>, <a href="/end-user-guide/preferences/manage-your-desktop-notifications">Desktop</a>, &amp; <a href="/end-user-guide/preferences/manage-your-mobile-notifications">Mobile</a></td>
</tr>
</tbody>
</table>
### Email notifications
When your admin [enables email notifications](/administration-guide/configure/site-configuration-settings#enable-email-notifications), Mattermost notifications are sent to you via email for [@mentions](/end-user-guide/collaborate/mention-people) and [direct messages](/end-user-guide/collaborate/channel-types#direct-message-channels) as soon as you're away from Mattermost for 5 minutes.
You can also opt in to be notified by email about thread replies you're following.
Additionally, if your admin [enables email batching](/administration-guide/configure/site-configuration-settings#enable-email-batching), email-based notifications are batched, and you can customize how frequenly you receive batched notifications by going to **Settings \> Notifications \> Email notifications**. The default frequency is 15 minutes. Choosing every 15 minutes or every hour will reduce the number of emails you receive.
Disable email notifications by going to **Settings \> Notifications \> Email notifications** and changing **On** to **Off**.
## Missing notifications?
Visit the Mattermost [notifications Knowledge Base article](https://support.mattermost.com/hc/en-us/articles/19161390661780-Troubleshooting-Mattermost-Notifications) for additional troubleshooting tips and tricks.

View File

@@ -0,0 +1,30 @@
---
title: "Manage your plugin preferences"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
Using Mattermost in a web browser or the desktop app, you can customize Mattermost plugin preferences for Microsoft Teams and Calls by selecting **Settings** <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> next to your profile picture.
## Microsoft Teams plugin preferences
<PlanAvailability slug="entry-ent" />
Select **MS Teams** to connect your Mattermost and Microsoft Teams accounts, and manage notification preferences for Microsoft Teams chats and group chats. See the [connect your account](/end-user-guide/collaborate/collaborate-within-connected-microsoft-teams#connect-your-mattermost-account-to-your-microsoft-teams-account).
<Tip>
Download our [Mattermost for Microsoft Teams datasheet](https://mattermost.com/mattermost-for-microsoft-teams-datasheet/) to learn how Mattermost helps your organization get more from your Microsoft tools.
</Tip>
## Calls plugin preferences
<PlanAvailability slug="all-commercial" />
Select **Calls** to specify the audio devices, including micrphone and speaker, used for Mattermost calls.
<Tip>
Download our [Mattermost Calls datasheet](https://mattermost.com/mattermost-calls-datasheet/) to learn how Calls make it easy for teams to adapt their communication to a wider variety of situations.
</Tip>

View File

@@ -0,0 +1,49 @@
---
title: "Manage your Mattermost profile"
---
<PlanAvailability slug="all-commercial" />
Select your profile picture and select **Profile** to manage the details of your Mattermost profile, including your name, username, nickname, email, and profile picture.
Your Mattermost system admin may [define custom user profile fields](/administration-guide/manage/admin/user-attributes) that you can personalize. Additionally, some of your profile information may be pulled from another source, which means you won't be able to modify it in Mattermost. Contact your Mattermost system admin for assistance.
Your system admin may also manage profile fields for accounts that sign in with email and password. Empty first and last names can each be entered once and become locked after you save them. Other managed fields remain locked, while your email address remains editable.
<table style={{width: '99%'}}>
<colgroup>
<col style={{width: '16%'}} />
<col style={{width: '84%'}} />
</colgroup>
<thead>
<tr>
<th>Profile setting</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Full, first, and last name</td>
<td>Your name appears in the direct messages member list and team management modal. By default, you'll receive mention notifications when someone types your first name in a message.</td>
</tr>
<tr>
<td>Username</td>
<td><p>Usernames are unique identifiers appearing next to all posts. Usernames must begin with a letter, and contain between 3 to 22 lowercase characters made up of numbers, letters, and the symbols <code>.</code>, <code>-</code>, and <code>_</code>.</p><p>Pick something easy for teammates to recognize and recall. By default, you'll receive mention notifications when someone types your username. Changing your username won't change your existing @mentions in sent messages.</p></td>
</tr>
<tr>
<td>Nickname</td>
<td>(Optional) Nicknames appear in the direct messages member list and team management modal. Your nickname can be up to 64 characters long.<br/><br/>You won't be notified when someone types your nickname unless you add your nickname to the list of <strong>Keywords that Trigger Notifications</strong> as a <a href="/end-user-guide/preferences/manage-your-mentions-keywords-notifications#customize-notification-keywords">notification preference</a>.<br/><br/>From Mattermost v10.8, nicknames display in <a href="/end-user-guide/collaborate/organize-conversations">threaded discussions</a> when available.</td>
</tr>
<tr>
<td>Position</td>
<td>(Optional) Position can be used to describe your role or job title. Your position appears in the profile popup that displays when you select a user's name in the center channel or right-hand sidebar.</td>
</tr>
<tr>
<td>Email</td>
<td>Email is used for signing in, notifications, and password reset.</td>
</tr>
<tr>
<td>Profile picture</td>
<td><p>Profile pictures appear next to all posts, and you can select your profile picture to access your profile settings. To change your profile picture:</p><p><strong>Using the web or the desktop app</strong></p><ol type="1"><li>Select <strong>Edit</strong> next to the <strong>Profile Picture</strong> option.</li><li>Choose <strong>Select</strong>, pick the profile image you want to use, and select <strong>Save</strong>.</li></ol><p><strong>Using the mobile app</strong></p><ol type="1"><li>Tap your current profile picture.</li><li>Take a photo using your device, or select an image to use.</li></ol><div class="tip"><p>For best results, choose an image that's at least 128 x 128 pixels in size. Supported image formats include: BMP, JPG, JPEG, and PNG. GIF isn't supported.</p></div></td>
</tr>
</tbody>
</table>

View File

@@ -0,0 +1,43 @@
---
title: "Manage your security preferences"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
Select your profile picture, select **Profile**, and then select **Security** to configure your password, view access history, and to view or logout of active sessions.
<table style={{width: '99%'}}>
<colgroup>
<col style={{width: '20%'}} />
<col style={{width: '80%'}} />
</colgroup>
<thead>
<tr>
<th scope="col">Security setting</th>
<th scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Password</td>
<td><p>You may change your password if you've logged in by email using Mattermost in a web browser or using the desktop app.</p><Important><ul><li>If you sign in to Mattermost using a single sign-on service, you must update your password through your SSO service account.</li><li><strong>Password Security Enhancement</strong>: From v11.0, Mattermost uses PBKDF2 password hashing for improved security. When you log in after your server upgrades to v11.0+, your password will be automatically migrated to the more secure format. If your server is later downgraded to a version prior to v11.0, you may be unable to log in and will need to contact your system administrator for a password reset.</li></ul></Important></td>
</tr>
<tr>
<td>Multi-factor authentication (MFA)</td>
<td><p>If your system admin has enabled <a href="/administration-guide/configure/authentication-configuration-settings#enable-multi-factor-authentication">multi-factor authentication</a> (MFA), you can require a passcode in addition to your password to log-in to your Mattermost account.</p><p>You'll need to download a MFA passcode generation app, such as Google Authenticator or a similar app, and then set-up MFA in your Mattermost account.</p><p><strong>Download a passcode generation app</strong></p><ul><li>Download Google Authenticator for an Apple device from <a href="https://apps.apple.com/us/app/google-authenticator/id388497605">iTunes</a></li><li>Download Google Authenticator for an Android device from <a href="https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&amp;hl=en">Google Play</a></li></ul><p><strong>Enable MFA in Mattermost</strong></p><ol><li>Open Mattermost in a web browser or the desktop app.</li><li>In Mattermost, from your profile picture, select <strong>Profile &gt; Security</strong>.</li><li>Under <strong>Multi-factor Authentication</strong>, select <strong>Edit</strong>.<p><img src={useBaseUrl('/images/multi-factor-authentication.png')} alt="Enable multi-factor authentication through your Mattermost user profile." /></p></li><li>Select <strong>Add MFA to Account</strong>.<p><img src={useBaseUrl('/images/add-mfa-to-account.png')} alt="Add multi-factor authentication to your Mattermost user profile." /></p></li><li>Scan the QR code or enter the <strong>Secret</strong> provided by Mattermost into the authenticator app.</li><li>In Mattermost, enter the <strong>MFA Code</strong> generated by the authenticator app.</li><li>Select <strong>Save</strong>.</li></ol></td>
</tr>
<tr>
<td>Sign-in method</td>
<td><p>This option allows you to switch your login method between using email/username and password and <a href="/end-user-guide/access/access-your-workspace#single-sign-on-sso">single sign-on credentials</a>.</p><p>You can configure this setting using Mattermost in a web browser or using the desktop app.</p><Note><p>While you can choose to log in with either set of credentials, you can only enable one login method at a time. For example, if AD/LDAP single sign-on is enabled, you can select <strong>Switch to using AD/LDAP</strong>, and enter your AD/LDAP credentials to switch login over to AD/LDAP. You'll need to enter the password for your email account to verify your existing credentials. Following the change, you'll receive an email to confirm the action.</p></Note></td>
</tr>
<tr>
<td>View access history</td>
<td><p>Using Mattermost in a browser or using the desktop app, you can access a chronological list of the last 20 login and logout attempts, channel creations and deletions, account settings changes, or channel setting modifications made with your account.</p><p>The details of the Session ID, which is a unique identifier for each Mattermost browser session, and IP Address of the action is recorded for audit log purposes.</p></td>
</tr>
<tr>
<td>View and log out of active sessions</td>
<td><p>Sessions are created when you log in with your credentials a new browser on a device. Sessions let you use Mattermost for up to 30 days without having to log in again.</p><p>Using Mattermost in a browser or using the desktop app:</p><ul><li>Select <strong>Logout</strong> during an active session if you want to revoke automatic login privileges for a specific browser or device.</li><li>Select <strong>More Info</strong> to view browser and system details.</li></ul></td>
</tr>
</tbody>
</table>

View File

@@ -0,0 +1,32 @@
---
title: "Manage your sidebar options"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
Using Mattermost in a web browser or the desktop app, you can customize your Mattermost sidebar based on your preferences. Select the gear icon <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> next to your profile picture, then select **Sidebar**.
Your channel sidebar includes [enhanced sidebar features](/end-user-guide/preferences/customize-your-channel-sidebar), including custom, collapsible channel categories, drag and drop, unread filtering, channel sorting options, and more.
<Note>
- The following sidebar settings apply to your current sidebar only.
- You must manage sidebar settings individually for every team you're a member of.
- You can manage these settings in a web browser or the desktop app. You can't manage these channel sidebar settings using the Mattermost mobile app.
</Note>
## Group unread channels separately
You can control whether unread channels are grouped together separately in the channel sidebar, unless your system admin has [disabled your ability to do so](/administration-guide/configure/experimental-configuration-settings#group-unread-channels).
Select **Sidebar Settings \> Group unread channels separately \> Edit** to group unread channels at the top of the channel sidebar in an **Unreads** category.
## Number of direct messages to show
You can set the default number of direct messages to show in the channel sidebar.
Select **Sidebar Settings \> Number of direct messages to show \> Edit** to define a default number of direct messages.
You can update the number of direct messages displayed in the channel sidebar at any time, regardless of the default you set. See the [manage direct messages](/end-user-guide/preferences/customize-your-channel-sidebar#manage-direct-messages) documentation for details.

View File

@@ -0,0 +1,43 @@
---
title: "Manage your thread reply notifications"
---
<PlanAvailability slug="all-commercial" />
You're [notified](/end-user-guide/preferences/manage-your-notifications) in a [web browser](/end-user-guide/preferences/manage-your-web-notifications), the [desktop app](/end-user-guide/preferences/manage-your-desktop-notifications), and on your [mobile device](/end-user-guide/preferences/manage-your-mobile-notifications), for threads you're following when you're @mentioned or the messages contain a keyword you're tracking.
<Tip>
- Mattermost auto-follows you on all direct and group messages, any thread you start, as well as any thread where you've been [@mentioned](/end-user-guide/collaborate/mention-people) directly.
- You can choose to [follow or unfollow any thread](/end-user-guide/collaborate/organize-conversations#follow-threads-and-messages) at any time.
</Tip>
You won't receive notifications for threads you're not following, or thread replies when they don't @mention you directly. However, blue message indicators show you unread thread replies you're not following in a given public or private channel.
For all other messages, a channel appears bolded to indicate unread messages.
## Customize your notifications
### Follow all threads in channels automatically
You can follow all threads in a channel automatically by going to **Channel Settings \> Notification Preferences \> Follow all threads in this channel and enable the Automatically follow threads in this channel**.
### Get notified when threaded discussions are disabled
If your organization doesn't use threaded discussions, or you have [opted out of threaded discussions](/end-user-guide/preferences/manage-your-display-options#threaded-discussions), you can configure Mattermost to notify you when someone replies to a thread you started, or have participated in. Go to **Settings \> Notifications \> Reply notifications** to choose one of 3 options:
- Receive notifications for messages in reply threads that you either start or participate in.
- Receive notifications on messages, but only in threads that you start.
- Don't receive notifications on messages in reply threads unless you're directly @mentioned.
### Send automatic replies to direct messages
Want to automatically reply to direct messages when you're out of office? When your system admin [enables the ability for you to do so](/administration-guide/configure/experimental-configuration-settings#enable-automatic-replies), you can configure Mattermost to send custom replies to direct messages by going to **Settings \> Notifications \> Automatic Direct Message Replies**, selecting **Enable**, and composing your automatic reply message.
## Frequently asked questions
### Are thread notification counts the same across all Mattermost clients?
No. Mobile app notifications only indicate unread threads with @mentions, and not general unread activity.
Using Mattermost in a web browser or the desktop app, the **Threads** list bolds unread threads that don't contain @mentions.

View File

@@ -0,0 +1,62 @@
---
title: "Manage your web notifications"
---
<PlanAvailability slug="all-commercial" />
## Enable notifications
From Mattermost v9.10, Mattermost prompts you to grant permission to your web browser to show notifications.
![From Mattermost v9.10, you're prompted to enable notifications.](/images/enable-notifications.png)
- When you select **Enable notifications**, you won't be asked again. You'll start receiving notifications in your web browser for all Mattermost activity with [badges](#badge-based-notifications) and [sounds](#notification-sounds). See the section below on [customizing your notifications](#customize-your-notifications) based on how you prefer to be notified about Mattermost activity in a web browser.
- If you dismiss this prompt, you won't receive Mattermost notifications in the web browser, and you'll be prompted again the next time you open Mattermost in a web browser, or go to **Settings \> Notifications \> Desktop and mobile notifications**.
- If you select **Deny** or **Deny Permanently**, you won't be asked again. You won't receive Mattermost notifications in the web browser. You can change this preference by granting notification permissions for Mattermost in the web browser.
## Badge-based notifications
In a web browser, Mattermost icons display the following types of badges:
- Numbered badges for unread [direct](/end-user-guide/collaborate/channel-types#direct-message-channels) [group](/end-user-guide/collaborate/channel-types#group-message-channels) messages, [@mentions](/end-user-guide/preferences/manage-your-mentions-keywords-notifications), and [keywords](/end-user-guide/preferences/manage-your-mentions-keywords-notifications) you're actively watching.
A red dot badge means you have unread @mentions, keywords, direct messages, and group messages. ![An example of a Chrome web browser mention badge indicator.](/images/chrome-mention-badge.png)
A black dot badge means you have unread activity in channels you're a member of. ![An example of a Chrome web browser activity badge indicator.](/images/chrome-activity-badge.png)
## Notification sounds
By default, web-based notifications include audible sounds.
## Customize your notifications
<Tip>
Mattermost notification settings labeled as Desktop also configure your web-based notifications when using Mattermost in a web browser.
</Tip>
### Reduce web notifications
To reduce the number of notifications you receive, select **Desktop and mobile notifications \> Mentions, direct messages, and group messages**, and save your changes. You can set this preference across all channels or for specific channels.
With limited notifications enabled, you can also choose to receive notifications about replies to threads you're following by selecting **Notify me about replies to threads I'm following**.
### Change or disable sounds
You can change or disable notification sounds by going to **Desktop notification sounds \> Message notification sound**.
### Incoming Call notifications
Want to hear a sound when a Mattermost call starts? If your Mattermost admin [enables this Beta feature](/administration-guide/configure/plugins-configuration-settings#enable-call-ringing), you can choose the sound that plays when a call is started within a direct or group message by going to **Desktop notification sounds \> Incoming call sound**.
### Disable all web notifications
Select **Desktop and mobile notifications \> Nothing** to disable all web and desktop notifications.
Clear the **Use different settings for my mobile devices** to additionally disable all Mattermost mobile notifications everywhere you use Mattermost.
## Frequently asked questions
### Why am I prompted repeatedly enable notifications I don't want?
Mattermost will continue to prompt you to grant permission to the browser to show notifications until you respond to the prompt. If you want to disable all Mattermost notifications, select **Enable notifications** when prompted, and then [disable all Mattermost web notifications](#disable-all-web-notifications).

View File

@@ -0,0 +1,35 @@
---
title: "Customize your preferences"
sidebar_label: "Preferences"
---
<PlanAvailability slug="all-commercial" />
You can customize many aspects of your Mattermost experience based on your preferences, including notifications for Mattermost activity, how unread channels are organized, the number of direct messages displayed, your Mattermost look and feel, and more!
<Tip>
Download [this guide to customizing Mattermost for technical teams](https://mattermost.com/customizing-mattermost-for-technical-teams-guide/) to learn how to get more from the platform.
</Tip>
## Learn more
- [Manage your Mattermost profile](/end-user-guide/preferences/manage-your-profile) - Configure your Mattermost profile.
- [Set your status and availability](/end-user-guide/preferences/set-your-status-availability) - Let your team know whether you’re available.
- [Manage your security preferences](/end-user-guide/preferences/manage-your-security-preferences) - Configure your Mattermost security preferences.
- [Manage your notifications](/end-user-guide/preferences/manage-your-notifications) - Learn how Mattermost notifications work by default and how to customize notifications based on how you prefer to work.
- [Manage your @mention and keyword notifications](/end-user-guide/preferences/manage-your-mentions-keywords-notifications) - Choose the words that get your attention.
- [Manage your thread reply notifications](/end-user-guide/preferences/manage-your-thread-reply-notifications) - Choose when replies to a thread notify you.
- [Manage your channel-specific notifications](/end-user-guide/preferences/manage-your-channel-specific-notifications) - Override your global settings for a single channel.
- [Manage your desktop notifications](/end-user-guide/preferences/manage-your-desktop-notifications) - Customize notifications in the desktop app.
- [Manage your mobile notifications](/end-user-guide/preferences/manage-your-mobile-notifications) - Customize push notifications on iOS and Android.
- [Manage your web notifications](/end-user-guide/preferences/manage-your-web-notifications) - Customize notifications in a web browser.
- [Troubleshoot notifications](/end-user-guide/preferences/troubleshoot-notifications) - Find out why you're not receiving the notifications you expect.
- [Customize your Mattermost theme](/end-user-guide/preferences/customize-your-theme) - Learn how to change the look and feel of Mattermost based on your preferences.
- [Manage your display options](/end-user-guide/preferences/manage-your-display-options) - Customize your Mattermost display to suit your preferences.
- [Customize your channel sidebar](/end-user-guide/preferences/customize-your-channel-sidebar) - Organize conversations in the sidebar to keep your workspace efficient.
- [Manage your sidebar options](/end-user-guide/preferences/manage-your-sidebar-options) - Customize your Mattermost channel sidebar to suit your preferences.
- [Manage advanced options](/end-user-guide/preferences/manage-advanced-options) - Customize advanced Mattermost user options to suit your preferences.
- [Manage your plugin preferences](/end-user-guide/preferences/manage-your-plugin-preferences) - Customize Mattermost plugin preferences for Microsoft Teams and Calls.
- [Customize your Desktop App experience](/end-user-guide/preferences/customize-desktop-app-experience) - Learn about additional preferences available only in the desktop app.
- [Connect to multiple Mattermost workspaces](/end-user-guide/preferences/connect-multiple-workspaces) - Learn how to connect to multiple Mattermost workspaces using the Mattermost desktop or mobile app.

View File

@@ -0,0 +1,114 @@
---
title: "Set your status and availability"
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="all-commercial" />
Let your team know whether you're available by setting a [custom status](/end-user-guide/preferences/set-your-status-availability#set-a-custom-status) and your [availability](/end-user-guide/preferences/set-your-status-availability#set-your-availability) in Mattermost.
## Set a custom status
Set a custom status to display a descriptive status message and optional emoji next to your name in Mattermost. Other members can see your status anywhere they can see your name, such as the channel sidebar and in conversations. To set a custom status in Mattermost:
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Select your profile picture, then select **Set a custom status**.
2. Choose from a list of suggested statuses, or enter a new emoji and status. The Speech bubble emoji 💬 is used by default if you don't specify an emoji. A custom status can be a maximum of 100 characters in length.
3. Specify when to clear your custom status.
4. Select **Set Status**.
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Select your profile picture, then select **Set a status**.
2. Choose from a list of suggested statuses, reuse a recent status, or tap to enter a status and select an emoji. The Speech bubble emoji 💬 is used by default if you don't specify an emoji. A custom status can be a maximum of 100 characters in length.
3. Specify when to clear your custom status.
4. Tap **Done**.
</TabItem>
</Tabs>
<Tip>
- Custom statuses are enabled by default in Mattermost. System admins can disable this feature by going to **System Console \> Site Configuration \> Users and Teams \> Enable Custom Statuses**. Disabling this feature also removes the `Update your status` prompts in Mattermost.
</Tip>
### Clear a custom status
To clear a custom status, select your profile picture, then select **Clear Status**, or select the **Clear** option next to your current status.
![Clear your custom status.](/images/clear-custom-status.png)
## Set your availability
To set your availability, select your profile picture, then specify your availability as **Online**, **Away**, **Do Not Disturb**, or **Offline**.
<table>
<colgroup>
<col style={{width: '20%'}} />
<col style={{width: '80%'}} />
</colgroup>
<thead>
<tr>
<th>Availability</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><img src={useBaseUrl('/img/ui/online.png')} alt="Online status icon" className="theme-icon" /> Online</td>
<td>
- Set automatically for you when you're active on Mattermost using a browser, the desktop app, or the mobile app.
- When using the desktop app, any mouse or keyboard activity keeps your availability set to **Online**.
- By default, notifications are sent to the browser, the desktop app, and the mobile app.
</td>
</tr>
<tr>
<td><img src={useBaseUrl('/img/ui/away.png')} alt="Away status icon" className="theme-icon" /> Away</td>
<td>
- Set automatically for you when you've been inactive for more than 5 minutes. System admins can change this value using an experimental configuration setting called `user status away timeout`.
- You're inactive in Mattermost when you're not: typing in or navigating between channels, switching to another browser tab, or when you've minimized or moved the browser window to the background.
- You can manually set yourself as **Away** any time.
- By default, notifications are sent to your Mattermost mobile app.
</td>
</tr>
<tr>
<td><img src={useBaseUrl('/img/ui/dnd.png')} alt="Do Not Disturb status icon" className="theme-icon" /> Do Not Disturb</td>
<td>
- Set your availability as **Do Not Disturb** any time you don't want notifications for a period of time.
</td>
</tr>
<tr>
<td><img src={useBaseUrl('/img/ui/offline.png')} alt="Offline status icon" className="theme-icon" /> Offline</td>
<td>
- Set automatically for you when you exit the Mattermost desktop app or close the browser window, sleep or lock your computer, or on mobile when you change apps, close the Mattermost mobile app, or lock your mobile device screen.
- You can manually set yourself as **Offline** any time.
- By default, notifications are sent to your Mattermost mobile app.
</td>
</tr>
</tbody>
</table>
Other members can see your availability anywhere they can see your name, such as the channel sidebar, within conversations, and within direct messages.
### Set your availability as Do Not Disturb
Set your availability to **Do Not Disturb** to disable all desktop, email, and push notifications when you are unavailable or need to concentrate.
You can specify how long to disable notifications by selecting a preset expiration, by setting a custom expiration, or by setting your status as **Don't clear**. Your availability automatically reverts to its previous setting once the expiration is reached (this may take up to five minutes).
![Example of setting your Mattermost availability as Do Not Disturb.](/images/set-your-availability-dnd.png)

View File

@@ -0,0 +1,232 @@
---
title: "Troubleshoot notifications"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
The Mattermost notifications you receive depend on your [Mattermost preferences](#check-your-mattermost-preferences), the [Mattermost client](#check-your-mattermost-client-settings) you're using, and the [operating system (OS)](#check-your-operating-system-settings) you're running Mattermost on.
## Send yourself a test notification
From Mattermost v10.3, you can send yourself a test notification by selecting **Settings** <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" />, and going to the **Notifications** options.
Under **Troubleshooting notifications** select the **Send a test notification** option. If notifications are working, you'll receive a system-bot direct message in Mattermost confirming that notifications are working.
If you don't receive a system-bot direct message, see the following sections for troubleshooting steps you can follow to ensure you're receiving the notifications you want.
## Check your Mattermost preferences
Start by ensuring that your Mattermost preferences have notifications enabled.
<Tabs>
<TabItem value="desktop" label="Desktop">
1. Select **Settings** <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> in the top right corner of Mattermost.
2. Select **Desktop and mobile notifications**.
If **Send notifications for** is set to **Nothing**, then Mattermost notifications are currently disabled. Select either the **All new messages** or **Mentions, direct messages, and group messages** option instead, and save your changes.
![Select the Gear icon to enable Mattermost notifications.](/images/desktop-notification-check.gif)
</TabItem>
<TabItem value="web" label="Web">
1. Select **Settings** <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> in the top right corner of Mattermost.
2. Select **Desktop and mobile notifications**.
If **Send notifications for** is set to **Nothing**, then Mattermost notifications are currently disabled. Select either the **All new messages** or **Mentions, direct messages, and group messages** option instead.
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap on your profile picture in the bottom right corner of Mattermost.
2. Tap **Settings** <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" />.
3. Tap **Notifications**.
4. Tap **Push Notifications**.
5. Ensure that **All new messages** or **Mentions, direct messages, and group messages** option is selected.
6. Under **Trigger push notifications when…**, select **Online, away or offline** to always receive notifications.
</TabItem>
</Tabs>
We recommend checking your Mattermost client settings next.
## Check your Mattermost client settings
<Tabs>
<TabItem value="desktop" label="Desktop">
Ensure notifications are enabled in your Mattermost server connection.
1. Select the Mattermost Server option in the top left of the desktop app, then edit the server details.
2. Under **Permissions**, enable **Notifications** and save your changes.
![Select the server option to enable Mattermost notifications.](/images/desktop-server-notification-check.gif)
</TabItem>
<TabItem value="web" label="Web">
If you prefer to use Mattermost in a web browser, you must grant notification permissions for Mattermost in the web browser. If you don't, the web browser can block you from receiving Mattermost notifications.
Select the **Chrome**, **Edge**, **Firefox**, or **Safari** tab below based on your preferred web browser:
<Tabs>
<TabItem value="chrome" label="Chrome">
Grant notification permissions for Mattermost in your Chrome web browser.
1. From the Chrome menu, select **Settings**.
2. Select **Privacy and Security** in the left pane.
3. Expand **Site settings**.
4. Under **Permissions**, expand **Notifications**.
5. Enable the **Sites can ask to send notifications** option, and add your Mattermost workspace URL to the **Allowed to send notifications** list.
</TabItem>
<TabItem value="edge" label="Edge">
Grant notification permissions for Mattermost in your Edge web browser.
1. From the Edge menu, select the **Settings and more (...)** option.
2. Select **Cookies and Site Permissions** in the left pane.
3. Under **All Permissions**, **select Notifications**.
4. Add your Mattermost workspace URL to the **Allow** section.
</TabItem>
<TabItem value="firefox" label="Firefox">
Grant notification permissions for Mattermost in your Firefox web browser.
1. From the Firefox menu, select **Settings**.
2. Select **Privacy and Security** in the left pane.
3. Under **Permissions**, select the **Settings** option for **Notifications**.
4. Enable notifications for your Mattermost workspace URL in the **Permissions** list.
</TabItem>
<TabItem value="safari" label="Safari">
Grant notification permissions for Mattermost in your Safari web browser.
1. From the Safari menu, select **Preferences**.
2. Select **Websites** and select **Notifications** in the left pane.
3. Enable notifications for your Mattermost site.
</TabItem>
</Tabs>
</TabItem>
<TabItem value="mobile" label="Mobile">
Ensure that your mobile device isn't blocking device settings. Visit the **Android** or **iOS** tab below based on your mobile device type.
<Note>
From Mattermost mobile v2.34, if your device has notifications disabled, a banner displays in the Mattermost mobile **Settings \> Notifications** screen with a quick link to help you restore device-level notifications.
</Note>
<Tabs>
<TabItem value="android" label="Android">
Ensure that your Android device isn't blocking Mattermost notifications by granting notification permission for Mattermost in device settings.
1. Open the Android **Settings app**, and tap **Application Manager**.
2. Locate **Google Play Services** and enable notifications for it.
3. Locate **Mattermost** and enable notifications for it.
Also ensure that your Android device isn't set to **Do Not Disturb** mode which is designed to block notifications. See the [Android help](https://support.google.com/android/answer/9069335#zippy=%2Cturn-interruptions-back-on) documentation to learn more.
</TabItem>
<TabItem value="ios" label="iOS">
Ensure that your iOS device isn't blocking Mattermost notifications by granting notification permission for Mattermost in device settings.
1. Open the iOS **Settings app** and tap **Notifications**.
2. In the list of apps, tap **Mattermost**.
3. Enable the **Allow notifications** toggle and set **Notification Delivery** to **Immediate Delivery**.
Also ensure that your iOS device isn't set to **Do Not Disturb** mode or a **Focus mode** designed to block notifications. See the [iOS support](https://support.apple.com/en-ca/105112) documentation to learn more.
</TabItem>
</Tabs>
</TabItem>
</Tabs>
We recommend checking your operating system settings next.
## Check your Operating System settings
The operating system you're running Mattermost on can also block Mattermost notifications. Select the **Linux**, **macOS**, or **Windows** tab based on your operating system:
<Tabs>
<TabItem value="windows" label="Windows">
If you're using Mattermost on a Windows machine, you must enable notifications from Mattermost and turn off both Do Not Disturb mode and Focus Assist. If you don't, Windows can block you from receiving Mattermost notifications.
1. Open **Windows Settings** and go to **System \> Notifications & actions**.
2. Ensure that **Get notifications from apps and other senders**, is enabled.
3. Find Mattermost in the list and enable notifications.
Also ensure that Windows’ **Do Not Disturb** mode and **Focus Assist** is turned off. See the Windows support docmentation on [Do Not Disturb mode](https://support.microsoft.com/en-us/windows/turn-off-notifications-in-windows-during-certain-times-81ed1b25-809b-741d-549c-7696474d15d3) and [Focus Assist](https://support.microsoft.com/en-us/windows/make-it-easier-to-focus-on-tasks-0d259fd9-e9d0-702c-c027-007f0e78eaf2) to learn more.
</TabItem>
<TabItem value="linux" label="Linux">
If you're using Mattermost on a Linux machine, you must enable pop-up notifications from Mattermost and turn off Do Not Disturb mode. If you don't, Linux can block you from receiving Mattermost notifications.
1. Open **Settings**, then go to **Notifications**.
2. Enable the **Show Pop-up Notifications** option.
3. Enable the **Show Notification Center** to review and manage your Mattermost notifications.
Also ensure that **Do Not Disturb** mode is turned off.
</TabItem>
<TabItem value="macos" label="macOS">
If you're using Mattermost on a macOS machine, you must enable application notifications for Mattermost and turn off focus mode. If you don't, macOS can block you from receiving Mattermost notifications.
1. Open **System Settings** and go to **Notifications**.
2. Under **Application Notifications**, ensure notifications are enabled.
Also ensure that macOS’ **Focus mode** is turned off. See the Apple Support [Focus mode](https://support.apple.com/en-ca/guide/mac-help/mchl999b7c1a/mac) documentation to learn more.
</TabItem>
</Tabs>
## Frequently Asked Questions
### What determines if a desktop notification should be triggered?
Desktop notifications are triggered under to following conditions. Click to expand the flow chart.
<img src={useBaseUrl('/images/desktop_notification_chart.png')} width="239" height="232" alt="A flow diagram shows how Mattermost Desktop App notifications are triggered when a message is posted." />
### What determines if an email notification should be triggered?
Email notifications are triggered under to following conditions. Click to expand the flow chart.
<img src={useBaseUrl('/images/email_notification_chart.png')} width="239" height="232" alt="A flow diagram shows how Mattermost email notifications are triggered when a message is posted." />
### What determines if a mobile push notification should be triggered?
Mobile push notifications are triggered under to following conditions. Click to expand the flow chart.
<img src={useBaseUrl('/images/push_notification_chart.png')} width="239" height="232" alt="A flow diagram shows how Mattermost mobile push notifications are triggered when a message is posted." />
### Are mobile push notifications free?
Yes, push notifications are free if you compile your own [push-proxy service](https://github.com/mattermost/mattermost-push-proxy). Push notifications are also free if you use the hosted Test Push Notification Service (TPNS) provided by Mattermost, Inc.
TPNS, hosted at [https://push-test.mattermost.com](https://push-test.mattermost.com), offers transport-level encryption, but not production-level service level agreements (SLAs).
If you need production-level SLAs for push notifications, you can either compile your own push-proxy service, with your own key, or you can use a paid option and become a Mattermost Professional subscriber [agreeing to our Conditions of Use](https://mattermost.com/terms-of-use/), which enables you to use a production-level Hosted Push Notification Service (HPNS) at a regional URL such as `https://global.push.mattermost.com` — see the [push notification server location](/administration-guide/configure/push-notification-server-configuration-settings#push-notification-server-location) setting for the full list of regions.
Learn more about [our push notification service](/administration-guide/configure/environment-configuration-settings#enable-push-notifications).
[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.

View File

@@ -0,0 +1,18 @@
---
title: "Boards settings"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="entry-ent" />
## Set language
In a board, set your preferred language by selecting the gear icon <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> next to your profile picture, then go to **Set language** to apply your language settings. Language settings in Boards are independent from language settings in Channels.
## Random emoji icons
To enable or disable random emoji icons for your board and cards, select the gear icon <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> next to your profile picture, then toggle **Random icons on or off**.
## Product tour
If you skipped the product tour or want a refresher on Boards, you can restart the product tour by going to the gear icon <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> next to your profile picture and selecting **Product tour**. This will add a new **Welcome to Boards** template to your sidebar and kick-off the guided onboarding tour.

View File

@@ -0,0 +1,48 @@
---
title: "Work with calculations"
---
<PlanAvailability slug="entry-ent" />
When you view a board in table or board view, you can use calculations to answer basic metric questions without needing to create complex reports. Hover over the bottom of a column to display the **Calculate** feature, then select the arrow to open the menu options.
You can use calculations to quickly see:
- How many story points are planned for a release.
- How many tasks have been assigned or not assigned.
- How long has the oldest bug been sitting in the backlog.
- The count of cards where particular properties are empty (useful to make sure important info isn’t missing).
- The sum of estimated developer days for features (to make sure your team isn’t overloaded).
- The range of estimated dates (to make sure your milestones all line up).
## Calculation options
Calculation options include the following:
- **Count**: Counts the total number of rows in table view or total number of cards in a column in Board view. Applies to any property type.
- **Count Empty**: Applies to any property type.
- Table View: Counts the total number of empty rows per column selected.
- Board View: Counts the total number of empty values per property specified within the same column.
- **Count Not Empty**: Applies to any property type.
- Table View: Counts the total number of rows with non-empty cells per column selected.
- Board View: Counts the total number of non-empty values per property specified within the same column.
- **Percent Empty**: Applies to any property type.
- Table View: Percentage of empty rows per column selected.
- Board View: Percentage of empty values per property specified within the same column.
- **Percent Not Empty**: Applies to any property type.
- Table View: Percentage of rows with non-empty cells per column selected.
- Board View: Percentage of non-empty values per property specified within the same column.
- **Count Value**: Applies to any property type.
- Table View: Counts the total number of values within the column (helpful for multi-select properties).
- Board View: Counts the total number of values per property specified within the same column.
- **Count Unique Values**: Applies to any property type.
- Table View: Counts the total number of rows with unique values within the column, omitting any duplicates from the count.
- Board View: Counts the total number of unique values per property specified within the same column, omitting any duplicates from the count.
- **Sum**: The sum of any specified number property within the same column.
- **Average**: The average of any specified number property within the same column.
- **Median**: The median of any specified number property within the same column.
- **Min**: The lowest number of any specified number property within the same column.
- **Max**: The highest number of any specified number property within the same column.
- **Range**: Displays the lowest and highest number. Requires a number property.
- **Earliest Date**: Displays the oldest date. Requires any custom date property or the included "Created time" or "Last updated time".
- **Latest Date**: Displays the most recent date. Requires any custom date property or the included "Created time" or "Last updated time".
- **Date Range**: The difference between the most recent date and oldest date within the same column. In Table View, it's labeled simply as "Range" for any date property/column. Requires any custom date property or the included "Created time" or "Last updated time".

View File

@@ -0,0 +1,84 @@
---
title: "Work with groups, filter, and sort"
---
<PlanAvailability slug="entry-ent" />
Your board can be grouped, filtered, and sorted into different views using a range of properties. This gives you a powerful way to track work from various perspectives. When used in conjunction with [saved views](/end-user-guide/project-management/work-with-views#work-with-saved-views), you can create multiple views with different groupings and filters for quick access without having to reapply the groupings and filters every time.
For example, easily find tasks assigned to you or a team member using the person or multi-person filters, and keep track of upcoming tasks with date filters.
## Group cards
You can group cards on your board if they utilize the **Select** or **Person** property. Card grouping is only available in board and table views and you must have at least one **Select** or **Person** property on your board for grouping to work.
### Apply a group
To apply a group, select the **Group by** option at the top of the board, then select any available **Select** or **Person** property to group your cards by.
- In the [boards view](/end-user-guide/project-management/work-with-views#board-view), cards are automatically grouped into columns by the values from the specified property.
- In the <code>table view \<end-user-guide/project-management/work-with-views:board view\></code>, grouped cards will appear in individual sections based on the values from the specified property. Select the arrow to the left of the group name to expand or collapse cards in the group.
### Hide and unhide groups
- To hide a group, select the options menu **(...)** to the right of any group name, then select **Hide**. Additionally, in table view only, you can hide empty groups by selecting the **Group by** option at the top of the board, then selecting **Hide empty groups**.
- To unhide a group, go to the hidden column section towards the right of a board view, select the group you want to unhide, then select **Show**. On table view, select the **Group by** option at the top of the board, then select **Show hidden groups**.
### Ungroup cards
To ungroup cards on table view, select the **Group by** option at the top of the board, then select **Ungroup** from the top of the menu. This will return your table to its default state. Cards can be ungrouped in table view only. Ungrouping is not possible on board view since groups are used to determine what to display.
## Filters
You can filter cards on your board if they utilize any of the following property types:
- Select
- Text
- Email
- Phone
- URL
- Date
- Person
- Multi-person
- Created time
- Created by
- Last updated time
- Last updated by
To use filters, you must have the above property types already added to your board. Go to **Filter \> Add filter**, and select the property you wish to filter by. You can use the modifiers to get even more granular results.
### Add filters
To add a filter, select the **Filter** option at the top of the board, then select **+ Add filter**. To change the property to filter by, select the name of the first property, then select another property (if available) from the menu.
**Specify the filtering criteria**
- **Includes**: Display cards with any of the specified values.
- **Doesn’t include**: Display all cards without any of the specified values.
- **Is empty**: Display cards with no values assigned to a property.
- **Is not empty**: Display cards with any value assigned to a property.
To add another filtering layer, repeat the steps above with another property to refine your filtering results. Adding another layer will display cards that only match the criteria from the first layer and the second layer.
### Delete filters
To delete a filter, select the **Filter** option at the top of the board, then select **Delete** to the right of each filtering layer. Delete all filtering layers to completely remove filters from the board.
## Sorting cards
Cards can be sorted by the card name or by any property available on the card.
<Note>
Sorting is only available in boards, table, and gallery views.
</Note>
### Apply sorting
To apply a sort, select the **Sort** option at the top of the board, then select an option from the menu. The cards will be sorted in ascending order by default based on the selected option and the **Sort** menu will display an upward pointing arrow next to the selected option.
To change the sort order to descending order, select the same option again from the **Sort** menu. The cards will now be sorted in descending order and the menu will display a downward pointing arrow next to the selected option.
### Clear sorting
To clear a sort, select the **Sort** option at the top of the board, then select the **Manual** option from the top of the menu.

View File

@@ -0,0 +1,181 @@
---
title: "Import, export, and migrate"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="entry-ent" />
## Import and export a board archive
If you’d like to back up your board or re-use it on another team or channel workspace, you can export it as an archive file, and then import the archive file in the team or channel workspace of your choosing. Exported and imported board archives include all card content such as properties, comments, descriptions, and image attachments.
To do this, select the options menu <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> to the left of the **New** button at the top of the board. Then select **Export board archive**. Download the archive file. Navigate to the team or channel workspace where you’d like to add the exported board. Select the Gear icon next to your profile picture, then choose **Import archive**. The board you exported will be added to this team or channel workspace.
The **Import archive** option will import the board to your current team. Use [board permissions](/end-user-guide/project-management/share-and-collaborate#board-permissions) to control access to your imported board. The previous `.focalboard` format will be deprecated in a future release, but will support importing until then. Currently, the import dialog looks for `.boardarchive`. Use **Select all files** to select `.focalboard` files to import.
## Export to CSV
To export a board into a CSV file, select the options menu <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> to the left of the **New** button at the top of the board. Then select **Export to CSV**.
## Import and export from other applications
You can import data from other tools to use with Boards.
## Import from Asana
This node app converts an Asana JSON archive into a `.boardarchive` file.
1. Log into your Asana account.
2. Select the drop-down menu next to the Asana board's name. Then select **Export/Print \> JSON**. This will create an archive file which you'll use in Boards.
3. Save the file locally, e.g. to `asana.json`.
4. Open a terminal window on your local machine and clone the focalboard repository to a local directory, e.g. to `focalboard`:
``` sh
git clone https://github.com/mattermost/focalboard focalboard
```
5. Navigate to `focalboard/webapp`.
6. Run `npm install`.
7. Change directory to `focalboard/import/asana`.
8. Run `npm install`.
9. From within the same folder, run `npx ts-node importAsana.ts -i <asana.json> -o archive.boardarchive`. This generates the following data:
``` sh
asana macbook$ npx ts-node importAsana.ts -i ~/Downloads/asana.json -o archive.boardarchive
Board: 1:1 Meeting Agenda Test
Card: [READ ME] Instructions for using this project
Card: [EXAMPLE TASK] Feedback on design team presentation
Card: [EXAMPLE TASK] Finalize monthly staffing plan
Card: [EXAMPLE TASK] Review Q2 launch video outline
Card: [EXAMPLE TASK] Mentor a peer
Found 5 card(s).
Exported to archive.boardarchive
```
10. In Boards, open the board you want to use for the export.
11. Select **Settings \> Import archive** and select `archive.boardarchive`.
12. Select **Upload**.
13. Return to your board and confirm that your Asana data is now displaying.
If you don't see your Asana data, an the error should be displayed. You can also check log files for errors.
### Import scope
Currently, the script imports all cards from a single board, including their section (column) membership, names, and notes.
## Import from Notion
This node app converts a Notion CSV and markdown export into a `.boardarchive` file.
1. From a Notion Board, open the **...** menu at the top right corner of the board.
2. Select <code>Export</code> and pick <code>Markdown & CSV</code> as the export format.
3. Save the generated file locally, and unzip the folder.
4. Open a terminal window on your local machine and clone the focalboard repository to a local directory, e.g. to `focalboard`:
``` sh
git clone https://github.com/mattermost/focalboard focalboard
```
5. Navigate to `focalboard/webapp`.
6. Run `npm install`.
7. Change directory to `focalboard/import/notion`.
8. Run `npm install`.
9. From within the same folder, run `npx ts-node importNotion.ts -i <path to the notion-export folder> -o archive.boardarchive`.
10. In Boards, open the board you want to use for the export.
11. Select **Settings \> Import archive** and select `archive.boardarchive`.
12. Select **Upload**.
13. Return to your board and confirm that your Notion data is now displaying.
### Import scope
Currently, the script imports all cards from a single board, including their properties and markdown content.
The Notion export format does not preserve property types, so the script currently imports all card properties as a Select type. You can change the type after importing into Focalboard.
## Import from Jira
This node app converts a Jira `.XML` export into a `.boardarchive` file.
1. Open Jira advanced search, and search for all the items to export.
2. Select **Export \> Export XML**.
3. Save the generated file locally, e.g. to `jira_export.xml`.
4. Open a terminal window on your local machine and clone the focalboard repository to a local directory, e.g. to `focalboard`:
``` sh
git clone https://github.com/mattermost/focalboard focalboard
```
5. Navigate to `focalboard/webapp`.
6. Run `npm install`.
7. Change directory to `focalboard/import/jira`.
8. Run `npm install`.
9. From within the same folder, run `npx ts-node importJira.ts -i <path-to-jira.xml> -o archive.boardarchive`.
10. In Boards, open the board you want to use for the export.
11. Select **Settings \> Import archive** and select `archive.boardarchive`.
12. Select **Upload**.
13. Return to your board and confirm that your Jira data is now displaying.
### Import scope and known limitations
Currently, the script imports each item as a card into a single board. Note that Jira `.XML` export is limited to 1000 issues at a time.
Users are imported as Select properties, with the name of the user.
The following aren't currently imported:
- Custom properties
- Comments
- Embedded files
## Import from Trello
This node app converts a Trello `.json` archive into a `.boardarchive` file.
1. From the Trello Board Menu, select **...Show Menu**.
2. Select **More \> Print and Export \> Export to JSON**.
3. Save the generated file locally, e.g. to `trello.json`.
4. Open a terminal window on your local machine and clone the focalboard repository to a local directory, e.g. to `focalboard`:
``` sh
git clone https://github.com/mattermost/focalboard focalboard
```
5. Navigate to `focalboard/webapp`.
6. Run `npm install`.
7. Change directory to `focalboard/import/trello`.
8. Run `npm install`.
9. From within the same folder, run `npx ts-node importTrello.ts -i <path-to-trello.json> -o archive.boardarchive`.
10. In Boards, open the board you want to use for the export.
11. Select **Settings \> Import archive** and select `archive.boardarchive`.
12. Select **Upload**.
13. Return to your board and confirm that your Trello data is now displaying.
### Import scope
Currently, the script imports all cards from a single board, including their list (column) membership, names, and descriptions.
## Import from Todoist
This node app converts a Todoist `.json` archive into a `.boardarchive` file.
1. Visit the open source Todoist data export service at [https://darekkay.com/todoist-export/](https://darekkay.com/todoist-export/).
2. From the **Options** menu, select **Export As \> JSON (all data)**.
3. Uncheck the **Archived** option if checked.
4. Select **Authorize and Backup**. This will take you to your Todoist account. Follow the instructions on screen.
5. Note the name and location of the downloaded `.json` file.
6. Open a terminal window on your local machine and clone the focalboard repository to a local directory, e.g. to `focalboard`:
``` sh
git clone https://github.com/mattermost/focalboard focalboard
```
7. Navigate to `focalboard/webapp`.
8. Run `npm install`.
9. Change directory to `focalboard/import/todoist`.
10. Run `npm install`.
11. From within the same folder, run `npx ts-node importTodoist.ts -i <path-to-todoist.json> -o archive.boardarchive`.
12. In Boards, open the board you want to use for the export.
13. Select **Settings \> Import archive** and select `archive.boardarchive`.
14. Select **Upload**.
15. Return to your board and confirm that your Todoist data is now displaying.

View File

@@ -0,0 +1,80 @@
---
title: "Navigate boards"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="entry-ent" />
## Access boards
To access Mattermost Boards, select the **Product** <img src={useBaseUrl('/img/ui/products_E82F.svg')} alt="Navigate between Channels, collaborative playbooks, and boards using the product menu icon." className="theme-icon" /> menu in the top left corner of Mattermost, and then select **Boards** to view all the boards for your team.
To access boards linked to a channel, select the **Toggle Linked Boards** icon to the far right.
## Link a board to a channel
Boards can be linked to channels and accessed from the channel Apps Bar. Select the **Boards** icon from the Apps Bar in a channel to open a right-hand sidebar (RHS) where channel members can search for and link boards to the channel. To link a board to the channel, select **Add** button to open the link boards dialog and search for a board to link. Channel members can only search and link boards within the team where they are also board admins.
<Note>
A channel can be linked to multiple boards, but each individual board can only be linked to one channel at a time. Linking the same board to another channel will automatically remove the link from the previous channel.
</Note>
Open the Boards Apps Bar icon, and select **Create a Board** to create a new board linked to the current channel. Once a board is linked to a channel, it's listed in the right-hand side of the Boards Apps Bar. Linking a board to a channel automatically grants all channel members access to the board, with the exception of guest accounts. Select a linked board to navigate directly to the board.
<Note>
All the boards previously associated with the workspace will automatically appear on the right-hand side panel post-migration as you upgrade to newer Boards versions.
</Note>
## Unlink a board from a channel
If you're a board admin and want to unlink a board from a channel you're in, open the Boards Apps Bar, select the options <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> menu and select **Unlink**. Alternatively, you can open the **Share** dialog on the board, open the **Role** drop-down menu next to the channel's name and select **Unlink**.
## Sidebar categories
You can organize your boards in the left-hand sidebar using custom categories. By default, all boards will appear under the **Boards** category. To manage your categories, open the <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> menu next to the category to create, delete, or rename a category. With the exception to the default **Boards** category, all other categories can be renamed or deleted.
After creating categories, you can move your boards to those categories by opening the more <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> menu next to the board and selecting **Move To…** to select the category where you want the board to be moved.
If you delete a category with boards in it, then those boards will return to the default **Boards** category.
Categories are organized per-user, so you can arrange your boards under categories that make sense to you without impacting boards or categories for other users. If a board is moved to a custom category, then the board will appear under that category for you only. Other users who are members of the board will continue to see the board in their own categories.
<Note>
If you belonged to a workspace prior to v7.2, you’ll see that the workspaces have been migrated to custom categories in the sidebar. All boards from a workspace are listed under a category of the same name. Boards from direct messages and group messages appear under the default **Boards** category.
Categories are per-user, and can be renamed or deleted by each user after migration. New users won’t have default categories, and boards they join will appear under the default **Boards** category.
Boards that you create after the migration won’t be linked to a workspace and will always appear under the default **Boards** category unless you move or hide the boards.
</Note>
## Drag and drop
You can move both sidebar categories and boards and change the order of both to suit your preference. You can:
- Set the position of a board within a category.
- Drag a board out of one category and drop it into another category.
To do this, select and hold the cursor over the category or board name. Then move the category or board around as needed. Boards moved into a category are sorted to the top of the category by default unless you specifically position the board before releasing the cursor.
## Manage boards on the sidebar
In addition to moving boards to other categories, from the <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> menu next to each board name you can perform the following actions:
- **Delete board**: If you're an admin of the board, you will see an option to delete the board. Deleting the board permanently removes the board from the sidebar of all board members.
- **Duplicate board**: Creates a copy of the board and all the cards on the board. The duplicated board will appear under the same category as the original board. Board members and comments from the original board aren't migrated to the new board.
- **New template from board**: Creates a custom board template of the board and all the cards on the board.
- **Hide board**: Hides the board from your sidebar only. The board will still remain visible on the sidebar for other board members. You can add the board back to your sidebar using the search box (CMD+K/CTRL+K).
## Find a board
From the top of the boards left hand sidebar, select the **Find Boards** field (CMD+K/CTRL+K) to open the board switcher, and start typing the name of the board you’re looking for.
## Team sidebar
If you’re a member of multiple teams, the team sidebar will appear on the left hand side of Boards. To switch teams, select any of the team icons from the team sidebar.

View File

@@ -0,0 +1,42 @@
---
title: "Project and Task Management"
sidebar_label: "Project Management"
---
<PlanAvailability slug="entry-ent" />
Mattermost Boards provides tight integration between project management and Mattermost to align, define, organize, track, and manage work across teams.
With Boards you can:
- **Manage projects and organize tasks:** A familiar kanban board structure integrated with channel-based communication.
- **Manage and collaborate on various projects:** Software releases, product launches, meetings, personal to-do’s, events, etc.
- **Stay on schedule:** Clearly-defined tasks, owners, checklists, deadlines, and calendars.
- **Increase transparency and keep everybody in the loop:** Everything your team needs in one place, including documents, images, and links that are visible to every stakeholder.
## Install Boards
Your system admin may need to install and enable Mattermost Boards before you can use it. See the [install Mattermost Boards](/administration-guide/configure/install-boards) documentation to learn how to install and configure the Boards plugin for your Mattermost instance.
## What's a board?
A board is a collection of cards to help you manage your projects, organize tasks, and collaborate with your team all in one place.
Boards can be displayed and filtered in different views such as kanban, table, calendar, and gallery views to help you visualize work items in the format that makes most sense to you. Learn about [working with boards](/end-user-guide/project-management/work-with-boards).
## What's a card?
Cards are used on a board to track individual work items. Cards are customizable and can have a number of properties added to them, which are then used as a way to tag, sort, and filter the cards.
When working with cards, you can manage properties, add descriptions, attach images, assign them to team members, mention team members, add comments, and so on. Learn more about [working with cards](/end-user-guide/project-management/work-with-cards).
Learn more about working with boards by visiting the following documentation pages:
- [Navigate boards](/end-user-guide/project-management/navigate-boards) - Find your way around the Boards interface.
- [Work with boards](/end-user-guide/project-management/work-with-boards) - Create boards, and display them as kanban, table, calendar, or gallery views.
- [Work with cards](/end-user-guide/project-management/work-with-cards) - Track individual work items, and customize their properties.
- [Work with saved views](/end-user-guide/project-management/work-with-views) - Save a board's layout, filters, and sorting to return to later.
- [Work with groups, filter, and sort](/end-user-guide/project-management/groups-filter-sort) - Organize the cards on a board to focus on the work that matters now.
- [Work with calculations](/end-user-guide/project-management/calculations) - Summarize card properties across a board or a group.
- [Share and collaborate on boards](/end-user-guide/project-management/share-and-collaborate) - Manage who can see and edit a board.
- [Import, export, and migrate](/end-user-guide/project-management/migrate-to-boards) - Migrate your data from other tools into Mattermost Boards.
- [Boards settings](/end-user-guide/project-management/boards-settings) - Adjust language and emoji settings, and restart the product tour.

View File

@@ -0,0 +1,196 @@
---
title: "Share and collaborate on boards"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="entry-ent" />
## Board permissions
Boards belong to teams and any member of that team can be granted access to a board.
If your boards workspace looks different, you may be on an earlier version of boards. In earlier versions, boards are tied to channel workspaces and board membership is determined by channel membership. In this case, roles and permissions won't be applicable to you.
## Roles
<table>
<colgroup>
<col style={{width: '32%'}} />
<col style={{width: '17%'}} />
<col style={{width: '17%'}} />
<col style={{width: '17%'}} />
<col style={{width: '17%'}} />
</colgroup>
<thead>
<tr>
<th>Board permissions</th>
<th>Admin</th>
<th>Editor</th>
<th>Commenter</th>
<th>Viewer</th>
</tr>
</thead>
<tbody>
<tr>
<td>Modify permissions</td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Share a public board</td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Delete board</td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Rename board</td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Add, edit, and delete views</td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Add, edit, and delete cards</td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Comment, delete my comments</td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td></td>
</tr>
<tr>
<td>Delete any comment</td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>View</td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
<td><img src={useBaseUrl('/img/ui/checkmark.svg')} alt="Yes" className="theme-icon" /></td>
</tr>
</tbody>
</table>
The level of access to a board is determined by a user’s assigned board role. Individual board membership always gets precedence, followed by highest (most permissive) group role.
- **Admin**: Can modify the board, its contents, and its permissions. By default, board creators are also admins of the board.
- **Editor**: Can modify the board and its contents.
- **Commenter**: Can add comments to cards.
- **Viewer**: Can view the board and its contents but can't comment or edit the board.
### System admin access
System admins can access any board across the server provided they have the board's URL without having to request permission or be manually added. When a system admin joins a board, their default role is admin. System admins will have an **Admin** label assigned to their name on the participants list.
### Team admin access
Team admins can access any board within their team provided they have the board's URL without having to request permission or be manually added. When a system admin joins a board, their default role is admin. Team admins will have a **Team admin** label assigned to their name on the participants list.
### Manage team access
Board admins can manage team access to their board by selecting **Share** in the top-right corner of the board. On the dropdown next to **Everyone at… Team** option, select a minimum board role for everyone on the team. You can also easily assign the new roles to the entire team and/or to individual team members.
Minimum default board roles reduce permission ambiguity and prevent security loopholes. The minimum default role means that board admins can't assign individual board members a role lower than the team role. If the team role is set to **Editor** then the board admin will only be able to assign the **Editor** or **Admin** role to individual team members. Lower roles will not be available for selection unless the admin changes the minimum board role.
Depending on the role selected, everyone on the team will have access to the board with a minimum of the permissions from the role selected. Users can get elevated permissions based on their individual board membership. The default team access for a newly created board is **None**, which means nobody on the team has access to the board.
### Manage individual board membership
Only board admins can manage user permissions on a board, including adding, changing, and removing members.
To add individual users from the team as explicit members of the board, open the **Share** dialog on the board, search for individual team members, then assign a role to set their permissions for the board. The role for individual board members overrides any role specified for team access.
- To change a board member’s role, open the **Share** dialog, select the role dropdown next to the user’s name, then select another role from the list.
- To remove a member from a board, open the **Share** dialog, select the role dropdown next to the user’s name, then select **Remove member**.
Board admins can also add individual members using the autocomplete list from @mentions and the person properties. To add an individual from the autocomplete list, type their username in an @mention or in the **Person** or **Multi-person** properties, then assign a role to the user from the confirmation dialog, and select **Add to board**.
On boards with team access, board members with **Editor** or **Commenter** roles can also add individuals to the board from the autocomplete list. Board members added in this manner will be assigned the default minimum board role.
### Channel role groups
Board admins can add a channel to a board to grant all its members Editor access. To do this, select **Share** in the top-right corner of the board, search for the channel name, and add it to the board as a user. The default role is Editor. Doing so also [links the board back to the channel](/end-user-guide/project-management/navigate-boards#link-a-board-to-a-channel), where the board will appear on the channel RHS.
To unlink the channel from the board, open the **Share** dialog, select the role dropdown next to the channel’s name, then select **Unlink**.
<Note>
A board can only be linked to one channel at a time. Linking another channel to the same board will automatically remove the link from the previous channel.
</Note>
## Guest accounts
From Mattermost Boards v7.4, [guest accounts](/administration-guide/onboard/guest-accounts) are supported in Boards. Guests can:
- Access boards where they're added as an explicit member of the board. [Team access](#manage-team-access) and [channel role groups](#channel-role-groups) don't apply to guest accounts.
- Access existing boards, but not create new boards. Guests don't have access to the template picker and can't duplicate an existing board.
- Search for boards where they're currently an explicit member.
- Be assigned the Viewer, Commenter, or Editor roles, but not the board Admin.
- Only @mention current members on the board.
If you're not able to access this functionality, you may be on an earlier version of Boards.
## Share a board
Boards can be shared internally with your team or published externally with limited accessibility.
### Share a board internally
To share a board with team members internally, select **Share** in the top-right corner of the board, then select **Copy link** from the **Share** tab below. Paste the copied link in a channel or direct message to share the board with other team members. Only team members who have permissions to the board will be able to open the board from the shared link.
### Share a board publicly
Sharing boards publicly is disabled by default. This means that the **Publish** tab is not available from the **Share** dialog. To enable public board sharing:
1. Go to **Product menu \> System Console \> Products \> Boards**.
2. Set **Enable Publicly-Shared Boards** to **true**.
3. Select **Save**.
Once enabled, board admins can share a read-only link online with anyone:
1. Select **Share** in the top-right corner of the board.
2. Toggle to the **Publish** tab.
3. Switch to the **Publish to the web** option.
4. Select **Copy link**.
Paste the link anywhere you want to share the board. Anyone with the link will be able to view the board, but they won’t be able to edit the board.
Select the **Regenerate Token** icon in the URL box if you want to invalidate all the previously shared links. Confirm the action to regenerate the token.
## Share cards on Channels
Cards can be linked and shared with team members directly on Mattermost Channels. When you share a link to a card within Channels, the card details are automatically displayed in a preview. This preview highlights what the card is about at a glance without having to navigate to it.
To share a card, you'll need to copy the card link first:
- Open a card and select the options menu **(...)** at the top right of the card, then select **Copy link**.
- Alternatively, you can open the board view and hover your mouse over any card to access the options menu **(...)** for the card and select **Copy link** from there.
After you've copied the link, paste it into any channel or direct message to share the card. A preview of the card will display within the channel with a link back to the card on Boards.

View File

@@ -0,0 +1,97 @@
---
title: "Work with boards"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="entry-ent" />
Start by selecting the type of board you want to use. A board contains cards, which typically track tasks or topics, and views, which define how to display the cards, or a subset of them. Views can display cards in a board, table, calendar, or gallery layout, optionally filtered and grouped by a property (e.g., priority, status, etc).
## Add new boards
To add a new board, select the plus icon <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> at the top of the sidebar, then select **Create New Board** to open the template picker and select a template or blank board.
### Board details
To name or rename a board, select the title area to edit it.
To display board description, hover above the board’s title and select **Show description** to activate the show/hide toggle. Once the description field is displayed, select **Add a description** right below the board title to add or edit the description.
Boards and cards are created with random icons by default. To change or remove icons, select the icon then choose the appropriate action.
All changes you make to boards and cards are saved immediately.
## Choose a board template
Templates provide you with a predefined structure so that you can get started quickly. Each template has a different function, but can be customized to suit your use case. When you create a new board from the template picker, select each template’s name to preview it and make sure it suits your requirements. Alternatively, you can create your own board templates.
### Board templates
Standard board templates include:
- **Content Calendar**: Plan and organize your content creation and publication schedule.
- **Company Goals & OKRs**: Plan your company goals and objectives more efficiently.
- **Competitive Analysis**: Track and stay ahead of the competition.
- **Meeting Agenda**: Use this template for recurring meetings. Queue up items, organize discussions, and plan what to revisit later.
- **Personal Goals**: Categorize and plan your personal goals.
- **Personal Tasks**: Organize your life and track your personal tasks.
- **Project Tasks**: Stay on top of your project tasks, track progress, and set priorities.
- **Roadmap**: Plan your roadmap and manage your releases more efficiently.
- **Sprint Planner**: Plan your sprints and releases more efficiently.
- **Team Retrospective**: Identify what worked well and what can be improved for the future.
- **User Research Sessions**: Manage and keep track of all your user research sessions.
- **Welcome to Boards!**: Onboarding template with guided tour points to help you quickly ramp up on Boards.
### Create a blank board
If none of the available templates suit your requirements, you can create a blank board using the **Create empty board** option from the template picker.
### Create a new template
To create a new board template select the plus icon <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> at the top of the sidebar to open the template picker, select **Create New Board** and then select **+ New template**.
To turn an existing board into a template, hover over the board title in the sidebar. Select the options menu <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" />, then select **New template from board**.
### Share a custom board template
<Tabs>
<TabItem value="from-boards-v7-2-or-later" label="From Boards v7.2 or later">
Custom templates support permissions control, and are restricted to only the template creator by default. The template creator is an admin of the template. To make the template accessible to everyone on the team, select **Share** on the template editor, and then set the team role as **Viewer**. All members of the team will now be able to see and select the template from the template picker.
The admin of the template can also grant specific team members elevated permissions to the template and/or limit access to selected team members by setting the team role as **None** and adding individual members to the template. Individual team members can be assigned the following roles on a template:
- **Admin**: Can modify the template and its permissions, and delete the template.
- **Editor**: Can modify but not delete the template, nor change permissions.
- **Viewer**: Can view and select the template.
</TabItem>
<TabItem value="prior-to-boards-v7-2" label="Prior to Boards v7.2">
Boards and templates are channel-specific so whichever channel you create your board or template in, is where you’ll find it. If you’d like to re-use a board as a template on another channel workspace, you can export it and then import the archive file in the channel of your choosing.
To do this, select the options menu <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> in the toolbar at the top of the board. Then select **Export** board archive. Download the archive file. Navigate to the channel where you’d like to add the exported board. Select the gear icon <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> next to your profile picture, then choose **Import archive**. The board you created will be added to this channel.
</TabItem>
</Tabs>
## Edit board templates
Custom templates are fully editable, but standard templates cannot be edited or deleted. To open the template editor for a specific template, go to the template picker then hover over the custom template and select the pencil icon. Any changes made on the template editor will be automatically saved and visible to team members who have access to the template.
<Tabs>
<TabItem value="from-boards-v7-2-or-later" label="From Boards v7.2 or later">
Only admins and editors of a custom template can edit the template. If you don't see the pencil icon when hovering over the template, then you don't have the appropriate permissions to edit the template.
</TabItem>
<TabItem value="prior-to-boards-v7-2" label="Prior to Boards v7.2">
Any member of the channel workspace can edit a custom template in the channel. To limit access to the template, create or export the template to a private channel.
</TabItem>
</Tabs>

View File

@@ -0,0 +1,161 @@
---
title: "Work with cards"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="entry-ent" />
A card consists of:
- **A set of properties**: Properties are common to all cards in a board. Board views can group cards by “Select” type properties into different columns.
- **A list of comments**: Comments are useful for noting important changes or milestones.
- **A set of content**: The content of a card can consist of Markdown text, checkboxes, and images. Use this to record detailed specs or design decisions for an item for example.
Drag cards from one column to another to change their group-by property. For example, if cards are grouped by “Status” on board view, drag a card to the **Completed** column to mark it as completed. When a board is unsorted, you can drag a card up and down within a column to custom sort your cards.
For sorted boards, dragging a card to a column will auto-sort it using the specified sort settings. The ability to move cards between boards isn't supported.
Our standard board templates provide some default card properties that can be customized or removed. In the Roadmap template, we include **Type** property, whereas in the Project Tasks template, we include an **Estimated Hours** property. These properties are not exclusive to any template and can be easily re-created in any of the templates provided.
## Card descriptions
Card descriptions can include text with Markdown formatting, checkboxes, and visual elements such as images or GIFs, and can be separated into blocks of content. To add a description, open a card, select **Add a description** below the **Comments** section, and start typing in your content.
To add a new content block in the description section, hover over the section and select **Add content**. Then choose from any of the following options:
- **Text**: Adds a new text block that can be formatted with Markdown.
- **Image**: Select and embed an image file into the content block. The following image formats are currently supported: GIF, JPEG, and PNG.
- **Divider**: Adds a divider content block below the previous block.
- **Checkbox**: Adds a checkbox content block. Press Enter/Return after typing in content for your checkbox to add another checkbox within the same block. Please note, Markdown formatting isn't supported within the **Checkbox** content block.
To manage the description content blocks on a card, hover over any existing block and select the options menu <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> to move the block up or down, insert a new block above, or delete the current block. Alternatively, you can hover over any existing block, then select and hold the grid button to drag and drop it to a new position within the description section.
## Card properties
Cards can contain different data fields depending on the purpose of the board. Using card properties, you can customize these data fields to fit your needs and track the information most important to you. For example, in a **Roadmap** board, cards include a **Type** field where you can add categories such as **Bug**, **Epic**, etc. In a **Project Task** board, cards include the **Estimated Hours** field instead.
## Add properties
To create a new property field open a card and select **Add a property**. Then select the type of property from the drop-down menu. The property type specifies the type of data you plan to capture within that field. When you create new card properties, they're added to all new and all existing cards on the current board.
Properties are automatically added to the board filter list at the top of the page, so ensure you customize all property names to make it easy to filter your board by specific properties later.
### Work with property types
Boards supports a wide range of fully customizable property types:
- **Text** can be used to add short notes to a card. An advantage of the text property over card descriptions is that it can be [shown on the board](#toggle-properties-shown-on-a-board) without needing to open the card.
- **Numbers** are useful to capture metrics such as task sizing or effort estimates. Use in conjunction with calculations to get the most out of the number property type.
- **Email** and **Phone** can be used to record contact information.
- **URL** can be used to provide a link to a pull request or relevant website. Clicking on the box of a URL property will automatically open the link in a new tab on your browser. Hover over the box to surface options to copy or edit the URL.
- **Select** and **Multi-select** allows you to create a predefined list of options that can be color-coded and displayed as badges on the card to indicate things like status and priority.
- **Dates** are useful to set and track due dates or milestones. Use the date property to make a card appear on the [Calendar view](/end-user-guide/project-management/work-with-views#calendar-view). Set a single date or toggle on the **End date** to set a date range.
- **Person** and **Multi-person** provides a quick way to capture user assignments.
- **Checkbox** is a toggle property that can be used for assigning simple binary options on a card such as True/False or Yes/No.
- **Created time/Created by/Last updated time/Last updated by** are predefined system properties to help you audit changes on a card. The names of these properties are customizable, but the values are not.
## Rename a property
The default name for a new property is the name of the property type (e.g. **Date**, **URL**). To rename a property field, open up a card and select the property name to open an editable field. Enter the new name in the field provided. The change is saved immediately and applied across all cards on the current board.
## Change a property type
To change a property type, select the property then open the **Type** menu and choose a new property type. You’ll be asked to confirm the change from every card on the current board. Changing the type for an existing property will affect values across all cards on the board and may result in data loss.
## Delete a property
To delete properties you no longer need, select the property, then choose **Delete**. You’ll be asked to confirm that you want to remove that property from every card on the current board. Properties are displayed in the order they were created and cannot be re-ordered at this time.
## Define a "Select" or "Multi-select" property
The options on a **Select** and **Multi-select** property type appear as color-coded tags on a card. To add and configure the options on these types:
1. Select a card to open the card view.
2. Add a new property, give it a name, and set its type to **Select** (or **Multi-Select**).
3. Select the field box for the property, and start typing the name of a new option. Press Enter to accept. Repeat this step to add additional options.
- To assign a color to or delete an option, select the value and select the options menu **(...)** next to each option name.
- To select an option on the property, select the box and choose one of the values from the menu.
- To remove an option on the property, select the box and chooose the <code>X</code> next to the option name you want to remove.
Alternatively, you can also add new options directly from a board:
1. Open a board view.
2. Group by a **Select** property.
3. Scroll to the right of the board and select **+ Add a group**.
This will add a new column, which corresponds to a new value option for the Select property. Options in a **Select** or **Multi-Select** property list are sorted in the order they were created and cannot be re-ordered or renamed at this time.
## Toggle properties shown on a board
Once you have card properties defined, you have full control over which properties are shown on the board as a preview without having to open the card. Select **Properties** at the top of the board, then enable all properties you want to see at a glance, and hide all properties you don’t want to see.
## Attach files
You can attach files to your cards that other board members can download. There are no limitations to the file types that you can upload.
To upload a file to a card, select **Attach** in the top-right corner of the card. Then select the file you'd like to upload. When your file has been uploaded, you can find it in the **Attachments** section of the card. Select the **+** sign to add additional files to your card.
To delete a file, hover over it and select the <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> menu. Then select **Delete**. To download the file, select the download icon.
## Card badges
Card badges are a quick way to view card details without opening up a card. To add them, select **Properties \> Comments and Description**. Icons related to the card description, comments, and checkboxes will be displayed on cards with the respective content. Open the card to view the details.
- The description icon indicates that a card has a text description.
- The comment icon displays a number indicating how many comments have been added to a card. When a new comment is added, that number is updated.
- The checkbox icon displays the number of items checked off relative to the total number of checkboxes within the card. When an item is checked off, the icon is automatically updated.
## Comment on a card
Comments allow you to provide feedback and ask questions relevant to the specific work item on the card.
To add a comment, select a card to open the card view, then click on **Add a comment…** to type in your comment, and press **Send** to save the comment to the card. All team members who are [following the card](#receive-updates) will receive a notification with a preview of your comment in Mattermost Channels.
Only board members with the *Commenter* role or higher can comment on a card. Board members assigned the *Viewer* role can view, but not comment on, a card.
## Mention people
You can include a team member on a card by [mentioning them on a card](/end-user-guide/collaborate/mention-people) the same way you would in Channels. Mentions are supported in the [Comments](#comment-on-a-card) and [Description](#card-descriptions) sections within a card. The team member you mention will receive a direct message notification from the boards bot with a link to the card you mentioned them on. To mention multiple team members, separate each name with a comma.
## Receive updates
When you create a card, you automatically follow it. You can @mention someone on a card to add them as a follower. This can be a card you've created or someone else's card. Lastly, you can also follow cards manually using the **Follow** option on the top-right corner of a card. To unfollow a card, select **Following**.
When updates are made to a card you're following, you'll receive a direct message from the boards bot with a summary of the change (e.g. Bob changed status from **In progress** to **Done**) and a link to the card for more detailed information. You won't get a notification of your own changes made to a card, even if you're following that card.
## Search cards
You can search through all the cards on a board to find what you’re looking for. Open the board you want to search, then select the **Search cards** field in the top-right of the board.
## Card templates
Card templates can help reduce repetitive manual input for similar types of work items. Each board can have any number of card templates. To create a new card template:
1. Open the board where you want to add the card template.
2. Select the drop-down arrow next to **New**, then select **New template**.
3. Add a title to the card template.
4. Then assign values to any properties and add a description you wish to have pre-populated when a card is created from the template.
5. Close the card using the **X** in the top left corner.
6. Select the drop-down arrow next to **New**, then select the template you just created.
Alternatively, you can turn any existing card into a template:
1. Open the card you want to use as a template.
2. Select the options menu <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> in the top-right corner of the card.
3. Select **New template from card**.
4. Edit the card as needed, including a helpful name.
5. Close the card using the **X** in the top left corner.
6. Select the drop-down arrow next to **New**, then select the template you just created.
To set a default card template for all new cards created on the board:
1. Select the drop-down arrow next to **New**.
2. Open the options menu <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> next to the card template of your choosing.
3. Select **Set as default**.
<Note>
The card template is applicable only to the board in which it’s created and isn’t available in other boards in your team workspace. Comments on a template don't get populated on to new cards. Additionally, properties can't be hidden from a card template at this time. All cards on a board share the same properties, so adding or deleting a property on a template will also apply to all cards on a board.
</Note>

View File

@@ -0,0 +1,28 @@
---
title: "Work with saved views"
---
<PlanAvailability slug="entry-ent" />
You can change board views to adjust how your cards are represented. To add a new view to a board, from the board header, select the menu next to the current view name. Scroll down and select **+ Add view**, then select the new visualization you’d like to use.
## Board view
This is a kanban view where cards are grouped into columns. Column groups only work with the **Select** or **Person** properties and display all cards that share the same value from the specified property. The column names are editable, and any changes to the column names are also applied to the value from the property. Cards can be dragged between columns, which will automatically update the property’s assigned value on the card.
## Table view
Displays cards in a table format with rows and columns. Use this view to get an overview of all your project tasks. Easily view and compare the state of all properties across all cards without needing to open individual cards. Each column corresponds to a card property. You can edit cells directly or you can select **Open** to open the card view for that row.
## Gallery view
Displays cards in a gallery format, so you can manage and organize cards with image attachments. Gallery view displays a preview of the first image attached on the card. For cards with no image attachments, a preview of the first description block will be displayed instead.
## Calendar view
To use this view, cards need to have the **Date** property added.
If cards don’t have a custom **Date** property, they’ll be sorted and displayed by the card creation date (default). These cards can’t be moved around the board until a custom **Date** property is added. If your cards do have a **Date** property and you’re not able to move them around, you may be displaying them by **Created Time** or **Last Updated Time**.
- To add a new card, select the **+** option in the top-left corner of the relevant date.
- To create a date range event, select a start date and then drag to the end date to create a card for that date range event.
- To add a date range to an existing card, hover over the side of the card to display the arrow and drag to the left or right to create a date range.

View File

@@ -0,0 +1,36 @@
---
title: "View system information"
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="all-commercial" />
You can view technical details about your Mattermost server, including version information and system metrics. This information is useful when working with Mattermost support or troubleshooting issues.
<Tabs>
<TabItem value="web-desktop" label="Web/Desktop">
1. Select your profile picture in the top-right corner of Mattermost.
2. Select **About Mattermost** from the dropdown menu.
</TabItem>
<TabItem value="mobile" label="Mobile">
1. Tap your profile picture.
2. Tap **About** to view system information.
</TabItem>
</Tabs>
## About dialog information
The About dialog displays key information about your Mattermost instance, including:
- **Mattermost Version**: The current version of the Mattermost server. Click to copy the version number.
- **Desktop App Version**: The current version of the Mattermost Desktop App (when using Desktop App). Click to copy the version number.
- **Database Schema Version**: The version of the database schema in use
- **License**: Information about your Mattermost license (if applicable)
- **Build Information**: Details about the server build
- **Load Metric**: Monthly active users relative to licensed users ([learn more](/administration-guide/manage/admin/generating-support-packet#load-metric))

View File

@@ -0,0 +1,33 @@
---
title: "Interact with playbooks"
---
<PlanAvailability slug="entry-ent" />
## Slash commands
Slash commands are available for collaborative playbooks. The `/playbook` slash command allows interaction with incidents via the post textbox on desktop, browser, and mobile. To run a playbook use the `/playbook run` slash command from any channel.
Available slash commands include:
- `/playbook run` - Run a playbook.
- `/playbook finish` - Finish the playbook run in this channel.
- `/playbook update` - Provide a status update.
- `/playbook check [checklist #] [item #]` - Check/uncheck the checklist item.
- `/playbook checkadd [checklist #] [item text]` - Add a checklist item.
- `/playbook checkremove [checklist #] [item #]` - Remove a checklist item.
- `/playbook owner [@username]` - Show or change the current owner.
- `/playbook info` - Show a summary of the current playbook run.
- `/playbook timeline` - Show the timeline for the current playbook run.
- `/playbook todo` - Get a list of your assigned tasks.
- `/playbook settings digest [on/off]` - Turn daily digest on/off.
- `/playbook settings weekly-digest [on/off]` - Turn weekly digest on/off.
## Playbooks on the go
Learn how to [access and work with playbooks on the go](/end-user-guide/workflow-automation/work-with-runs#playbook-runs-on-mobile) with the Mattermost mobile app.
## API documentation
To interact with the data model programmatically, consult the [REST API specification](https://github.com/mattermost/mattermost-plugin-incident-collaboration/blob/master/server/api/api.yaml).
Playbooks help streamline and manage complex processes while decreasing the risk of forgotten steps or tasks. They also support tool integration, status updates in a dedicated channel, and can be edited on the fly. When a playbook run is finished, you can review the entire run to assess any areas of improvement for the next run.

View File

@@ -0,0 +1,59 @@
---
title: "Learn about collaborative playbooks"
---
<PlanAvailability slug="entry-ent" />
A collaborative playbook is a repeatable process that is measured and refined over time. For example, the steps you follow when dealing with an outage, a software release, or welcoming a new member of your team can all be made into a playbook.
Using collaborative playbooks, teams can orchestrate prescribed workflows and define, streamline, and document complex, recurring operations.
Each playbook represents a recurring outcome or specific goal that your teams collaborate on to achieve, such as service outage recovery or customer onboarding. Collaborative playbooks are made up of:
- [Checklists](/end-user-guide/workflow-automation/work-with-playbooks#make-checklists): The list of tasks to be completed for the run. Can be edited during a run. From Playbooks v2.6.0, checklists can also be created and managed directly within public and private channels.
- [Templates](/end-user-guide/workflow-automation/work-with-playbooks#templates): Used for frequently-used actions such as updates and reminders. You can create your own templates or use default ones.
- [Automation actions](/end-user-guide/workflow-automation/work-with-tasks#task-actions): Used for inviting members, creating webhooks, editing welcome messages, and more.
- [Permissions](/end-user-guide/workflow-automation/share-and-collaborate): Manage permissions at the channel and at the playbook level.
Teams run a playbook every time they want to orchestrate people, tools, and data to achieve that outcome as quickly as possible while providing visibility to stakeholders.
- For participants, playbooks prescribe processes and actions such as task checklists, status updates, and retrospective reports.
- For your integrated tools, playbooks configure the triggers that execute automated actions.
- For stakeholders, playbooks provide a single pane of glass for visibility into each run as well as aggregate insights over time.
## What's a run?
A run is the execution of the steps in a playbook. When a playbook is run, the process begins in a channel. Members of a playbook can view the run's progress in the run details page or they can participate in the run channel.
To find all playbook runs, open **Product menu \> Playbooks**, and then select any playbook name. Next, select **Runs** from the navigation bar, then choose a run to view its overview. Select **Go to channel** to open the run’s channel.
When the process is completed, the run is ended. A retrospective can be run and the channel can be archived.
## Keywords
It's important to make it easy to start a run. One way to do this is by setting up keywords. These keywords prompt a user to start the run when they're used. In the incident response playbook, the keywords are specific to critical incidents, for example `sev-1` and `#incident`. It's unlikely that someone would use those terms in general conversation and, even if they do, they can elect not to start the playbook run when prompted.
## Welcome message
Create a welcome message so that when members join your run, it's easy for them to see where they're needed and where to find the relevant information. This is especially important during a time-sensitive incident to eliminate confusion and help members ramp up quickly.
## Tasks and checklists
Tasks and checklists are the foundation of a template and a workflow. In an incident, it's critical to get stakeholders together as soon as possible, so one of the first tasks is to add the on-call engineer to the channel, followed by starting a bridge call. When you're setting up these tasks, you can add slash commands, @mentions, and integrations with tools such as Zoom to make the initiation as seamless as possible.
## Status updates
Regular updates are important communication tools, especially in the middle of an incident like an outage. Channels can get very busy and overwhelming, and if you have more than one incident at a time, it's often too noisy for stakeholders to keep track of everything.
Use the **Broadcast update to other channels** option to cut through the noise and share critical information with both channel members and other users in a dedicated channel.
Additionally, set a timer that issues a reminder for updates to be shared.
## Retrospective
When an incident is over, create a retrospective that captures the impact of the event. You can also add metrics, such as how long it took to resolve the incident, which you can apply to other, similar incidents to see where you can improve and refine your workflows.
<Tip>
Looking to optimize team productivity? Learn how to automate repeatable workflows with [this on-demand webinar](https://mattermost.com/webinar/4-strategies-to-improve-technical-teams-productivity/), then download our [Mattermost Playbooks datasheet](https://mattermost.com/mattermost-playbooks-datasheet/).
</Tip>

View File

@@ -0,0 +1,52 @@
---
title: "Work with metrics and goals"
---
<PlanAvailability slug="entry-ent" />
Workflow dashboards unlock insights about the performance of workflows across organizations. They compare the output metrics from different runs of collaborative playbooks, against targets and historical performance. Each time a collaborative playbook is run, you can update the workflow dashboard for the team and stakeholders to review, where dashboard components are customized per playbook.
Examples of metrics-based workflow dashboards that can be set up to monitor and inform performance include: time to detect, time to resolve in incident response workflows, work plan completion percentage for monthly software releases management workflows, and launch success rate for logistical workflows involving launch operations.
## Configure retrospectives before a run
Access the **Playbooks** tab in Mattermost. Locate the playbook you want to modify, select the **...** icon under **Actions** and then select **Edit**. In the next screen, select **Retrospective**. Move the toggle to **Enable Retrospective**.
You can set a reminder to fill out the retrospective after a run is finished. The configured template is pre-populated in the run's retrospective.
Use the run timeline to help write an accurate retrospective. Events such as owner changes, status updates, and task assignments appear automatically. Selected posts may also be added to the timeline by using the post context menu.
![Create and publish retrospective reports.](/images/Retro.gif)
## Metrics
Use metrics to identify key areas where you want to extract valuable insights by measuring performance and improvement. Metrics are enabled when you enable retrospectives. Calibrate the type of metric you want to measure, and once a run is finished you can view the output in the retrospective. You can have multiple metrics configured per playbook and you can edit them at any time. Metrics can be configured based on numeric, time, or value input.
These metrics can be anything that's of interest to you and your team. For example, for a software release playbook you might want to have a metric tracking how many bugs were detected during a run. The output of the metrics you've added is provided in the retrospective. Over time, you can use metrics across retrospectives to examine anomalies and refine goals.
Another example is a support incident playbook. The time to resolution metric can be applied and used to identify areas that need more refinement, such as tasks that might work better if they're split up so goals are reached faster.
When you delete configured metrics from a playbook, the data isn't deleted, but you no longer see those metrics in the dashboard. In addition, the corresponding metric field is removed from the retrospective form and from published retrospectives.
### Metrics dashboard
For each run, you can enter a value per metric under the retrospective section. This value can be based on whatever you are measuring, such as number of bugs found per run.
You can edit this value as many times as you'd like - for example to ensure you have the correct parameters for your metric - until you've published the retrospective at which point both the metrics and report are no longer editable. The final value only shows up in the playbook dashboard once the retrospective has been published.
The playbook dashboard reports on each metric for all runs by showing:
- Average value for all runs
- The last 10-run average value and difference with prev 10-run average
- The value range for all runs
- The target value
- The actual values chart for last 10-runs
The lower half of the page shows a list of finished runs with metrics values. You can filter or sort a list by metrics values.
![View and assess metrics for your playbook.](/images/playbook-metrics.png)
### Export channel data
<PlanAvailability slug="ent-plus" />
See the [export channel data](/administration-guide/comply/export-mattermost-channel-data) documentation for details on working with channel export functionality.

View File

@@ -0,0 +1,90 @@
---
title: "Work with notifications and updates"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="entry-ent" />
There are multiple ways to receive collaborative playbook updates and notifications.
## Status updates
Status updates ensure that stakeholders remain informed about the playbook run's progress.
You can post a status update from the run channel and you can also configure the playbook to send a reminder to post a status update.
<Tabs>
<TabItem value="web-and-desktop" label="Web and Desktop">
1. To post a status update, access the **Playbooks** tab in Mattermost. Select the run you want to post the update for. In the run details page, select **Post update**.
- If this is the first status update and the playbook has a defined template, that template will be pre-populated here.
- If this is a subsequent status update, the message from the last status update will be pre-populated here.
2. Optionally set a reminder to prompt for the next status update.
- If this is the first status update and the playbook has a defined default reminder timer, that timer will be pre-selected here.
- If this is a subsequent status update, the last reminder timer will be pre-populated here.
3. Select **Post update** to post your status update.
</TabItem>
<TabItem value="mobile" label="Mobile">
From Mattermost v11.1 and mobile v2.34.0, mobile users can post status updates directly from the Mattermost mobile app:
1. Open a playbook run from your mobile app.
2. Select the status update button that appears when viewing the run details.
3. In the status update modal:
- If this is your first status update and the playbook has a status update template, the template content will be pre-populated.
- For subsequent updates, your most recent status update content will be pre-populated.
- The modal header shows how many people and channels will receive your status update.
4. Select your reminder timing from the predefined options available in the mobile app.
5. Select **Post update** to share your status update.
<Note>
- The status update button is only available to participants in the playbook run and is disabled when the run is finished.
- Mobile time selector options are limited to predefined choices, unlike the web interface which allows custom date entry.
</Note>
</TabItem>
</Tabs>
When the playbook has a defined broadcast channel, status updates are copied to the broadcast channel as a message from the Playbooks bot. Status updates broadcast to another channel won’t be updated or removed if the original post is edited or deleted.
The most recent status post alsos displays in the right-hand sidebar of the run channel and in the timeline. To correct or remove a status post, edit or delete the post as needed.
## Request an update
To request a status update, access the **Playbooks** tab in Mattermost. Select the run you want an update for. In the run details page, select the <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> menu next to **Post update** and select **Request update**.
<Note>
Requesting updates is only available in the web browser and desktop app. This functionality is not available on mobile.
</Note>
## Follow runs and playbooks
Follow specific playbooks to receive updates on important events such as when a run is started and finished, as well as status and retrospective updates every time that playbook is run. This is a good option if you're interested in all instances of a specific workflow, such as an outage resolution playbook.
You can also choose to follow a specific run without actively participating. You’ll receive updates for that run only and can take action if needed. This is useful when you’re only interested in a single instance of a procedure—for example, following onboarding for one specific customer rather than every onboarding run.
<Note>
Following playbooks and runs is only available in the web browser and desktop app. This functionality is not available on mobile.
</Note>
## Daily digest
To help you keep track of your runs, tasks, and statuses, a daily digest is sent via direct message in Mattermost.
Running playbooks in multiple channels can be overwhelming. The daily digest is sent once a day, in the morning. It lists the actionable items for each run, as well as any outstanding tasks or status updates required. Select the run name to move to that channel.
The digest is on by default. To turn it off, use the slash command `/playbook settings digest off`.
## Playbook to do
As you complete tasks and finish runs, you can update the details in the digest using the slash command `/playbook todo`. This slash command can be run in any channel, direct message, or group message. Once run, it delivers an updated digest which includes a list of active runs you belong to.

View File

@@ -0,0 +1,139 @@
---
title: "Share and collaborate on playbooks"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="entry-ent" />
There are different ways for teams to access and interact with collaborative playbooks. This is managed in the System Console using permissions. Permissions can be granted in a variety of ways, to allow for different combinations of access and visibility.
Permissions are provided using:
- **System Scheme:** Applies permissions universally across all teams, channels, and playbooks.
- **Team Override Schemes:** Allow admins to customize permissions for each team.
For more information about System and Team Override Schemes, refer to the [Advanced Permissions](/administration-guide/onboard/advanced-permissions) documentation.
<Note>
Some permissions functionality is only available to Mattermost Enterprise customers. For more information, visit [https://mattermost.com/pricing](https://mattermost.com/pricing).
</Note>
In the context of collaborative playbooks, members are assigned a role and based on the selected permissions, this determines how they interact with playbooks. A member can be a member of one playbook, and an admin of another. This allows for granular permissions across teams and departments. For example, setting playbook visibility so only certain teams can view it, or setting permissions to allow an organization to view a playbook but only designated team members can make edits.
Permissions are applied only to playbooks. There are no permissions that are specific to runs.
<Important>
From Playbooks v2.6.0, channel checklists use [channel-based permissions](/administration-guide/manage/team-channel-members) rather than playbook-specific permissions. This means that users with appropriate channel permissions can create, manage, and interact with checklists directly within channels without requiring separate playbook access permissions.
</Important>
## Playbook roles
- **Member**: In the context of collaborative playbooks, members are users of Mattermost who are added to a playbook.
- **Playbook Admin**: Playbook Admins are also members, and may have elevated permissions to change playbook and run visibility as well as functional settings. They do not have access to the System Console and their privileges are managed by the system admin. Members need to be promoted to the role from within playbooks. The Playbook Admin role is applied per playbook.
<Note>
Before you make system or team changes to permissions, ensure that you don't lose access to your existing playbooks. Navigate to the playbook you're a member of. Select the **Manage Access** icon and change your role from **Member** to **Admin**.
</Note>
## Playbooks permissions
Default playbooks settings are completely open which enable all members to participate in runs, edit playbooks, view runs and playbooks, remove other members from runs, edit actions, and make other changes. Permissions provide better control over confidential runs and playbooks, as well as member management. Note that even with the default settings, private playbooks restrict these actions to members of the playbook.
### Create read-only playbooks
In the following example, only playbook admins can edit playbooks. Other users can view public playbooks and private playbooks of which they are a member, but can't edit any playbook or change playbook memberships.
1. Go to **System Console \> User Management \> Permissions**.
2. In the **All Members** section, uncheck **Manage Public Playbooks** and uncheck **Manage Private Playbooks**.
3. Scroll down to the **Playbook Admin** section and confirm that **Manage Public Playbooks** and **Manage Private Playbooks** are checked.
4. Select **Save**.
## Restrict who can create playbooks
You can also set permissions for read-only playbooks that do allow members to create new public or private playbooks.
1. Go to **System Console \> User Management \> Permissions**.
2. In the **All Members** section, uncheck **Manage Public Playbooks** and uncheck **Manage Private Playbooks**.
3. Then, check **Create Public Playbook** and **Create Private Playbook**.
4. Select **Save**.
### I want to restrict who can convert playbooks from public to private
You can control whether Members can convert playbooks from public to private.
1. Go to **System Console \> User Management \> Permissions**.
2. In the **All Members** section, check **Convert Playbooks**.
3. Select **Save**.
Alternatively, to restrict this action so only Playbook Admins can convert playbooks from public to private, uncheck the setting above and:
1. Go to **System Console \> User Management \> Permissions**.
2. Scroll down to **Playbook Admin**.
3. Check **Convert Playbooks**.
4. Select **Save**.
### I want to control who starts a run
By default, all Members can start a run using a playbook. You can restrict this so that only Playbook Admins can start a run. Note that with this configuration, Members are not able to start runs or edit playbooks.
1. Go to **System Console \> User Management \> Permissions**.
2. In the **All Members** section, uncheck **Manage Runs**. This also unchecks **Create Runs**.
3. Scroll down to **Playbook Admin** and ensure that **Manage Runs** is checked.
4. Select **Save**.
If you want to continue to allow Members to edit playbooks, an alternative to this configuration is to make the playbook private.
## Duplicate a playbook
Playbooks are repeatable workflows and sometimes it’s easier to copy and improve rather than start from scratch.
You can do this by duplicating a playbook in the Playbooks screen. Select the **...** under **Actions** and then select **Duplicate**. The copied playbook will have **Copy of** appended to its original name which you can edit.
To import a playbook, go to the Playbooks screen, and select **Import**. Choose the team you’re importing to, then select the JSON file. You can also export any playbook to JSON to easily share with other Mattermost servers.
## Archive a playbook
<Note>
To archive a playbook, you must be a member of the playbook or playbook admin and have applicable **Manage Playbook Configurations** permission granted by a system administrator.
</Note>
To archive a playbook:
1. Go to the **Product** <img src={useBaseUrl('/img/ui/products_E82F.svg')} alt="Navigate between Channels, collaborative playbooks, and boards using the product menu icon." className="theme-icon" /> icon and select **Playbooks**.
2. Select **View all...** under the **Playbooks** section in the left menu.
3. Select the **...** in the **Actions** column for the playbook you would like to archive.
4. Select the **Archive** menu option then the **Archive** button to confirm you would like to archive the playbook.
![Archive a playbook](/images/archive-a-playbook.gif)
## Restore an archived playbook
<Note>
To restore an archived playbook, you must have applicable **Manage Playbook Configurations** permission granted by a system administrator.
</Note>
To restore an archived playbook:
1. Go to the **Product** <img src={useBaseUrl('/img/ui/products_E82F.svg')} alt="Navigate between Channels, collaborative playbooks, and boards using the product menu icon." className="theme-icon" /> icon and select **Playbooks**.
2. Select **View all...** under the **Playbooks** section in the left menu.
3. Verify the **With archived** checkbox next to the playbook search bar is selected.
4. Select the **...** in the **Actions** column for the playbook you would like to restore.
5. Select the **Restore** menu option then the **Restore** button to confirm you would like to restore the playbook.
![Restore an archived playbook](/images/restore-an-archived-playbook.gif)
## Export channel data
<PlanAvailability slug="ent-plus" />
See the [export channel data](/administration-guide/comply/export-mattermost-channel-data) documentation for details on working with channel export functionality.

View File

@@ -0,0 +1,207 @@
---
title: "Work with collaborative playbooks"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="entry-ent" />
A collaborative playbook is a checklist of the tasks that make up your processes. Collaborative playbooks allow you to take codified knowledge and processes and make them accessible and editable by your organization and team. When you're setting up your playbook, you'll be able to break tasks down, and assign actions to them - such as using a slash command to start a Zoom call. You can also decide whether to use the same channel every time your playbook is run, or a new one.
There are other parts of a playbook, such as automation settings, and metrics. Playbook configuration applies both to the execution of the playbook as well as to its management and improvement.
But the very first thing you’ll want to set up is a checklist.
Each time you use the process you’ve documented, such as onboarding a new customer, the playbook is used to start a run - a discrete single use of the process - and that run is captured in a channel (either a dedicated one or a new one every time you run the playbook).
Setting up a playbook includes configuring how the playbook manages the creation of its channel as well as how stakeholders are notified.
To open a playbook and view its statistics, select the playbook name. To begin a run using a specific playbook, select **Run** beside that playbook’s name.
## Templates
Creating a playbook from scratch can be daunting, even if you have the process mapped out. One way to get started quickly is to use one of the pre-configured templates available. These templates are populated with content and settings to provide guidance and are customizable.
Playbook templates are basic workflows that you can use to get started quickly. As you learn more about your workflows, you can customize them into specific playbooks.
### Choose a template
The first step is to choose the right template for your use case. There are pre-configured templates for specific scenarios. The checklists, actions, status updates, and retrospective settings for these templates may already be filled in and, where appropriate, enabled. You can always edit and adjust these settings - they're there to guide you - removing them doesn't negatively affect the playbook run.
<Tip>
Take a look at the **Learn how to use playbooks** template. This template breaks down the components of a playbook and you can also start a test run to see how everything fits together. If you're taking this option, you can stop reading here and enjoy the test run. You can also choose a blank template and start from scratch - this is a good option if your use case is unique.
</Tip>
In the incident response template, the template contains items that are relevant to incident resolution. These are general items to help you get started.
## Edit a playbook
You can change a playbook’s configuration at any time, but changes will only be applied to future incidents. Ongoing or ended incidents previously started from that playbook remain unchanged.
1. Go to **Product menu \> Playbooks**.
2. Find the playbook you want to edit.
- Only public playbooks and private playbooks that you're a member of are listed. System admins have unrestricted access to all playbooks on the team.
3. Select the name of the playbook.
- To edit the playbook directly select the actions menu next to the playbook name, then select **Edit**.
- To access the playbook dashboard, select the hyperlinked playbook name.
4. Select the **Outline** tab.
5. Edit the text portions of the playbook inline. Use the left-hand menu to navigate to other parts of the playbook that you may want to edit.
## Make checklists
Checklists in a playbook or run are restricted to playbook participants and owners.
To create a checklist in a playbook, go to the **Tasks** section. Start from templated tasks or create your own. Select **Add a task** or **Add a section** to build out checklists in the playbook. Drag and drop to reorder tasks and sections as needed. Task descriptions support a limited form of Markdown, including text styling and hyperlinks.
Playbook tasks consist of text rendered in Markdown (when present). You can't run commands directly from a task in a playbook, but you can trigger [built-in slash commands](/integrations-guide/built-in-slash-commands) and [custom slash commands](https://developers.mattermost.com/integrate/slash-commands/custom/), or outgoing webhooks, to run as part of the task action by starting the task with `/`.
### Channel checklists
From Playbooks v2.6.0, you can additionally create and manage channel-based checklists directly within [public](/end-user-guide/collaborate/channel-types#public-channels) and [private](/end-user-guide/collaborate/channel-types#private-channels) channels without requiring a playbook template or a run. Channel checklists use existing Mattermost channel permissions to control access, so any channel member who can manage channel names, headers, and purpose can create, edit, and manage channel checklists.
To create a new channel checklist or modify an existing checklist, select the **Checklists** option in the top left corner of the Mattermost interface.
<Note>
- Channel checklists aren't available in [direct messages](/end-user-guide/collaborate/channel-types#direct-message-channels) or [group messages](/end-user-guide/collaborate/channel-types#group-message-channels).
- To create a channel checklist, you must be a channel [Member](/end-user-guide/collaborate/learn-about-roles#member) (not a [Guest](/end-user-guide/collaborate/learn-about-roles#guest)). To edit a channel checklist, any channel member who can post to the channel can do so, including guests.
- Channel checklists in [archived](/end-user-guide/collaborate/channel-types#archived-channels) channels can't be modified. Archived channels must be [unarchived](/end-user-guide/collaborate/archive-unarchive-channels#unarchive-a-channel) to access and edit their channel checklists.
- A single channel can contain both playbook runs and channel checklists.
- When using Mattermost in a web browser or the Desktop app, you can convert a channel checklist into a playbook by selecting the checklist name and then selecting **Save as a Playbook**.
</Note>
## Multiple runs in a channel
From Mattermost v7.7, you can choose to start each run in a new channel or re-use an already existing channel.
Here are some scenarios why you might want to start each run in the same channel:
- Short, frequently-used processes benefit from being in the same channel - it keeps the process streamlined.
- Teams with multiple independent workflows, such as release teams, benefit from having them in one place.
- Cutting down on the number of new channels created makes it easier to find run channels again.
- The run name isn't linked to the channel's name so you can tell multiple workflows apart.
When you're configuring your playbook:
- You can link it to an existing channel so that each run starts in that channel.
- You can choose that each time the playbook is run, it creates a new channel.
To access this setting, open the **Playbooks** tab. Select the playbook you want to edit, then select the **Outline** tab. Select **Actions** in the left-hand menu and make your selection under the **When a run starts** heading.
When you start a run, your selection is the default but can be changed for each run. Additionally, it's also possible to move a started run to another channel, so you're not locked into whichever option you select.
## Status updates
There may be multiple active runs on any given day.
Configuring an update cadence is an easy way to centralize status updates, decrease noise, and remember where everything is. You can do this when you're setting up your playbook. Navigate to the **Usage** section and set the parameters based on expected update cycles and where the updates should be published.
## Keywords
You can use keywords to trigger a playbook. Keywords are set in the **Channel Actions** menu and are applicable to a specific channel. When you use the Keywords action any channel member who has access to the playbook and who uses one of the listed keywords will be prompted to run the associated playbook.
If you find your keywords result in too many false positives, consider refining your list and also consider that URLs used by run members may also contain monitored keywords.
## Actions
You can customize actions associated with your playbook to ensure a smooth start when starting a run. Select the **Actions** tab to view the automation options available.
Options include:
- Create a channel when a run is started
- Invite members to the run
- Send outgoing webhooks
- Automatically add the run channel to a sidebar category
Actions such as channel creation and adding the channel to a sidebar category are set per-playbook and applied to each run that uses that playbook.
If you’re a system admin or channel admin of the run channel you can also edit these settings in the run channel, via the channel menu, in **Channel Actions**. Editing the settings in the run channel will only affect that channel and the changes aren’t applied to the playbook. Only channel admins can edit the **Channel Actions** items (such as the welcome message) but members who have access to the playbook can edit the welcome message and run behavior settings. Editing these won’t change the welcome message of a run that’s in progress - it only applies going forward. If you want to change the behavior of all future runs associated with the playbook, edit the playbook directly in the **Actions** menu.
## Playbook attributes
<PlanAvailability slug="entry-ent" />
From Mattermost v11.1, using Mattermost in a web browser or the desktop app, you can define custom attributes for your playbooks to create adaptive workflows that respond to changing mission or operational context. From Mattermost mobile v2.37.0, you can view and edit playbook run attributes on mobile devices, including text fields, select, and multi-select types. Attributes such as severity, category, or linked ticket ID can be configured to trigger context-aware tasks and enable intelligent adaptation to situational conditions.
<Note>
This feature requires Mattermost Playbook v2.5.0 or later.
</Note>
Attributes enable you to:
- Define contextual information that varies between runs (e.g., incident severity, priority level, customer type).
- Trigger different tasks or workflows based on attribute values.
- Create conditional logic in your playbooks for more sophisticated automation.
- Maintain consistent data collection across runs.
Playbook attributes are visible to all run participants and can be referenced in status updates.
<Note>
When viewing and editing playbook run attributes on mobile devices, color formatting and URL links in attributes are not supported and display as plain text.
</Note>
### Configure attributes
To configure attributes:
1. Go to the **Product** <img src={useBaseUrl('/img/ui/products_E82F.svg')} alt="Navigate between Channels, collaborative playbooks, and boards using the product menu icon." className="theme-icon" /> icon and select **Playbooks**.
2. Select the playbook you want to define attributes for.
3. Select the **Attributes** tab.
4. Select **Add your first attribute**.
![An example of the Playbooks Attributes tab with no attributes defined.](/images/playbook-attributes-create-first.png)
5. Enter an attribute name and specify its type as **Text**, **URL**, **Select**, or **Multi-Select**.
6. For **Select** and **Multi-Select** types, define the available values.
7. Select **Add attribute** to add additional attributes and values.
![An example of the Playbooks Attributes tab with one attribute and multiple values defined.](/images/playbook-attributes-create-second.png)
<Tip>
- Control how attribute-based conditions appear in a playbook outline by dragging and dropping them into your preferred order.
- Use the **Actions** menu to rename, duplicate, or delete attributes.
![An example of the Playbooks Attributes tab with the Actions menu open.](/images/playbook-attribute-actions.png)
</Tip>
## Conditional playbooks
<PlanAvailability slug="entry-ent" />
From Mattermost v11.1, using Mattermost in a web browser or the desktop app, you can create conditional playbooks with more sophisticated workflows that respond intelligently to changing circumstances. From Mattermost mobile v2.37.0, you can also view and edit playbook run attributes on mobile devices. By leveraging playbook attributes, you can define conditions that determine which tasks and checklists are included in a playbook run based on real-time data.
Conditional playbooks enable you to:
- Add tasks that only apply when specific conditions are met.
- Define tasks and checklists that change based on attribute values.
- Create adaptive workflows that change based on real-time data.
See the [conditional tasks](/end-user-guide/workflow-automation/work-with-tasks#conditional-tasks) documentation for details on configuring conditional tasks within playbooks.
## Run metrics
The **Usage** tab in the workflow dashboard provides run metrics for that playbook. These metrics are available to all viewers. It's not possible to edit or add to these metrics.
## Webhooks
- For information about the webhook payload for `run start`, see the [PlaybookRunWebhookPayload](https://github.com/mattermost/mattermost-plugin-playbooks/blob/b4c8058d8660efe35050bc7eb080e3819c7ab09c/server/app/playbook_run_service.go#L176-L185) struct. An example of the JSON payload for a run start [is available](https://gist.github.com/icelander/b68f2bf2b4ffefec93400cb050211cf1).
- For information about the webhook payload for `status update`, see the [PlaybookRunWebhookPayload](https://github.com/mattermost/mattermost-plugin-playbooks/blob/b4c8058d8660efe35050bc7eb080e3819c7ab09c/server/app/playbook_run_service.go#L176-L185) struct. An example JSON payload for a status update [is available](https://gist.github.com/icelander/2f9938ad68d1e0aa656f97969895d080).
<Tip>
Watch this [on-demand webinar on securing your mission-critical work](https://mattermost.com/webinar/cybersecurity-incident-response/) to learn about the key features and functionality to look for in your incident response tooling.
</Tip>

View File

@@ -0,0 +1,47 @@
---
title: "Work with runs"
---
<PlanAvailability slug="entry-ent" />
A run is the execution of a collaborative playbook. You can start each run in a new channel or you can elect to use the same channel for multiple runs.
To access runs, select the product menu in the top-left corner of Mattermost, then select **Playbooks**. In the runs list, you can select a run to view more details, such as the overview and retrospective. This is an easy way to assess all the active runs to which you have access.
## Follow and participate
You don't have to be in a run's channel to follow the run. You can:
- **Follow**: If you're following a playbook, you won't necessarily be added to each of the playbook's runs but you will be added as a follower. To join a run channel, select **Participate** in the header of that run.
- **Participate**: If you're participating in a run it's likely because you're in a team or group of people who've been added to it. In this case, you'll be able to follow the run in the run channel and also view the details in the list of runs in the **Playbooks** tab.
## View run details
When you’re in a channel with an active run, select the **Toggle Run Details** icon in the channel header to open the right-hand pane to view the run details. Information such as run name and description can be edited in-line, and the checklists can be collapsed and filtered based on their status.
Some run actions can be edited while the run is in progress. This increases visibility into the run's progress and can improve accountability.
## Playbook runs on mobile
From Mattermost server v11.0 and mobile app v2.34.0, mobile users can create and manage playbook runs for operational command at the edge.
## Runs and channel behavior
When you configure your playbook, you can decide whether each run of that playbook starts in a new channel or uses the same channel. You can run multiple playbooks in the same channel, simultaneously. Each playbook in use is listed in the RHS of the run channel.
If you decide to run a playbook in a new channel, you can do this when you start the run. In the channel RHS, select **Start run**. Then select how you'd like it to be executed.
<Tip>
- When deciding whether to reuse a channel for multiple runs, or create new channels for each playbook run, multiple runs in a single channel can help avoid too many channels being created, which can lead to channel overload.
- Playbook run channels aren't automatically archived when runs are marked as complete; however, you can [archive channels](/end-user-guide/collaborate/archive-unarchive-channels#archive-a-channel) you no longer need, and system admins can [allow user access to archived channels](/administration-guide/configure/site-configuration-settings#allow-users-to-view-archived-channels) if needed. See the [multiple runs in a channel](/end-user-guide/workflow-automation/work-with-playbooks#multiple-runs-in-a-channel) documentation for additional considerations.
- In contrast, using a dedicated channel for each playbook run can be helpful particularly in cases where strict [compliance](/administration-guide/comply/compliance-export) and [channel data export](/administration-guide/comply/export-mattermost-channel-data) is required.
</Tip>
## Send outgoing webhooks
1. In your run, select **Toggle Run Details** to open the right-hand sidebar.
2. Select **Run details**.
3. In the **Run details** page, scroll down to **Actions**.
4. Add your webhook URLs in the field provided. You can turn off this option using the toggle.
5. Select **Save**.

View File

@@ -0,0 +1,104 @@
---
title: "Work with tasks"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<PlanAvailability slug="entry-ent" />
## Tasks and due dates
In some workflows, there are time constraints on tasks and others may have more flexible timeframes. Associating tasks with deliverable dates provides visibility into workloads and helps everyone stay accountable during the run.
To assign a due date to a task, select the **Toggle Run Details** icon to open the **Run Details** screen. Hover over the task you’d like to edit and select the calendar icon to assign a due date. Due dates can be used to sort tasks in the run overview.
When a due date is assigned to a task, and the task is overdue or due today, a reminder is added to the playbook's daily digest along with tasks that don't have an assigned due date. As tasks are completed, they're removed from the daily digest reminders. You can refresh the list of assigned tasks at any time using the `/playbook todo` slash command.
Due dates can be entered in text (e.g., "two minutes ago") or numerically (e.g., "15 March 2023").
## Task actions
You can automatically complete tasks in a playbook run using keyword triggers. When the keywords you've entered are mentioned in the run, the task is marked as completed.
For this feature, you should use a string of text rather than individual words. The search is an `ANY` search, meaning that if you used the individual words "target" and "completed", either of those words will trigger the action to be marked as complete. If you're using phrases that have formatting, make sure you use the Markdown formatting in the text field.
When you edit a task, you'll see the following:
- The text to search for in the messages
- Ability to limit this for posts from a specific user (or bot)
- Option to mark the task as done (or not).
![Configure tasks to be automatically marked as complete.](/images/task-actions.png)
## Conditional tasks
<PlanAvailability slug="entry-ent" />
From Mattermost v11.1, using Mattermost in a web browser or the desktop app, tasks can be conditionally included in playbooks based on attribute values or runtime conditions. This enables adaptive workflows where tasks are only presented when they're relevant to the current context. For example:
- **Security incidents**: Include additional forensic tasks for incidents classified as security-related.
- **Customer tier workflows**: Show different approval processes based on customer subscription level.
- **Geographic operations**: Include region-specific compliance tasks based on the location property.
- **Skill-based assignments**: Automatically assign tasks to team members based on areas of expertise.
### Configure conditional logic
To set up conditional behavior in a playbook:
1. Go to **Product** <img src={useBaseUrl('/img/ui/products_E82F.svg')} alt="Navigate between Channels, collaborative playbooks, and boards using the product menu icon." className="theme-icon" /> icon and select **Playbooks**.
2. Select the playbook or run you want to add conditions to.
3. Select the **Outline** tab.
4. Under **Tasks**, identify a task you want to make conditional.
5. From the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon next to the task, select **Add condition**.
![An example of a playbook condition being added.](/images/playbook-conditions-add.png)
6. Select an attribute, condition, and value to define when the task should be included. Then select **Done editing**.
![An example of a playbook condition with values defined.](/images/playbook-conditions-values.png)
Conditional tasks are evaluated and automatically added to or removed from the checklist based on defined conditions. This reduces cognitive load by showing only relevant tasks and ensures that critical steps aren't overlooked in different scenarios.
<Tip>
You can add up to 2 conditions per task to create an either/or condition.
</Tip>
## Task inbox
In addition to the daily digest, you also have access to a task inbox. The task inbox provides you with a cross-run overview of the tasks you're accountable for, sorted by due date.
You can:
- Access each task directly, without having to visit the individual runs.
- Mark tasks as complete or skip them.
- Change the task assignee from yourself to another team member. The task will then be removed from your inbox.
- You can change the due date of tasks to manage priorities and urgency.
To view your task inbox, access the **Playbooks** tab in Mattermost. In the header, next to your profile image, select the tasks list icon. A list of every task assigned to you from every run that's in progress is displayed.
## Mobile playbooks task management
From Mattermost v11.0 and mobile v2.32.0, mobile users can perform the following task management operations on playbook runs:
### Interact with playbook tasks
- **Task interaction**: Tap on any task to open a detailed bottom sheet view with task options and information.
- **Check/Uncheck tasks**: Complete or reopen tasks directly from the Mattermost mobile app.
- **Skip/Unskip tasks**: Mark tasks as skipped or return them to active status as workflow requirements change.
### Update tasks
- **Update assignee**: Change who is responsible for completing a task directly from the mobile app.
- **Modify due dates**: Adjust task deadlines to accommodate changing priorities and schedules.
- **Edit task commands**: Update slash commands or instructions associated with tasks.
- **Change run ownership**: Transfer run ownership between team members.
- **Rename tasks**: Update a task's name to reflect evolving scope or priorities. (From Mattermost mobile v2.38.0)
- **Add or edit task descriptions**: Add context to a task or update an existing description. (From Mattermost mobile v2.38.0)
- **Delete a task**: This action cannot be undone. (From Mattermost mobile v2.37.0)
These mobile capabilities provide full task management functionality for teams working with playbooks while on mobile devices, complementing your existing desktop and web browser experiences.

View File

@@ -0,0 +1,67 @@
---
title: "Workflow Automation"
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<PlanAvailability slug="entry-ent" />
Mattermost Playbooks provides structure, monitoring and automation for repeatable, team-based processes integrated with the Mattermost platform. Playbooks are [configurable checklists](/end-user-guide/workflow-automation/work-with-tasks) for teams to achieve [specific and predictable outcomes](/end-user-guide/workflow-automation/metrics-and-goals), such as incident response, software release management, and logistical operations.
From Mattermost v11.1, Entry, Enterprise, and Enterprise Advanced customers can enable adaptive, conditional workflows responding in real time to changing mission or operational context. Admins can define attributes such as severity, category, or linked ticket ID, and use those attributes to hide or show tasks depending on the values of these attributes which can be seen and modified during a playbook run. Learn more about [playbook attributes](/end-user-guide/workflow-automation/work-with-playbooks#playbook-attributes) and [conditional playbook tasks](/end-user-guide/workflow-automation/work-with-tasks#conditional-tasks).
While Playbooks primarily focus on coordinating people and tasks, they also have integration points. You can trigger a playbook run via an incoming webhook, allowing an external tool to trigger a playbook run. Within a playbook, you can define steps that execute webhooks or call external APIs. Additionally, playbooks can work in conjunction with plugins, keeping the entire workflow visible in Mattermost, and reducing the need to switch between apps during critical processes.
Playbooks monitor channels for keywords or user actions to trigger a structured process, which brings up a set of individual or shared tasks, each associated with manual or automated actions. As playbooks are executed, some may have requirements for [broadcasting status updates to stakeholders](/end-user-guide/workflow-automation/notifications-and-updates) at regular intervals, to populate workflow dashboards by conducting [retrospectives](/end-user-guide/workflow-automation/metrics-and-goals#configure-retrospectives-before-a-run) after the core process is complete, or other customer requirements as exit criteria for a [playbook “run”](/end-user-guide/workflow-automation/work-with-runs).
[Advanced permissions](/end-user-guide/workflow-automation/share-and-collaborate) are also available to delegate and manage playbook controls in larger organizations.
![An example of the collaborative playbooks screen that includes active run details in the right-hand pane.](/images/Playbooks_Hero.png)
## Configuration
Playbooks comes pre-packaged, installed, and enabled with Mattermost server.
## Access
<Tabs>
<TabItem value="web-and-desktop" label="Web and Desktop">
Access playbooks using a web browser or the desktop app by selecting the product menu located in the top-left corner of the Mattermost interface and then selecting **Playbooks**.
</TabItem>
<TabItem value="mobile" label="Mobile">
From Mattermost v11.0 and mobile app v2.34.0, mobile users can:
- **Post status updates directly from mobile**: When you open a playbook run on mobile, a new status update button allows you to post progress updates and share status with your team while on the move or in the field.
- **Create and manage playbook runs** for operational command at the edge.
From Mattermost v11 and mobile app v2.32.0, mobile users can access playbooks from the mobile app to [interact with playbook tasks](/end-user-guide/workflow-automation/work-with-tasks#interact-with-playbook-tasks) and [update tasks](/end-user-guide/workflow-automation/work-with-tasks#update-tasks).
From Mattermost v10.11 and mobile app v2.31.0, mobile users can access playbooks from the mobile app in read-only mode. [Playbooks slash commands](/end-user-guide/workflow-automation/interact-with-playbooks#slash-commands) are supported in the mobile app, but actions like starting runs or updating checklists aren't available through the mobile interface.
</TabItem>
</Tabs>
## Usage
Use collaborative playbooks to orchestrate prescribed workflows and define, streamline, and document complex, recurring operations, and help your organization stay in command with integrated communication, collaboration, and status dashboards managing your workflow life cycles.
### Try it yourself!
Walk through our [Incident Response playbook demonstration](https://mattermost.com/demo/playbooks-incident-response/) to see what you can do with playbooks.
## Learn more
This end user documentation is for anyone who wants guidance on building repeatable processes in Mattermost.
- [Learn about collaborative playbooks](/end-user-guide/workflow-automation/learn-about-playbooks) - Learn what collaborative playbooks are and how they're used.
- [Work with collaborative playbooks](/end-user-guide/workflow-automation/work-with-playbooks) - Customize a playbook for successful runs.
- [Work with runs](/end-user-guide/workflow-automation/work-with-runs) - Edit triggers and actions in an active run.
- [Work with tasks](/end-user-guide/workflow-automation/work-with-tasks) - Work with tasks and the task inbox.
- [Work with notifications and updates](/end-user-guide/workflow-automation/notifications-and-updates) - Keep track of all your active runs and tasks.
- [Work with metrics and goals](/end-user-guide/workflow-automation/metrics-and-goals) - Unlock insights about the performance of collaborative workflows across organizations with workflow dashboards.
- [Share and collaborate on playbooks](/end-user-guide/workflow-automation/share-and-collaborate) - Reuse and share collaborative playbooks with your organization.
- [Interact with playbooks](/end-user-guide/workflow-automation/interact-with-playbooks) - Interact with collaborative playbooks using slash commands and the REST API.