Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/vendor/custom-domains-using.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ For information about adding and managing custom domains with the Vendor API v3,

For more information about custom domains, see [About Custom Domains](custom-domains).

## Known Issue

If you use a custom domain for the Replicated Enterprise Portal 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.

For more information, see [About the Enterprise Portal](enterprise-portal-about).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ I was thinking this could fit well in the custom domains topic since it sounds like it's specific to using a custom domain. also added a note down in the procedure below that links back up to this known issue

## Add a Custom Domain in the Vendor Portal {#add-domain}

To add and verify a custom domain:
Expand All @@ -14,6 +20,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. See [Known Issue](#known-issue) above.
:::

The **Configure a custom domain** wizard opens.

<img src="/images/custom-domains-download-configure.png" alt="custom domain wizard" width="500"/>
Expand Down
10 changes: 5 additions & 5 deletions docs/vendor/enterprise-portal-about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,18 @@ 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).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ unrelated, but I noticed this was down under the Customize section. Moved up to the overview

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.

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

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

## Comparison to the Download Portal

The Enterprise Portal is the next generation version of the Replicated Download Portal. Compared to the Download Portal, the Enterprise Portal not only provides access to installation assets and instructions, but also allows users to track available updates, manage their team and service accounts, view the status of their instances, view license details, and more. These features are designed to make it easier for your customers to manage their instances of your application from a centralized location outside of the installation environment.
Expand All @@ -51,9 +53,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

Expand Down