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,62 @@
|
||||
---
|
||||
title: "Agents context management"
|
||||
---
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Mattermost Agents are designed to handle context efficiently, ensuring that only necessary information is sent to the Large Language Model (LLM) for generating accurate responses. This document outlines how Agents process and include relevant context. The company name, the server name, and the time are always passed to the LLM to ensure accurate and contextually relevant responses.
|
||||
|
||||
<Note>
|
||||
|
||||
**Ensure data privacy**
|
||||
|
||||
We recommend that customers with strict privacy requirements run the LLM locally to prevent sensitive data, including personally identifiable information (PII) and message content, from being shared with an external LLM hosting vendor. This ensures data privacy while enabling Agent functionality.
|
||||
|
||||
</Note>
|
||||
|
||||
## Direct messages to Agent bots
|
||||
|
||||
When you send a direct message to an Agent bot, the context sent to the LLM includes:
|
||||
|
||||
- The profile information of the user sending the prompt.
|
||||
- Chat messages exchanged between the user and the bot.
|
||||
|
||||
**Additional context in direct messages**
|
||||
|
||||
By default, some tool use is enabled to allow for features such as integrations with JIRA, and additional context may be sent to the LLM, depending on the prompt that includes:
|
||||
|
||||
- Jira tickets (public tickets)
|
||||
- Example: Summarize the Jira ticket: \<LINK TO TICKET\>
|
||||
- GitHub issues
|
||||
- Example: Summarize the GitHub issue: \<LINK TO ISSUE\>
|
||||
- User data
|
||||
- Example: What is @Bob's position?
|
||||
|
||||
## @-Mentions in channels
|
||||
|
||||
When you `@mention` Agents in a channel, the context sent to the LLM includes:
|
||||
|
||||
**Standalone messages (@-mentions in a channel)**
|
||||
|
||||
- The message containing the @-mention, including any attachments.
|
||||
- The channel name and display name.
|
||||
- The team name and display name.
|
||||
- The profile information of the user sending the prompt.
|
||||
|
||||
**Threaded messages (@-mentions in a thread)**
|
||||
|
||||
- Everything sent when used in a standalone message.
|
||||
- Messages within the thread, including the usernames of the users involved, as well as any attachments and their filenames.
|
||||
|
||||
**Context differences between standalone and threaded messages:**
|
||||
|
||||
- For @-mentions in standalone messages, the context includes only the mentioned message.
|
||||
- For @-mentions in threads, the entire thread's messages are included, along with usernames of the authors of the messages.
|
||||
|
||||
## Built-in ways to trigger Agents
|
||||
|
||||
In addition to regular chat interactions, Agents provide specialized features where extra context is sent to the LLM. Each feature provides specialized context tailored to the task being performed. Below are the scenarios where extra context is sent to the LLM:
|
||||
|
||||
- **Thread summarization**: Includes thread messages and the usernames of the authors
|
||||
- **Meeting summary**: Incorporates transcriptions from calls
|
||||
- **Channel summary since last visit**: Uses channel posts along with their authors to create summaries.
|
||||
- **Finding action items & open questions**: Analyzes thread and channel messages to identify action items or open questions.
|
||||
@@ -0,0 +1,108 @@
|
||||
---
|
||||
title: "Archive and unarchive channels"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
## Archive a channel
|
||||
|
||||
Delete [public channels](/end-user-guide/collaborate/channel-types#public-channels) and [private channels](/end-user-guide/collaborate/channel-types#private-channels) when they're no longer needed by archiving them. Archiving channels removes them from the channel sidebar and marks them as read-only. Anyone can archive a public or private channel they're a member of, unless your system admin has [disabled](/administration-guide/onboard/advanced-permissions) your ability to do so.
|
||||
|
||||
<Tip>
|
||||
|
||||
You can continue to access archived channels, unless your system admin has [disabled](/administration-guide/configure/site-configuration-settings#allow-users-to-view-archived-channels) your ability to do so.
|
||||
|
||||
</Tip>
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
To archive a channel, select the channel name at the top of the center pane to access the drop-down menu, then select **Archive Channel**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
To archive a channel:
|
||||
|
||||
1. Tap the channel you want to delete.
|
||||
|
||||

|
||||
|
||||
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
|
||||
|
||||

|
||||
|
||||
3. Tap **View info**.
|
||||
|
||||

|
||||
|
||||
4. Tap **Archive Channel**.
|
||||
|
||||

|
||||
|
||||
5. Tap **Yes** to confirm.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
<Note>
|
||||
|
||||
- When a Mattermost user is deactivated in the system, your [direct message channel](/end-user-guide/collaborate/channel-types#direct-message-channels) with that user are archived and marked as read-only. An **Archived** icon <img src={useBaseUrl('/img/ui/archive-outline_F120E.svg')} alt="Archived channels are identified with a File Box icon." className="theme-icon" /> displays next to archived channels. From Mattermost v11.5, archived private channels display a distinct **Archive Lock** icon to differentiate them from other archived channels.
|
||||
- [Group message channels](/end-user-guide/collaborate/channel-types#group-message-channels) can't be archived, but they can be closed to hide them from the channel sidebar.
|
||||
- The default **Town Square** channel can't be archived.
|
||||
- System admins can archive channels without needing to be a channel member by using the System Console.
|
||||
- Because a copy of the channel exists on the server, you can't reuse the URL of an archived channel when [creating a new channel](/end-user-guide/collaborate/create-channels).
|
||||
|
||||
</Note>
|
||||
|
||||
## Unarchive a channel
|
||||
|
||||
System admins and Team admins can restore archived channels. When a channel is unarchived, channel membership and all its content is restored, unless messages and files have been deleted based on a [data retention policy](/administration-guide/configure/compliance-configuration-settings#data-retention-policies).
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Search for the channel if required. Then, open the channel, select the channel name at the top of the center pane to access the drop-down menu and select **Unarchive Channel**.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
To unarchive a channel:
|
||||
|
||||
1. Tap the channel you want to unarchive.
|
||||
|
||||

|
||||
|
||||
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
|
||||
|
||||

|
||||
|
||||
3. Tap **View info**.
|
||||
|
||||

|
||||
|
||||
4. Tap **Unarchive Channel**.
|
||||
|
||||

|
||||
|
||||
5. Tap **Yes** to confirm.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
<Tip>
|
||||
|
||||
Alternatively, system admins can unarchive channels [via the mmctl](/administration-guide/manage/mmctl-command-line-tool#mmctl-channel-unarchive), and Team admins can unarchive channels [via the API](https://api.mattermost.com/#operation/RestoreChannel).
|
||||
|
||||
</Tip>
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: "Audio and screen sharing"
|
||||
---
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Mattermost Calls offers native real-time chat, self-hosted audio calls, and screen sharing within your own network, enabling secure, effective team communication and collaboration. Learn more about [deploying Mattermost Calls](/deployment-guide/calls/calls-deployment-guide) in a self-hosted environment and [making calls](/end-user-guide/collaborate/make-calls) with Mattermost.
|
||||
|
||||
With calls and screen sharing, Mattermost ensures that communications remain uninterrupted, even during maintenance or outages, and scales effortlessly to meet your team’s growing needs, safeguarding the integrity of mission-critical operations.
|
||||
|
||||
Functionality includes:
|
||||
|
||||
- **1:1 Audio Calls**: Initiate direct, real-time voice communication between two participants for quick resolution and sensitive discussions.
|
||||
- **Audio Conference Calls**: Host multi-party voice calls to coordinate teams and resolve issues faster across distributed environments.
|
||||
- **Screen Share**: Share your screen during calls to collaborate visually on tasks, review documents, or troubleshoot live issues.
|
||||
- **Chat/Messaging During Calls**: Exchange messages alongside audio communication to enhance clarity, drop links, and provide visual context.
|
||||
- **Search Chat History Post-Call**: Access in-call messages later to retain decision trails, links, and key points discussed.
|
||||
- **Host Controls**: Manage participants, mute/unmute, and control the flow of conversations during conferences for structured engagements.
|
||||
- **Call Recording**: Record voice sessions for review, compliance, or sharing with unavailable team members. *(Enterprise, Enterprise Advanced)*
|
||||
- **Call Transcription**: Convert spoken content into text to support documentation, compliance, and improved accessibility. *(Enterprise, Enterprise Advanced)*
|
||||
- **Live Captioning**: Provide real-time subtitles for inclusivity, accessibility, and support in noisy or multilingual environments. *(Enterprise, Enterprise Advanced)*
|
||||
- **AI Call Summarization**: Automatically generate concise summaries of calls to save time and preserve key outcomes. *(Enterprise, Enterprise Advanced)*
|
||||
- **Advanced Security Controls**: Enforce stricter encryption, access policies, and controls for high-assurance environments. *(Enterprise, Enterprise Advanced)*
|
||||
- **High Availability**: Maintain service continuity through system failover and backup call paths. *(Enterprise, Enterprise Advanced)*
|
||||
|
||||
## Video conferencing integrations
|
||||
|
||||
For video conferencing, Mattermost integrates seamlessly with leading self-hosted and cloud providers, giving users the flexibility to easily transition from chat to video:
|
||||
|
||||
- [Pexip](https://mattermost.com/marketplace/pexip-video-connect/): An enterprise-grade video conferencing solution with advanced security features, tailored for secure and scalable video collaboration.
|
||||
- [Zoom](/integrations-guide/zoom): A widely used, cloud-based video conferencing platform known for its ease of use and wide range of collaboration tools, including screen sharing and breakout rooms.
|
||||
- [Webex](https://mattermost.com/marketplace/webex-cloud/): A comprehensive video conferencing solution designed for enterprise-grade security, offering features like file sharing, virtual backgrounds, and meeting recordings.
|
||||
- [Microsoft Teams](/integrations-guide/microsoft-teams-sync): A cloud-based collaboration platform that integrates with Microsoft 365, with text, voice, video, and file-sharing features.
|
||||
|
||||
<Note>
|
||||
|
||||
- Webex is community supported and not maintained by Mattermost. Please see the [GitHub repository](https://github.com/mattermost-community/mattermost-plugin-webex#readme) for the latest releases and documentation.
|
||||
- Community supported integrations are not available to Cloud deployments of Mattermost.
|
||||
- Looking for a [Skype for Business replacement](https://mattermost.com/skype-for-business-datasheet/)? Learn why Mattermost is the best solution to upgrade your collaboration strategy.
|
||||
|
||||
</Note>
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
title: "Auto-translate messages"
|
||||
---
|
||||
<PlanAvailability slug="ent-adv" />
|
||||
|
||||
From Mattermost v11.5, messages in channels with auto-translation enabled are automatically translated into your preferred language. This enables seamless multilingual collaboration — you can read and respond in your own language while teammates do the same in theirs.
|
||||
|
||||
## How auto-translation works
|
||||
|
||||
Your system admin must first [enable auto-translation](/administration-guide/manage/admin/autotranslation) for your Mattermost instance. Then, a system admin or channel admin can enable it for individual channels. When autotranslation is enabled in a channel:
|
||||
|
||||
- The language of each message is automatically detected.
|
||||
- Messages are translated into your preferred display language and shown in place of the original text.
|
||||
- Code blocks, URLs, and @mentions are preserved and not translated.
|
||||
- Translations happen asynchronously — there may be a brief delay before the translated text appears.
|
||||
- Messages written in your preferred language are not translated.
|
||||
|
||||
## View translated messages
|
||||
|
||||
Translated messages display in place of the original text. To view the original untranslated message, select the **translation** icon on the message.
|
||||
|
||||
## Set your preferred language
|
||||
|
||||
Auto-translation translates messages into your Mattermost display language. To change your display language:
|
||||
|
||||
1. Select the gear icon to open **Settings**.
|
||||
2. Select **Display \> Language**.
|
||||
3. Choose your preferred language.
|
||||
4. Select **Save**.
|
||||
|
||||
See the [language](/end-user-guide/preferences/manage-your-display-options#language) documentation for more details.
|
||||
|
||||
## Opt out of auto-translation in a channel
|
||||
|
||||
You can opt out of auto-translation on a per-channel basis if you prefer to see original messages in a specific channel. To opt out:
|
||||
|
||||
1. Open the channel where you want to disable auto-translation.
|
||||
2. Select the channel name at the top to open the channel menu.
|
||||
3. Disable the auto-translation option for this channel.
|
||||
|
||||
You'll see original, untranslated messages in that channel going forward. You can re-enable auto-translation at any time using the same steps.
|
||||
|
||||
## Limitations
|
||||
|
||||
- **Direct and group messages**: Your system admin may have restricted auto-translation in direct and group messages. If auto-translation isn't available in a direct or group message, contact your system admin.
|
||||
- **Short or mixed-language messages**: Very short messages or messages that mix multiple languages may not be reliably detected and translated.
|
||||
- **Code-only messages**: Messages that contain only code blocks are not translated, as code is preserved in its original form.
|
||||
- **Translation accuracy**: Translation quality depends on the translation provider configured by your system admin. Some languages or specialized terminology may produce less accurate results.
|
||||
68
docs/main/end-user-guide/collaborate/browse-channels.mdx
Normal file
68
docs/main/end-user-guide/collaborate/browse-channels.mdx
Normal file
@@ -0,0 +1,68 @@
|
||||
---
|
||||
title: "Browse channels"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
1. Select the **Plus** <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> icon at the top of the channel sidebar to see all available public channels you can join that you're not already a member of.
|
||||
2. Select **Browse Channels**.
|
||||
3. Search for channels by name or scroll through the list.
|
||||
4. Select **Join** next to any channel to become a member of that channel.
|
||||
|
||||
<Tip>
|
||||
|
||||
From Mattermost v9.1, you can filter the list of channels by public, private, or archived channels, and you can hide all channels you're already a member of.
|
||||
|
||||
</Tip>
|
||||
|
||||
<Note>
|
||||
|
||||
From Mattermost v11.8.0, if your organization uses membership policies, **Browse Channels** may include a **Recommended** filter. Recommended channels are public channels your attributes match. You can still browse and join public channels according to your organization's normal channel permissions.
|
||||
|
||||
</Note>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
1. Tap the **Plus** <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> icon located in the top right corner of the app.
|
||||
|
||||

|
||||
|
||||
2. Tap **Browse Channels**.
|
||||
|
||||

|
||||
|
||||
3. Search for channels by name or filter the list of channels to show only public, archived or shared channels.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
4. Tap a channel to become a member of that channel.
|
||||
|
||||

|
||||
|
||||
<Tip>
|
||||
|
||||
You can filter the list of channels by public, archived, or shared channels.
|
||||
|
||||
</Tip>
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
Want to see all of the channels you're already a member of, or can't find a specific private channel? Using a browser or the desktop app, select **Find Channel** in the channel sidebar to see all of the channels you're currently a member of across all of your teams, including public and private channels, direct and group messages, channels with unread messages, and threads. Channels you have muted aren't included in results.
|
||||
|
||||
## Revisit recent channels
|
||||
|
||||
Using a browser or the desktop app, use the **History** arrows at the top of the sidebar to move back and forth through your channel history.
|
||||
|
||||
- Select the left arrow to go back one page.
|
||||
- Select the right arrow to go forward one page.
|
||||
109
docs/main/end-user-guide/collaborate/channel-header-purpose.mdx
Normal file
109
docs/main/end-user-guide/collaborate/channel-header-purpose.mdx
Normal file
@@ -0,0 +1,109 @@
|
||||
---
|
||||
title: "Communicate a channel's focus and scope"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Every channel in Mattermost serves a purpose and exists for a reason. You can communicate a channel's focus and scope in 3 ways:
|
||||
|
||||
- a descriptive [channel name](#channel-name)
|
||||
- a [channel purpose](#channel-purpose) description
|
||||
- [channel header](#channel-header) details
|
||||
|
||||
## Channel name
|
||||
|
||||
You're prompted to provide a channel name when [creating a new channel in Mattermost](/end-user-guide/collaborate/create-channels). Channel names must be at least 2 characters, and can be up to 64 characters in length. See the [channel naming conventions](/end-user-guide/collaborate/channel-naming-conventions) documentation for additional details and guidance on why channel naming is important.
|
||||
|
||||
<Note>
|
||||
|
||||
[Some unicode characters](https://www.w3.org/TR/unicode-xml/#Charlist) aren't supported in channel names.
|
||||
|
||||
</Note>
|
||||
|
||||
Looking to rename an existing channel? See the [rename channels](/end-user-guide/collaborate/rename-channels) documentation for details.
|
||||
|
||||
## Channel purpose
|
||||
|
||||
You're prompted to provide an optional channel purpose description when [creating a channel](/end-user-guide/collaborate/create-channels) or [renaming a channel](/end-user-guide/collaborate/rename-channels). A channel purpose can be up to 250 characters in length, and is often used to help users decide whether to join that channel.
|
||||
|
||||
A channel's purpose is visible in the right pane when you select the **View Info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon for the channel. Any member of a channel can change a channel's purpose description, unless the system admin has [disabled the ability to do so](/administration-guide/onboard/advanced-permissions).
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||

|
||||
|
||||
1. Select the channel name at the top of the center pane to access the drop-down menu, then select **Channel Settings**.
|
||||
2. Enter or update the channel purpose.
|
||||
3. Select **Save**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
1. Tap the channel you want to edit.
|
||||
|
||||

|
||||
|
||||
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
|
||||
|
||||

|
||||
|
||||
3. Tap **View info**.
|
||||
|
||||

|
||||
|
||||
4. Tap **Edit Channel**.
|
||||
|
||||

|
||||
|
||||
5. Type the new purpose of the channel and tap on **Save** to update the purpose.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Channel header
|
||||
|
||||
A channel header is text that displays directly under a channel name at the top of the channel. Any channel member can change a channel header, unless the system admin has [disabled the ability to do so](/administration-guide/onboard/advanced-permissions)
|
||||
|
||||
A channel header can be up to 1024 characters in length, include Markdown formatting, and is often used to summarize the channel's focus or to provide links to frequently accessed documents, tools, or websites.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
1. Select the channel name at the top of the center pane to access the drop-down menu, then select **Channel Settings**.
|
||||
2. Enter or change channel header details. You can use the same [Markdown formatting](/end-user-guide/collaborate/format-messages#use-markdown) in the channel header as you would when composing a message.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
1. Tap the channel you want to edit.
|
||||
|
||||

|
||||
|
||||
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
|
||||
|
||||

|
||||
|
||||
3. Tap **View info**.
|
||||
|
||||

|
||||
|
||||
4. Tap **Edit Channel**.
|
||||
|
||||

|
||||
|
||||
5. Type the new header of the channel and tap on **Save** to update the header.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
@@ -0,0 +1,176 @@
|
||||
---
|
||||
title: "Channel naming conventions"
|
||||
---
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
All organizations are different and have different communication needs. The importance of organizing your conversations increases as your user base grows. The following are ideas for how you might want to name, group, and structure your channels. If you change your mind about a channel's name, you can [rename it](/end-user-guide/collaborate/rename-channels).
|
||||
|
||||
## Basic structure
|
||||
|
||||
- Channel names appear in menus where users select which conversations to join.
|
||||
- Channel names are unique.
|
||||
- Channel names have a 64-character limit to ensure readability on both desktop and mobile devices.
|
||||
- An additional 1024 characters are available for describing the channel's focus in the channel header and channel information pane.
|
||||
- An additional 128 characters are available for a **Channel Purpose** that's visible in the channel header and the channel information pane.
|
||||
- Channel names can include standard Unicode emojis that are universally supported emojis that look the same (or similar) across platforms. Specify a Unicode emoji by positioning your cursor in the channel **Display Name** field and accessing the Unicode emoji picker for your operating system, as follows:
|
||||
|
||||
> - On Windows press <kbd>Windows</kbd> + <kbd>.</kbd> or <kbd>;</kbd> to open the Unicode emoji picker.
|
||||
> - On macOS, press <kbd>Ctrl</kbd> + <kbd>⌘</kbd> + <kbd>Space</kbd> to open the Unicode emoji picker.
|
||||
|
||||
We recommend prefixing channel names with emojis for the following reasons:
|
||||
|
||||
> - Emojis can make it easier for users to quickly identify and manage channels, particularly in large workspaces with many channels.
|
||||
> - Sharing the same emoji across channels related to a specific category or function helps maintain organization and consistency across the workspace.
|
||||
> - Making channels more visually distinct with emojis helps users find the channels they need more quickly and easily at a glance, reducing the time spent searching for the right channel.
|
||||
> - New users can quickly understand the purpose of various channels based on their emoji prefixes without needing extensive explanations.
|
||||
> - As users grasp channel structure through emojis, the time and effort needed to train new members on navigating the workspace is reduced.
|
||||
> - A well-organized and visually appealing workspace can encourage users to participate more actively, which can lead to more effective communication and collaboration.
|
||||
|
||||
## Scope channel names
|
||||
|
||||
It's natural to start with broadly defined channels and let them divide into narrower topics as discussions progress.
|
||||
|
||||
For example, you might begin with a general "Marketing" channel. As conversations progress, you might divide that channel into: "Marketing: Website", "Marketing: Social Media", "Marketing: General".
|
||||
|
||||
<Tip>
|
||||
|
||||
Use colons to separate sections of channel names, rather than `-` or `>` which require more spaces to display.
|
||||
|
||||
</Tip>
|
||||
|
||||
As the organization grows, disciplines might split across business units, products and geographies, with channel names like "US: Marketing" and "UK: Marketing".
|
||||
|
||||
<Tip>
|
||||
|
||||
If you need to shorten country names, use standard [2-letter country codes](https://www.nationsonline.org/oneworld/country_code_list.htm).
|
||||
|
||||
</Tip>
|
||||
|
||||
You can combine the hierarchies, with formats like `[SUB-TEAM]: [TOPIC]: [SUB-TOPIC]`. For example: `US: Mrkt: Website` and `UK: Mrkt: Social Media`.
|
||||
|
||||
<Tip>
|
||||
|
||||
Shorten words, particularly categories, by removing vowels, endings, and redundant letter sounds. Example: Turn "Marketing" into "Mrkt", and "Project" into "Prjt".
|
||||
|
||||
</Tip>
|
||||
|
||||
Good naming can take a team up to several thousand channels without significant confusion. Eventually every organization hits a limit and an additional team might need to be created on the server to accommodate the large number of channels. Keeping names clear and short lets users navigate large collections of channels quickly.
|
||||
|
||||
Here are different navigation options and types of channels to consider.
|
||||
|
||||
### Navigate channels using the keyboard
|
||||
|
||||
Keyboard shortcuts allow users to jump between channels. See the [keyboard shortcuts](/end-user-guide/collaborate/keyboard-shortcuts) documentation for all available keyboard shortcuts.
|
||||
|
||||
### Topic channels
|
||||
|
||||
Topics are broad categories for organizing discussions. Topics are similar to how a user might create a folder for organizing emails or documents. Examples: Recruiting, Interviews, Legal Reviews, Documentation.
|
||||
|
||||
Users can join and leave topic-based channels, as well as add colleagues to have topic-based discussions.
|
||||
|
||||
As teams get larger and the number of channels increase, you may start naming topics in a hierarchy to make them easier to find. Examples: Legal: Trademarks, Legal: Contracts, Legal: Licensing.
|
||||
|
||||
### Meeting channels
|
||||
|
||||
Meeting channels are often used to organize regular meetings. Members can add topics as messages to be discussed during the regular meeting time. Examples: Monday Sales Update, All Hands Meeting.
|
||||
|
||||
There are three built-in features to make meetings easier:
|
||||
|
||||
1. Numbered agenda items in title text
|
||||
|
||||
You can number and format messages as agenda items to discuss for the next meeting.
|
||||
|
||||
<Tip>
|
||||
|
||||
Try pasting the following as an example in a channel designated for meetings:
|
||||
|
||||
#### 1) Agenda item example
|
||||
#### Commentary about agenda item to be discussed.
|
||||
|
||||
</Tip>
|
||||
|
||||
2. Threaded messaging
|
||||
|
||||
On an agenda item message, you can select `[...] > Reply` to leave comments about an agenda item before or after a meeting to extended discussion.
|
||||
|
||||
3. Header links
|
||||
|
||||
When meeting remotely, add persistent links to your video or audio conferencing solution, like Zoom, Google Hangouts, or BlueJeans in the channel header. See our [documentation](/end-user-guide/collaborate/channel-header-purpose) to learn more about working with channel headers.
|
||||
|
||||
When it's time to meet, your team can select the conference link to connect.
|
||||
|
||||
### Sub-team channels
|
||||
|
||||
Sub-teams can include people from the same discipline, project teams, people with the same manager or other groups brought together for a shared purpose. Examples: Developers, Marketers, Offsite Organizing Committee, SusanK's Directs
|
||||
|
||||
As sub-teams grow beyond a manageable size for one channel, they can sub-divide. Examples: US: Developers, UK: Developers, SusanK's Directs, SusanK's Extended Directs.
|
||||
|
||||
### Project channels
|
||||
|
||||
Project channels discuss how groups of people come together to achieve specific outcomes. Examples: Logo Design, Localization, Product Launch.
|
||||
|
||||
Projects are often private channels rather than public channels and are used to organize a small team around a project brought up in a larger channel. The Project Channel is used to do detailed work, and updates are typically communicated back to larger channels.
|
||||
|
||||
### Location channels
|
||||
|
||||
If your teams are in different buildings, cities or regions, you can create Location channels to help people coordinate meetings and get-togethers. Examples: Building 10, Palo Alto, Toronto, Delaware.
|
||||
|
||||
This helps share announcements and discussions relevant to only those locations.
|
||||
|
||||
### Data channels
|
||||
|
||||
Data channels allow automatic integration. Information like new or updated support tickets or bug reports, Twitter updates or mentions of your company name in the news can all be made available in channels your team chooses to monitor. There is a wide array of options. Examples: Bugs, Support Tickets, Twitter, News Mentions.
|
||||
|
||||
People might use these channels like a daily newspaper, reading about everything that's happened in the last day, while other configurations allow notifications to alert only when their username or certain key words are mentioned.
|
||||
|
||||
## Channel naming examples
|
||||
|
||||
Here is an example of what a marketer's channels might look like in a small team:
|
||||
|
||||
CHANNELS
|
||||
|
||||
- Recruiting
|
||||
- Interviews
|
||||
- Marketing
|
||||
- Sales
|
||||
- All Hands Meeting
|
||||
- Town Square
|
||||
- Off-Topic
|
||||
|
||||
PRIVATE CHANNELS
|
||||
|
||||
- Website
|
||||
- Twitter Marketing
|
||||
- Logo Design
|
||||
|
||||
DIRECT MESSAGES
|
||||
|
||||
- \[Sales People\]
|
||||
- \[Marketers\]
|
||||
- \[Recruiter\]
|
||||
- \[Manager\]
|
||||
|
||||
Here's an example of what a marketer's channels might look like if she was working in the Palo Alto, California office of a large enterprise, working on a product called "Pontoon":
|
||||
|
||||
CHANNELS
|
||||
|
||||
- Geo: PA: Recruiting
|
||||
- Geo: PA: Interviews
|
||||
- US: Mrkt: General
|
||||
- US: Sales: West Coast
|
||||
- US: All Hands
|
||||
- Town Square
|
||||
- Off-Topic
|
||||
|
||||
PRIVATE CHANNELS
|
||||
|
||||
- Pontoon: Mkrt: Website
|
||||
- Pontoon: Mkrt: Twitter
|
||||
- Pontoon: Mkrt: Logo Design
|
||||
|
||||
DIRECT MESSAGES
|
||||
|
||||
- \[West Coast Sales People\]
|
||||
- \[Marketing Peers\]
|
||||
- \[Recruiter for PA office\]
|
||||
- \[Manager\]
|
||||
74
docs/main/end-user-guide/collaborate/channel-types.mdx
Normal file
74
docs/main/end-user-guide/collaborate/channel-types.mdx
Normal file
@@ -0,0 +1,74 @@
|
||||
---
|
||||
title: "Channel types"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Channels are used to organize conversations across different topics. The channels you're a member of display in the left pane. Learn how to create channels by visiting the [create channels](/end-user-guide/collaborate/create-channels) documentation.
|
||||
|
||||
There are 5 types of channels in Mattermost:
|
||||
|
||||
- [Public channels](#public-channels)
|
||||
- [Private channels](#private-channels)
|
||||
- [Direct message channels](#direct-message-channels)
|
||||
- [Group message channels](#group-message-channels)
|
||||
- [Archived channels](#archived-channels)
|
||||
|
||||
<Tip>
|
||||
|
||||
Enterprise customers can additionally configure [read-only](/administration-guide/onboard/advanced-permissions#read-only-channels) broadcast channels.
|
||||
|
||||
</Tip>
|
||||
|
||||
## Public channels
|
||||
|
||||
Public channels are open to everyone on a team and are identified with a **Globe** <img src={useBaseUrl('/img/ui/globe_E805.svg')} alt="Public channels are identified with a Globe icon." className="theme-icon" /> icon. New team members are automatically added to the **Town Square** channel.
|
||||
|
||||
See the [Join and leave channels](/end-user-guide/collaborate/join-leave-channels) documentation for details on discovering, joining, and leaving other channels.
|
||||
|
||||
## Private channels
|
||||
|
||||
Private channels are channels for sensitive topics and are only visible to selected team members. Private channels are identified with a **Lock** <img src={useBaseUrl('/img/ui/lock-outline_F0341.svg')} alt="Private channels are identified with a Lock icon." className="theme-icon" /> icon. Channel members can choose to leave private channels at any time.
|
||||
|
||||
<Note>
|
||||
|
||||
- Mattermost Enterprise and Professional customers can restrict channel management to system and channel admins.
|
||||
- In a Mattermost Team Edition instance, any member of a private channel can add or remove other members from private channels.
|
||||
|
||||
</Note>
|
||||
|
||||
## Direct message channels
|
||||
|
||||
Direct message channels are for conversations between 2 people. Only members of the conversation can see direct messages and channel heading information, including the last active status of the other user.
|
||||
|
||||
You can start a direct message with people on other teams [unless the system admin has disabled your ability to do so](/administration-guide/configure/site-configuration-settings#enable-users-to-open-direct-message-channels-with).
|
||||
|
||||
Direct messages update the numbered badge count and trigger a notification unless the direct message is muted, or your notifications are disabled. See the [notification documentation](/end-user-guide/preferences/manage-your-notifications) for details on customizing notifications based on your preferences.
|
||||
|
||||
<Note>
|
||||
|
||||
- From Mattermost v10, when sending a direct message, Mattermost warns you that the recipient's availability is set to [Do Not Disturb](/end-user-guide/preferences/set-your-status-availability#set-your-availability), and when the recipient's local time is outside of regular business hours (between 10PM and 6AM). This warning displays directly above the message text field.
|
||||
- When a Mattermost user is deactivated in the system, your [direct message channel](/end-user-guide/collaborate/channel-types#direct-message-channels) with that user are [archived](#archived-channels) and marked as read-only. An **Archived** icon <img src={useBaseUrl('/img/ui/archive-outline_F120E.svg')} alt="Archived channels are identified with a File Box icon." className="theme-icon" /> displays next to archived channels.
|
||||
|
||||
</Note>
|
||||
|
||||
## Group message channels
|
||||
|
||||
Group message channels are for conversations between 3 to 7 people. Only members of the conversation can see group messages. Group messages always display a new message badge.
|
||||
|
||||
Want to have a group conversation with more than 7 people? [Create a private channel](/end-user-guide/collaborate/create-channels). Alternatively, from Mattermost v9.1, you can [convert group messages to a private channel](/end-user-guide/collaborate/convert-group-messages).
|
||||
|
||||
<Note>
|
||||
|
||||
- You can start a group message with people on other teams when [unless the system admin has disabled your ability to do so](/administration-guide/configure/site-configuration-settings#enable-users-to-open-direct-message-channels-with).
|
||||
- From Mattermost v9.1, group messages increase the numbered badge count and trigger a notification unless the direct message is muted, or your notifications are disabled. Control how you're notified about group message conversations by going to **Settings \> Notifications**. See the [notification documentation](/end-user-guide/preferences/manage-your-notifications) to learn more.
|
||||
- Any group message history you have with a deactivated user remains available [unless your system admin disables your ability to do so](/administration-guide/configure/site-configuration-settings#allow-users-to-view-archived-channels).
|
||||
|
||||
</Note>
|
||||
|
||||
## Archived channels
|
||||
|
||||
Archived channels are deactivated public, private, direct message, or group message channels that are no longer used. Archived channels are identified with a **File Box** <img src={useBaseUrl('/img/ui/archive-outline_F120E.svg')} alt="Archived channels are identified with a File Box icon." className="theme-icon" /> icon. From Mattermost v11.5, archived private channels are identified with a distinct **Archive Lock** icon to visually differentiate them from archived public channels.
|
||||
|
||||
[Archiving a channel](/end-user-guide/collaborate/archive-unarchive-channels#archive-a-channel) marks it read-only to prevent new messages from being sent and preserve channel history. You can continue to access archived channels, unless your system admin has [disabled](/administration-guide/configure/site-configuration-settings#allow-users-to-view-archived-channels) your ability to do so.
|
||||
19
docs/main/end-user-guide/collaborate/collaborate-index.mdx
Normal file
19
docs/main/end-user-guide/collaborate/collaborate-index.mdx
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: "Messaging Collaboration"
|
||||
sidebar_label: "Collaborate"
|
||||
---
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Mattermost provides 1:1 and group messaging that features integrated voice/video conferencing, file, image, and link sharing, rich markdown formatting, and a fully searchable message history. With Mattermost, you can keep all of your team's communications in one place and remove information and organizational silos.
|
||||
|
||||
This Mattermost end user documentation is designed for anyone who wants guidance on using Mattermost to collaborate.
|
||||
|
||||
## Getting Started
|
||||
|
||||
- [Invite people to your workspace](/end-user-guide/collaborate/invite-people) - Learn how to add new users to Mattermost and add users to existing teams and channels.
|
||||
- [Channels](/end-user-guide/collaborate/collaborate-within-channels) - Learn how channels work, and how to create, join, organize, and manage them.
|
||||
- [Messages and threads](/end-user-guide/collaborate/communicate-with-messages) - Learn how to send, format, and find messages, and how to keep conversations organized in threads.
|
||||
- [Calls and screen sharing](/end-user-guide/collaborate/audio-and-screensharing) - Learn about Mattermost's self-hosted audio calls with screen sharing, and the video conferencing integrations Mattermost supports.
|
||||
- [Teams, groups, and roles](/end-user-guide/collaborate/organize-using-teams) - Learn about team-based organization, custom user groups, and what each Mattermost user role can do.
|
||||
- [Integrations and connected apps](/end-user-guide/collaborate/extend-mattermost-with-integrations) - Find open-source integrations to common tools in the Mattermost Marketplace, and learn how to collaborate from within Microsoft Teams.
|
||||
- [Keyboard shortcuts and accessibility](/end-user-guide/collaborate/keyboard-shortcuts) - Make more efficient use of your keyboard, and learn how to navigate Mattermost without a mouse.
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: "Collaborate within channels"
|
||||
---
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Channels are where you connect, collaborate, and communicate with your team about various topics or projects. Use channels to organize conversations across different topics. as you're [sending messages](/end-user-guide/collaborate/send-messages), [replying to messages](/end-user-guide/collaborate/reply-to-messages), and [participating in conversation threads](/end-user-guide/collaborate/organize-conversations#start-or-reply-to-threads).
|
||||
|
||||
## You're added to default channels automatically
|
||||
|
||||
Everyone who joins a Mattermost [workspace](/end-user-guide/end-user-guide-index) is automatically added to the **Town Square** channel. See our [Channel Types](/end-user-guide/collaborate/channel-types) documentation for details.
|
||||
|
||||
<Note>
|
||||
|
||||
The Town Square channel can't be [archived](/end-user-guide/collaborate/archive-unarchive-channels#archive-a-channel) or [converted to a private channel](/end-user-guide/collaborate/convert-public-channels), and users can't [leave](/end-user-guide/collaborate/join-leave-channels#leave-a-channel) this default channel. However, [guests](/administration-guide/onboard/guest-accounts) who are manually invited to **Town Square** can leave the channel.
|
||||
|
||||
</Note>
|
||||
|
||||
## Channel sidebar
|
||||
|
||||
In the channel sidebar on the left, you'll find all of the the channels you're a member of as well as useful channel management tools. See the [channel types](/end-user-guide/collaborate/channel-types) to learn about the types of channels available, how they work, and how to identify them in the channel sidebar. Learn how to create channels by visiting the [create channels](/end-user-guide/collaborate/create-channels) documentation.
|
||||
|
||||
As your channel sidebar fills up with channels you've joined, you can organize your channels into categories based on how you work. See the [customize your channel sidebar](/end-user-guide/preferences/customize-your-channel-sidebar) documentation for details.
|
||||
|
||||
## Learn more
|
||||
|
||||
Learn more about collaborating within Mattermost channels:
|
||||
|
||||
- [Channel naming conventions](/end-user-guide/collaborate/channel-naming-conventions) - Learn why channel names are important.
|
||||
- [Communicate a channel's focus and scope](/end-user-guide/collaborate/channel-header-purpose) - Learn how to communicate a channel's scope and focus.
|
||||
- [Browse channels](/end-user-guide/collaborate/browse-channels) - Browse all available public channels you can join, and all channels you're a member of.
|
||||
- [Join and leave channels](/end-user-guide/collaborate/join-leave-channels) - Learn how to start or stop being a channel member.
|
||||
- [Make calls in Mattermost](/end-user-guide/collaborate/make-calls) - Learn how to start, join, and attend calls in Mattermost, as well as screen share.
|
||||
- [Navigate between channels](/end-user-guide/collaborate/navigate-between-channels) - Learn how to navigate between channels.
|
||||
- [Create channels](/end-user-guide/collaborate/create-channels) - Create channels to organize discussion by topic, project, or focus.
|
||||
- [Rename a channel](/end-user-guide/collaborate/rename-channels) - Rename channels to make them more discoverable.
|
||||
- [Display channel banners](/end-user-guide/collaborate/display-channel-banners) - Display a fixed banner at the top of channels to warn users about the presence of classified or sensitive information.
|
||||
- [Auto-translate messages](/end-user-guide/collaborate/autotranslate-messages) - Automatically translate channel messages into your preferred language.
|
||||
- [Convert public channels to private channels](/end-user-guide/collaborate/convert-public-channels) - Learn how to convert channel access and visibility.
|
||||
- [Convert group messages to private channels](/end-user-guide/collaborate/convert-group-messages) - Learn how to convert group messages to private channels.
|
||||
- [Manage channel members](/end-user-guide/collaborate/manage-channel-members) - Add and remove users from channels.
|
||||
- [Mark channels as favorites](/end-user-guide/collaborate/favorite-channels) - Mark commonly visited channels as favorites.
|
||||
- [Manage channel bookmarks](/end-user-guide/collaborate/manage-channel-bookmarks) - Manage quick access links or files pinned to the top of channels.
|
||||
- [Mark channels as unread](/end-user-guide/collaborate/mark-channels-unread) - Mark channels unread to return to messages later.
|
||||
- [Archive and unarchive channels](/end-user-guide/collaborate/archive-unarchive-channels) - Keep the number of available channels manageable.
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
title: "Collaborate within Microsoft Teams"
|
||||
---
|
||||
<PlanAvailability slug="entry-ent" />
|
||||
|
||||
The Mattermost for Microsoft Teams integration enables you to break through siloes in a mixed Mattermost and Teams environment by forwarding real-time chat notifications from Teams to Mattermost.
|
||||
|
||||

|
||||
|
||||
<PlanAvailability slug="academy-msteams" />
|
||||
|
||||
## Connect your Mattermost account to your Microsoft Teams account
|
||||
|
||||
<Note>
|
||||
|
||||
Your System Administrator must install and enable the [Mattermost for Microsoft Teams integration](/integrations-guide/microsoft-teams-sync) and ensure [support for notifications is enabled](/administration-guide/configure/plugins-configuration-settings#sync-notifications) in order for you to connect your account and recieve chat notifications.
|
||||
|
||||
</Note>
|
||||
|
||||
Once the integration is installed and configured by a System Administrator, you can connect your Mattermost user account to your Microsoft Teams account. You only need to complete this step once.
|
||||
|
||||
1. Log into Mattermost using your credentials.
|
||||
2. In any channel, run the `/msteams connect` slash command, and select the resulting link.
|
||||
3. Authenticate with Microsoft Teams using the email address matching your account in Mattermost.
|
||||
|
||||
Mattermost will confirm when your account is connected.
|
||||
|
||||
Once you've connected your Mattermost account to your Microsoft Teams account, when you're offline or away from Microsoft Teams, any messages you receive in a chat or group chat in Microsoft Teams will display in Mattermost as a notification and include a link to open the chat in Microsoft Teams to continue the conversation. These notifications won't appear if you've been recently active in Teams.
|
||||
|
||||

|
||||
|
||||
### Manage notification settings
|
||||
|
||||
Manage your Mattermost notification settings for the Microsoft Teams integration at any time in **Settings** \> **Plugin Preferences**
|
||||
|
||||

|
||||
|
||||
<Tip>
|
||||
|
||||
You can run the following [slash commands](/integrations-guide/run-slash-commands) to manage your integration settings by typing the commands into the Mattermost message text box, and selecting **Send**:
|
||||
|
||||
- `/msteams connect`: Connect your Mattermost account to Microsoft Teams account.
|
||||
- `/msteams disconnect`: Disconnect your Mattermost account from Microsoft Teams account.
|
||||
- `/msteams status`: Show your current connection status.
|
||||
- `/msteams notifications on|off`: Change your current notifications settings.
|
||||
|
||||
</Tip>
|
||||
|
||||
## Frequently asked questions
|
||||
|
||||
### How does the integration determine when to send chat notifications?
|
||||
|
||||
Chat notifications are sent in real-time whenever you're not active in Microsoft Teams and receive a chat or group chat. Mattermost uses your online status in Teams to determine if a chat notification should be delivered. Mattermost delivers notifications if you appear **Away** or **Offline** in Microsoft Teams, so the default behavior for when notifications will be delivered depends on the client you typically use to access Microsoft Teams:
|
||||
|
||||
- Web browser: Mattermost delivers notifications when you've not had activity in your Microsoft Teams browser tab for 5 minutes or more, when the browser tab is closed, or when you mark yourself as **Offline** in Microsoft Teams.
|
||||
- Desktop app: Mattermost delivers notifications when you've not had activity at your computer for 5 minutes or more, when the Microsoft Teams desktop app is closed, or when you mark yourself as **Offline** in Microsoft Teams.
|
||||
|
||||
In order to avoid double notifications, Mattermost won't deliver chat notifications when your availability is set to **Available**, **Busy**, **Do not disturb**, or **Be right back** in Microsoft Teams.
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: "Communicate with messages and threads"
|
||||
---
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
[Sending messages](/end-user-guide/collaborate/send-messages), [replying to messages](/end-user-guide/collaborate/reply-to-messages), and [participating in discussion threads](/end-user-guide/collaborate/organize-conversations#start-or-reply-to-threads) are important ways to keep conversations active with your team.
|
||||
|
||||
## Work with messages and threads
|
||||
|
||||
Learn more about messages and threads:
|
||||
|
||||
- [Send messages](/end-user-guide/collaborate/send-messages) - Send messages to other Mattermost users.
|
||||
- [Reply to messages](/end-user-guide/collaborate/reply-to-messages) - Communicate with your team in Mattermost.
|
||||
- [React with emojis and GIFs](/end-user-guide/collaborate/react-with-emojis-gifs) - Use emojis and GIFs to react to messages and to express concepts, humor, emotions, and physical gestures in your own messages.
|
||||
- [Organize conversations with threaded discussions](/end-user-guide/collaborate/organize-conversations) - An enhanced communication thread experience is available in Mattermost.
|
||||
- [Mark messages as unread](/end-user-guide/collaborate/mark-messages-unread) - Change messages to an unread state for easy follow-up.
|
||||
- [Forward messages](/end-user-guide/collaborate/forward-messages) - Quickly and easily forward messages with previews.
|
||||
- [Share links to messages](/end-user-guide/collaborate/share-links) - Share links to messages across channels.
|
||||
- [Save and pin messages](/end-user-guide/collaborate/save-pin-messages) - Mark useful messages for easy retrieval in the future.
|
||||
- [Set message reminders](/end-user-guide/collaborate/message-reminders) - Set reminders to follow up on messages.
|
||||
- [Search for messages](/end-user-guide/collaborate/search-for-messages) - Use search to find messages, replies, and file contents across Mattermost channels.
|
||||
- [Schedule messages](/end-user-guide/collaborate/schedule-messages) - Schedule messages to be sent in the future.
|
||||
- [Flag messages](/end-user-guide/collaborate/flag-messages) - Flag messages that may contain sensitive or restricted information for review by authorized moderators.
|
||||
|
||||
## Make your messages stand out
|
||||
|
||||
Learn more about making your messages stand out:
|
||||
|
||||
- [Format messages](/end-user-guide/collaborate/format-messages) - Use markdown to format message content.
|
||||
- [Set message priority](/end-user-guide/collaborate/message-priority) - Ensure important and urgent messages stand out clearly by adding priority labels, and requesting message acknowledgements.
|
||||
- [Mention people](/end-user-guide/collaborate/mention-people) - Get the attention of specific people.
|
||||
- [Share files in messages](/end-user-guide/collaborate/share-files-in-messages) - Share videos, voice recordings, and images in your Mattermost messages.
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: "Convert group messages to private channels"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
From Mattermost v9.1, you can change the members of your group conversation by converting the group message to a private channel. When a group message is converted to private, its history and membership are preserved. Membership in a private channel remains as invitation only.
|
||||
|
||||
<Note>
|
||||
|
||||
- Any member of an existing group message, except [guests](/administration-guide/onboard/guest-accounts), can convert that group message to a private channel.
|
||||
- Conversation history will be visible to all channel members.
|
||||
- All group message participants must share at least one team membership.
|
||||
|
||||
</Note>
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
1. Select the group message name at the top of the center pane to access the drop-down menu, then select **Convert to Private Channel**.
|
||||
2. Specify the team where the new private channel will be created. You're prompted to specify a team when all group message members share more than one team membership.
|
||||
3. Enter a channel name.
|
||||
4. Select **Convert to private channel**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
1. Tap the group message you want to convert to a private channel.
|
||||
|
||||

|
||||
|
||||
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
|
||||
|
||||

|
||||
|
||||
3. Tap **View info**.
|
||||
|
||||

|
||||
|
||||
4. Tap **Convert to a Private Channel**.
|
||||
|
||||

|
||||
|
||||
5. Enter the private channel name.
|
||||
|
||||

|
||||
|
||||
6. Tap **Convert to Private Channel** to confirm.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
---
|
||||
title: "Convert public channels to private channels"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
You must be a system admin or team admin to convert public channels to private channels. When a channel is converted from public to private, its history and membership are preserved. Membership in a private channel remains as invitation only. Publicly-shared files remain accessible to anyone with the link.
|
||||
|
||||
<Note>
|
||||
|
||||
The default channel `Town Square` can't be converted to a private channel.
|
||||
|
||||
</Note>
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
To convert a public channel to a private channel, select the public channel name at the top of the center pane to access the drop-down menu, then select **Convert to Private Channel**.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
To convert a public channel to a private channel:
|
||||
|
||||
1. Tap the channel you want to convert.
|
||||
|
||||

|
||||
|
||||
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
|
||||
|
||||

|
||||
|
||||
3. Tap **View info**.
|
||||
|
||||

|
||||
|
||||
4. Tap **Convert to private channel**.
|
||||
|
||||

|
||||
|
||||
5. Tap **Yes** to confirm.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Convert private channels to public channels
|
||||
|
||||
Due to potential security concerns with sharing private channel history, only system admins can convert private channels to public channels using the System Console.
|
||||
|
||||
<Note>
|
||||
|
||||
- The ability to convert private channels to public channels using the [API](https://api.mattermost.com/#tag/channels/operation/UpdateChannelPrivacy) or [mmctl channel modify command](/administration-guide/manage/mmctl-command-line-tool#mmctl-channel-modify) is limited to system admins, team admins, and users with specific granular admin roles. Team admins have this permission by default, but system admins can restrict it or assign it to other roles.
|
||||
- Granular roles require permissions for managing User Management Channels and Groups, including `sysconsole_write_user_management_channels` and `sysconsole_write_user_management_groups`. Manage permissions through the [permission scheme](/administration-guide/onboard/advanced-permissions#permissions-structure).
|
||||
- If [Sync Group channel management](/administration-guide/manage/team-channel-members#channel-management) is enabled, private channels can't be converted to public channels.
|
||||
|
||||
</Note>
|
||||
|
||||
1. Go to **System Console \> Channels**.
|
||||
2. Select **Edit** for an existing private channel. You can also filter the list of channels to private channels only.
|
||||
3. Under **Channel Management \> Public channel or private channel**, select **Private**.
|
||||
4. Select **Save**.
|
||||
76
docs/main/end-user-guide/collaborate/create-channels.mdx
Normal file
76
docs/main/end-user-guide/collaborate/create-channels.mdx
Normal file
@@ -0,0 +1,76 @@
|
||||
---
|
||||
title: "Create channels"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Anyone can create public channels, private channels, direct messages, and group messages unless the system admin has [restricted permissions to do so using advanced permissions](/administration-guide/onboard/advanced-permissions). Enterprise system administrators can also configure channels as [read-only](/administration-guide/onboard/advanced-permissions#read-only-channels).
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
## Create a public or private channel
|
||||
|
||||
1. Select the **Add channels** button in the channel sidebar, then select **Create New Channel**. Alternatively, you can select <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> at the top of the channel sidebar, then select **Create New Channel**.
|
||||
|
||||
> <img src={useBaseUrl('/images/add-channels-button.png')} width="400" alt="You can create a channel using the Add channels button" />
|
||||
|
||||
2. Enter a channel name.
|
||||
3. Choose whether this is a public or private channel. See the [channel types](/end-user-guide/collaborate/channel-types) documentation to learn more about public and private channels.
|
||||
4. (Optional) Describe the channel's focus or purpose. This text is visible to all channel members in the channel header.
|
||||
5. (Optional) Assign the channel to a category. When [channel category sorting](/administration-guide/configure/experimental-configuration-settings#enable-channel-category-sorting) is enabled (the default from Mattermost v11.8), channel admins see a **Default category (optional)** field when creating or editing a channel. You can select an existing category, type a new category name, or clear the default category from channel settings. Members who join the channel see it under that category in their sidebar. If this option isn't available, you can [customize your channel sidebar](/end-user-guide/preferences/customize-your-channel-sidebar).
|
||||
|
||||
## Start a direct or group message
|
||||
|
||||
1. Select the <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> next to the **Direct Messages** category in the channel sidebar.
|
||||
|
||||
> 
|
||||
|
||||
2. Select up to seven users by searching or browsing. If your organization uses [connected workspaces](/administration-guide/onboard/connected-workspaces), you can also select remote users from shared channels for direct and group messages.
|
||||
|
||||
<Tip>
|
||||
|
||||
- Alternatively, select <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> at the top of the channel sidebar, then select **Open a Direct Message**. In the **Direct Messages** list, you'll see your most recent conversations.
|
||||
- To add more people to the conversation select the channel name, then select **Add Members**. Adding members to a group message creates a new channel and starts a new conversation.
|
||||
- You can't remove members of a group message; however, you can start a new group channel and conversation with different members.
|
||||
- If you want to add more than 7 users to a group message, create a private channel instead.
|
||||
|
||||
</Tip>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
## Create a public or private channel
|
||||
|
||||
Tap <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> in the top right corner of the app, then select **Create New Channel**. Channels are created as public by default. If you want to create a private channel, tap the **Make Private** option.
|
||||
|
||||
> 
|
||||
>
|
||||
> 
|
||||
|
||||
## Start a direct or group message
|
||||
|
||||
Tap <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> in the top right corner of the app, then select **Open a Direct Message**. You can select one person for a direct message or up to seven people for a group message. If your organization uses [connected workspaces](/administration-guide/onboard/connected-workspaces), remote users from shared channels are also available to select. Tap **Start** to start the conversation.
|
||||
|
||||
> 
|
||||
>
|
||||
> 
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Automate with channel actions
|
||||
|
||||
The person who creates a channel automatically becomes the channel admin. Channel admins using Mattermost in a web browser or the desktop app can access **Channel Actions** from the channel name drop-down menu in the center pane to set up automatic actions when users [join the channel](/end-user-guide/collaborate/join-leave-channels#join-a-channel) or [post a message](/end-user-guide/collaborate/send-messages) to the channel.
|
||||
|
||||
Automatic actions include:
|
||||
|
||||
- Displaying a temporary welcome message for new channel members.
|
||||
- Automatically adding the channel to a [category in the user's channel sidebar](/end-user-guide/preferences/customize-your-channel-sidebar).
|
||||
- Prompting to run a playbook based on the contents of a message.
|
||||
|
||||
The [collaborative playbooks must be enabled](/administration-guide/configure/plugins-configuration-settings#collaborative-playbooks) for channel admins to use channel actions.
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: "Display channel banners"
|
||||
---
|
||||
<PlanAvailability slug="entry-adv" />
|
||||
|
||||
From Mattermost v10.9, users with admin permissions can enable channel banners to remind channel members about being diligent to avoid data spillage in channels that aren't intended for classified or sensitive information. These non-dismissible banners can be styled using Markdown and are visible across all Mattermost clients, including web browsers, the desktop app, and the mobile app.
|
||||
|
||||
Channel banner use cases include the following:
|
||||
|
||||
- Security classifications, such as **SENSITIVE INFORMATION: IMPACT LEVEL 5** with a distinctive color to alert members of the required security level.
|
||||
- Important notices, such as **Reminder: Code complete deadlines are Fridays at 3 PM**, for recurring reminders.
|
||||
- Policy or terms, such as **All discussion in this channel is private and restricted** with a red color to signal caution.
|
||||
|
||||
Mattermost [channel admins](/end-user-guide/collaborate/learn-about-roles#channel-admin), [team admins](/end-user-guide/collaborate/learn-about-roles#team-admin), and [system admins](/end-user-guide/collaborate/learn-about-roles#system-admin) can enable a banner with custom text at the top of Mattermost public or private channels.
|
||||
|
||||
Create a channel banner:
|
||||
|
||||
1. Open a channel where you have administrative permissions.
|
||||
2. Select the channel name at the top of the center pane to access the drop-down menu, then select **Channel Settings**.
|
||||
3. Select **Configuration** and enable the **Channel Banner** option.
|
||||
4. Specify the banner text you want to display at the top of the channel. You can style the text using [Markdown](/end-user-guide/collaborate/format-messages#use-markdown), if desired.
|
||||
5. Select the banner color.
|
||||
6. Select **Save** to apply the changes. The banner displays immediately.
|
||||
|
||||
## Change a channel banner
|
||||
|
||||
You can change the banner text or color at any time by following the same steps above. The new banner text or color displays immediately.
|
||||
|
||||
## Remove a channel banner
|
||||
|
||||
Disable the **Channel Banner** option in the channel settings to remove the banner from the channel.
|
||||
|
||||
<Tip>
|
||||
|
||||
System admins can grant any user the ability to create and manage channel banners by assigning the **Manage Channel Banners** permission in the System Console. See the [advanced permissions](/administration-guide/onboard/advanced-permissions) documentation for details.
|
||||
|
||||
</Tip>
|
||||
|
||||
## Classification markings
|
||||
|
||||
From Mattermost v11.8, system admins can configure classification markings that display as global or channel-level banners in the web and desktop apps. See the [Classification Markings](/administration-guide/configure/site-configuration-settings#classification-markings) configuration documentation for setup details.
|
||||
|
||||
Classification markings use predefined or custom classification levels, including the classification name and banner color. These markings are informational only and don't control access to channels, messages, files, or other Mattermost resources.
|
||||
|
||||
When a channel classification is applied, Mattermost displays the selected classification as the channel banner. Classification markings take priority over a custom channel banner when both are configured for the same channel.
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "Extend Mattermost with integrations"
|
||||
---
|
||||
Ensure your teams are are always informed about important events, status changes, deadlines, or priorities with Mattermost operational and DevOps integrations. Enhance communication, streamline Mattermost with external workflows, ensure security and compliance, and foster a more efficient and collaborative work environment with major communication tools and services featuring real-time alerts, updates, and notifications directly within channels.
|
||||
|
||||
## Interoperability with pre-built integrations
|
||||
|
||||
Your system admin can install the following pre-packaged integrations through the Mattermost Marketplace, and enable and configure them in the Mattermost System Console.
|
||||
|
||||
### Mattermost features
|
||||
|
||||
- [AI Agents](/end-user-guide/agents#access-ai-features)
|
||||
- [Export Mattermost channel data](/administration-guide/comply/export-mattermost-channel-data#usage)
|
||||
- [Monitor performance metrics](/administration-guide/scale/collect-performance-metrics#usage)
|
||||
- [Perform legal holds](/administration-guide/comply/legal-hold)
|
||||
|
||||
### Mattermost interoperability
|
||||
|
||||
- [GitHub](/integrations-guide/github#use)
|
||||
- [GitLab](/integrations-guide/gitlab#use)
|
||||
- [Jira](/integrations-guide/jira#use)
|
||||
- [Microsoft Teams](/integrations-guide/microsoft-teams-sync#use)
|
||||
- [ServiceNow](/integrations-guide/servicenow#use)
|
||||
- [Zoom](/integrations-guide/zoom#usage)
|
||||
|
||||
<Tip>
|
||||
|
||||
- [Visit the Mattermost Marketplace](https://mattermost.com/marketplace/) to find open source, community-supported integrations to common developer tools like [CircleCI](https://mattermost.com/marketplace/circleci/), [Opsgenie](https://mattermost.com/marketplace/opsgenie/), [PagerDuty Notifier](https://mattermost.com/marketplace/pagerduty/); productivity tools like [Autolink](https://mattermost.com/marketplace/autolink-plugin/), [ToDo](https://mattermost.com/marketplace/todo/), and [WelcomeBot](https://mattermost.com/marketplace/welcomebot-plugin/); as well as social tools like [Memes](https://mattermost.com/marketplace/memes-plugin/) and [GIFs](https://mattermost.com/marketplace/giphy-plugin/) that are freely available for use and customization.
|
||||
- Looking for a way to get notifications of new Mattermost Marketplace integrations in your Mattermost channels? See the [integrations FAQ](/integrations-guide/faq) documentation for details.
|
||||
|
||||
</Tip>
|
||||
62
docs/main/end-user-guide/collaborate/favorite-channels.mdx
Normal file
62
docs/main/end-user-guide/collaborate/favorite-channels.mdx
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: "Mark channels as favorites"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
You can mark public and private channels, as well as direct and group messages as favorites so they're easy to access later. Favorite channels display in the **Favorites** category in the channel sidebar.
|
||||
|
||||

|
||||
|
||||
To mark a channel as a **Favorite**:
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
1. Open a channel.
|
||||
2. Select on the star icon next to the channel name.
|
||||
|
||||
At the top of the page, select the <img src={useBaseUrl('/img/ui/star-outline_F04D2.svg')} alt="Use the Star icon to mark a channel as a favorite." className="theme-icon" /> icon next to the channel name.
|
||||
|
||||

|
||||
|
||||
To remove a channel from your **Favorites** list, select the <img src={useBaseUrl('/img/ui/star-outline_F04D2.svg')} alt="Use the Star icon to mark a channel as a favorite." className="theme-icon" /> icon again.
|
||||
|
||||
Alternatively to mark channels as favorites, select the channel name, select the **View Info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon, then select **Favorite** in the right pane. Select **Favorited** to remove the channel from your list of favorites.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
1. Tap the channel you want to mark as a favorite.
|
||||
|
||||

|
||||
|
||||
2. Tap the <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
|
||||
|
||||

|
||||
|
||||
3. Tap **Favorite**.
|
||||
|
||||

|
||||
|
||||
Alternatively, you can mark a favorite channel as follows:
|
||||
|
||||
1. In a channel, tap the channel name at the top of the screen.
|
||||
|
||||

|
||||
|
||||
2. Tap on **Favorite**
|
||||
|
||||

|
||||
|
||||
To remove a channel from the **Favorites** list, tap the **Favorited** option.
|
||||
|
||||

|
||||
|
||||

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

|
||||
|
||||
The message formatting toolbar offers the following formatting options:
|
||||
|
||||
<table>
|
||||
<colgroup>
|
||||
<col style={{width: '53%'}} />
|
||||
<col style={{width: '46%'}} />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Formatting option</th>
|
||||
<th>Icon</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a href="#use-markdown">Bold, italicize, or strike out text</a></td>
|
||||
<td>
|
||||
<img src={useBaseUrl('/img/ui/format-bold_F0264.svg')} alt="Bold" className="theme-icon" />
|
||||
<img src={useBaseUrl('/img/ui/format-italic_F0277.svg')} alt="Italicize" className="theme-icon" />
|
||||
<img src={useBaseUrl('/img/ui/format-strikethrough-variant_F0281.svg')} alt="Strikeout" className="theme-icon" />
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Add <a href="#headings">headings</a>, <a href="#links">links</a>, or attachments</td>
|
||||
<td>
|
||||
<img src={useBaseUrl('/img/ui/format-header_E81D.svg')} alt="Headings" className="theme-icon" />
|
||||
<img src={useBaseUrl('/img/ui/link-variant_F0339.svg')} alt="Copy link" className="theme-icon" />
|
||||
<img src={useBaseUrl('/img/ui/paperclip_F03E2.svg')} alt="Attachments" className="theme-icon" />
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Format a numbered list, a bulleted list, quoted text, or text as code</td>
|
||||
<td>
|
||||
<img src={useBaseUrl('/img/ui/format-list-numbered_F027B.svg')} alt="Numbered list" className="theme-icon" />
|
||||
<img src={useBaseUrl('/img/ui/format-list-bulleted_F0279.svg')} alt="Bulleted list" className="theme-icon" />
|
||||
<img src={useBaseUrl('/img/ui/format-quote-open_F0757.svg')} alt="Quoted text" className="theme-icon" />
|
||||
<img src={useBaseUrl('/img/ui/code-tags_F0174.svg')} alt="Code" className="theme-icon" />
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2"><a href="/end-user-guide/collaborate/react-with-emojis-gifs">Add emojis or GIFs</a> <img src={useBaseUrl('/img/ui/emoticon-outline_F01F2.svg')} alt="Emoji" className="theme-icon" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2"><a href="/end-user-guide/collaborate/message-priority">Set message priority</a> <img src={useBaseUrl('/img/ui/alert-circle-outline_F05D6.svg')} alt="Message priority" className="theme-icon" /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
Review how your message formatting will look when the message is sent by selecting the **Show/Hide Preview** <img src={useBaseUrl('/img/ui/eye-outline_F06D0.svg')} alt="Review your message text formatting using the Show/Hide preview icon in the message formatting toolbar." className="theme-icon" /> icon. Return to your draft message by selecting the icon again.
|
||||
|
||||
<Tip>
|
||||
|
||||
- Hide the formatting options by selecting the **Show/Hide Formatting** <img src={useBaseUrl('/img/ui/format-letter-case_F0B34.svg')} alt="Hide formatting options in the message formatting toolbar using the Show/Hide Formatting icon." className="theme-icon" /> icon. Select the icon again to show the formatting options.
|
||||
- You can control whether post formatting is rendered within the message formatting editor. When disabled, raw text is shown. See the [Channels customization](/end-user-guide/preferences/manage-advanced-options) documentation for details.
|
||||
|
||||
</Tip>
|
||||
|
||||
## Use Markdown
|
||||
|
||||
You can also format your messages in Mattermost using Markdown to control [text styling](#text-style), [links](#links), [headings](#headings), [lists](#lists), [code blocks](#code-blocks), [in-line code](#in-line-code), [in-line images](#in-line-images), [horizontal lines](#horizontal-lines), [block quotes](#block-quotes), [tables](#tables), and [math formulas](#math-formulas). Markdown makes it easy to format messages: type a message as you normally would, then use formatting syntax to render the message a specific way. For a guide to using Markdown in Mattermost, [see this blog post](https://mattermost.com/blog/laymans-guide-to-markdown-on-mattermost/).
|
||||
|
||||

|
||||
|
||||
### Text style
|
||||
|
||||
You can use either `_` or `*` around a word or phrase to make it italic, or `__` or `**` around a word or phrase to make it bold.
|
||||
|
||||
<Tip>
|
||||
|
||||
Common formatting keyboard shortcuts are supported. Bold text by pressing <kbd>Ctrl</kbd> <kbd>B</kbd> on Windows and Linux, or <kbd>⌘</kbd> <kbd>B</kbd> on Mac. Italicize text by pressing <kbd>Ctrl</kbd> <kbd>I</kbd> on Windows or Linux, or <kbd>⌘</kbd> <kbd>I</kbd> on Mac.
|
||||
|
||||
</Tip>
|
||||
|
||||
- `*italics*` (or `_italics_`) renders as *italics*
|
||||
- `**bold**` renders as **bold**
|
||||
- `***bold-italic***` renders as <img src={useBaseUrl('/images/bold_italics.png')} width="100" alt="Bold Italics" />
|
||||
- `~~strikethrough~~` renders as <img src={useBaseUrl('/images/strikethrough.png')} width="100" alt="Strike Through" />
|
||||
|
||||
### Links
|
||||
|
||||
<Tip>
|
||||
|
||||
Format selected message text as a link by pressing <kbd>Ctrl</kbd> <kbd>K</kbd> on Windows and Linux, or by pressing <kbd>⌘</kbd> <kbd>K</kbd> on Mac.
|
||||
|
||||
</Tip>
|
||||
|
||||
#### Channel links
|
||||
|
||||
Create a link to a public channel in a message by typing `~` followed by the channel name (e.g. `~roadmap`). Channel members see private channel names returned.
|
||||
|
||||
#### Labeled links
|
||||
|
||||
Create labeled links by putting the desired text in square brackets `[ ]` and the associated link in round brackets `( )`.
|
||||
|
||||
`[Check out Mattermost!](https://.mattermost.com/)`
|
||||
|
||||
Renders as: [Check out Mattermost!](https://mattermost.com/)
|
||||
|
||||
### Headings
|
||||
|
||||
Make a heading by typing `#` and a space before your title. For smaller headings, use more `#`'s.
|
||||
|
||||
``` text
|
||||
## Large Heading
|
||||
### Smaller Heading
|
||||
#### Even Smaller Heading
|
||||
```
|
||||
|
||||
Renders as:
|
||||
|
||||

|
||||
|
||||
Alternatively, you can underline the text using equal signs `===` or hyphens `---` to create headings.
|
||||
|
||||
``` text
|
||||
Large Heading
|
||||
-------------
|
||||
```
|
||||
|
||||
Renders as:
|
||||
|
||||

|
||||
|
||||
### Lists
|
||||
|
||||
Create a list by using asterisks `*`, hyphens `-`, and/or plus signs `+` interchangeably as bullets. Indent bullet points by adding two spaces in front each one.
|
||||
|
||||
``` text
|
||||
* item one
|
||||
- item two
|
||||
+ item two sub-point
|
||||
```
|
||||
|
||||
Renders as:
|
||||
|
||||
- item one
|
||||
- item two
|
||||
- item two sub-point
|
||||
|
||||
Make an ordered list by using numbers instead:
|
||||
|
||||
``` text
|
||||
1. Item one
|
||||
1. Item two
|
||||
1. item three
|
||||
```
|
||||
|
||||
Renders as:
|
||||
|
||||
1. Item one
|
||||
2. Item two
|
||||
3. Item three
|
||||
|
||||
You can also start a list at any number:
|
||||
|
||||
``` text
|
||||
4. The first list number is 4.
|
||||
1. The second list number is 5.
|
||||
1. The third list number is 6.
|
||||
```
|
||||
|
||||
Renders as:
|
||||
|
||||
4. The first list number is 4.
|
||||
5. The second list number is 5.
|
||||
6. The third list number is 6.
|
||||
|
||||
Make a task list by including square brackets `[ ]`. Mark a task as complete by adding an `x`.
|
||||
|
||||
``` text
|
||||
- [ ] Item one
|
||||
- [ ] Item two
|
||||
- [x] Completed item
|
||||
```
|
||||
|
||||
Renders as:
|
||||
|
||||

|
||||
|
||||
### Code blocks
|
||||
|
||||
Creating a fixed-width code block is recommended for pasting multi-line blocks of code or other text output because it's easier to read with fixed-width font alignment. Examples include block text snippets, ASCII tables, and log files. Rendered code blocks include a **Copy** option to copy the contents of the code block.
|
||||
|
||||
This can be accomplished by placing three backticks (```` ``` ````) on the line directly above and directly below your code:
|
||||
|
||||
````text
|
||||
```
|
||||
this is my
|
||||
code block
|
||||
```
|
||||
````
|
||||
|
||||
<Tip>
|
||||
|
||||
Type three backticks (```` ``` ````), press <kbd>Shift</kbd> <kbd>Enter</kbd> on Windows or Linux, or <kbd>⇧</kbd> <kbd>↵</kbd> on Mac, `<type_your_code>`, press <kbd>Shift</kbd> <kbd>Enter</kbd> on Windows or Linux, or <kbd>⇧</kbd> <kbd>↵</kbd> on Mac again, then type three more backticks (```` ``` ````).
|
||||
|
||||
</Tip>
|
||||
|
||||
Or by indenting each line by four spaces:
|
||||
|
||||
```text
|
||||
this is my
|
||||
code block
|
||||
```
|
||||
|
||||
### Syntax highlighting
|
||||
|
||||
To add syntax highlighting, type the language to be highlighted after the ```` ``` ```` at the beginning of the code block. Mattermost also offers four different code themes (GitHub, Solarized Dark, Solarized Light, and Monokai) that can be changed in **Settings \> Display \> Theme \> Custom Theme \> Center Channel Styles**.
|
||||
|
||||
Supported languages and their aliases include:
|
||||
|
||||
<table width="100%" border="1" cellpadding="5px" style={{marginBottom: '20px'}}>
|
||||
<tr class="row-odd">
|
||||
<th class="head">Language</th>
|
||||
<th class="head">Aliases</th>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">ActionScript</td>
|
||||
<td valign="middle">actionscript, as, as3</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">AppleScript</td>
|
||||
<td valign="middle">applescript</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Bash</td>
|
||||
<td valign="middle">bash, sh</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Clojure</td>
|
||||
<td valign="middle">clojure</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">CoffeeScript</td>
|
||||
<td valign="middle">coffescript, coffee, coffee-script</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">C/C++</td>
|
||||
<td valign="middle">cpp, c++, c</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">C#</td>
|
||||
<td valign="middle">cs, c#, csharp</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">CSS</td>
|
||||
<td valign="middle">css</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">D</td>
|
||||
<td valign="middle">d, dlang</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Dart</td>
|
||||
<td valign="middle">dart</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Delphi</td>
|
||||
<td valign="middle">delphi</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Diff</td>
|
||||
<td valign="middle">diff, patch, udiff</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Django</td>
|
||||
<td valign="middle">django</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Dockerfile</td>
|
||||
<td valign="middle">dockerfile, docker</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Elixir</td>
|
||||
<td valign="middle">elixir, ex, exs</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Erlang</td>
|
||||
<td valign="middle">erlang, erl</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Fortran</td>
|
||||
<td valign="middle">fortran</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">F#</td>
|
||||
<td valign="middle">fsharp</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">G-Code</td>
|
||||
<td valign="middle">gcode</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Go</td>
|
||||
<td valign="middle">go, golang</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Groovy</td>
|
||||
<td valign="middle">groovy</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Handlebars</td>
|
||||
<td valign="middle">handlebars, hbs, mustache</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Haskell</td>
|
||||
<td valign="middle">haskell, hs</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Haxe</td>
|
||||
<td valign="middle">haxe</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Java</td>
|
||||
<td valign="middle">java</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">JavaScript</td>
|
||||
<td valign="middle">javascript, js</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">JSON</td>
|
||||
<td valign="middle">json</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Julia</td>
|
||||
<td valign="middle">julia, jl</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Kotlin</td>
|
||||
<td valign="middle">kotlin</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">LaTeX</td>
|
||||
<td valign="middle">latex, tex</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Less</td>
|
||||
<td valign="middle">less</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Lisp</td>
|
||||
<td valign="middle">lisp</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Lua</td>
|
||||
<td valign="middle">lua</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Makefile</td>
|
||||
<td valign="middle">makefile, make, mf, gnumake, bsdmake</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Markdown</td>
|
||||
<td valign="middle">markdown, md, mkd</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Matlab</td>
|
||||
<td valign="middle">matlab, m</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Objective C</td>
|
||||
<td valign="middle">objectivec, objective_c, objc</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">OCaml</td>
|
||||
<td valign="middle">ocaml</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Perl</td>
|
||||
<td valign="middle">perl, pl</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Pascal</td>
|
||||
<td valign="middle">pascal, pas</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">PostgreSQL</td>
|
||||
<td valign="middle">pgsql, postgres, postgresql</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">PHP</td>
|
||||
<td valign="middle">php, php3, php4, php5</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">PowerShell</td>
|
||||
<td valign="middle">powershell, posh</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Puppet</td>
|
||||
<td valign="middle">puppet, pp</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Python</td>
|
||||
<td valign="middle">python, py</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">R</td>
|
||||
<td valign="middle">r, s</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Ruby</td>
|
||||
<td valign="middle">ruby, rb</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Rust</td>
|
||||
<td valign="middle">rust, rs</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Scala</td>
|
||||
<td valign="middle">scala</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Scheme</td>
|
||||
<td valign="middle">scheme</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">SCSS</td>
|
||||
<td valign="middle">scss</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Smalltalk</td>
|
||||
<td valign="middle">smalltalk, st, squeak</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">SQL</td>
|
||||
<td valign="middle">sql</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Stylus</td>
|
||||
<td valign="middle">stylus, styl</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Swift</td>
|
||||
<td valign="middle">swift</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Text</td>
|
||||
<td valign="middle">text</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">TypeScript</td>
|
||||
<td valign="middle">typescript, ts, tsx</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">VB.Net</td>
|
||||
<td valign="middle">vbnet, vb, visualbasic</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">VBScript</td>
|
||||
<td valign="middle">vbscript</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">Verilog</td>
|
||||
<td valign="middle">verilog</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">VHDL</td>
|
||||
<td valign="middle">vhdl</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">HTML, XML</td>
|
||||
<td valign="middle">html, xml</td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td valign="middle">YAML</td>
|
||||
<td valign="middle">yaml, yml</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Example:
|
||||
|
||||
```` text
|
||||
``` go
|
||||
package main
|
||||
import "fmt"
|
||||
func main() {
|
||||
fmt.Println("Hello, 世界")
|
||||
}
|
||||
```
|
||||
````
|
||||
|
||||
Renders as:
|
||||
|
||||
**GitHub Theme**
|
||||
|
||||

|
||||
|
||||
**Solarized Dark Theme**
|
||||
|
||||

|
||||
|
||||
**Solarized Light Theme**
|
||||
|
||||

|
||||
|
||||
**Monokai Theme**
|
||||
|
||||

|
||||
|
||||
### In-line code
|
||||
|
||||
Create in-line monospaced code text by surrounding it with backticks ``<code>. Don't use single quotes </code><code>'</code>\`.
|
||||
|
||||
``` text
|
||||
`monospace`
|
||||
```
|
||||
|
||||
Renders as: `monospace`.
|
||||
|
||||
### In-line images
|
||||
|
||||
In-line images are images added within lines of text. You can control whether all in-line images over 100px in height are automatically collapsed or expanded in messages by setting a [user preference](/end-user-guide/preferences/manage-your-display-options), or by using the `/collapse` and `/expand` slash commands.
|
||||
|
||||
To add in-line images to text, use an exclamation mark `!` followed by the `alt text` in square brackets `[ ]`, then the `image URL` in round brackets `( )`. You can add hover text after the link by placing the text in quotes `" "`.
|
||||
|
||||
Example:
|
||||
|
||||
``` text
|
||||

|
||||
```
|
||||
|
||||
If the height of the original image is more than 500 pixels, Mattermost sets the image height at 500 pixels and adjusts the width to maintain the original aspect ratio.
|
||||
|
||||
You can set the width and height of the displayed image after the URL of the image by using an equals sign `=` followed by values for both width and height `##x##`. If you set only the width, Mattermost adjusts the height to maintain the original aspect ratio.
|
||||
|
||||
<Warning>
|
||||
|
||||
The native apps do not support fixed width and height and will display the full-size image.
|
||||
|
||||
</Warning>
|
||||
|
||||
Examples:
|
||||
|
||||
``` text
|
||||
.. |mattermost-icon-76x76| image:: ../images/icon-76x76.png
|
||||
.. |mattermost-icon-50x76| image:: ../images/icon-50x76.png
|
||||
```
|
||||
|
||||
#### In-line image with hover text
|
||||
|
||||
``` text
|
||||

|
||||
```
|
||||
|
||||
Renders as:
|
||||
|
||||
> 
|
||||
|
||||
#### In-line image with link
|
||||
|
||||
<Note>
|
||||
|
||||
An extra set of square brackets `[ ]` is required around the alt text, and round brackets `( )` are required around the image link.
|
||||
|
||||
</Note>
|
||||
|
||||
``` text
|
||||
[](https://github.com/mattermost/mattermost)
|
||||
```
|
||||
|
||||
Renders as:
|
||||
|
||||
> [](https://github.com/mattermost/mattermost)
|
||||
|
||||
#### In-line image displayed with fixed width and height
|
||||
|
||||
Example: An in-line image that's 50 pixels wide and 76 pixels high.
|
||||
|
||||
``` text
|
||||

|
||||
```
|
||||
|
||||
Renders as:
|
||||
|
||||
> <img src={useBaseUrl('/images/icon-50x76.png')} id="Mattermost Icon" alt="Mattermost" />
|
||||
|
||||
#### In-line image displayed with fixed width
|
||||
|
||||
Example: An in-line image that's 50 pixels wide where the system adjusts the height to maintain the original aspect ratio.
|
||||
|
||||
``` text
|
||||

|
||||
```
|
||||
|
||||
Renders as:
|
||||
|
||||
> <img src={useBaseUrl('/images/icon-76x76.png')} width="50" alt="Mattermost" />
|
||||
|
||||
### Horizontal lines
|
||||
|
||||
Create a line by using three `*`, `_`, or `-`.
|
||||
|
||||
`***`
|
||||
|
||||
Renders as:
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Block quotes
|
||||
|
||||
Create block quotes using `>`.
|
||||
|
||||
`> block quotes` renders as:
|
||||
|
||||

|
||||
|
||||
### Tables
|
||||
|
||||
Create a table by placing a dashed line `---` under the header row, then separating each column with using pipes `|`. The columns don’t need to line up exactly. Choose how to align table columns by including colons `:` within the header row.
|
||||
|
||||
``` text
|
||||
| Left-Aligned | Center Aligned | Right Aligned |
|
||||
| :------------ |:---------------:| -----:|
|
||||
| Left column 1 | this text | $100 |
|
||||
| Left column 2 | is | $10 |
|
||||
| Left column 3 | centered | $1 |
|
||||
```
|
||||
|
||||
Renders as:
|
||||
|
||||

|
||||
|
||||
<Note>
|
||||
|
||||
Multi-line text in a table cell isn't supported using HTML tags such as `<br />` or `<br/>`.
|
||||
|
||||
</Note>
|
||||
|
||||
### Math Formulas
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="using-inline-latex" label="Using Inline LaTeX">
|
||||
|
||||
You can create formulas that display inline using LaTeX. Use the dollar sign ($) symbol at the beginning and end of each formula.
|
||||
|
||||
<Note>
|
||||
|
||||
This feature is [disabled by default](/administration-guide/configure/site-configuration-settings#enable-inline-latex-rendering). Contact your system admin to enable this setting in **System Console \> Site Configuration \> Posts** to use this feature.
|
||||
|
||||
</Note>
|
||||
|
||||
``` text
|
||||
$X_k = \sum_{n=0}^{2N-1} x_n \cos \left[\frac{\pi}{N} \left(n+\frac{1}{2}+\frac{N}{2}\right) \left(k+\frac{1}{2}\right) \right]$
|
||||
```
|
||||
|
||||
Renders as:
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="using-latex-in-code-blocks" label="Using LaTeX in Code Blocks">
|
||||
|
||||
Create formulas as code blocks by using LaTeX in a `latex` [code blocks](#code-blocks).
|
||||
|
||||
<Note>
|
||||
|
||||
This feature is [disabled by default](/administration-guide/configure/site-configuration-settings#enable-latex-code-block-rendering). Contact your system admin to enable this setting in **System Console \> Site Configuration \> Posts** to use this feature.
|
||||
|
||||
</Note>
|
||||
|
||||
```` text
|
||||
```latex
|
||||
X_k = \sum_{n=0}^{2N-1} x_n \cos \left[\frac{\pi}{N} \left(n+\frac{1}{2}+\frac{N}{2}\right) \left(k+\frac{1}{2}\right) \right]
|
||||
```
|
||||
````
|
||||
|
||||
Renders as:
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
<PlanAvailability slug="academy-message-formatting" />
|
||||
32
docs/main/end-user-guide/collaborate/forward-messages.mdx
Normal file
32
docs/main/end-user-guide/collaborate/forward-messages.mdx
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: "Forward messages"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
From Mattermost v7.2, using a web browser or the desktop app, you can forward messages in public channels to other public channels. From Mattermost v7.5, you can also forward messages from bots and webhooks.
|
||||
|
||||
<Note>
|
||||
|
||||
Private channels, direct messages, and group messages intended for specific people can't be forwarded.
|
||||
|
||||
</Note>
|
||||
|
||||
To forward a message:
|
||||
|
||||
1. Select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a message, then select **Forward**.
|
||||
|
||||
> 
|
||||
|
||||
2. Specify where you want to forward the message, and include an optional comment.
|
||||
|
||||
Forwarding a message also generates a preview of the message.
|
||||
|
||||

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

|
||||
|
||||
2. Tap **Browse Channels**.
|
||||
|
||||

|
||||
|
||||
3. Tap the public channel you want to join.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
<Tip>
|
||||
|
||||
When you join channels, depending on the [channel actions configured](/end-user-guide/collaborate/create-channels), you may see a welcome message, and channels may be added to [a category in your channel sidebar](/end-user-guide/preferences/customize-your-channel-sidebar) automatically. Using Mattermost in a web browser or the desktop app, access **Channel Actions** from the channel name drop-down menu in the center pane to see what automatic actions have been configured.
|
||||
|
||||
</Tip>
|
||||
|
||||
See the following documentation to learn more about working with channels:
|
||||
|
||||
- [Create channels](/end-user-guide/collaborate/create-channels)
|
||||
- [Browse channels](/end-user-guide/collaborate/browse-channels)
|
||||
- [Customize your channel sidebar](/end-user-guide/preferences/customize-your-channel-sidebar)
|
||||
|
||||
## Leave a channel
|
||||
|
||||
When you leave a private channel, you must be re-added by another channel member to rejoin. You won't receive mention notifications from a channel if you're not a member of that channel.
|
||||
|
||||
<Note>
|
||||
|
||||
All users are added to the **Town Square** channel automatically. This means that users can't [archive](/end-user-guide/collaborate/archive-unarchive-channels#archive-a-channel), [unarchive](/end-user-guide/collaborate/archive-unarchive-channels#unarchive-a-channel), or leave the **Town Square** channel. However, [guests](/administration-guide/onboard/guest-accounts) who are manually invited to **Town Square** can leave the channel.
|
||||
|
||||
</Note>
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Select the channel name at the top of the center pane to access the drop-down menu, then select **Leave Channel**.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
1. Tap the channel you want to leave.
|
||||
|
||||

|
||||
|
||||
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
|
||||
|
||||

|
||||
|
||||
3. Tap **Leave channel**.
|
||||
|
||||

|
||||
|
||||
4. Tap on **Leave** to confirm you choice.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### Leave a public channel added by a membership policy
|
||||
|
||||
From Mattermost v11.8.0, when you leave a public channel you were added to by a membership policy, Mattermost asks you to confirm:
|
||||
|
||||
- Choosing **Leave channel** removes you from the channel.
|
||||
- Choosing **Mute instead** keeps you in the channel and mutes its notifications.
|
||||
|
||||
If the channel is already muted, Mattermost shows **Cancel** and **Leave channel** instead of **Mute instead**.
|
||||
|
||||
@@ -0,0 +1,88 @@
|
||||
---
|
||||
title: "Keyboard accessibility"
|
||||
---
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Navigational keyboard shortcuts help you use Mattermost in a web browser or the desktop app without needing a mouse. Below is a list of supported accessibility shortcuts.
|
||||
|
||||
<table>
|
||||
<colgroup>
|
||||
<col style={{width: '40%'}} />
|
||||
<col style={{width: '60%'}} />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Keyboard shortcut</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Desktop App: <kbd>F6</kbd><br/>Browser: <kbd>Ctrl</kbd> <kbd>F6</kbd></td>
|
||||
<td>Move focus to the next section</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Desktop App: <kbd>Shift</kbd> <kbd>F6</kbd><br/>Browser: <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>F6</kbd></td>
|
||||
<td>Move focus to the previous section</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Tab</kbd></td>
|
||||
<td>Move focus to the next element</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Shift</kbd> <kbd>Tab</kbd></td>
|
||||
<td>Move focus to the previous element</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>↑</kbd> or <kbd>↓</kbd></td>
|
||||
<td>Move focus between messages in the post list or sections in the channel sidebar</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Enter</kbd></td>
|
||||
<td>Take action on the focused element</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Region navigation
|
||||
|
||||
Mattermost has eight regions that can be focused for navigation. Use <kbd>F6</kbd> in the desktop app, or use <kbd>Ctrl</kbd> <kbd>F6</kbd> in a browser repeatedly to move focus and loop through the regions in this order:
|
||||
|
||||
1. Message list region
|
||||
2. Message input region
|
||||
3. Right-hand side message list region
|
||||
4. Right-hand side message input region
|
||||
5. Team menu region
|
||||
6. Channel sidebar region
|
||||
7. Channel header region
|
||||
8. Search
|
||||
|
||||

|
||||
|
||||
## Message navigation
|
||||
|
||||
When the message list region is focused, use the <kbd>↑</kbd> or <kbd>↓</kbd> arrow keys to navigate through messages and reply threads. Press <kbd>Tab</kbd> to navigate through message actions.
|
||||
|
||||

|
||||
|
||||
### Message composition
|
||||
|
||||
Mattermost is compatible with most popular screen readers, such as [Apple VoiceOver](https://www.apple.com/ca/accessibility/vision/) or [JAWS for Windows](https://www.freedomscientific.com/products/software/jaws/). A custom readout is composed for each message by combining the message elements and reading them together in full sentences. Message elements will read in the following order:
|
||||
|
||||
1. Header: Author, timestamp, message type (i.e. parent post or reply)
|
||||
2. Main Content: The message content typed by the author
|
||||
3. Attachments: The number of attachments (if applicable)
|
||||
4. Emoji Reactions: The number of unique emoji reactions (if applicable)
|
||||
5. Saves/Pins: If a message is saved or pinned (if applicable)
|
||||
|
||||
For example, a message read by a screen reader may sound like the following:
|
||||
|
||||
``` text
|
||||
Eric Sethna at 12:57pm Thursday June 13th wrote a reply "Thanks for the review", 3 attachments, 2 reactions, message is saved and pinned.
|
||||
```
|
||||
|
||||
## Channel sidebar navigation
|
||||
|
||||
When the channel sidebar region is focused, use the <kbd>↑</kbd> or <kbd>↓</kbd> arrow keys to focus individual sidebar sections, such as Insights, Threads, Favorites, custom categories, public channels, private channels, and direct messages. Press <kbd>Tab</kbd> to navigate through channels or other buttons within a sidebar section.
|
||||
|
||||

|
||||
506
docs/main/end-user-guide/collaborate/keyboard-shortcuts.mdx
Normal file
506
docs/main/end-user-guide/collaborate/keyboard-shortcuts.mdx
Normal file
@@ -0,0 +1,506 @@
|
||||
---
|
||||
title: "Mattermost keyboard shortcuts"
|
||||
---
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Mattermost keyboard shortcuts help you make a more efficient use of your keyboard when using Mattermost in a web browser or the desktop app.
|
||||
|
||||
<Tip>
|
||||
|
||||
- More keyboard shortcuts are available. See the [team keyboard shortcuts](/end-user-guide/collaborate/team-keyboard-shortcuts) and [text style](/end-user-guide/collaborate/format-messages#text-style) documentation for details.
|
||||
- In Mattermost, display a list of available keyboard shortcuts by pressing <kbd>Ctrl</kbd> <kbd>/</kbd> on Windows or Linux, pressing <kbd>⌘</kbd> <kbd>/</kbd> on macOS, or using the `/shortcuts` slash command.
|
||||
|
||||

|
||||
|
||||
</Tip>
|
||||
|
||||
## Channel navigation
|
||||
|
||||
The following keyboard shortcuts for channels are supported in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>On Windows & Linux</th>
|
||||
<th>On Mac</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Alt</kbd> <kbd>↑</kbd></td>
|
||||
<td><kbd>⌥</kbd> <kbd>↑</kbd></td>
|
||||
<td>Previous channel or direct message in the channel sidebar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Alt</kbd> <kbd>↓</kbd></td>
|
||||
<td><kbd>⌥</kbd> <kbd>↓</kbd></td>
|
||||
<td>Next channel or direct message in the channel sidebar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Alt</kbd> <kbd>Shift</kbd> <kbd>↑</kbd></td>
|
||||
<td><kbd>⌥</kbd> <kbd>⇧</kbd> <kbd>↑</kbd></td>
|
||||
<td>Previous channel or direct message in the channel sidebar with unread messages.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Alt</kbd> <kbd>Shift</kbd> <kbd>↓</kbd></td>
|
||||
<td><kbd>⌥</kbd> <kbd>⇧</kbd> <kbd>↓</kbd></td>
|
||||
<td>Next channel or direct message in the channel sidebar with unread messages.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Alt</kbd> + select channel</td>
|
||||
<td><kbd>⌥</kbd> + select channel</td>
|
||||
<td>Mark the last post in the channel as unread.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>K</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>K</kbd></td>
|
||||
<td><ul><li>If text isn't selected: Open the <strong>Find Channels</strong> dialog.</li><li>If text is selected: Create a hyperlink in the format <code>[linktext](URL)</code>.</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>K</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>K</kbd></td>
|
||||
<td>Open the <strong>Direct Messages</strong> dialog.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>A</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>A</kbd></td>
|
||||
<td>Open the <strong>Settings</strong> dialog.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>M</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>M</kbd></td>
|
||||
<td>Open recent mentions.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>L</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>L</kbd></td>
|
||||
<td>Set focus to center channel input field.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>.</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>.</kbd></td>
|
||||
<td>Open or close the right-hand sidebar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>.</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>.</kbd></td>
|
||||
<td>Expand or shrink the width of the open right-hand sidebar.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>F</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>F</kbd></td>
|
||||
<td>Move focus to the <strong>Search</strong> field and search the current channel.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>U</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>U</kbd></td>
|
||||
<td>Find unread channels or search through all channels.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>I</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>I</kbd></td>
|
||||
<td>Open or close <strong>Channel Info</strong> details in the right-hand sidebar.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## File uploads
|
||||
|
||||
The following keyboard shortcuts are supported in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>On Windows & Linux</th>
|
||||
<th>On Mac</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>U</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>U</kbd></td>
|
||||
<td>Upload a file.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Messages
|
||||
|
||||
The following keyboard shortcuts are supported in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>On Windows & Linux</th>
|
||||
<th>On Mac</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>↑</kbd> (in empty input field)</td>
|
||||
<td><kbd>⌘</kbd> <kbd>↑</kbd> (in empty input field)</td>
|
||||
<td>Reprint previous message or slash command you entered.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>↓</kbd> (in empty input field)</td>
|
||||
<td><kbd>⌘</kbd> <kbd>↓</kbd> (in empty input field)</td>
|
||||
<td>Reprint next message or slash command you entered.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Shift</kbd> <kbd>↑</kbd> (in empty input field)</td>
|
||||
<td><kbd>⇧</kbd> <kbd>↑</kbd> (in empty input field)</td>
|
||||
<td>Reply to the most recent message in the current channel.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>↑</kbd> (in empty input field)</td>
|
||||
<td><kbd>↑</kbd> (in empty input field)</td>
|
||||
<td>Edit your last message in the current channel.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>@[character]</kbd> <kbd>Tab</kbd></td>
|
||||
<td><kbd>@[character]</kbd> <kbd>Tab</kbd></td>
|
||||
<td>Autocomplete @username beginning with [character].</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>~[character]</kbd> <kbd>Tab</kbd></td>
|
||||
<td><kbd>~[character]</kbd> <kbd>Tab</kbd></td>
|
||||
<td>Autocomplete channel beginning with [character].</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>:[character]</kbd> <kbd>Tab</kbd></td>
|
||||
<td><kbd>:[character]</kbd> <kbd>Tab</kbd></td>
|
||||
<td>Autocomplete emoji beginning with [character].</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>\</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>\</kbd></td>
|
||||
<td>React to last message in channel or thread.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Message formatting
|
||||
|
||||
The following keyboard shortcuts are supported in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>On Windows & Linux</th>
|
||||
<th>On Mac</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>B</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>B</kbd></td>
|
||||
<td>Bold text.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>I</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>I</kbd></td>
|
||||
<td>Italicize text.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Alt</kbd> <kbd>K</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⌥</kbd> <kbd>K</kbd></td>
|
||||
<td>Format text as a link.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Accessibility nagivation
|
||||
|
||||
The following keyboard shortcuts work in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>On Windows & Linux</th>
|
||||
<th>On Mac</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Alt</kbd> <kbd>←</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>[</kbd></td>
|
||||
<td>Go to the previous channel in your history.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Alt</kbd> <kbd>→</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>]</kbd></td>
|
||||
<td>Go to the next channel in your history.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Shift</kbd> <kbd>↑</kbd> (in input field)</td>
|
||||
<td><kbd>⇧</kbd> <kbd>↑</kbd> (in input field)</td>
|
||||
<td>Highlight text to the previous line.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Shift</kbd> <kbd>↓</kbd> (in input field)</td>
|
||||
<td><kbd>⇧</kbd> <kbd>↓</kbd> (in input field)</td>
|
||||
<td>Highlight text to the next line.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Shift</kbd> <kbd>Enter</kbd> (in input field)</td>
|
||||
<td><kbd>⇧</kbd> <kbd>Enter</kbd> (in input field)</td>
|
||||
<td>Create a new line.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<Note>
|
||||
|
||||
Though Mattermost keyboard shortcuts support standard languages and keyboard layouts, they may not work if you use keymapping that overwrites default browser shortcuts.
|
||||
|
||||
</Note>
|
||||
|
||||
## Calls
|
||||
|
||||
The following keyboard shortcuts are supported in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app when [calls](/end-user-guide/collaborate/make-calls) are enabled.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>On Windows & Linux</th>
|
||||
<th>On Mac</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Alt</kbd> <kbd>S</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⌥</kbd> <kbd>S</kbd></td>
|
||||
<td>Start or join call in current channel.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>Space</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>Space</kbd></td>
|
||||
<td>Mute or unmute.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>Y</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>Y</kbd></td>
|
||||
<td>Raise or lower hand.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>E</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>E</kbd></td>
|
||||
<td>Share or unshare screen.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Alt</kbd> <kbd>P</kbd> or <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>P</kbd></td>
|
||||
<td><kbd>⌥</kbd> <kbd>P</kbd> or <kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>P</kbd></td>
|
||||
<td>Show or hide participants list.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>L</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>L</kbd></td>
|
||||
<td>Leave current call.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Space</kbd></td>
|
||||
<td><kbd>Space</kbd></td>
|
||||
<td>Hold to unmute (push to talk) <code>Note</code>: works in the expanded view/popout window only.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Navigation in the desktop app
|
||||
|
||||
The following navigation keyboard shortcuts are supported only in the Mattermost desktop app.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="desktop-app-v6-x" label="Desktop app v6.x">
|
||||
|
||||
Mattermost desktop app v6.0 introduces the ability to keep multiple workspaces open at the same time and work across them without constant switching contexts. The following keyboard shortcuts help you navigate multiple views:
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>On Windows & Linux</th>
|
||||
<th>On macOS</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>N</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>N</kbd></td>
|
||||
<td>Open a new window for the current server</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>T</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>T</kbd></td>
|
||||
<td>Open a new tab for the current server</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Tab</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>Tab</kbd></td>
|
||||
<td>Go to the next tab</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>Tab</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>Tab</kbd></td>
|
||||
<td>Go to the previous tab</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>1-9</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>1-9</kbd></td>
|
||||
<td>Jump to a specific tab based on its position</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>W</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>W</kbd></td>
|
||||
<td>Close current tab when multiple tabs are open</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>W</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>W</kbd></td>
|
||||
<td>Close main window</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="desktop-app-v5-x" label="Desktop app v5.x">
|
||||
|
||||
Mattermost desktop app v5.0 introduces additional ways to navigate your Mattermost interface, including server selections, as well as tabs for channels, collaborative playbooks, and boards.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>On Windows & Linux</th>
|
||||
<th>On macOS</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>F</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>F</kbd></td>
|
||||
<td>Move focus to the <strong>Search</strong> field and search the current channel.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>S</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⌃</kbd> <kbd>S</kbd></td>
|
||||
<td>Open the <strong>Servers</strong> selector, press <kbd>↑</kbd> or <kbd>↓</kbd> to navigate between servers, then press <kbd>Enter</kbd> on Windows or Linux, or <kbd>↵</kbd> on macOS, to select a server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>1</kbd><br/><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>2</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⌃</kbd> <kbd>1</kbd><br/><kbd>⌘</kbd> <kbd>⌃</kbd> <kbd>2</kbd></td>
|
||||
<td>Navigate to the first server in the <strong>Servers</strong> list.<br/>Replace the number with the server's position within the server in the list.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Tab</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>Tab</kbd></td>
|
||||
<td>Navigate to the next product tab based on the current product selected.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>Tab</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>Tab</kbd></td>
|
||||
<td>Navigate to the previous product tab based on the current product selected.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>1</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>1</kbd></td>
|
||||
<td>Navigate to the <strong>Channels</strong> tab.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>2</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>2</kbd></td>
|
||||
<td>Navigate to the <strong>Boards</strong> tab.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>3</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>3</kbd></td>
|
||||
<td>Navigate to the <strong>Playbooks</strong> tab.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="desktop-app-v4-7-and-earlier" label="Desktop app v4.7 and earlier">
|
||||
|
||||
Mattermost desktop app v4.7 and earlier releases support the following navigation keyboard shortcuts:
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>On Windows & Linux</th>
|
||||
<th>On macOS</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>F</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>F</kbd></td>
|
||||
<td>Move focus to the <strong>Search</strong> field and search the current channel.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>1</kbd><br/><kbd>Ctrl</kbd> <kbd>2</kbd><br/><kbd>Ctrl</kbd> <kbd>3</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>1</kbd><br/><kbd>⌘</kbd> <kbd>2</kbd><br/><kbd>⌘</kbd> <kbd>3</kbd></td>
|
||||
<td>Navigate to the first server in the <strong>Servers</strong> list.<br/>Replace the number with the server's tab position.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Tab</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>Tab</kbd></td>
|
||||
<td>Navigate to the next server tab based on the current server selected.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>Tab</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>Tab</kbd></td>
|
||||
<td>Navigate to the previous server tab based on the current server selected.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Alt</kbd> <kbd>↓</kbd></td>
|
||||
<td><kbd>⌥</kbd> <kbd>↓</kbd></td>
|
||||
<td>Next channel or direct message in the channel sidebar.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Zoom in & zoom out display
|
||||
|
||||
The following display keyboard shortcuts work in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost desktop app.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>On Windows & Linux</th>
|
||||
<th>On macOS</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>+</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>+</kbd></td>
|
||||
<td>Increase font size (zoom in).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>-</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⇧</kbd> <kbd>-</kbd></td>
|
||||
<td>Decrease font size (zoom out).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<Note>
|
||||
|
||||
Though Mattermost keyboard shortcuts support standard languages and keyboard layouts, they may not work if you use keymapping that overwrites default browser shortcuts.
|
||||
|
||||
</Note>
|
||||
82
docs/main/end-user-guide/collaborate/learn-about-roles.mdx
Normal file
82
docs/main/end-user-guide/collaborate/learn-about-roles.mdx
Normal file
@@ -0,0 +1,82 @@
|
||||
---
|
||||
title: "Learn about Mattermost roles"
|
||||
---
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
There are 6 types of user roles with different permission levels in Mattermost: [system admin](#system-admin), [team admin](#team-admin), [channel admin](#channel-admin), [member](#member), [guest](#guest), and [deactivated](#deactivated).
|
||||
|
||||
<Tip>
|
||||
|
||||
To view a list of users on the team and what their roles are, you need to be A team admin using Mattermost in a web browser or the desktop app. Open the Team menu and select **Manage Members**.
|
||||
|
||||
</Tip>
|
||||
|
||||
## System admin
|
||||
|
||||
The first user added to a newly-installed Mattermost system is assigned the system admin role. System admins are allowed to perform any actions on the system, and only a system admin can make changes to another system admin user account in Mattermost.
|
||||
|
||||
The system admin is typically a member of the IT staff and has all the privileges of a team admin, along with the following additional privileges:
|
||||
|
||||
- Access to the System Console in any team site.
|
||||
- Ability to change any setting on the Mattermost server available in the System Console.
|
||||
- Ability to promote and demote other users from Member role to system admin role (and vice versa).
|
||||
- Ability to promote and demote other users to and from Guest role.
|
||||
- Ability to deactivate user accounts and to reactivate them.
|
||||
- Access to private channels, but only if given the link to the private channel.
|
||||
|
||||
A system admin can view and manage users in **System Console \> User Management \> Users**. They can search users by name, filter users by teams, and filter to view other system admins, guests, as well as activated and deactivated users.
|
||||
|
||||
### Grant personal access tokens
|
||||
|
||||
System admin also can enable [personal access tokens](https://developers.mattermost.com/integrate/admin-guide/admin-personal-access-token/) for user accounts. This gives specific users permissions to create personal access tokens via **System Console \> Users**.
|
||||
|
||||
In addition, a system admin can optionally set the following permissions for the account, which are useful for integrations and bot accounts:
|
||||
|
||||
- **post:all**: Allows the account to post to all Mattermost channels including direct messages.
|
||||
- **post:channels**: Allows the account to post to all Mattermost public channels.
|
||||
|
||||
## Team admin
|
||||
|
||||
When a team is first created, the person who set it up is made a team admin. It is a team-specific role, meaning that someone can be a team admin for one team but only a member on another team. Team admins have the following privileges:
|
||||
|
||||
- Access to the **Team Settings** menu.
|
||||
- Ability to change the team name and import data from Slack export files.
|
||||
- Access to the **Manage Members** menu, where they can control whether team members are a **Member** or a **Team Admin**.
|
||||
- Ability to manage all aspects of a team, such as joining and managing private channels they're not a member of.
|
||||
- Ability to create and manage [attribute-based channel membership policies](/administration-guide/manage/admin/abac-team-channel-policies) for channels within the team, from the **Channel Membership** tab in Team Settings, when ABAC is enabled by a System Admin (Enterprise Advanced).
|
||||
- From Mattermost v11.10, ability to define [attribute-based team membership rules](/administration-guide/manage/admin/abac-team-membership) that control who can be a member of the team itself, from the **Team Membership** tab in Team Settings, when ABAC is enabled by a System Admin (Enterprise Advanced).
|
||||
|
||||
## Channel admin
|
||||
|
||||
The person who creates a channel is assigned the channel admin role for that channel. People with the channel admin role have the following privileges:
|
||||
|
||||
- Ability to assign the channel admin role to other members of the channel.
|
||||
- Ability to remove the channel admin role from other holders of the channel admin role.
|
||||
- Ability to remove members from the channel.
|
||||
- Ability to configure channel actions that automate tasks based on trigger conditions, such as [joining a channel](/end-user-guide/collaborate/join-leave-channels#join-a-channel) or [sending a message](/end-user-guide/collaborate/send-messages) in a channel.
|
||||
|
||||
Depending on your system configuration, channel admins can be granted special permissions by the system admin to rename and delete channels.
|
||||
|
||||
## Member
|
||||
|
||||
This is the default role given to users when they join a team. Members have basic permissions on a Mattermost team. See the [advanced permissions backend infrastructure](/administration-guide/onboard/advanced-permissions-backend-infrastructure) documentation for details.
|
||||
|
||||
## Guest
|
||||
|
||||
A guest is a role with restricted permissions. Guests enable organizations to collaborate with users outside of their organization, and control what channels they are in and who they can collaborate with. See the [guest accounts](/administration-guide/onboard/guest-accounts) documentation for details on working with guest accounts.
|
||||
|
||||
## Deactivated
|
||||
|
||||
A system admin can deactivate user accounts via **System Console \> Users**. A list of all users on the server can be searched and filtered to make finding users easier. Select the user's role and in the menu that opens, then select **Deactivate**. See the [deactivate user accounts admin](/administration-guide/configure/user-management-configuration-settings#deactivate-users) documentation for details.
|
||||
|
||||
When **Deactivate** is selected, the user is logged out of the system, and receives an error message if they try to log back in. The user no longer appears in channel member lists, and they are removed from the team members list. A deactivated account can also be reactivated from the System Console, in which case the user rejoins channels and teams that they previously belonged to.
|
||||
|
||||
Direct message channels with deactivated users are hidden in users' sidebars, but can be reopened using the **More...** button or by pressing <kbd>Ctrl</kbd> <kbd>K</kbd> on Windows or Linux, or <kbd>⌘</kbd> <kbd>K</kbd> on Mac.
|
||||
|
||||
Mattermost is designed as a system-of-record, so there isn't an option to delete users from the Mattermost system, as such an operation could compromise the integrity of message archives.
|
||||
|
||||
<Note>
|
||||
|
||||
AD/LDAP user accounts can't be deactivated from Mattermost; they must be deactivated from your Active Directory.
|
||||
|
||||
</Note>
|
||||
368
docs/main/end-user-guide/collaborate/make-calls.mdx
Normal file
368
docs/main/end-user-guide/collaborate/make-calls.mdx
Normal file
@@ -0,0 +1,368 @@
|
||||
---
|
||||
title: "Make calls"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Using a web browser, the desktop app, or the mobile app, you can [join a call](#join-a-call) or [start a call](#start-a-call), [share your screen](#share-your-screen), raise your hand, [react using emojis](#react-using-emojis) during a call, [chat in a thread](#chat-in-a-call), and continue working in Mattermost during a call.
|
||||
|
||||
<Note>
|
||||
|
||||
- All Mattermost customers can start, join, and participate in 1:1 audio calls with optional screen sharing.
|
||||
- For group calls up to 50 concurrent users, Mattermost Enterprise, Professional, or Mattermost Cloud is required.
|
||||
- Enterprise customers can also [record calls](#record-a-call), enable [live text captions](/end-user-guide/collaborate/make-calls#live-captions-during-calls) during calls, and [transcribe recorded calls](#transcribe-recorded-calls). We recommend that Enterprise self-hosted customers looking for group calls beyond 50 concurrent users consider using the [dedicated RTCD service](/deployment-guide/calls/calls-deployment-guide).
|
||||
- Mattermost Cloud users can start calling right out of the box. For Mattermost self-hosted deployments, System admins need to enable and configure the plugin [using the System Console](/administration-guide/configure/plugins-configuration-settings#calls).
|
||||
|
||||
</Note>
|
||||
|
||||
<PlanAvailability slug="academy-calls" />
|
||||
|
||||
## Join a call
|
||||
|
||||
To join a call, select **Join call** in a channel, group message, or direct message. Any active team member in a channel or message can join a call, whether it's a public or private channel, or a group or direct message.
|
||||
|
||||
<Tip>
|
||||
|
||||
- You can share a call's link to use in a meeting request or share with other people. The link is unique to each channel, and contains the channel's ID, so it doesn't change between calls. Use the `/call link` slash command to generate a shareable link. The call link is valid for long as the channel is active. When a channel is archived or deleted, the share link becomes invalid.
|
||||
- If someone from outside of the organization wants to join a call, you need to provide them with a guest account, and add them to the channel. Users who are archived or not registered can't join a call.
|
||||
|
||||
</Tip>
|
||||
|
||||
From Mattermost v9.4:
|
||||
|
||||
- You can join the same call using a web browser, the desktop app, and the mobile app. You can mute, unmute, react, share your screen, and configure voice settings independently for each Mattermost client you're using. You'll appear multiple times as a call participant in the call widget when you join one call on multiple clients.
|
||||
- You'll see incoming call notifications for direct and group messages when a new call is started. Multiple calls will result in multiple incoming call notifications. If you're already in a call, and you receive a new incoming call notification, Mattermost prompts you to **Join** the incoming call, or dismiss the notification.
|
||||
|
||||
## Start a call
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
To start a call, select **Start call** in the channel header. When you start a call, you become the call host by default. See the [host controls](#host-controls) section below for details on host controls available to ensure calls run smoothly.
|
||||
|
||||
<Tip>
|
||||
|
||||
- When you start a call in a channel, you're muted by default. In a direct or group message you're unmuted by default.
|
||||
- You can move the call widget to a different area of your screen.
|
||||
- Alternatively, you can start a call using the `/call start` slash command.
|
||||
|
||||
</Tip>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
To start a call, go the channel info menu. Then tap **Start Call**.
|
||||
|
||||

|
||||
|
||||
After starting the call, audio will come through the device's speaker or a Bluetooth device, if connected. On Android, audio output will automatically switch to a Bluetooth device if one is connected during a call. You can tap the **Speaker** icon to manually select the output device.
|
||||
|
||||
On iOS, audio will automatically come through a connected device. You can override this behavior by tapping the **Speaker** button. Audio will then come through the speaker. However, you cannot manually select an output device on iOS at this time.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Host controls
|
||||
|
||||
From Mattermost v9.9, and Mattermost mobile v2.17, call host controls are available and include the ability to [transfer host duties](#transfer-host-duties), [remove call participants](#remove-call-participants), [stop a screen share](#stop-a-screen-share), [mute or unmute participants](#mute-participants), [lower raised hands](#lower-raised-hands), and [end the call for everyone](#end-the-call-for-everyone).
|
||||
|
||||
Host controls are available to call hosts and admins in both the call widget by selecting the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a participant's name, and in the expanded the call window as hosts hover over a call participant in the list.
|
||||
|
||||
### Transfer host duties
|
||||
|
||||
Transfer host duties to another call participant by accessing the host controls and selecting **Make host**. Once host duties are transferred to someone else, you can't access host controls unless they're transferred back to you. System admins can change the host at any time.
|
||||
|
||||
### Remove call participants
|
||||
|
||||
Remove a call participant from an active call by accessing the host controls and selecting **Remove from call**, then confirm by selecting **Yes, remove**. The call participant is notified that they've been removed from the call by the host.
|
||||
|
||||
### Stop a screen share
|
||||
|
||||
Stop a call participant's screen share by accessing the host controls and selecting **Stop screen share**.
|
||||
|
||||
### Mute participants
|
||||
|
||||
Invite muted participants to unmute their microphone by accessing the host controls and selecting **Ask to unmute**. The call particpant is prompted to decide whether unmute or stay muted.
|
||||
|
||||
You can mute the microphone of specific particpants by accessing the host controls and toggling the particpant's mute icon. Mute all call particpants by selecting **Mute all**.
|
||||
|
||||
### Lower raised hands
|
||||
|
||||
Lower a raised hand by accessing the host controls and selecting **Lower hand**. The participant is notified that their hand was lowered by the host.
|
||||
|
||||
### End the call for everyone
|
||||
|
||||
From Mattermost v10.2 and mobile v2.19, call hosts who choose to leave a call are prompted to confirm whether they want to leave or end the call for all participants.
|
||||
|
||||
## Share your screen
|
||||
|
||||
During a call, call participants can share their screen with other call participants, unless your system admin has [disabled your ability to do so](/administration-guide/configure/plugins-configuration-settings#allow-screen-sharing).
|
||||
|
||||
<Note>
|
||||
|
||||
Screensharing is available in the Mattermost desktop app or a web browser. The ability to screenshare using the mobile app isn't supported.
|
||||
|
||||
</Note>
|
||||
|
||||
To share your screen:
|
||||
|
||||
1. In the call widget, select **Start presenting**.
|
||||
2. Select the screen you want to share.
|
||||
3. To stop sharing, select the **Stop presenting** icon or the **Stop sharing** option.
|
||||
|
||||
### Share audio during screen sharing
|
||||
|
||||
From Mattermost Calls plugin v1.9.0, you can share audio along with your screen during screen sharing. To enable this feature, you must first turn on the **Share sound with screen** preference in your Calls settings by going to **Settings \> Plugin Preferences \> Calls**. This setting is stored locally on each client and is not synchronized across devices.
|
||||
|
||||
<Note>
|
||||
|
||||
Audio sharing support varies by platform and browser:
|
||||
|
||||
**Web browsers:**
|
||||
|
||||
- **Chrome-based browsers only** (Google Chrome, Chromium, Microsoft Edge): When sharing a browser tab, you'll have the option to include audio from that tab. On Windows only, you can also share system sounds when sharing the entire screen.
|
||||
- **Other browsers**: Audio sharing is not supported.
|
||||
|
||||
**Desktop app:**
|
||||
|
||||
- **Windows and Linux**: System audio is shared when sharing the entire screen.
|
||||
- **macOS**: Audio sharing is not supported due to system limitations.
|
||||
|
||||
</Note>
|
||||
|
||||
## React using emojis
|
||||
|
||||
All call participants can use emojis to react during a call.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Expand the call window using the arrows in the top-right of the call widget. From there, select the emoji icon to access frequently-used emojis or select additional emojis from the emoji picker.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Expand the call window using the arrows in the top-right of the active call banner. From there, select **React**.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Chat in a call
|
||||
|
||||
A chat thread is created automatically for every new call.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Open the chat thread in the widget by selecting the **Gear** <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> icon, then select **Show chat thread**. Alternatively, expand the call window using the arrows in the top-right of the call widget. From there, select the chat icon to access the chat thread.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Expand the call window using the arrows in the top-right of the active call banner. Then select **More \> Call Thread**.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Record a call
|
||||
|
||||
<PlanAvailability slug="ent-plus" />
|
||||
|
||||
From Mattermost v7.7, if you're the host of a meeting, you can record the call, unless your system admin has [disabled the host's ability to do so](/administration-guide/configure/plugins-configuration-settings#enable-call-recordings).
|
||||
|
||||
Call recordings include audio, any screen sharing during the call, and text transcriptions, when [enabled](/administration-guide/configure/plugins-configuration-settings#enable-call-transcriptions).
|
||||
|
||||
The default setting for a recording is 60 minutes, but your system admin may [change the recording duration](/administration-guide/configure/plugins-configuration-settings#maximum-call-recording-duration) as needed. You'll receive a reminder 10 minutes before the recording limit is reached. If your call is going to continue beyond the recording limit, allow the first recording to complete, then start a new recording immediately after.
|
||||
|
||||
When you stop recording, the recording file is posted in the call thread as an MP4 file attachment. It's available to all users in the channel both during the call, and after the call has ended.
|
||||
|
||||
To record a call:
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
1. Select **Start call** in the header of the channel, group message, or direct message.
|
||||
2. Select the pop-out icon.
|
||||
3. In the call widget, select the **Record** button.
|
||||
4. To stop recording, select the **Record** button again.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
To start recording, use the `/call recording start` slash command. When you're finished recording, use the `/call recording stop` slash command.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
Alternatively, expand the call window using the arrows in the top-right of the active call banner. Then select the **Record** button. To finish, tap on **Stop Recording** button.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Live captions during calls
|
||||
|
||||
<PlanAvailability slug="ent-plus" />
|
||||
|
||||
From Mattermost v9.7, and Mattermost mobile app v.2.16, all call participants can display real-time text captions by selecting the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon and **Show live captions** when the call is being recorded, and when [live captions are enabled](/administration-guide/configure/plugins-configuration-settings#enable-live-captions). Live captions can be helpful in cases where noise is preventing you from hearing the audio of participants clearly.
|
||||
|
||||
By default, live captions display in English. Your Mattermost system admin can [specify a different language for live captions](/administration-guide/configure/plugins-configuration-settings#live-captions-language) in the System Console.
|
||||
|
||||
<Note>
|
||||
|
||||
- The ability to enable live captions during Mattermost calls is currently in [Beta](/administration-guide/manage/feature-labels#beta).
|
||||
- Your system admin must enable [call recordings](/administration-guide/configure/plugins-configuration-settings#enable-call-recordings) to enable live captions.
|
||||
|
||||
</Note>
|
||||
|
||||
## Transcribe recorded calls
|
||||
|
||||
<PlanAvailability slug="ent-plus" />
|
||||
|
||||
From Mattermost v9.4, and Mattermost mobile app v.2.13, call recordings can include text captions, and a transcription text file can be generated, unless your system admin has [disabled the ability to transcribe call recordings](/administration-guide/configure/plugins-configuration-settings#enable-call-transcriptions).
|
||||
|
||||
When call recording stops, the transcription file is posted in the call thread as a TXT file attachment. It's available to all users in the channel both during the call, and after the call has ended. Additionally, users viewing the call recording can show or hide text captions using the Closed Captioning option in the video player.
|
||||
|
||||
<Note>
|
||||
|
||||
- The ability to enable recorded call transcriptions is currently in [Beta](/administration-guide/manage/feature-labels#beta).
|
||||
- Your system admin must enable [call recordings](/administration-guide/configure/plugins-configuration-settings#enable-call-recordings) to enable recorded call transcriptions.
|
||||
|
||||
</Note>
|
||||
|
||||
## Frequently asked questions
|
||||
|
||||
### Can I set a ring tone for incoming calls?
|
||||
|
||||
Yes! From Mattermost v8.0 and Calls v0.17.0, desktop app and web users can go to **Settings \> Notifications \> Desktop Notifications** to enable Mattermost to alert you to incoming calls through direct or group messages with a specific ring tone and a desktop notification, unless the system admin has [disabled your ability to do so](/administration-guide/configure/plugins-configuration-settings#enable-call-ringing).
|
||||
|
||||
### Is video supported?
|
||||
|
||||
From Mattermost Calls plugin v1.12.0, experimental video support is available in direct message (DM) calls on the desktop and web apps. It's disabled by default; a system admin can enable it using the [Enable video calls in DMs (Experimental)](/administration-guide/configure/plugins-configuration-settings#enable-video-calls-in-dms-experimental) plugin setting in the System Console. The following limitations apply:
|
||||
|
||||
- Video is available in DM calls only. All other calls continue to support voice calling and screen sharing only.
|
||||
- Video isn't available on the mobile app. Mobile users can't start a video call, and when they join a DM call that includes video, it behaves like an audio call — they hear voice and see shared screens, but don't see video.
|
||||
- Call recordings don't capture video. Recordings include voice and screen sharing only.
|
||||
|
||||
### Can I password-protect a call?
|
||||
|
||||
No. Any member with sufficient permission to access the channel can join the call.
|
||||
|
||||
### Is there encryption?
|
||||
|
||||
Media (audio/video) is encrypted using security standards as part of WebRTC. It's mainly a combination of DTLS and SRTP. It's not e2e encrypted in the sense that in the current design all media needs to go through Mattermost which acts as a media router and has complete access to it. Media is then encrypted back to the clients so it's secured during transit. In short: only the participant clients and the Mattermost server have access to unencrypted call data.
|
||||
|
||||
### Are there any third-party services involved?
|
||||
|
||||
The only external service used is Mattermost official STUN server (`stun.global.calls.mattermost.com`) which is configured as default. This is primarily used to find the public address of the Mattermost server. The only information sent to this service is the IP addresses of clients connecting as no other traffic goes through it. It can be removed in the System Console if you want to provide an `ICE Host Override` setting instead.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### My audio doesn't work when I join a call
|
||||
|
||||
If you can hear the other participants in the call but they can't hear you, select the Gear icon <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> next to the call end button in the widget. From there, you can check and change your audio output and microphone settings. Select <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> again to close the menu. Alternatively, you can [manage your audio and microphone preferences](/end-user-guide/preferences/manage-your-plugin-preferences) in **Settings**.
|
||||
|
||||
### My call is disconnected after a few seconds
|
||||
|
||||
This is usually a sign that the underlying UDP channel has not been established and the connection times out after ~10 seconds. When the connection has been established correctly an `rtc connected` line should appear in the client-side logs (JS console). There isn't a single solution as it depends on your infrastructure/deployment specifics. However, if you're a system or network admin, you may need to open up the UDP port or configure the network accordingly.
|
||||
|
||||
### I can't screen share using Mattermost desktop on macOS
|
||||
|
||||
There's a known bug on macOS with some versions of Chrome (which is used by Mattermost desktop). If you've given screen sharing permissions to Mattermost desktop, and are still unable to screen share, do the following:
|
||||
|
||||
1. Quit Mattermost.
|
||||
2. Open Terminal.
|
||||
3. In the terminal, run: `tccutil reset ScreenCapture Mattermost.Desktop`
|
||||
4. Restart Mattermost and start a call.
|
||||
5. Select **Screen share** and give it permissions again.
|
||||
6. Restart Mattermost again.
|
||||
|
||||
If the issue persists please post on the Mattermost Community Server in the [Developer: Calls](https://community.mattermost.com/core/channels/developers-channel-call) channel to troubleshoot further.
|
||||
|
||||
## Debugging
|
||||
|
||||
If you experience issues with calls, collecting information is helpful as you can share it with us for debugging purposes.
|
||||
|
||||
As with any other issue, but more importantly with calls, it’s very useful to let us know the date and time that the problem occurred, with as much detail as possible so that information can be cross-checked with server logs. Also please include any reproduction steps if applicable. Other important information includes:
|
||||
|
||||
- Browser/app version
|
||||
- Operating system type and version
|
||||
|
||||
### JS console logs
|
||||
|
||||
#### Web app
|
||||
|
||||
<table>
|
||||
<colgroup>
|
||||
<col style={{width: '13%'}} />
|
||||
<col style={{width: '86%'}} />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Browser</th>
|
||||
<th>Action</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><strong>Chrome</strong></td>
|
||||
<td>CMD+OPTION+J (macOS) CTRL+SHIFT+J (Windows, Linux, ChromeOS)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Firefox</strong></td>
|
||||
<td>CMD+SHIFT+J (macOS)/CTRL+SHIFT+J (Windows, Linux, ChromeOS)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Safari</strong></td>
|
||||
<td>Enable Developer Menu in <strong>Safari > Preferences > Advanced > Show Develop Menu in Menu Bar</strong>. Then <strong>Develop > Show Javascript Console</strong>. Right-click on the console and select <strong>Save to file</strong> to download the logs.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### Desktop app
|
||||
|
||||
In the top menu bar of the app, select **View \> Developer Tools \> Developer Tools for Current Tab**. In the logs that are generated, right-click and select **Save as** to download the logs.
|
||||
|
||||
#### Mobile app
|
||||
|
||||
You can access and share debug logs from **Account screen \> Settings \> Report a problem**.
|
||||
|
||||
### Call stats dump
|
||||
|
||||
In cases where there are audio/video issues, difficulty in hearing other participants, and/or stuttering video and/or choppy audio, run the `/call stats` slash command in the channel where the call is currently active. This returns a JSON object via an ephemeral message. Additionally, run the `/call logs` command to review the client logs for the last call session.
|
||||
|
||||
You can run this command in an active call or after leaving the call in question. However, we will only save data for the last joined call so joining again will delete the previous call's feedback.
|
||||
|
||||
### WebRTC internals (Chrome and Firefox only)
|
||||
|
||||
This is an additional method for Chrome and Firefox users in cases where there are audio/video issues, difficulty in hearing other participants, and/or stuttering video and/or choppy audio.
|
||||
|
||||
#### Chrome browser (recommended)
|
||||
|
||||
Open `chrome://webrtc-internals/` in the browser that you're using for the active call.
|
||||
|
||||
#### Firefox browser
|
||||
|
||||
Open `about://webrtc` in the browser that you're using for the active call.
|
||||
|
||||
### Share information
|
||||
|
||||
Debug information is helpful to our community as there may be other community members having the same issue as you. We recommend that debug information be shared in either of the two options below:
|
||||
|
||||
- Post in [Developers: Calls](https://community.mattermost.com/core/channels/developers-channel-call) channel: prefer this method when possible but keep in mind the channel is public.
|
||||
- Post in [Team: Calls](https://community.mattermost.com/private-core/channels/calls-team) channel: use this channel if posting sensitive information.
|
||||
@@ -0,0 +1,139 @@
|
||||
---
|
||||
title: "Manage channel bookmarks"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
From Mattermost v10.1, you can bookmark up to 50 links or files to the top of channels for quick and easy access, unless your system admin has disabled your ability to do so. Bookmarks display directly under channel headers. Files added as channel bookmarks are also [searchable](/end-user-guide/collaborate/search-for-messages) in Mattermost.
|
||||
|
||||
## Open a bookmark
|
||||
|
||||
Opening a channel bookmark works the same way as selecting a file link or attachment in a message. Select or tap a bookmark to view the file or link.
|
||||
|
||||
From Mattermost v10.11, bookmarks containing `mattermost://` links open directly in the desktop app using deep linking. This turns bookmarks into one-click shortcuts to channels, threads, or messages, letting you jump straight to key assets in Mattermost quickly and easily.
|
||||
|
||||
## Add a bookmark
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
1. From Mattermost v10.5, select the channel name at the top of the center pane to access the drop-down menu, and select **Bookmarks Bar** to add a link or attach a file. In Mattermost versions prior to v10.5, select **Add a bookmark** in the bookmarks bar instead.
|
||||
|
||||
> - Select **Add a link** to specify the link URL, specify bookmark text, and an optional bookmark icon.
|
||||
> - Select **Attach a file** to select a file, specify bookmark text, and an optional bookmark icon.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
The bookmarks bar is hidden when a channel has no bookmarks.
|
||||
|
||||
1. In a channel, select the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon.
|
||||
|
||||

|
||||
|
||||
2. Select **View info**.
|
||||
|
||||

|
||||
|
||||
3. Tap on **Add a bookmark** to add the first bookmark.
|
||||
|
||||

|
||||
|
||||
For subsequent bookmarks, select the **Plus** <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> icon in the bookmarks bar.
|
||||
|
||||

|
||||
|
||||
4. You can either select **Add a link** to specify the link URL, specify bookmark text, and an optional bookmark icon.
|
||||
|
||||

|
||||
|
||||
Or you can select **Add a file** to select a file, specify bookmark text, and an optional bookmark icon.
|
||||
|
||||

|
||||
|
||||
5. Tap on **Save**.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Manage bookmarks
|
||||
|
||||
You can [edit](#edit-bookmarks) and [delete](#delete-bookmarks) bookmarks, as well as [copy bookmark links](#copy-bookmark-links). Additionally, web and desktop users can [reorder bookmarks](#reorder-bookmarks), and mobile users can [share bookmarks](#share-bookmarks). Changes to bookmarks are visible to all channel members.
|
||||
|
||||
### Reorder bookmarks
|
||||
|
||||
Using Mattermost in a web browser or the desktop app, drag bookmarks to reorder them in the bookmarks bar. Reordering channel bookmarks changes the display order for all channel members.
|
||||
|
||||
<Note>
|
||||
|
||||
You can't reorder channel bookmarks using the mobile app.
|
||||
|
||||
</Note>
|
||||
|
||||
### Edit bookmarks
|
||||
|
||||
You can make changes to the bookmark link or file, the bookmark title, or the optional bookmark icon. Editing a bookmark changes the bookmark for all channel members.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a bookmark and select **Edit**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Long-press on a bookmark and select **Edit**.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
### Share bookmarks
|
||||
|
||||
Using the mobile app, long-press on a bookmark and select **Share**.
|
||||
|
||||
### Copy bookmark links
|
||||
|
||||
You can copy bookmark links when your system admin has [enabled your ability to do so](/administration-guide/configure/site-configuration-settings#enable-public-file-links).
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a bookmark and select **Copy link**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Long-press on a bookmark and select **Copy link**.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
### Delete bookmarks
|
||||
|
||||
Deleting a channel bookmark deletes it for all channel members.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a bookmark and select **Delete**.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Long-press on a bookmark and select **Delete**.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
165
docs/main/end-user-guide/collaborate/manage-channel-members.mdx
Normal file
165
docs/main/end-user-guide/collaborate/manage-channel-members.mdx
Normal file
@@ -0,0 +1,165 @@
|
||||
---
|
||||
title: "Manage channel members"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
## Add members to a channel
|
||||
|
||||
Any member of a channel can add other members to public or private channels, unless your system admin has restricted access to do so.
|
||||
|
||||
When a channel has [attribute-based access controls](/administration-guide/manage/admin/attribute-based-access-control) enabled, you'll see details about which user attributes are permitted access to the channel. Behavior differs by channel type:
|
||||
|
||||
- **Private channels**: Only users who meet the requirements appear in search results when adding members, and only those users can be added.
|
||||
- **Public channels**: All eligible team members appear in search results, and users who meet the recommended attributes are labeled **Recommended**. Anyone can still be added because public-channel access controls are advisory and never remove existing members.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
To add members to a channel:
|
||||
|
||||
1. Select the channel name at the top of the center pane to access the drop-down menu, then select **Add Members**.
|
||||
|
||||

|
||||
|
||||
2. Search for users, select users, then select **Add** to add users to the current channel. Mattermost notifies you when a user is already a member of the channel.
|
||||
|
||||
<div class="tip">
|
||||
|
||||
<div class="title">
|
||||
|
||||
Tip
|
||||
|
||||
</div>
|
||||
|
||||
- From Mattermost v7.8, people you've messaged directly are listed first, followed by all users in alphabetical order.
|
||||
- Alternatively, to add members to a channel, select the channel name, select the **View Info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon, select **Members** in the right pane, and then select **Add**. If the channel has access control restrictions, you'll see details about required attributes at the top of the right pane.
|
||||
|
||||
</div>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
To add members to a channel:
|
||||
|
||||
1. Tap the channel name at the top of the screen.
|
||||
|
||||

|
||||
|
||||
2. Tap **Add members**.
|
||||
|
||||

|
||||
|
||||
3. Select members to add to the channel. You can scroll through the alphabetical list of members, or search for members in the Search field.
|
||||
|
||||

|
||||
|
||||
4. Tap **Add Members**.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
### Mention users
|
||||
|
||||
You can also [@mention users](/end-user-guide/collaborate/mention-people) to add them to a channel. If they're not a channel member, Mattermost prompts you to add them.
|
||||
|
||||

|
||||
|
||||
### Add users from their profile
|
||||
|
||||
Using a web browser or the desktop app, you can also add users to channels within their profile pop-over.
|
||||
|
||||
1. Select a user's profile image.
|
||||
|
||||
2. Tap on <img src={useBaseUrl('/img/ui/account-plus-outline_F0801.svg')} alt="Account plus outline icon used to add user to a channel." className="theme-icon" /> icon.
|
||||
|
||||

|
||||
|
||||
3. Type to find a channel name, then select a channel and choose **Add**.
|
||||
|
||||

|
||||
|
||||
## Leave a channel
|
||||
|
||||
You can leave public or private channels any time.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Select the channel name at the top of the center pane to access the drop-down menu, then select **Leave Channel**. When you have permission to manage channel members, you can also leave a channel by going to **View Info \> Members \> Manage** and selecting your own name.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
1. In a channel, tap <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> in the top right corner.
|
||||
|
||||

|
||||
|
||||
2. Tap **Leave channel**.
|
||||
|
||||

|
||||
|
||||
3. Tap on **Leave** to confirm you choice.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Remove other members from a channel
|
||||
|
||||
Any member of a channel can remove other members from a channel.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
You have two ways to remove members from a channel:
|
||||
|
||||
- Select the channel name at the top of the center pane to access the drop-down menu, then select **Manage Members**. Select the member's [user role](/end-user-guide/collaborate/learn-about-roles), then select **Remove from Channel**.
|
||||
- Select the channel's **View Info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon, and select **Members** in the right pane. From there, select **Manage**, select a user's role, then select **Remove from Channel**.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
1. In a channel, tap <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> in the top right corner.
|
||||
|
||||

|
||||
|
||||
2. Tap **View Info**.
|
||||
|
||||

|
||||
|
||||
3. Tap **Members**.
|
||||
|
||||

|
||||
|
||||
4. Tap **Manage** in the top right corner of the screen.
|
||||
|
||||

|
||||
|
||||
5. Tap a user role to change it, and tap **Remove from Channel**.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
6. Tap **Remove**.
|
||||
|
||||

|
||||
|
||||
7. Tap **Done**.
|
||||
|
||||

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

|
||||
|
||||
<Tip>
|
||||
|
||||
Marking messages as unread displays those channels as bold in the channel sidebar.
|
||||
|
||||
</Tip>
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "Mark messages as unread"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
If you read a message, but don't have time to address it right away, you can mark that message as unread. Marking a message as unread displays the channel as bold in the channel sidebar, and groups the message with all other unread messages.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Hover over the message, select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> option, then select **Mark as Unread**.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Long press a message, and then tap **Mark as Unread**.
|
||||
|
||||

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

|
||||
|
||||
Your recent mentions are shown for all of your teams.
|
||||
|
||||
Select **Jump** next to a search result in the right-hand sidebar to jump the center pane to the channel and location of the message with the mention.
|
||||
|
||||
## Confirmation dialog warnings
|
||||
|
||||
When your system admin has configured Mattermost to require confirmations for @mentions, you must confirm any mention that will trigger notifications for more than five users before sending the notification.
|
||||
|
||||
This confirmation dialog only appears when your system admin has configured this setting in the System Console. See our [configuration settings](/administration-guide/configure/site-configuration-settings#show-channel-all-or-here-confirmation-dialog) product documentation for details. This configuration setting is supported on the Mattermost Mobile App (from v1.34) if the [AD/LDAP groups](/administration-guide/onboard/ad-ldap-groups-synchronization) feature is enabled.
|
||||
|
||||
## Mention highlights
|
||||
|
||||
Valid mentions will have highlighted font text with some exceptions, for example if mentions are disabled at the channel level. The highlighted text becomes a hyperlink when a username is displayed. When the username is selected, the profile popover is displayed.
|
||||
|
||||
When mentions trigger a notification, the user being notified will see highlighted font text and highlighted font background. This functions as an identifier of which mentions in the post triggered a notification for the user.
|
||||
60
docs/main/end-user-guide/collaborate/message-priority.mdx
Normal file
60
docs/main/end-user-guide/collaborate/message-priority.mdx
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: "Set message priority"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
From Mattermost v7.7 and mobile v2.4, you can add a message priority label to root messages to make important messages requiring timely action or response more visible and less likely to be overlooked.
|
||||
|
||||
<img src={useBaseUrl('/images/MPA-Animated-GIF-Update-2023-08-15.gif')} width="700" alt="Ensure important and urgent messages stand out clearly by adding priority labels to root messages." />
|
||||
|
||||
To set the priority of a new root message:
|
||||
|
||||
1. Select the **Message Priority** <img src={useBaseUrl('/img/ui/alert-circle-outline_F05D6.svg')} alt="Mark a message as important or urgent using the Priority Message icon." className="theme-icon" /> icon in the message formatting toolbar. Select from Standard, Important, or Urgent.
|
||||
2. Select the priority for the message. Messages have a standard priority by default.
|
||||
3. Select **Apply**
|
||||
|
||||
When you send a priority message, the priority label displays next to your name in the channel, as well as the **Threads** view when others reply to the thread.
|
||||
|
||||
## Send persistent notifications
|
||||
|
||||
From Mattermost v8.0, messages marked as urgent with a priority label and containing an @mention can trigger persistent notifications that repeat until the recipient acknowledges, reacts, or replies.
|
||||
|
||||
To enable persistent notifications for a message:
|
||||
|
||||
1. Compose a root message with at least one @mention.
|
||||
2. Select the **Message Priority** <img src={useBaseUrl('/img/ui/alert-circle-outline_F05D6.svg')} alt="Mark a message as important or urgent using the Priority Message icon." className="theme-icon" /> icon in the message formatting toolbar.
|
||||
3. Select **Urgent**.
|
||||
4. Select **Send persistent notifications**.
|
||||
5. Select **Apply**.
|
||||
|
||||
<Note>
|
||||
|
||||
- @channel, @all and @here mentions don't send persistent notifications.
|
||||
- System admins can customize the maximum number of @mentions permitted, how frequently and how many persistent notifications are sent, as well as disable persistent notifications for all users, if preferred. By default, users are notified every 5 minutes for a total of 30 minutes. See the [configuration](/administration-guide/configure/site-configuration-settings#persistent-notifications) documentation for details.
|
||||
|
||||
</Note>
|
||||
|
||||
## Receive persistent notifications
|
||||
|
||||
You must have desktop and/or mobile push notifications enabled to receive persistent notifications. How you're notified depends on your [notifications preferences](/end-user-guide/preferences/manage-your-notifications) for desktop and mobile push notifications. You won't be notified when your availability is set to **Do Not Disturb**, or if you're [Out of Office](/end-user-guide/preferences/set-your-status-availability#set-your-availability). Learn more about managing and customizing how you receive [Mattermost notifications](/end-user-guide/preferences/manage-your-notifications).
|
||||
|
||||
Urgent messages show a red mention badge which remains visibible until you view the message. Selecting the **Acknowledge** icon (when present) won't impact the urgent red mention badge.
|
||||
|
||||

|
||||
|
||||
To stop receiving persistent notifications, you can reply to the thread, select the **Acknowlege** icon (when present), or react to the thread with an emoji. Persistent notifications also stop if the original message is deleted, or if the maximum number of persistent notifications are sent.
|
||||
|
||||
## Request acknowledgements
|
||||
|
||||
You can additionally request that recipients actively acknowledge the message to track that messages have been seen and actioned. By default, marking a message as Urgent priority automatically requests an acknowledgement.
|
||||
|
||||
When you request acknowledgement of a message, an **Acknowledge** <img src={useBaseUrl('/img/ui/Ack-Button-Default.svg')} alt="Select the Acknowledge button to indicate that you've read it and taken necessary action." /> button is added below the sent message. You can mark the message as acknowledged by selecting the button, and you can hover over the **Acknowledged** <img src={useBaseUrl('/img/ui/Ack-Button-Default.svg')} alt="Select the Acknowledge button to indicate that you've read it and taken necessary action." /> icon to review who has acknowledged the message.
|
||||
|
||||
<Tip>
|
||||
|
||||
- When you have push notifications enabled on mobile, you'll be notified every five minutes until you acknowledge or reply to the message.
|
||||
- After acknowledging a message, you have up to five minutes to change your mind. Select the **Acknowledged** <img src={useBaseUrl('/img/ui/Ack-Button-Default.svg')} alt="Select the Acknowledge button to indicate that you've read it and taken necessary action." /> button again to remove your name from the list of acknowledged users.
|
||||
|
||||
</Tip>
|
||||
18
docs/main/end-user-guide/collaborate/message-reminders.mdx
Normal file
18
docs/main/end-user-guide/collaborate/message-reminders.mdx
Normal file
@@ -0,0 +1,18 @@
|
||||
---
|
||||
title: "Set a reminder"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
From Mattermost v7.10, using Mattermost in a web browser or the desktop app, you can set 1 timed reminder on a post made in a channel, direct message, and group message. The ability to set up recurring reminders isn't supported.
|
||||
|
||||
Hover over the message you want to remember, select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> option, then select **Remind**. Select a time period or enter a custom date and time. You'll receive a direct message at the time you've chosen, with the body of the message you wanted to be reminded about.
|
||||
|
||||
Once you've been reminded about a message, you won't receive another reminder unless you set one.
|
||||
|
||||
<Tip>
|
||||
|
||||
From Mattermost v10.3, you can also schedule reminder messages to be sent in the future. See the [schedule messages](/end-user-guide/collaborate/schedule-messages) documentation for details.
|
||||
|
||||
</Tip>
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: "Navigate channels"
|
||||
---
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
## Navigate between channels
|
||||
|
||||
Using Mattermost in a web browser or the desktop app, you can navigate between channels by selecting the **Find channel** option in the channel sidebar, or by pressing <kbd>Ctrl</kbd> <kbd>K</kbd> on Windows or Linux, or <kbd>⌘</kbd> <kbd>K</kbd> on Mac. The Find channels screen also displays [member availability](/end-user-guide/preferences/set-your-status-availability) at a glance.
|
||||
|
||||
> 
|
||||
|
||||
## Return to recently viewed channels
|
||||
|
||||
Using a web browser or the desktop app, use the **History** arrows at the top of the sidebar to move back and forth through your channel history.
|
||||
|
||||
- Select the left arrow to go back one page.
|
||||
- Select the right arrow to go forward one page.
|
||||
113
docs/main/end-user-guide/collaborate/organize-conversations.mdx
Normal file
113
docs/main/end-user-guide/collaborate/organize-conversations.mdx
Normal file
@@ -0,0 +1,113 @@
|
||||
---
|
||||
title: "Organize conversations using threaded discussions"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Threads are a key part of the messaging experience in Mattermost. They're used to organize conversations and enable users to discuss topics without adding noise to channels or direct messages.
|
||||
|
||||
Threaded discussions offers an enhanced experience for users communicating in threads and replying to messages that includes a unified threads inbox to read all conversations in one view. Threads improve the ability to process channel content, find, follow, and resume conversations more easily, and keep threaded conversations focused.
|
||||
|
||||

|
||||
|
||||
<Note>
|
||||
|
||||
- From Mattermost v7.0, threaded discussions are enabled by default for all new Mattermost deployments. All Mattermost users can create new threads, unless the system admin has [disabled the ability to do so](/administration-guide/configure/site-configuration-settings#threaded-discussions).
|
||||
- System admins can [configure default availability and user opt-in](/administration-guide/configure/site-configuration-settings#threaded-discussions) of threaded discussions.
|
||||
|
||||
</Note>
|
||||
|
||||
## Start or reply to threads
|
||||
|
||||
[Replies to messages](/end-user-guide/collaborate/reply-to-messages) are collapsed under the first message of a thread. Open a thread by selecting the message or reply count.
|
||||
|
||||
From Mattermost v11.2, when using Mattermost in a web browser, you can open threads in separate browser windows by selecting the **New Window** <img src={useBaseUrl('/img/ui/dock-window_F10AC.svg')} alt="Open thread in a new browser window icon." /> icon in the thread header. This allows you to view and participate in multiple threads simultaneously without losing context.
|
||||
|
||||
## Follow threads and messages
|
||||
|
||||
You'll automatically follow every thread you participate or are mentioned in. You can manually follow particular messages and threads so that any reply activity triggers [notifications](/end-user-guide/preferences/manage-your-notifications). Follow or unfollow any thread, at any time. In channels, a dot next to thread participants means there are unread replies for the threads you're following.
|
||||
|
||||

|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Toggle the thread’s **Follow** option, or select **Follow thread** from the **More Actions** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon.
|
||||
|
||||

|
||||
|
||||
<Tip>
|
||||
|
||||
- Follow messages with no replies from the **More Actions** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon to be notified if someone replies to the message later based on your notification preferences.
|
||||
- You can also use keyboard arrow keys to navigate threads in the **Threads** view.
|
||||
|
||||
</Tip>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Long-press on a message to access message options, then tap **Follow Thread**.
|
||||
|
||||

|
||||
|
||||
Alternatively, you can also tap on the **Follow** indicator below a message thread to follow it.
|
||||
|
||||

|
||||
|
||||
<Tip>
|
||||
|
||||
Follow messages with no replies from the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon to be notified if someone replies to the message later based on your notification preferences.
|
||||
|
||||

|
||||
|
||||
</Tip>
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Unfollow threads
|
||||
|
||||
If you’re no longer interested in a or message thread, unfollow it to stop receiving notifications. Viewing a thread without responding to it doesn’t automatically follow that thread.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Toggle the thread’s **Following** indicator, or select **Unfollow thread** from the **More Actions** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon to unfollow it.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Long-press on a message to access message options, then tap **Unfollow Thread**.
|
||||
|
||||

|
||||
|
||||
Alternatively, you can tap on the **Following** indicator below the message thread to unfollow it.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## View all threads
|
||||
|
||||
Select **Threads** at the top of the channel sidebar to see all your followed threads on the currently selected team. Threads with the most recent replies display at the top of the list.
|
||||
|
||||
Select **Unreads** to filter your followed threads by only those with unread replies.
|
||||
|
||||

|
||||
|
||||
## Tutorial video
|
||||
|
||||
<script src="https://fast.wistia.com/embed/medias/5gjgi10rr0.jsonp" async></script><script src="https://fast.wistia.com/assets/external/E-v1.js" async></script><div class="wistia_responsive_padding" style={{padding: '56.25% 0 0 0', position: 'relative'}}><div class="wistia_responsive_wrapper" style={{height: '100%', left: '0', position: 'absolute', top: '0', width: '100%'}}><div class="wistia_embed wistia_async_5gjgi10rr0 videoFoam=true" style={{height: '100%', position: 'relative', width: '100%'}}><div class="wistia_swatch" style={{height: '100%', left: '0', opacity: '0', overflow: 'hidden', position: 'absolute', top: '0', transition: 'opacity 200ms', width: '100%'}}><img src="https://fast.wistia.com/embed/medias/5gjgi10rr0/swatch" style={{filter: 'blur(5px)', height: '100%', objectFit: 'contain', width: '100%'}} alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div>
|
||||
<br />
|
||||
|
||||
## Known issues
|
||||
|
||||
Threaded discussions were released as generally available in Mattermost v7.0, including significant server performance improvements and more flexible configuration options for system admins to enable the feature by default. We highly recommended [upgrading Mattermost](/administration-guide/upgrade/upgrading-mattermost-server) to take advantage of configuration and performance enhancements.
|
||||
@@ -0,0 +1,87 @@
|
||||
---
|
||||
title: "Manage custom groups"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Custom groups reduce noise and improve focus by notifying the right people in a channel at the right time, while maintaining transparency for all members in that channel. Custom user groups let you notify up to 256 users at a time rather than notifying users individually.
|
||||
|
||||
For example, perhaps you want to @mention a cross-functional team about a bug fixes needed for an upcoming feature release, without notifying everyone else in the channel. Using a custom group notifies the cross-functional team immediately, while keeping important stakeholders in the loop on the status of the feature release.
|
||||
|
||||
Or perhaps you want to add a group of users to a team and a channel. When you @mention a custom group in a channel, Mattermost prompts you to add anyone from that custom group who isn't already a channel and team member. See the [invite people to your workspace](/end-user-guide/collaborate/invite-people) documentation for details.
|
||||
|
||||
Once a custom user group has been created, you can mention that group the same way you @mention another Mattermost member. See the [mention people in messages](/end-user-guide/collaborate/mention-people) documentation for details.
|
||||
|
||||
<Note>
|
||||
|
||||
- System admins need to enable this feature. See our [Mattermost Configuration Settings](/administration-guide/configure/site-configuration-settings#enable-custom-user-groups) documentation for details.
|
||||
- From Mattermost v7.2, system admins can limit who can manage custom user groups through the Custom Group Manager system admin role. See the [delegated granular administration](/administration-guide/onboard/delegated-granular-administration) documentation for details.
|
||||
- The ability to create custom user groups on mobile will be available in a future release. @mentions for custom user groups on mobile work the same as [LDAP-synced groups](/end-user-guide/collaborate/mention-people#groupname).
|
||||
|
||||
</Note>
|
||||
|
||||
## Create a custom group
|
||||
|
||||
1. Using Mattermost in a web browser or the desktop app, select <img src={useBaseUrl('/img/ui/plus_F0415.svg')} alt="The Plus icon provides access to channel and direct message functionality." className="theme-icon" /> at the top of the channel sidebar, then select **Create New User Group**.
|
||||
2. Specify a name and mention. The mention is the handle you use to @mention a notification to the group. Group names must be unique across the Mattermost [workspace](/end-user-guide/end-user-guide-index). If a name is in use as a channel name, display name, or another custom group's name, it won't be available.
|
||||
3. Search for and select members to add to the custom user group, then select **Create Group**.
|
||||
|
||||
## Review group members
|
||||
|
||||
From Mattermost v7.8, using Mattermost in a web browser or the desktop app, select a group mention in a thread to display a list of group members.
|
||||
|
||||
## Manage custom user groups
|
||||
|
||||
You can review and filter the list of custom groups, add people to an existing group, edit the group name or mention, leave the group, or archive the group.
|
||||
|
||||
To manage a custom user group in a web browser or the desktop app, select **User Groups** from the Products menu, then select the group you want to modify.
|
||||
|
||||

|
||||
|
||||
### Review available groups
|
||||
|
||||
Review a list of all available custom user groups, search for specific groups by name.
|
||||
|
||||
<Tip>
|
||||
|
||||
You can filter the list of groups to display only groups you're a member of, or only archived groups.
|
||||
|
||||
</Tip>
|
||||
|
||||
### Change name or mention
|
||||
|
||||
1. From the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon to the right of any custom group, select **View Group**.
|
||||
|
||||
> 
|
||||
|
||||
2. From the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon, select **Edit Details**.
|
||||
|
||||
> 
|
||||
|
||||
3. Update the **Name** or **Mention**, then select **Save Details**.
|
||||
|
||||
### Add people
|
||||
|
||||
1. Select **Add People**.
|
||||
2. Search for and select people to add to the group, then select **Add People**.
|
||||
|
||||
### Remove people
|
||||
|
||||
Hover over a member, then select the **Trash** icon to remove them from the group.
|
||||
|
||||
### Join a group
|
||||
|
||||
While viewing the members of a group, from the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon, select **Join Group**.
|
||||
|
||||
### Leave a group
|
||||
|
||||
From the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon, select **Leave Group**.
|
||||
|
||||
### Archive group
|
||||
|
||||
From the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon, select **Archive Group**. When you archive a custom user group, you won’t be able to mention the group’s handle or view its members. However, the group isn't deleted from the list, and all members remain in the group unless they're manually removed.
|
||||
|
||||
### Unarchive group
|
||||
|
||||
From Mattermost v9.1, you can restore an archived group. From the **More Actions** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon, filter the list of groups to show only archived groups. Select an archived group to view details about the group, if preferred, and then select **Restore Group**.
|
||||
109
docs/main/end-user-guide/collaborate/organize-using-teams.mdx
Normal file
109
docs/main/end-user-guide/collaborate/organize-using-teams.mdx
Normal file
@@ -0,0 +1,109 @@
|
||||
---
|
||||
title: "Organize using teams"
|
||||
---
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
A team is a digital [workspace](/end-user-guide/end-user-guide-index) where you and your teammates can collaborate in Mattermost. Depending on how Mattermost is [set up](/administration-guide/configure/experimental-configuration-settings#primary-team) in your organization, you can belong to one team or multiple teams, and [access to the team](/end-user-guide/collaborate/team-settings#access-settings) can be open or restricted.
|
||||
|
||||
Users with the **Create Teams** permission can [create new teams](#create-a-team) and [manage team settings](/end-user-guide/collaborate/team-settings) for existing teams. System admins can grant the **Create Team** permission to roles via the [System scheme](/administration-guide/onboard/advanced-permissions#system-scheme) or the [Team override scheme](/administration-guide/onboard/advanced-permissions#team-override-scheme).
|
||||
|
||||
## Single team versus multiple teams
|
||||
|
||||
Mattermost can be deployed both to a single team and to multiple teams. Currently, we recommend deploying to a single team for the following reasons:
|
||||
|
||||
- Single team deployments promote communication across the organization. When you add multiple teams, groups can become isolated.
|
||||
- Integrations (e.g., webhooks and slash commands) are only persistent across single team deployments.
|
||||
|
||||
However, some Mattermost customers prefer multiple team deployments for the following reasons:
|
||||
|
||||
- Teams are useful when there is a purpose for each of them. For example, one team is used for staff members and another team for external users.
|
||||
- Performance is better when users are scattered across multiple teams instead of all in the same one. With multiple teams, there is less content to load per team or channel switch and database queries are faster.
|
||||
- Creating a shared team for all users, and using advanced permissions to control who can create channels and add members to the shared team, improves cross-team collaboration when using multiple teams. Additionally, an annoucement banner can be used to provide system-wide announcements.
|
||||
- The platform supports multiple team functionalities including general search, saved posts, and recent mentions across teams.
|
||||
|
||||
## Team sidebar
|
||||
|
||||
If you belong to more than one team, a team sidebar displays to the left of the channel sidebar. Drag teams to reorder them in the sidebar. You can also use keyboard shortcuts to navigate between teams.
|
||||
|
||||

|
||||
|
||||
## Create a team
|
||||
|
||||
You can create a team using a web browser or the desktop app by selecting a team name, and then selecting **Create a Team**, unless your system admin has disabled your ability to do so.
|
||||
|
||||

|
||||
|
||||
### Team name and URL selection
|
||||
|
||||
There are a few details and restrictions to consider when selecting a team name and team URL.
|
||||
|
||||
<Note>
|
||||
|
||||
If your system admin has enabled anonymous team and channel URLs (available in Mattermost Enterprise Advanced from v11.6.0), team creation becomes a single-step flow and you will not be prompted to choose a team URL. The URL is assigned automatically.
|
||||
|
||||
</Note>
|
||||
|
||||
#### Team name
|
||||
|
||||
This is the display name of your team that appears in menus and headings.
|
||||
|
||||
- Team names can contain any letters, numbers, or symbols.
|
||||
- Team names are case sensitive.
|
||||
- Team names must be 2 - 64 characters in length.
|
||||
|
||||
#### Team URL
|
||||
|
||||
If your system admin has not enabled anonymous URLs, you choose a team URL during team creation. The team URL is part of the web address that navigates to your team on the system domain, `https://domain.com/teamurl/`.
|
||||
|
||||
- Teams may contain only lowercase letters, numbers, and dashes.
|
||||
- Teams must start with a letter and cannot end in a dash.
|
||||
- Teams must be 2 - 64 characters in length.
|
||||
- Team names cannot start with the following restricted words: `admin`, `api`, `channel`, `claim`, `error`, `files`, `help`, `landing`, `login`, `mfa`, `oauth`, `plug`, `plugins`, `post`, `signup`, or `playbooks`.
|
||||
|
||||
## Join a team
|
||||
|
||||
You can join any open teams, or join any team you receive an invitation to join.
|
||||
|
||||
If you haven't yet joined any teams in Mattermost, you're prompted to join available teams when you [log in to Mattermost](/end-user-guide/access/access-your-workspace).
|
||||
|
||||
You can be a member of multiple teams at the same time. To join additional teams, select the current team name, choose **Join Another Team**, and select the name of the team you want to join.
|
||||
|
||||

|
||||
|
||||
<Note>
|
||||
|
||||
When your organization uses [team membership access policies](/administration-guide/manage/admin/abac-team-membership), the list of teams you can join depends on your user attributes. Public teams whose requirements you meet are marked **Recommended**, and private teams whose requirements you don't meet aren't listed at all.
|
||||
|
||||
</Note>
|
||||
|
||||
From Mattermost Mobile v2.40.0, you can join another team from the mobile app by tapping the team name in the channel list header, then tapping **Join Another Team**.
|
||||
|
||||
## Leave a team
|
||||
|
||||
Users can also choose to remove themselves from a team, from **Team menu \> Leave Team**. This will remove the user from the team, and from all public channels and private channels on the team.
|
||||
|
||||
From Mattermost Mobile v2.40.0, you can leave a team from the mobile app when you belong to more than one team. In the channel list, tap the team name, tap **Leave team**, then confirm.
|
||||
|
||||
They will only be able to rejoin the team if it's open, or if they receive a new invitation. If they do rejoin, they will no longer be a part of their old channels.
|
||||
|
||||
## Remove people from teams
|
||||
|
||||
Team admins can remove users from a team via **Team menu \> Manage Members \> Remove From Team** in the dropdown menu beside a user entry.
|
||||
|
||||
When a user is removed from a team, the team will no longer be visible or accessible in their team sidebar. If they currently have the team open, they are redirected to the first team that appears in their team sidebar. If they didn't belong to any other teams, the user is sent to the team selection page.
|
||||
|
||||
Removing a user from the team does not deactivate the account. The user will still be able to log in to the site, and join other teams. They will also be able to rejoin the team they were removed from if they receive another invite. When a private team has a team membership access policy, invited users must also satisfy that policy. Users can also rejoin if the team is set to [Public Team](/end-user-guide/collaborate/team-settings#discoverability) and they meet any other join restrictions, such as approved email domains. Team membership access policies on public teams are advisory and don't prevent users from rejoining. If the user does rejoin the team, they will no longer belong to the channels they were previously a part of, and they will lose all Admin privileges if they had them previously.
|
||||
|
||||
A system admin can also remove users from teams via **System Console \> Users**, and selecting the dropdown beside a user entry and selecting **Manage Teams**. The list of teams an individual user belongs to can be viewed on the user's profile page via **System Console \> Users** and selecting the member's name from the list provided in the **User Configuration** screen.
|
||||
|
||||
## Archive a team
|
||||
|
||||
A Mattermost system admin can archive teams they no longer need by going to **System Console \> Teams**, selecting a team, and selecting **Archive Team**. Archived teams can be unarchived if needed.
|
||||
|
||||
When a team is archived, the team will no longer be visible or accessible in the team sidebar for any user. If users currently have the team open when it's being archived, users are redirected to the first time that appears in their team sidebar. If users didn't belong to any other teams, users are sent to the team selection page.
|
||||
|
||||
<Note>
|
||||
|
||||
Archiving a team doesn't remove the team data from the Mattermost database. Teams may still be accessible by using the Mattermost API.
|
||||
|
||||
</Note>
|
||||
100
docs/main/end-user-guide/collaborate/react-with-emojis-gifs.mdx
Normal file
100
docs/main/end-user-guide/collaborate/react-with-emojis-gifs.mdx
Normal file
@@ -0,0 +1,100 @@
|
||||
---
|
||||
title: "React with emojis and GIFs"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Emojis and GIFs are small, digital images, animated images, or icons you can use to communicate or express concepts such as emotions, humor, and physical gestures in your messages.
|
||||
|
||||
From Mattermost v10.10, text emoticons (such as `:)` or `:D`) are automatically converted to emoji characters in your messages by default. You can [disable this auto-rendering](/end-user-guide/preferences/manage-your-display-options#render-emoticons-as-emojis) if you prefer to keep emoticons as text.
|
||||
|
||||
## Quick emoji reactions
|
||||
|
||||
You can react with up to 50 emojis per message. Recently used emojis are sorted based on how often you've used them. Don't see your most recently used emojis? Enable quick reactions by going to **Settings \> Display** and enabling **Quick reactions on messages**.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Hover over a message to select a recently used emoji.
|
||||
|
||||
> 
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Long press on a message, and then select a recently used emoji.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Include emojis and GIFs in messages
|
||||
|
||||
<Tip>
|
||||
|
||||
Can't find the perfect emoji? [Upload your own custom emoji](#upload-custom-emojis).
|
||||
|
||||
</Tip>
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Select the **Smile** icon <img src={useBaseUrl('/img/ui/emoticon-plus-outline_E80F.svg')} alt="Use the Smile icon to add emojis to your message." className="theme-icon" /> inside the Mattermost message input box to open the emoji and GIF picker.
|
||||
|
||||
Select an emoji from the **Emojis** tab, or switch to the **GIFs** tab to search for a GIF.
|
||||
|
||||
You can also specify emojis based on their name. Type `:` followed by at least two characters of the word describing the emoji. This opens an emoji autocomplete. Descriptions include skin tone details for people-based emojis, where supported.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Select the <img src={useBaseUrl('/img/ui/emoticon-plus-outline_E80F.svg')} alt="Use the Smile icon to add emojis to your message." className="theme-icon" /> to add an emoji. Mattermost accesses the emojis and GIFs available on your mobile device. You can also specify emojis based on their name. Type at least two characters of the word describing the emoji. This opens an emoji autocomplete.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Manage emojis
|
||||
|
||||
Using Mattermost in a web browser or the desktop app, you can select recently used emojis, select a default skin tone for people-based emojis, as well as manage custom emojis. From Mattermost mobile v2.37.0, you can select custom emojis and apply custom skin tones on mobile devices.
|
||||
|
||||
### Select default skin tone
|
||||
|
||||
Select the **Skin tone** icon in the top right corner of the emoji picker to specify the skin tone you prefer to use for people-based emojis by default. You can select an alternate skin tone at any time.
|
||||
|
||||

|
||||
|
||||
## Upload custom emojis
|
||||
|
||||
Using Mattermost in a web browser or the desktop app, you can upload new emojis that everyone in your Mattermost [workspace](/end-user-guide/end-user-guide-index) can access to react to messages, unless your system admin has [disabled your ability to do so](/administration-guide/configure/site-configuration-settings#enable-custom-emoji).
|
||||
|
||||
1. From the emoji picker, select **Custom Emoji**.
|
||||
|
||||

|
||||
|
||||
2. Enter a name for your custom emoji. This is the name that shows up in the emoji autocomplete.
|
||||
3. Choose **Select**, then select the image to use for the emoji. Small, square pictures work best when selecting an image to upload. The file can be any JPG, GIF, or PNG that's up to 512 KiB in size. Mattermost limits the number of frames allowed in animated GIF emojis.
|
||||
4. Select **Save**. Once saved, your emoji is added to the list of custom emoji.
|
||||
|
||||

|
||||
|
||||
4. To use your custom emoji in a message, select it from the emoji picker, or type `:` followed by your emoji name to bring it up in the emoji autocomplete.
|
||||
|
||||
### Remove custom emojis
|
||||
|
||||
Using Mattermost in a web browser or the desktop app, you can remove custom emojis that you uploaded to Mattermost.
|
||||
|
||||
1. Open the emoji picker.
|
||||
2. Select **Custom Emoji**.
|
||||
3. If required, use the Search bar to find your custom emoji in the list.
|
||||
4. Under **Actions** select **Delete**.
|
||||
5. Choose **Delete** to confirm.
|
||||
|
||||

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

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Long press on a message and select **Reply** or simply tap on it to reply.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
Depending on how your system admin has configured Mattermost, you may be able to [edit](/end-user-guide/collaborate/send-messages#edit-messages), [restore](/end-user-guide/collaborate/send-messages#restore-a-previous-version-of-an-edited-message), and [delete](/end-user-guide/collaborate/send-messages#delete-messages) messages after you've sent them.
|
||||
|
||||
<Tip>
|
||||
|
||||
It's easy to return to a message in progress with global message drafts. Find all of your draft messages in the **Drafts** view available at the top of the channel sidebar. See the [draft messages](/end-user-guide/collaborate/send-messages#draft-messages) documentation for details.
|
||||
|
||||
</Tip>
|
||||
|
||||
## Organize discussions into threads
|
||||
|
||||
When you reply to messages, those replies are [organized into a discussion thread](/end-user-guide/collaborate/organize-conversations). Threaded discussions are easy to follow and allow multiple parallel conversations to occur at the same time without confusion.
|
||||
|
||||
Using Mattermost in a web browser or the desktop app, replies appear indented slightly in the center pane to indicate that they are child messages of a parent message. Selecting the reply link opens a sidebar in the right-hand sidebar in a web browser and the desktop app. To expand the right-hand sidebar to its full width, select the **Expand** icon with two arrows at the top of the sidebar.
|
||||
|
||||

|
||||
|
||||
To shrink the right-hand sidebar to its original width, select the same **Collapse** icon.
|
||||
|
||||

|
||||
121
docs/main/end-user-guide/collaborate/save-pin-messages.mdx
Normal file
121
docs/main/end-user-guide/collaborate/save-pin-messages.mdx
Normal file
@@ -0,0 +1,121 @@
|
||||
---
|
||||
title: "Save and pin messages"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
You have two ways to mark a post to make it easy to find later:
|
||||
|
||||
- [Saving a message](#save-messages) saves it for only you.
|
||||
- [Pinning a message](#pin-messages) marks it for an entire channel.
|
||||
|
||||
## Save messages
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Save messages for later follow up by selecting the **Save** <img src={useBaseUrl('/img/ui/bookmark-outline_F00C3.svg')} alt="Save icon." className="theme-icon" /> icon next to a message.
|
||||
|
||||

|
||||
|
||||
To see all of your saved messages, select the **Bookmark** icon to the left of your profile picture. The right-hand sidebar opens to show the list of saved messages.
|
||||
|
||||
Remove an item from your **Saved Posts** list by selecting the **Save** icon next to message to clear it.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Long press a message, and then select **Save**.
|
||||
|
||||

|
||||
|
||||
To see all of your saved messages, tap the **Save** <img src={useBaseUrl('/img/ui/bookmark-outline_F00C3.svg')} alt="Save icon." className="theme-icon" /> icon at the bottom of the app.
|
||||
|
||||

|
||||
|
||||
Remove an item from your **Saved Messages** list by long pressing a message and selecting **Unsave**.
|
||||
|
||||

|
||||
|
||||
Alternatively, you can also tap on the saved message in a channel and then tap the <img src={useBaseUrl('/img/ui/bookmark_F00C0.svg')} alt="Saved icon." className="theme-icon" /> icon below it to unsave.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Pin messages
|
||||
|
||||
All members of a channel can pin important or useful messages to that channel. The list of pinned messages is visible to all channel members. There is no limit to the number of pinned posts in a channel. From Mattermost v10.2, the **Pinned** <img src={useBaseUrl('/img/ui/pin-outline_F0931.svg')} alt="Pin icon used to indicate when there are pinned messages in a given channel." /> icon is hidden when no messages are pinned.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
1. Hover over the message that you want to pin. The **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon link appears.
|
||||
2. Select the **More** option, then select **Pin to channel**.
|
||||
|
||||

|
||||
|
||||
Pinned messages are marked with the pinned icon. For example:
|
||||
|
||||

|
||||
|
||||
To see all pinned messages in a channel, select the **Pinned posts** icon in the channel header.
|
||||
|
||||

|
||||
|
||||
The right-hand sidebar opens to show the list of pinned messages. For example:
|
||||
|
||||

|
||||
|
||||
To unpin a message:
|
||||
|
||||
1. Mouse over the message that you want to unpin. The **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon link appears.
|
||||
2. Select the **More** icon, then select **Unpin from channel**
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Long press a message, and then select **Pin to Channel**.
|
||||
|
||||

|
||||
|
||||
To see all of your pinned messages in a channel:
|
||||
|
||||
1. Tap the channel whose pinned messages you want to review.
|
||||
|
||||

|
||||
|
||||
2. Tap the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon located in the top right corner of the app.
|
||||
|
||||

|
||||
|
||||
3. Tap **View Info**.
|
||||
|
||||

|
||||
|
||||
4. Tap **Pinned Messages**.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
Remove an item from your **Pinned Messages** list by long pressing a message and selecting **Unpin from Channel**.
|
||||
|
||||

|
||||
|
||||
Alternatively, you can long press on a pinned message in the channel and then tap on **Unpin from Channel** to unpin it.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
68
docs/main/end-user-guide/collaborate/schedule-messages.mdx
Normal file
68
docs/main/end-user-guide/collaborate/schedule-messages.mdx
Normal file
@@ -0,0 +1,68 @@
|
||||
---
|
||||
title: "Schedule messages"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
There are times when you want to send a message, but you don’t want it sent immediately. For example, it may be after working hours for the recipient. Scheduled messages can include a [priority](/end-user-guide/collaborate/message-priority), [request acknowledgements](/end-user-guide/collaborate/message-priority#request-acknowledgements), include [file attachments](/end-user-guide/collaborate/share-files-in-messages), and include anything that a non-scheduled message can contain, except [slash commands](/integrations-guide/run-slash-commands).
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
From Mattermost v10.3, you can schedule messages to send in the future. Compose a message, then select the right side of **Send** to schedule when the message will be sent. You can choose from a fixed time or set a custom time, and Mattermost displays both your local time and the recipient’s local time.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
From Mattermost mobile v2.28, you can schedule messages to send in the future. Compose a message, then long press on **Send** to schedule when the message will be sent. You can choose from a fixed time or set a custom time, and Mattermost displays both your local time and the recipient’s local time.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Manage scheduled messages
|
||||
|
||||
Once you schedule a message to send in the future, that message is available within the [Drafts view](/end-user-guide/collaborate/send-messages#draft-messages), under the **Scheduled** tab.
|
||||
|
||||
You can manage scheduled messages with the following actions:
|
||||
|
||||
- **Delete scheduled post**: Confirm that you want to delete the message.
|
||||
- **Edit scheduled post**: Make changes to the draft inline before its sent.
|
||||
- **Copy text**: Copy the draft text.
|
||||
- **Reschedule message**: Change when the message should be sent.
|
||||
- **Send now**: Confirm that you want to send the message immediately.
|
||||
|
||||
<img src={useBaseUrl('/images/manage-scheduled-message.png')} width="600" alt="Once a message is scheduled, you can delete, edit, and reschedule it, copy the message text, or send it immediately." />
|
||||
|
||||
<Note>
|
||||
|
||||
Once you schedule a message, file attachments are read-only and can't be changed.
|
||||
|
||||
</Note>
|
||||
|
||||
## Troubleshoot scheduled messages
|
||||
|
||||
Scheduled messages may fail for the following reasons:
|
||||
|
||||
- You're no longer a member of the channel.
|
||||
- The channel is archived.
|
||||
- The channel is read-only.
|
||||
- The Mattermost server was down for more than 24 hours. Mattermost processes scheduled posts up to 24 hours old, so in cases where the server is down for short time, scheduled messages will be processed. Scheduled messages older than 24 hours may fail to send.
|
||||
|
||||
If a scheduled message fails to send, you'll be alerted 2 ways:
|
||||
|
||||
- A red badge displays a total scheduled post count in the left pane next to **Drafts**. <img src={useBaseUrl('/img/ui/schedule-count-red-badge.png')} alt="Total count of scheduled messages." />
|
||||
- An alert banner displays on the **Scheduled** tab
|
||||
|
||||
<img src={useBaseUrl('/images/troubleshoot-scheduled-message.png')} width="600" alt="If a scheduled draft message can't be sent, Mattermost provides context about why it can't be sent on the Scheduled tab under Drafts." />
|
||||
|
||||
<Note>
|
||||
|
||||
You can't reschedule a failed message, but you can schedule a new replacement message.
|
||||
|
||||
</Note>
|
||||
224
docs/main/end-user-guide/collaborate/search-for-messages.mdx
Normal file
224
docs/main/end-user-guide/collaborate/search-for-messages.mdx
Normal file
@@ -0,0 +1,224 @@
|
||||
---
|
||||
title: "Search for messages"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Use Mattermost search to find messages, replies, and the contents of files. You can also search by [hashtags](#hashtags), perform more advanced searches using [search modifiers](#search-modifiers), or adjust search results to show messages from the current team, a specific team, or all teams.
|
||||
|
||||
## Search for message
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
1. Select the Search field, select **Messages**, enter your search criteria.
|
||||
|
||||
> 
|
||||
>
|
||||
> 
|
||||
|
||||
2. By default, your search results include messages from all channels within your current team. From Mattermost v10.8, you can select **All Teams** to search all channels across all teams, select a specific team instead, or continue searching within the current team.
|
||||
|
||||
> 
|
||||
>
|
||||
> <div class="tip">
|
||||
>
|
||||
> <div class="title">
|
||||
>
|
||||
> Tip
|
||||
>
|
||||
> </div>
|
||||
>
|
||||
> From Mattermost v10.10, the `from:` search modifier is available for cross-team searches. When searching all teams, you must manually add the `from:` modifier as part of your search criteria to search by specific users across teams.
|
||||
>
|
||||
> </div>
|
||||
|
||||
3. When message results display in the Search Results pane, select **Jump** to view a full message in context.
|
||||
|
||||
> 
|
||||
|
||||
<Tip>
|
||||
|
||||
From Mattermost v10.8, you can also adjust your search results to show messages from the current team, a specific team, or all teams.
|
||||
|
||||
</Tip>
|
||||
|
||||
<Tip>
|
||||
|
||||
When using Mattermost in a web browser or the desktop app, you can open your current search results in a separate popout window by selecting the **Open in new window** <img src={useBaseUrl('/img/ui/dock-window_F10AC.svg')} alt="Open thread in a new browser window icon." /> icon in the search results header.
|
||||
|
||||
</Tip>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
1. Tap the **Search** <img src={useBaseUrl('/img/ui/magnify_F0349.svg')} alt="Search for messages and files in Mattermost." className="theme-icon" /> icon at the bottom of the app to search for messages or files attached to messages.
|
||||
|
||||
> 
|
||||
|
||||
2. By default, your search results include messages from all channels within your current team. From mobile v2.28, tap **All Teams** to search all channels across all teams, or select a specific team instead.
|
||||
|
||||
> 
|
||||
|
||||
3. Enter your search criteria.
|
||||
|
||||
> 
|
||||
|
||||
4. Tap to apply [search modifiers](#search-modifiers) to your search.
|
||||
|
||||
> 
|
||||
>
|
||||
> 
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Search for files
|
||||
|
||||
From the **Search** field, select **Files** to search for files attached to messages. From Mattermost v10.8 and mobile v2.28, you can specify whether you want to search all channels you're a member of in the current team, a specific team, or all channels across all teams.
|
||||
|
||||

|
||||
|
||||
File contents that match on file name, or contain matching text content within supported document types, are returned in the Search Results pane. Each search result includes file name, extension, and size details, as well as details about when and where the file was originally shared. You can adjust search results to show messages from the current team, a specific team, or all teams.
|
||||
|
||||
- For Mattermost Cloud [workspaces](/end-user-guide/end-user-guide-index), supported document file formats include PDF, PPTX, DOCX, ODT, HTML, and plain text documents. DOC and RTF file formats, as well as the contents of ZIP files, are not supported.
|
||||
- For Mattermost self-hosted deployments, supported document file formats include PDF, PPTX, DOCX, ODT, HTML, and plain text documents.
|
||||
|
||||
<Note>
|
||||
|
||||
7zip (`.7z`) files are not supported for file content search and are skipped during search indexing for security reasons. Only standard ZIP files are supported when ZIP file search is enabled.
|
||||
|
||||
</Note>
|
||||
|
||||
<Note>
|
||||
|
||||
System admins can extend file content search support for self-hosted deployments to include:
|
||||
|
||||
- [files shared before upgrading to Mattermost Server v5.35](/administration-guide/manage/mmctl-command-line-tool#mmctl-extract).
|
||||
- [DOC and RTF file formats](/administration-guide/configure/environment-configuration-settings#enable-document-search-by-content).
|
||||
- [documents within ZIP files](/administration-guide/configure/environment-configuration-settings#enable-searching-content-of-documents-within-zip-files).
|
||||
|
||||
</Note>
|
||||
|
||||
### Filter results by file type
|
||||
|
||||
Using Mattermost in a web browser or the desktop app, you can narrow search results further by selecting the **File Type Filter** option, then selecting specific file types, such as documents, spreadsheets, or images.
|
||||
|
||||

|
||||
|
||||
### Access recently shared files
|
||||
|
||||
You can access files recently shared in a channel:
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Select the <img src={useBaseUrl('/img/ui/file-text-outline_F09EE.svg')} alt="Use the Channel Files icon to search for files attached to messages in a given channel." className="theme-icon" /> icon to the right of the channel name to access files recently shared in that channel.
|
||||
|
||||

|
||||
|
||||
Alternatively, you can select the channel name, select the **View Info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon, then select **Files** in the right pane.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Tap the channel name to view channel options, then tap **Files**.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Search modifiers
|
||||
|
||||
You can apply search modifiers to any search to reduce the number of results returned. Select a search modifier to add it to the Search field. Supported modifiers are described below. Your search results include messages from all of your teams.
|
||||
|
||||
### `from:` and `in:`
|
||||
|
||||
- Use `from:` to find messages or files from specific users.
|
||||
- For example, searching `from:john.smith` only returns content from your direct message history with John Smith.
|
||||
- From Mattermost v10.10, you can use `from:` in cross-team searches to find messages from specific users across all teams you're a member of.
|
||||
- Use `in:` to find messages or files posted in specific public channels, private channels, direct messages, or group messages. You can specify channels by display name or channel ID.
|
||||
- For example, searching `Mattermost in:town-square` only returns results in the Town Square public channel that contains the term `Mattermost`, while searching `Mattermost in:john.doe` only returns results that contains the term `Mattermost` in your direct message history with John Smith.
|
||||
|
||||
### `before:`, `after:`, and `on:`
|
||||
|
||||
- Use `before:` to find messages or files posted before a specified date.
|
||||
|
||||
- For example, searching `website before: 2018-09-01` returns messages or files containing the term `website` posted prior to September 1, 2018.
|
||||
|
||||
- Use `after:` to find messages or files posted after a specified date.
|
||||
|
||||
- For example, searching `website after: 2018-08-01` returns messages or files containing the term `website` posted after August 1, 2018.
|
||||
|
||||
- Use both `before:` and `after:` together to search in a specified date range.
|
||||
|
||||
- For example, searching `website before: 2018-09-01 after: 2018-08-01` returns all messages or files containing the term `website` posted between August 1, 2018 and September 1, 2018.
|
||||
|
||||
- Use `on:` to find messages or files posted on a specific date. Use the date picker to select a date, or type it in YYYY-MM-DD format.
|
||||
|
||||
- For example, searching `website on: 2018-09-01` returns messages or files containing the term `website` posted on September 1, 2018.
|
||||
|
||||

|
||||
|
||||
### Exclusions
|
||||
|
||||
Use the hyphen `-` symbol to exclude terms from your search results. For example, searching `test -release` only returns results that include the term `test` and exclude the term `release`.
|
||||
|
||||
This exclusion modifier can be used in combination with other modifiers to further refine search results. For example, searching `test -release -in:release-discussion -from:eric` returns all results with the term `test`, excludes posts with the term `release`, excludes posts made in the `release-discussion` channel, and excludes messages sent in direct messages by `eric`.
|
||||
|
||||
### Quotation marks
|
||||
|
||||
Use quotation marks `" "` to return search results for exact terms. For example, searching `"Mattermost website"` returns messages containing the exact phrase `Mattermost website`, but doesn't return results containing `Mattermost` and `website` as separate terms.
|
||||
|
||||
### Wildcards
|
||||
|
||||
Use the asterisk `*` symbol at the end of the word to perform a wildcard search. The wildcard search returns all words that begin with the specified letters. The wildcard in search cannot be used at the beginning or in the middle of a word. For example, searching `rea*` returns messages or files containing words like `reach`, `reason`, `reality`, `real`, and other words starting with `rea`. However, searches like `*each` and `re*ch` are invalid wildcard searches.
|
||||
|
||||
### Hashtags
|
||||
|
||||
Hashtags are searchable labels for messages. Anyone can create a hashtag in a message by using the pound sign `#` followed by alphanumeric or other unicode characters. Hashtag examples include: `#bug`, `#marketing`, `#user_testing`, `#per.iod`, `#check-in`, `#마케팅`.
|
||||
|
||||
Valid hashtags:
|
||||
|
||||
- Don't start with a number.
|
||||
- Are at least three characters long, excluding the `#`.
|
||||
- Are made up of alphanumeric or other unicode characters.
|
||||
- May contain dots, dashes, or underscores.
|
||||
|
||||
To search for messages containing hashtags, select a hashtag in an existing post, or type the hashtag (including the pound `#` symbol) into the search bar.
|
||||
|
||||
<Note>
|
||||
|
||||
Hashtags don't link to channels. If you have a channel named “Marketing”, selecting a `#marketing` hashtag does not take you to the Marketing channel. To link to public channels, use the tilde `~` symbol followed by the channel name. For example `~marketing`.
|
||||
|
||||
</Note>
|
||||
|
||||
## Search public channels you haven't joined
|
||||
|
||||
<PlanAvailability slug="ent-plus" />
|
||||
|
||||
From Mattermost v11.6, when your system admin [enables searching public channels without membership](/administration-guide/configure/environment-configuration-settings#allow-searching-public-channels-without-membership), search results can include messages from public channels you haven't joined. Results are scoped to teams you belong to, so you'll only see messages from public channels in your teams. This setting doesn't affect private channels — you can only search private channels you're a member of.
|
||||
|
||||
## Notes about performing Mattermost searches
|
||||
|
||||
- Multiple-word searches return results that contain *all* of your search criteria.
|
||||
- Search modifiers can help narrow down searches. See the [search modifiers](#search-modifiers) section for details.
|
||||
- You can search Archived channels as long as you're a member of that channel.
|
||||
- If you're unable to see messages or files in archived channels in your search results, ask your system admin if **Allow users to view archived channels** has been disabled via **System Console \> Site Configuration \> Users and Teams**.
|
||||
- To remove archived channels from your search results, you can leave the Archived channels.
|
||||
- Like many search engines, common words such as `the`, `which`, and `are` (known as "stop words"), as well as two-letter and one-letter search terms, are not shown in search results because they typically return too many results. See the [Technical notes about searching](#technical-notes-about-searching) section below for details.
|
||||
- IP addresses (e.g. `10.100.200.101`) don't return results.
|
||||
|
||||
## Technical notes about searching
|
||||
|
||||
By default, Mattermost uses full text search support included in PostgreSQL. Select the **product menu** <img src={useBaseUrl('/img/ui/products_E82F.svg')} alt="Navigate between Channels, collaborative playbooks, and boards using the product menu icon." className="theme-icon" /> then select **About Mattermost** to see which database you’re using.
|
||||
|
||||
- Stop words are filtered out of search results. See [PostgreSQL](https://www.postgresql.org/docs/10/textsearch-dictionaries.html#TEXTSEARCH-STOPWORDS) database documentation for a full list of applicable stop words.
|
||||
- URLs don’t return results.
|
||||
- Hashtags or recent mentions of usernames containing a dash don't return results.
|
||||
- Terms containing a dash return incorrect results since dashes are ignored in the search engine.
|
||||
- From Mattermost v7.1, search results respect the `default_text_search_config` value instead of being hardcoded to English. We recommend that Mattermost system admins review this value to ensure it's set correctly.
|
||||
238
docs/main/end-user-guide/collaborate/send-messages.mdx
Normal file
238
docs/main/end-user-guide/collaborate/send-messages.mdx
Normal file
@@ -0,0 +1,238 @@
|
||||
---
|
||||
title: "Send messages"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
You can send messages in public and private channels as well as to other users in Mattermost. Depending on when you compose a message, you can send it immediately, [schedule it for later](/end-user-guide/collaborate/schedule-messages), or [set its priority](/end-user-guide/collaborate/message-priority).
|
||||
|
||||
Mattermost may notify you when a recipient's availability is set to [Do Not Disturb](/end-user-guide/preferences/set-your-status-availability#set-your-availability), and the recipient's local time is outside of regular business hours (between 10PM and 6AM). This warning displays directly above the message text field.
|
||||
|
||||
<Note>
|
||||
|
||||
From Mattermost v11.5, you can access help resources for message formatting by selecting the **Help** link below the message text field.
|
||||
|
||||
</Note>
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Enter a message in the text field, then select **Send** <img src={useBaseUrl('/img/ui/send_F048A.svg')} alt="Select the Send icon to post your message." className="theme-icon" /> to send the message.
|
||||
|
||||
<Tip>
|
||||
|
||||
You can also use a keyboard to send messages:
|
||||
|
||||
- Press <kbd>Enter</kbd> on Windows or Linux, or <kbd>↵</kbd> on Mac.
|
||||
- You can configure Mattermost to require <kbd>Shift</kbd> <kbd>Enter</kbd> on Windows or Linux, or <kbd>⇧</kbd> <kbd>↵</kbd> on Mac to send multi-line messages. Select the **gear** <img src={useBaseUrl('/img/ui/settings-outline_F08BB.svg')} alt="Use the Settings icon to customize your Mattermost user experience." className="theme-icon" /> icon to go to **Settings**, then select **Advanced \> Send messages on CTRL+ENTER**.
|
||||
|
||||
</Tip>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
1. Tap the text field at the bottom of the Mattermost app to type a message.
|
||||
|
||||

|
||||
|
||||
2. Tap **Send** <img src={useBaseUrl('/img/ui/send_F048A.svg')} alt="Select the Send icon to post your message." className="theme-icon" /> icon to send it in the channel.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Rewrite messages with AI
|
||||
|
||||
You can use AI to enhance your messages before sending them. This feature helps you improve writing quality, fix spelling, adjust message length, or transform your text based on specific needs.
|
||||
|
||||
From Mattermost v11.5, when you use AI Rewrite while composing a reply in a thread, the AI incorporates context from the thread to generate suggestions that better fit the ongoing conversation.
|
||||
|
||||
From Mattermost v11.7, Rewrite is accessed through the **AI Actions** <img src={useBaseUrl('/img/ui/creation-outline_F1C2B.svg')} alt="AI Actions icon." className="theme-icon" /> menu, alongside any custom prompts your system admin has made available.
|
||||
|
||||
On Web/Desktop or Mobile:
|
||||
|
||||
> 1. Type your message in the message compose field.
|
||||
> 2. Open the **AI Actions** <img src={useBaseUrl('/img/ui/creation-outline_F1C2B.svg')} alt="AI Actions icon." className="theme-icon" /> menu from the message actions, then select **Rewrite**.
|
||||
> 3. Select a bot from the list of available AI agents.
|
||||
> 4. Choose from available rewrite options:
|
||||
> - **Improve writing**: Enhance clarity and professionalism
|
||||
> - **Fix spelling**: Correct spelling and grammar errors
|
||||
> - **Shorten**: Make your message more concise
|
||||
> - **Elaborate**: Add more detail and context
|
||||
> - **Simplify**: Use clearer, easier-to-understand language
|
||||
> - **Summarize**: Condense your message to key points
|
||||
> - **Custom prompt**: Specify your own transformation instructions
|
||||
> 5. Review the AI-generated suggestion. Select **Regenerate** to try again or **Discard** to return to your original message.
|
||||
> 6. Select **Send** <img src={useBaseUrl('/img/ui/send_F048A.svg')} alt="Select the Send icon to post your message." className="theme-icon" />
|
||||
|
||||
<Tip>
|
||||
|
||||
From Mattermost v11.7, system admins can publish custom prompts that appear alongside Rewrite in the **AI Actions** <img src={useBaseUrl('/img/ui/creation-outline_F1C2B.svg')} alt="AI Actions icon." className="theme-icon" /> menu. If you don't see a custom prompt you expect, check with your system admin.
|
||||
|
||||
</Tip>
|
||||
|
||||
<Note>
|
||||
|
||||
Messages that have been rewritten using AI are automatically marked as AI-generated content for transparency. Your system admin must [configure AI agents](/administration-guide/configure/agents-admin-guide) for the rewrite feature to be available.
|
||||
|
||||
</Note>
|
||||
|
||||
## Send burn-on-read messages
|
||||
|
||||
<PlanAvailability slug="entry-adv" />
|
||||
|
||||
From Mattermost v11.3, burn-on-read messages stay concealed until recipients reveal them. After revealing, the message is deleted for that recipient when the timer expires. Burn-on-read messages can't be replied to or edited. You can send burn-on-read messages unless your system admin has [disabled the ability to do so](/administration-guide/configure/site-configuration-settings#enable-burn-on-read-messages) in your Mattermost instance.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
1. Compose your message.
|
||||
2. Select the **Burn-on-read** <img src={useBaseUrl('/img/ui/fire_F0238.svg')} alt="Burn on Read icon." className="theme-icon" /> icon in the message toolbar.
|
||||
3. Select **Send** <img src={useBaseUrl('/img/ui/send_F048A.svg')} alt="Select the Send icon to post your message." className="theme-icon" />
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
From Mattermost mobile v2.38.0, you can send burn-on-read messages from the mobile app.
|
||||
|
||||
1. Compose your message.
|
||||
2. Tap the **Burn-on-read** <img src={useBaseUrl('/img/ui/fire_F0238.svg')} alt="Burn on Read icon." className="theme-icon" /> icon in the message toolbar.
|
||||
3. Tap **Send** <img src={useBaseUrl('/img/ui/send_F048A.svg')} alt="Select the Send icon to post your message." className="theme-icon" />
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
Recipients see a concealed placeholder with **Reveal**. After revealing, a timer shows when the message will be deleted.
|
||||
|
||||
As the message sender, hover over the **Burn-on-read** <img src={useBaseUrl('/img/ui/fire_F0238.svg')} alt="Burn on Read icon." className="theme-icon" /> icon above the sent message to see how many recipients have read the message. You can also delete the burn-on-read message for all recipients before the timer expires by selecting the **Burn-on-read** <img src={useBaseUrl('/img/ui/fire_F0238.svg')} alt="Burn on Read icon." className="theme-icon" /> icon above the sent message.
|
||||
|
||||
## Draft messages
|
||||
|
||||
From Mattermost v7.7, when composing new messages, it's easy to return to a message in progress later, unless your system admin has [disabled global drafts](/administration-guide/configure/site-configuration-settings#enable-server-syncing-of-message-drafts) in the System Console.
|
||||
|
||||
By default, message drafts are synchronized on the Mattermost server and are accessible everywhere you access Mattermost, including a web browser or the desktop app. Limit drafts to your current Mattermost client only by going to **Settings \> Advanced \> Allow message drafts to sync with the server** to disable draft synchronization.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Draft messages are added to a **Drafts** view available at the top of the channel sidebar.
|
||||
|
||||
<img src={useBaseUrl('/images/Global-Drafts-Animated-GIF.gif')} width="700" alt="Global drafts makes it easy for you to find all messages in progress." />
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
When composing a message, you can simply choose to complete it later. The partially composed message is kept in the text field and an **Edit** option <img src={useBaseUrl('/img/ui/pencil-outline_F0CB6.svg')} alt="Edit icon." className="theme-icon" /> displays next to the channel name.
|
||||
|
||||
From Mattermost v10.5, you'll find local draft messages under **Drafts**. Drafts synchronized to the Mattermost server will be listed under **Drafts** in a future mobile app release.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Edit messages
|
||||
|
||||
All users can edit their own sent messages, unless the system admin has [restricted the ability to do so](/administration-guide/onboard/advanced-permissions).
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
1. Using Mattermost in a web browser or the desktop app, select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a message that you've sent.
|
||||
|
||||
> 
|
||||
|
||||
2. Select **Edit** to edit your own messages. Editing a message won't trigger new [@mention notifications](/end-user-guide/collaborate/mention-people), or [desktop notifications](/end-user-guide/preferences/manage-your-notifications).
|
||||
|
||||
<Tip>
|
||||
|
||||
From Mattermost v10.5, using a web browser or the Mattermost Desktop app, you can also change or remove message attachments when editing your sent messages.
|
||||
|
||||
</Tip>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
1. Long press on the message that you want to edit and tap on **Edit**.
|
||||
|
||||

|
||||
|
||||
2. Type the updated message and tap on **Save**.
|
||||
|
||||

|
||||
|
||||
<Tip>
|
||||
|
||||
From Mattermost v10.11 and mobile app v2.31.0, when editing messages on mobile, you can also view, delete, and save message attachments as you would when using Mattermost in a web browser or the desktop app.
|
||||
|
||||
</Tip>
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
### Restore a previous version of an edited message
|
||||
|
||||
From Mattermost v7.9, [Mattermost Enterprise or Professional](https://mattermost.com/pricing) customers can [edit or delete messages](#edit-or-delete-messages) after sending them if your system admin hasn't restricted the ability to do so using [advanced permissions](/administration-guide/onboard/advanced-permissions).
|
||||
|
||||
Message recipients can't see your message edit history, and restoring a previous message version won't trigger new [@mention notifications](/end-user-guide/collaborate/mention-people).
|
||||
|
||||
<Note>
|
||||
|
||||
Restoring a previous version of the message is available in the Mattermost desktop app or a web browser. The ability to restore using the mobile app isn't supported.
|
||||
|
||||
</Note>
|
||||
|
||||
1. Select the word **Edited** next to your message.
|
||||
2. In the right pane, review all previous versions of the message.
|
||||
3. Select the **Restore** <img src={useBaseUrl('/img/ui/restore_F099B.svg')} alt="Use the Restore icon to restore a previous version of an edited message." className="theme-icon" /> icon next to the version you want to restore.
|
||||
4. Select **Confirm**.
|
||||
|
||||

|
||||
|
||||
## Delete messages
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
All users can delete their own sent messages, unless the system admin has [restricted the ability to do so](/administration-guide/onboard/advanced-permissions).
|
||||
|
||||
1. Using Mattermost in a web browser or the desktop app, select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a message that you want to delete.
|
||||
2. Select **Delete** to delete your own messages. Select **Delete** again to confirm.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
1. Long Press on the message you want to delete and tap on **Delete**.
|
||||
|
||||

|
||||
|
||||
2. Tap on **Delete** again to confirm your choice.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Do more with your messages
|
||||
|
||||
<Tip>
|
||||
|
||||
Using a RTL plugin, Mattermost can automatically detect and display messages written using right-to-left scripts, such as Arabic, Hebrew, or Persian. Your system admin must install the [RTL Plugin](https://github.com/QueraTeam/mattermost-rtl) to enable this functionality.
|
||||
|
||||
</Tip>
|
||||
|
||||
Do more with your Mattermost messages using the following features:
|
||||
|
||||
- [Format messages](/end-user-guide/collaborate/format-messages)
|
||||
- [Mention people](/end-user-guide/collaborate/mention-people)
|
||||
- [Share files](/end-user-guide/collaborate/share-files-in-messages)
|
||||
- [Share links to channels and messages](/end-user-guide/collaborate/share-links)
|
||||
107
docs/main/end-user-guide/collaborate/share-files-in-messages.mdx
Normal file
107
docs/main/end-user-guide/collaborate/share-files-in-messages.mdx
Normal file
@@ -0,0 +1,107 @@
|
||||
---
|
||||
title: "Share files in messages"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
With file attachments, you can share additional information that helps your team to visually understand your ideas. Sharing videos, voice recordings, screenshots, and photos can make your messages more effective and clear.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
You can share files with other Mattermost users or entire channels by:
|
||||
|
||||
- Dragging and dropping files into channels.
|
||||
- Selecting the **Attachment** <img src={useBaseUrl('/img/ui/paperclip_F03E2.svg')} alt="Add a message attachment using the Upload files icon in the message formatting toolbar." className="theme-icon" /> icon in the message input box.
|
||||
- Pasting from the clipboard.
|
||||
|
||||
## Share public links
|
||||
|
||||
Public links allow you to share message attachments with anyone outside your Mattermost [workspace](/end-user-guide/end-user-guide-index). To share an attachment, select the thumbnail of an attachment, then select **Get Public Link**.
|
||||
|
||||
<Tip>
|
||||
|
||||
If **Get Public Link** is not visible in the file previewer, ask your system admin to enable the feature from the System Console under **Site Configuration \> Public Links**.
|
||||
|
||||
</Tip>
|
||||
|
||||
## Download files
|
||||
|
||||
You can download an attached file by selecting the **Download** <img src={useBaseUrl('/img/ui/download-outline_F0B8F.svg')} alt="Use the Download icon to download an attached file to your local system." className="theme-icon" /> icon next to the file thumbnail.
|
||||
|
||||
<Tip>
|
||||
|
||||
From Mattermost desktop app v5.2, you can review download status, access downloads, and clear the list of downloads from a new **Downloads** <img src={useBaseUrl('/img/ui/arrow-down-bold-circle-outline_F0048.svg')} alt="Use the desktop app download icon to review download status, as well as access and clear the list of downloaded files." className="theme-icon" /> option located in the top-right corner of the desktop app window.
|
||||
|
||||
</Tip>
|
||||
|
||||
## Access files
|
||||
|
||||
Access all files shared in a channel by selecting the **Channel files** <img src={useBaseUrl('/img/ui/file-text-outline_F09EE.svg')} alt="Use the Channel Files icon to search for files attached to messages in a given channel." className="theme-icon" /> icon in the channel header.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
You can share files with other Mattermost users or entire channels by tapping the **Attachment** <img src={useBaseUrl('/img/ui/paperclip_F03E2.svg')} alt="Add a message attachment using the Upload files icon in the message formatting toolbar." className="theme-icon" /> icon under the message input box when composing a message.
|
||||
|
||||
From Mattermost v10.7 and mobile v2.27, you can play and download audio files directly from the message thread.
|
||||
|
||||

|
||||
|
||||
## Access files on mobile
|
||||
|
||||
1. Tap the channel name at the top of the screen.
|
||||
|
||||

|
||||
|
||||
2. Tap **Files**.
|
||||
|
||||

|
||||
|
||||
3. Tap a file to download it, open it, or copy a public link to the file.
|
||||
|
||||

|
||||
|
||||
Or you can also click on <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> to download the file or open it in the channel.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
## Attachment limits and sizes
|
||||
|
||||
Up to 10 files can be attached per post. The default maximum file size is 100 MB, but this can be changed by the system admin. See our [Configuration Settings](/administration-guide/configure/environment-configuration-settings#maximum-file-size) product documentation for details.
|
||||
|
||||
Image files can be a maximum size of 7680 pixels x 4320 pixels, with a maximum image resolution of 33 MP (mega pixels) or 8K resolution, and a maximum raw image file size of approximately 253 MB. System admins can customize the maximum image resolution size within the `config.json` file. See our [Configuration Settings](/administration-guide/configure/experimental-configuration-settings#maximum-image-resolution) product documentation for details.
|
||||
|
||||
## Preview file attachments
|
||||
|
||||
Mattermost has a built-in file previewer that you can use to:
|
||||
|
||||
- Download files
|
||||
- Share public links
|
||||
- View media
|
||||
|
||||
Select the thumbnail of an attached file to open it in the file previewer.
|
||||
|
||||
### View media
|
||||
|
||||
The following media formats are supported on most browsers:
|
||||
|
||||
- Images: BMP, GIF, JPG, JPEG, PNG, SVG, WEBP
|
||||
- Video: browser supported video formats, including but not limited to MP4 and MOV
|
||||
- Audio: MP3, M4A
|
||||
- Files: PDF, TXT
|
||||
|
||||
Other document previews (such as Word, Excel, or PPT) are not yet supported.
|
||||
|
||||
## Restricted file attachments
|
||||
|
||||
If your administrator has configured attribute-based permission policies on your Mattermost instance, file uploads or downloads may be restricted based on your user attributes. Restricted attachments appear in messages with the placeholder **Files not available** and the subtitle **Access to files is restricted based on attributes**.
|
||||
|
||||
If you expect to have access to a restricted file and don't, contact your Mattermost administrator. For administrator-facing details, see [Permission policies](/administration-guide/manage/admin/abac-system-wide-policies#permission-policies).
|
||||
77
docs/main/end-user-guide/collaborate/share-links.mdx
Normal file
77
docs/main/end-user-guide/collaborate/share-links.mdx
Normal file
@@ -0,0 +1,77 @@
|
||||
---
|
||||
title: "Share links to channels and messages"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
You can share links to Mattermost [channels](#share-channel-links) and [messages](#share-message-links) with other Mattermost users.
|
||||
|
||||
## Share channel links
|
||||
|
||||
Sharing channel links makes it easy for others to find and join channels. To share a link to a channel, type `~` into the message text box, then select the channel you want to link to. If you're a member of multiple teams, only channels for the current team are listed.
|
||||
|
||||
<Tip>
|
||||
|
||||
Alternatively, you can select the **View info** <img src={useBaseUrl('/img/ui/information-outline_F02FD.svg')} alt="Use the Channel Info icon to access additional channel management options." className="theme-icon" /> icon in the top right corner of the screen to access additional channel management options, including a **Copy Link** option you can share with others.
|
||||
|
||||
</Tip>
|
||||
|
||||
## Share message links
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-desktop" label="Web/Desktop">
|
||||
|
||||
Sharing message links displays a preview of the message in the post. To share links to messages in Mattermost, select the **More** <img src={useBaseUrl('/img/ui/dots-horizontal_F01D8.svg')} alt="Use the More icon to access additional message options." className="theme-icon" /> icon next to a message, then select **Copy Link**.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
Paste the link into a message to share the image link with others. Sharing links to messages generates a preview of the message.
|
||||
|
||||

|
||||
|
||||
<Tip>
|
||||
|
||||
- You can also hover over an image and select the <img src={useBaseUrl('/img/ui/link-variant_F0339.svg')} alt="Use the Copy Link icon to copy the public URL link for an image in a message." className="theme-icon" /> icon in the top right corner.
|
||||
- The timestamp next to the username of any message is also a permanent link to that conversation.
|
||||
|
||||
</Tip>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
Long press a message, and then tap **Copy Link** to copy the link to the clipboard. Long press to paste the link as a message or reply. From mobile v2.23, sharing links to messages generates a preview of the message.
|
||||
|
||||

|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
<Note>
|
||||
|
||||
- Message previews respect channel membership permissions, so they’re only visible to users who have access to the original message. If the link is to a message in a public channel, any member of the team can see the message preview. If the link is to a message in a private channel or direct message, only members in that channel can see the message preview.
|
||||
- If you're unable to share links, contact your Mattermost system admin for assistance. An [SSL certificate (or a self-signed certificate)](/administration-guide/onboard/ssl-client-certificate) may be required for this functionality to work.
|
||||
|
||||
</Note>
|
||||
|
||||
## Deep links
|
||||
|
||||
Deep links are a powerful feature in Mattermost that allow you to create direct links to specific teams, channels, messages, or threads. These links can be used to quickly navigate to important content within Mattermost, enhancing collaboration and efficiency.
|
||||
|
||||
Deep links can also be used, in combination with bots, scripts, and integrations, to trigger specific actions within Mattermost.
|
||||
|
||||
From Mattermost v10.11, [channel bookmarks](/end-user-guide/collaborate/manage-channel-bookmarks) containing `mattermost://` open directly in the desktop app using deep linking. This turns channel bookmarks into one-click shortcuts that enable you jump straight to key assets in Mattermost quickly and easily.
|
||||
|
||||
### Format deep links
|
||||
|
||||
Deep links must be formatted in Mattermost as follows:
|
||||
|
||||
- Deep link to a team: `mattermost://<your-Mattermost-server-URL>/<team-name>`
|
||||
- Deep link to a channel: `mattermost://<your-Mattermost-server-URL>/<team-name>/channels/<channel-name>`
|
||||
- Deep link to a channel message or thread: `mattermost://<your-Mattermost-server-URL>/<team-name>/pl/<post-id>`
|
||||
- Deep link to a direct message: `mattermost://<your-Mattermost-server-URL>/<team-name>/messages/@<user-name>`
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: "Team keyboard shortcuts"
|
||||
---
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Keyboard shortcuts help you make a more efficient use of your keyboard when navigating Mattermost teams in a web browser or the desktop app.
|
||||
|
||||
<Tip>
|
||||
|
||||
See a list of available keyboard shortcuts any time by pressing <kbd>Ctrl</kbd> <kbd>/</kbd> on Windows or Linux, pressing <kbd>⌘</kbd> <kbd>/</kbd> on Mac, or using the `/shortcuts` slash command.
|
||||
|
||||
</Tip>
|
||||
|
||||
## Team navigation
|
||||
|
||||
The following keyboard shortcuts are supported in all [supported browsers](/deployment-guide/software-hardware-requirements#software-requirements) and in the Mattermost Desktop App.
|
||||
|
||||
<table>
|
||||
<colgroup>
|
||||
<col style={{width: '100%'}} />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>On Windows & Linux</th>
|
||||
<th>On Mac</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Alt</kbd> <kbd>↑</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⌥</kbd> <kbd>↑</kbd></td>
|
||||
<td>Navigate to the previous team.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Alt</kbd> <kbd>↓</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⌥</kbd> <kbd>↓</kbd></td>
|
||||
<td>Navigate to the next team.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> <kbd>Alt</kbd> <kbd>1</kbd>-<kbd>9</kbd></td>
|
||||
<td><kbd>⌘</kbd> <kbd>⌥</kbd> <kbd>1</kbd>-<kbd>9</kbd></td>
|
||||
<td>Navigate to a specific team.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<Note>
|
||||
|
||||
Though Mattermost keyboard shortcuts support standard languages and keyboard layouts, they may not work if you use keymapping that overwrites default browser shortcuts.
|
||||
|
||||
</Note>
|
||||
129
docs/main/end-user-guide/collaborate/team-settings.mdx
Normal file
129
docs/main/end-user-guide/collaborate/team-settings.mdx
Normal file
@@ -0,0 +1,129 @@
|
||||
---
|
||||
title: "Team settings"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
<PlanAvailability slug="all-commercial" />
|
||||
|
||||
Team settings enable system and team administrators to adjust settings applied to a specific team. Using Mattermost in a web browser or the desktop app, select the team name to access **Team Settings**.
|
||||
|
||||

|
||||
|
||||
## Info settings
|
||||
|
||||
Info settings provide configuration options for how teams are displayed to users.
|
||||
|
||||
### Team name
|
||||
|
||||
Your **Team Name** is displayed on the login screen, and in the top of the channel sidebar for your team.
|
||||
|
||||
Team names can contain any letters, numbers, or symbols, must be 2 - 64 characters in length, and are case-sensitive.
|
||||
|
||||
<Note>
|
||||
|
||||
Team names don't support [some unicode characters](https://www.w3.org/TR/unicode-xml/#Charlist).
|
||||
|
||||
</Note>
|
||||
|
||||
### Team description
|
||||
|
||||
Your **Team Description** is displayed when viewing the list of teams available to join and in the tooltip when hovering over the team name in the team sidebar.
|
||||
|
||||
You can enter a description up to 50 characters in length.
|
||||
|
||||
<Note>
|
||||
|
||||
Team descriptions don't support [some unicode characters](https://www.w3.org/TR/unicode-xml/#Charlist).
|
||||
|
||||
</Note>
|
||||
|
||||
### Team icon
|
||||
|
||||
A **Team Icon** displays in the team sidebar. By default, the team icon contains the first two letters of the team name.
|
||||
|
||||
To customize the team icon:
|
||||
|
||||
1. Select **Team Settings**.
|
||||
2. Select the Team Icon **Edit** option.
|
||||
|
||||

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