Files
team/docs/main/end-user-guide/access/access-your-workspace.mdx
b5f007d35e docs: fix broken path links, anchors, and tab rendering from RST-to-MDX migration (#37433)
* docs: resolve cross-file anchor mismatches from RST-to-MDX migration

The Sphinx-to-Docusaurus migration converted `:ref:`/`{ref}` links using
naive text-slugification, so anchors that pointed to headings in a
different file (e.g. release-summary tables linking into their
respective changelog pages) were emitted as same-page fragments and
silently resolved to nothing.

Built a label registry from the original Sphinx `.. _label:` / `(label)=`
targets to recover the true source file for each cross-reference, then
rewrote the affected links to point at the correct file + heading
anchor. Fixes 282 broken cross-file anchors, primarily in the mobile/
desktop/server release-summary pages, plus assorted same-page anchor
mismatches caught by re-auditing after the prior admonition/anchor fix.

* docs: manually resolve remaining anchor mismatches after cross-file audit

Hand-verified fixes for anchors that fuzzy-matching alone couldn't
safely resolve (confirmed against actual heading text/context, and in a
few cases against the original RST source, before applying):

- Typos and dropped words carried over from the original Sphinx docs
  (e.g. "bot-acocunts", "auto-follow-all-new-channel-threads" ->
  "follow-all-new-channel-threads").
- Sphinx auto-generated duplicate-heading IDs (#id1/#id3/#id4) resolved
  to their real target headings.
- Numbered-step TOC links in enterprise-roll-out-checklist.mdx that
  dropped the leading "N. " used in the actual heading slugs.
- Push-notification docs pointing at the wrong file entirely
  (environment-configuration-settings instead of
  push-notification-server-configuration-settings).
- SAML "saml-enterprise" label resolved to its true cross-file target
  (authentication-configuration-settings#saml-2-0), recovered from the
  original RST label definition that the automated registry missed
  because it sat after an RST transition marker.
- sso-saml-technical references converted from broken same-page/
  malformed-path anchors to correct page links.

* docs: fix SAML 2.0 anchor slug (saml-2-0 -> saml-20)

github-slugger strips periods rather than hyphenating them, so "SAML
2.0" slugifies to saml-20, not saml-2-0 as previously fixed.

* docs: fix broken path links found during docs/main migration cleanup

* docs: convert div.tab blocks to Docusaurus Tabs/TabItem components

* docs: restore missing Kubernetes deployment architecture diagrams

The RST-to-MDX migration never copied over the AWS/Azure/Oracle
architecture diagrams referenced by the deployment-architecture-at-scale
page, leaving broken images in each Tabs/TabItem.

* docs: fix 7 anchor mismatches from the fragment/heading audit

Covers three root causes from the anchor mismatch breakdown:
- Fragment repeated the target page's own title instead of a real
  heading, so the link is simplified to point at the bare page.
- Heading exists verbatim but lives on a sibling settings page
  (experimental-configuration-settings, push-notification-server-
  configuration-settings) rather than environment-configuration-settings.
- A page path was mistakenly pasted into a same-page #fragment instead
  of being used as a real cross-page link.

* docs: fix 8 anchor slugs that were close but didn't match the real heading

Repoints links whose fragment was a plausible guess (typo, reworded
heading, or wrong section) at the actual auto-generated slug of the
target heading, confirmed by inspecting each target page directly.

* docs: merge split Tabs blocks so tabs render horizontally

The div.tab conversion script split some sibling tab groups into
separate single-item Tabs blocks whenever a stray blockquote marker
sat between them, causing them to render stacked instead of as one
horizontal tab bar. Merges the MySQL/PostgreSQL and Team/Enterprise
Edition tab groups back into single Tabs blocks.

* docs: remove Azure tab and restore Kubernetes deploy content

The Mattermost Operator, Azure, and Oracle platform tabs on the
Kubernetes deployment guide were split across two separate Tabs
blocks (rendering stacked instead of as one tab bar) and all three
tab bodies were empty because the migration never flattened the
original RST include directives. Removes the unsupported Azure tab
and restores the Mattermost Operator and Oracle content from the
pre-migration RST sources as a single merged Tabs block.

* addresscoderabbitreview

* docs: unify Linux/Kubernetes/Containers deploy pages and fix FIPS/STIG placement

Kubernetes and Containers duplicated full install content across a top-level
page (Tabs) and orphaned sidebar subpages that nothing linked to. Reworked
both to follow the Linux page's pattern: shared content on the landing page,
platform-specific instructions live once in their own subpage.

Also removed configure-fips-at-install-time.mdx, which claimed FIPS is
available for native Linux installs — FIPS/STIG in Mattermost is a container
image property (Chainguard-based build), not available outside Docker/
Kubernetes. Consolidated all FIPS/STIG references onto
containers/fips-stig.mdx and pointed the Mattermost Operator subpage (not
Oracle OKE, which doesn't expose image selection) at it.

* docs: fix review findings — image alt text, Important callout markup, typo

- Replace generic alt="image" on scaling diagrams with descriptive text
  identifying cloud provider and user scale.
- Convert raw div.important markup in deploy-containers.mdx to the
  repo's <Important> component, matching usage elsewhere in the file.
- Fix "Matermost" typo in manage-your-display-options.mdx.

---------

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-10 14:50:13 +03:00

302 lines
16 KiB
Plaintext
Raw Permalink Blame History

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