mirror of
https://github.com/hanzoai/team.git
synced 2026-11-01 07:55:31 +00:00
b5f007d35e
* 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]>
217 lines
12 KiB
Plaintext
217 lines
12 KiB
Plaintext
---
|
||
title: "Configure SAML with Microsoft ADFS using Microsoft Windows Server 2016"
|
||
---
|
||
import Inc0_sso_saml_before_you_begin from './sso-saml-before-you-begin.mdx';
|
||
import Inc1_sso_saml_faq from './sso-saml-faq.mdx';
|
||
import Inc2_sso_saml_ldapsync from './sso-saml-ldapsync.mdx';
|
||
|
||
<PlanAvailability slug="all-commercial" />
|
||
|
||
This document provides steps to configure SAML 2.0 with Microsoft ADFS for Mattermost and Microsoft Windows Server 2016.
|
||
|
||
<Inc0_sso_saml_before_you_begin />
|
||
|
||
## Prerequisites
|
||
|
||
- An Active Directory instance where all users have specified email and username attributes. For Mattermost servers running 3.3 and earlier, users must also have their first name and last name attributes specified.
|
||
- A running Microsoft Server. The screenshots used in this guide are from Microsoft Server 2012R2, but similar steps should work for other versions.
|
||
- An SSL certificate to sign your ADFS login page.
|
||
- ADFS installed on your Microsoft Server. You can find a detailed guide for deploying and configuring ADFS in [this Microsoft article](https://learn.microsoft.com/en-us/previous-versions/dynamicscrm-2016/deployment-administrators-guide/gg188612(v=crm.8)?redirectedfrom=MSDN).
|
||
|
||
On your ADFS installation, open the ADFS console. Select **Service**, then select **Endpoints**. In the **Type** column, search for `SAML 2.0/WS-Federation` and note down the value of **URL Path** column. This is also known as the **SAML SSO URL Endpoint** in this guide. If you chose the defaults for the installation, this will be `/adfs/ls`.
|
||
|
||
## Add a relying party trust
|
||
|
||
1. Open the ADFS management snap-in, then select **AD FS \> Relying Party Trusts \> Add Relying Party Trust** from the right sidebar. You can also right-click **Relying Party Trusts**, then select **Add Relying Party Trust** from the context menu.
|
||
|
||
> 
|
||
|
||
2. On the **Welcome** screen of the configuration wizard, select **Claims aware**, then select **Start**.
|
||
|
||
> 
|
||
|
||
3. On the **Select Data Source** screen, select **Enter data about the relying party manually**.
|
||
|
||
> 
|
||
|
||
4. On the **Specify Display Name** screen, enter a **Display Name** (e.g., `Mattermost`). You can add optional notes.
|
||
|
||
> 
|
||
|
||
5. On the **Configure Certificate** screen, leave the certificate settings at their default values.
|
||
|
||
> 
|
||
|
||
If you would like to set up encryption for your SAML connection, select **Browse**, then upload your Service Provider Public Certificate.
|
||
|
||
> 
|
||
|
||
6. On the **Configure URL** screen, select **Enable Support for the SAML 2.0 WebSSO protocol**, then enter the **SAML 2.0 SSO service URL** in the following format:`https://<your-mattermost-url>/login/sso/saml` where `<your-mattermost-url>` should typically match the [Mattermost Site URL](/administration-guide/configure/environment-configuration-settings#site-url).
|
||
|
||
> 
|
||
|
||
7. On the **Configure Identifiers** screen, enter the **Relying party trust identifier**. This identifies the claims being requested. The **SAML 2.0 SSO service URL** format should be `https://<your-mattermost-url>/login/sso/saml` where `<your-mattermost-url>` matches your [Mattermost Site URL](/administration-guide/configure/environment-configuration-settings#site-url). Then choose **Next**.
|
||
|
||
> 
|
||
>
|
||
> 
|
||
|
||
This string must match the **Service Provider Identifier** string. For more information about the Relying party trust identifier and how prefix matching is applied see [this documentation](https://learn.microsoft.com/en-us/windows-server/identity/ad-fs/technical-reference/how-uris-are-used-in-ad-fs).
|
||
|
||
Add your **SAML 2.0 SSO service URL** using this same process.
|
||
|
||
8. On the **Choose Access Control Policy** screen, select the access control policy suitable for your environment. This guide assumes the default values **Permit everyone** and an unchecked box.
|
||
|
||
> 
|
||
|
||
9. On the **Ready to Add Trust** screen, review your settings.
|
||
|
||
> 
|
||
|
||
10. On the **Finish** screen, select **Configure claims issuance policy for this application**, then select **Close**.
|
||
|
||
|
||
|
||
## Create claim rules
|
||
|
||
1. In the **Issuance Transform Rules** tab of the **Claim Rules** editor, select **Add Rule…**.
|
||
|
||
> 
|
||
|
||
2. On the **Choose Rule Type** screen, select **Send LDAP Attributes as Claims** from the drop-down menu, then select **Next**.
|
||
|
||
> 
|
||
|
||
3. On the **Configure Claim Rule** screen, enter a **Claim Rule Name** of your choice, select **Active Directory** as the **Attribute Store**, then add the following mapping:
|
||
|
||
> - From the **LDAP Attribute column**, select `E-Mail-Addresses`. From the **Outgoing Claim Type**, type `Email`.
|
||
> - From the **LDAP Attribute column**, select `E-Mail-Addresses`. From the **Outgoing Claim Type**, type `Name ID`.
|
||
> - From the **LDAP Attribute column**, select `Given-Name`. From the **Outgoing Claim Type**, type `FirstName`.
|
||
> - From the **LDAP Attribute column**, select `Surname`. From the **Outgoing Claim Type**, type `LastName`.
|
||
> - From the **LDAP Attribute column**, select `SAM-Account-Name`. From the **Outgoing Claim Type**, type `Username`.
|
||
|
||
The `FirstName` and `LastName` attributes are optional.
|
||
|
||
Select **Finish** to add the rule.
|
||
|
||
The entries in the **Outgoing Claim Type** column can be modified. The entries may contain dashes but no spaces. They are used to map the corresponding fields in Mattermost.
|
||
|
||
> 
|
||
|
||
4. Select **Add Rule** to create another new rule.
|
||
|
||
5. On the **Choose Rule Type** screen, select **Transform an Incoming Claim** from the drop-down menu, then select **Next**.
|
||
|
||
> 
|
||
|
||
6. On the **Configure Claim Rule** screen, enter a **Claim Rule Name** of your choice, then:
|
||
|
||
> - Select **Name ID** for the **Incoming claim type**
|
||
> - Select **Unspecified** for the **Incoming name ID format**
|
||
> - Select **E-Mail Address** for the **Outgoing claim type**
|
||
|
||
Select **Pass through all claim values**, then select **Finish**.
|
||
|
||
> 
|
||
|
||
7. Select **Finish** to create the claim rule, then select **OK** to finish creating rules.
|
||
8. Open Windows PowerShell as an administrator, then run the following command:
|
||
|
||
> `Set-ADFSRelyingPartyTrust -TargetName <display-name> -SamlResponseSignature "MessageAndAssertion"`
|
||
|
||
where `<display-name>`is the name you specified in step 4 when you added a relying party trust. In this example, `<display-name>` would be `mattermost`.
|
||
|
||
This action adds the signature to SAML messages, making verification successful.
|
||
|
||
## Export identity provider certificate
|
||
|
||
Next, export the identity provider certificate, which will be later uploaded to Mattermost to finish SAML configuration.
|
||
|
||
1. Open the ADFS management snap-in, select **AD FS \> Service \> Certificates**, then double-click on the certificate under **Token-signing**. You can also right-click the field, then select **View Certificate** in the context menu.
|
||
|
||
> 
|
||
|
||
2. On the **Certificate** screen, open the **Details** tab, select **Copy to File**, then select **OK**.
|
||
|
||
> 
|
||
|
||
3. On the **Certificate Export Wizard** screen, select **Next**.
|
||
|
||
> 
|
||
|
||
4. Select **Base-64 encoded X.509 (.CER)**, then select **Next** again.
|
||
|
||
> 
|
||
|
||
5. On the **Certificate Export Wizard** screen, select **Browse** to specify the location where you want the Identity Provider Certificate to be exported, then specify the file name.
|
||
|
||
> 
|
||
|
||
6. Select **Save**. On the **Certificate Export Wizard** screen, verify the file path is correct, then select **Next**.
|
||
|
||
7. In the **Completing the Certificate Export Wizard**, select **Finish**, then select **OK** to confirm the export was successful.
|
||
|
||
> 
|
||
|
||
## Configure SAML Sign-On for Mattermost
|
||
|
||
Create a metadata URL by appending "FederationMetadata/2007-06/FederationMetadata.xml" to the root URL of the ADFS server, for example: `https://<adfs.domain.com>/federationmetadata/2007-06/FederationMetadata.xml>`.
|
||
|
||
Next, start the Mattermost server, then log in to Mattermost as a system admin. Go to **System Console \> Authentication \> SAML**, paste the metadata URL in the **Identity Provider Metadata URL** field, then select **Get SAML Metadata from IdP**.
|
||
|
||
This populates the **SAML SSO URL** and the **Identity Provider Issuer URL** fields automatically. The Identity Provider Public Certificate is also downloaded from the server and set locally.
|
||
|
||
The following fields can be selected:
|
||
- Set **Enable Login With SAML 2.0** to **true**.
|
||
- Set **Enable Synchronizing SAML Accounts With AD/LDAP** to suit your environment.
|
||
- Set **Override SAML bind data with AD/LDAP information** to suit your environment.
|
||
|
||
If you don't plan to use a metadata URL, you can manually enter the following fields:
|
||
- For **SAML SSO URL** use the `SAML 2.0/W-Federation URL ADFS Endpoint` you copied at the beginning of the process.
|
||
|
||
- For **Identity Provider Issuer URL** use the `Relying party trust identifier` from ADFS.
|
||
|
||
- For **Identity Provider Public Certificate** use the`X.509 Public Certificate`.
|
||
|
||
|
||
|
||
2. Configure Mattermost to verify the signature.
|
||
|
||
> - Set **Verify Signature** to `true`.
|
||
>
|
||
> - For **Service Provider Login URL** use the `SAML 2.0 SSO service URL` you specified in ADFS.
|
||
>
|
||
> 
|
||
|
||
3. Enable encryption.
|
||
|
||
> - Set **Enable Encryption** to `true`.
|
||
>
|
||
> - For **Service Provider Private Key** use the Service Provider Private Key generated at the start of this process.
|
||
>
|
||
> - For **Service Provider Public Certificate** use the Service Provider Public Certificate you generated at the start of this process.
|
||
>
|
||
> - Set **Sign Request** to suit your environment.
|
||
>
|
||
> 
|
||
|
||
4. Set attributes for the SAML Assertions, which will be used to update user information in Mattermost. Attributes for email and username are required and should match the values you entered in ADFS earlier. See [documentation on SAML configuration settings](/administration-guide/configure/authentication-configuration-settings#saml-20) for more detail.
|
||
|
||
For Mattermost servers running 3.3 and earlier, the first name and last name attributes are also required fields.
|
||
|
||
> 
|
||
|
||
5. Select **Save**.
|
||
6. (Optional) If you configured `First Name` Attribute and the `Last Name` Attribute, go to **System Console \> Site Configuration \> Users and Teams**, then set **Teammate Name Display** to **Show first and last name**. This is recommended for a better user experience.
|
||
|
||
You’re done! If you’d like to confirm SAML SSO is successfully enabled, switch your system admin account from email to SAML-based authentication from your profile picture via **Profile \> Security \> Sign-in Method \> Switch to SAML SSO**, then log in with your SAML credentials to complete the switch.
|
||
|
||
We also recommend that you post an announcement about how the migration will work to your users.
|
||
|
||
You may also configure SAML for ADFS by editing the `config.json` file to enable SAML based on [SAML configuration settings](/administration-guide/configure/authentication-configuration-settings#saml-20). You must restart the Mattermost server for the changes to take effect.
|
||
|
||
<Inc1_sso_saml_faq />
|
||
|
||
<Inc2_sso_saml_ldapsync />
|
||
:start-after: :nosearch:
|