diff --git a/docs/vendor/custom-domains-using.md b/docs/vendor/custom-domains-using.md index 1738f4518b..16f6d0e5df 100644 --- a/docs/vendor/custom-domains-using.md +++ b/docs/vendor/custom-domains-using.md @@ -14,6 +14,10 @@ To add and verify a custom domain: 1. In the **Add custom domain** dropdown, select the target Replicated endpoint. + :::note + There is a known issue when using a custom domain for the Enterprise Portal if any of your customers use link transformers such as Microsoft Defender Safe Links. For more information, see [Known Issue](custom-domains#known-issue) in _About Custom Domains_. + ::: + The **Configure a custom domain** wizard opens. custom domain wizard diff --git a/docs/vendor/custom-domains.md b/docs/vendor/custom-domains.md index fc50146740..e54a44634e 100644 --- a/docs/vendor/custom-domains.md +++ b/docs/vendor/custom-domains.md @@ -38,4 +38,8 @@ Using custom domains has the following limitations: - Each custom domain can only be used by one team. -- For [Replicated Embedded Cluster](/vendor/embedded-overview) installations, any Helm [`extensions`](/reference/embedded-config) that you add in the Embedded Cluster Config do not use custom domains. During deployment, Embedded Cluster pulls both the repo for the given chart and any images in the chart as written. Embedded Cluster does not rewrite image names to use custom domains. \ No newline at end of file +- For [Replicated Embedded Cluster](/vendor/embedded-overview) installations, any Helm [`extensions`](/reference/embedded-config) that you add in the Embedded Cluster Config do not use custom domains. During deployment, Embedded Cluster pulls both the repo for the given chart and any images in the chart as written. Embedded Cluster does not rewrite image names to use custom domains. + +## Known Issue + +If you use a custom domain for the Replicated [Enterprise Portal](/vendor/enterprise-portal-about) and any of your customers use link transformers such as Microsoft Defender Safe Links, then there is a known issue where legitimate URLs in emails generated by the Enterprise Portal can break due to rewrapping. To avoid this issue, request a "Do not rewrite the following URLs" exclusion policy for your custom Enterprise Portal domain. \ No newline at end of file diff --git a/docs/vendor/enterprise-portal-about.mdx b/docs/vendor/enterprise-portal-about.mdx index 4881e8a967..dc3331fde4 100644 --- a/docs/vendor/enterprise-portal-about.mdx +++ b/docs/vendor/enterprise-portal-about.mdx @@ -27,15 +27,19 @@ The following diagram shows how customers can use the Enterprise Portal to acces As shown in the diagram above, your licensed customers can access the installation and update instructions for one or more application releases by logging in to the Enterprise Portal. The Enterprise Portal tracks the customer's installation attempts and progress, and shares those insights back to the Vendor Portal. After installing, customers can also upload support bundles in the Enterprise Portal. Support bundles uploaded to the Enterprise Portal are automatically made available to you in the Vendor Portal. +You can enable and disable access to the Enterprise Portal for all customers, or on a per-customer basis. For more information about how to enable access, see [Manage Customer Access](/vendor/enterprise-portal-invite#manage-ep-access). + For information about using the Enterprise Portal, see [Access and Use the Enterprise Portal](enterprise-portal-use). ## Limitations * The Enterprise Portal is Beta. The features and functionality of the Enterprise Portal are subject to change. +* Installation and upgrade instructions are available only for Embedded Cluster and Helm installations. The Enterprise Portal does not provide instructions for installing and upgrading with KOTS in existing clusters. + * Air gap instance records do not appear in the Enterprise Portal until the end customer creates an air gap instance record by either uploading a support bundle for that instance or manually entering instance information. For more information, see [View Active and Inactive Instances](/vendor/enterprise-portal-use#view-active-and-inactive-instances) in _Access and Use the Enterprise Portal_. -* Installation and upgrade instructions are available only for Embedded Cluster and Helm installations. The Enterprise Portal does not provide instructions for installing and upgrading with KOTS in existing clusters. +* There is a known issue when using a custom domain for the Enterprise Portal if any of your customers use link transformers such as Microsoft Defender Safe Links. For more information, see [Known Issue](custom-domains#known-issue) in _About Custom Domains_. ## Comparison to the Download Portal @@ -51,9 +55,7 @@ You can configure the Enterprise Portal to use a custom domain, add links and co For more information about customizing the Enterprise Portal, see [Customize the Enterprise Portal](enterprise-portal-configure). -For information about how to set a custom domain for the Enterprise Portal, see [Use Custom Domains](/vendor/custom-domains-using). - -You can enable and disable access to the Enterprise Portal for all customers, or on a per-customer basis. For more information about how to enable access, see [Manage Customer Access](/vendor/enterprise-portal-invite#manage-ep-access). +For information about how to set a custom domain for the Enterprise Portal, see [Use Custom Domains](/vendor/custom-domains-using). ## About Instance Reporting with the Enterprise Portal