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
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:
@@ -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**.
|
||||
|
||||
> 
|
||||
|
||||
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.
|
||||
|
||||
> 
|
||||
|
||||
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**.
|
||||
|
||||
> 
|
||||
|
||||
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**.
|
||||
|
||||

|
||||
|
||||
<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>
|
||||
@@ -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...**
|
||||
|
||||

|
||||
|
||||
## 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...**
|
||||
|
||||

|
||||
|
||||
## 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>
|
||||
|
||||
@@ -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.
|
||||
|
||||

|
||||
|
||||
## 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 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**.
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
## 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**.
|
||||
|
||||

|
||||
|
||||
## 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**.
|
||||
|
||||

|
||||
|
||||
## 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.
|
||||
|
||||

|
||||
|
||||
<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.
|
||||
|
||||

|
||||
|
||||
<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.
|
||||
266
docs/main/end-user-guide/preferences/customize-your-theme.mdx
Normal file
266
docs/main/end-user-guide/preferences/customize-your-theme.mdx
Normal 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
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||

|
||||
|
||||
[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)
|
||||
|
||||

|
||||
|
||||
[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)
|
||||
|
||||

|
||||
|
||||
[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
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
### 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.
|
||||
204
docs/main/end-user-guide/preferences/manage-advanced-options.mdx
Normal file
204
docs/main/end-user-guide/preferences/manage-advanced-options.mdx
Normal 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>
|
||||
|
||||
@@ -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.
|
||||
|
||||

|
||||
|
||||
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.
|
||||
@@ -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.
|
||||
|
||||

|
||||
|
||||
- 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'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 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.
|
||||
@@ -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>
|
||||
|
||||
@@ -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.
|
||||
|
||||

|
||||
|
||||
<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).
|
||||
|
||||

|
||||
@@ -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 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.
|
||||
@@ -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'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> & <a href="/end-user-guide/preferences/manage-your-desktop-notifications">Desktop</a> & <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> & <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>, & <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.
|
||||
@@ -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>
|
||||
49
docs/main/end-user-guide/preferences/manage-your-profile.mdx
Normal file
49
docs/main/end-user-guide/preferences/manage-your-profile.mdx
Normal 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>
|
||||
@@ -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&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 > 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>
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
|
||||

|
||||
|
||||
- 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. 
|
||||
|
||||
A black dot badge means you have unread activity in channels you're a member of. 
|
||||
|
||||
## 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).
|
||||
35
docs/main/end-user-guide/preferences/preferences-index.mdx
Normal file
35
docs/main/end-user-guide/preferences/preferences-index.mdx
Normal 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.
|
||||
@@ -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.
|
||||
|
||||

|
||||
|
||||
## 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).
|
||||
|
||||

|
||||
@@ -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.
|
||||
|
||||

|
||||
|
||||
</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.
|
||||
|
||||

|
||||
|
||||
</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.
|
||||
Reference in New Issue
Block a user