Skip to content

Commit 1eef573

Browse files
Merge pull request #4171 from replicatedhq/ep-v2-defaults
Update Enterprise Portal v2 defaults docs
2 parents 30d867f + 4be778d commit 1eef573

5 files changed

Lines changed: 28 additions & 16 deletions

docs/vendor/custom-domains-using.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ To add and verify a custom domain:
6969

7070
After you add one or more custom domains in the Vendor Portal, you can configure your application to use the domains.
7171

72+
### Configure Enterprise Portal domains {#enterprise-portal}
73+
74+
The New Enterprise Portal has its own domain settings. To add or manage a New Enterprise Portal custom domain, go to **Enterprise Portal > Domains**.
75+
76+
Teams that use only the New Enterprise Portal do not see Download Portal domains on the **Custom Domains** page. In mixed mode, use **Custom Domains** for Classic Enterprise Portal and Download Portal domains. Use **Enterprise Portal > Domains** for New Enterprise Portal domains.
77+
7278
### Configure Embedded Cluster to use custom domains {#ec}
7379

7480
You can configure Replicated Embedded Cluster to use your custom domains for the Replicated proxy registry and Replicated app service. For more information about Embedded Cluster, see [Embedded Cluster Overview](/embedded-cluster/v3/embedded-overview).

docs/vendor/enterprise-portal-v2-about.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# About the Enterprise Portal
22

33
:::important Alpha Feature
4-
Features described on this page are in alpha and subject to change. For access, contact your Replicated account representative.
4+
Features described on this page are in alpha and subject to change. Some capabilities might require additional access.
55
:::
66

77
The Enterprise Portal gives your customers one central place to view their install and upgrade instructions for each version of your software, set up their environment, manage their team, and get troubleshooting support by uploading support bundles.
@@ -39,28 +39,28 @@ The new Enterprise Portal is a complete rebuild of the customer portal experienc
3939

4040
## Requirements
4141

42-
The following feature flags must be enabled by Replicated for your team:
42+
Replicated enables the New Enterprise Portal by default for new teams. If your existing team uses the Classic Enterprise Portal, check the Vendor Portal for New Enterprise Portal pages. Contact your Replicated account representative if you do not see them.
4343

44-
* GitHub App Integration in Vendor Portal
45-
* Enable Customer Emails in Enterprise Portal
46-
* Enterprise Portal Customization
47-
* Enable Security Center in Enterprise Portal
48-
* Terraform Modules in Enterprise Portal (available to teams on the Business or Enterprise pricing plan)
44+
Some Enterprise Portal capabilities require additional access:
45+
46+
* Customer email customization
47+
* Security Center
48+
* Terraform module distribution, available to teams on the Business or Enterprise pricing plan
4949

5050
## For vendors already using the Classic Enterprise Portal
5151

52-
If your team is already using the Classic Enterprise Portal with customers, you can adopt the new Enterprise Portal incrementally without disrupting any existing customer experience.
52+
If your team already uses the Classic Enterprise Portal, you can adopt the New Enterprise Portal incrementally. To avoid disrupting existing customers, run both portal versions in mixed mode.
5353

5454
The new Enterprise Portal runs at a different domain (`{appSlug}.enterpriseportal.app`) than Classic (`get.replicated.com/{appSlug}/...`). Both portals share the same backend, so customer data, licenses, and instance information are consistent across both.
5555

5656
### How to get started
5757

58-
1. **Request the feature flags.** Contact Replicated to enable the new Enterprise Portal flags for your team. This has no effect on any customer's portal.
58+
1. **Enable mixed mode.** Contact Replicated to run the New Enterprise Portal alongside the Classic Enterprise Portal. Customers continue using their current portal until you move them to the new version.
5959
1. **Connect a content repo.** Follow the setup steps in [Connect a Git Repo](/vendor/enterprise-portal-v2-connect-repo). Connecting a repo has zero effect on any customer's portal version. No customer sees the new portal until you explicitly switch them.
6060
1. **Test it yourself.** Use the local CLI preview (`replicated enterprise-portal preview`) or open the new portal URL directly to see how your content renders. The Vendor Portal also has a "Login as customer" button on each customer's EP access tab.
6161
1. **Move individual customers.** On the customer's **Enterprise Portal access** tab in Vendor Portal, set the **Portal Version** toggle to use the new Enterprise Portal. Only that customer is affected.
6262
1. **Move customers back if needed.** Set the Portal Version toggle back to Classic at any time. The customer immediately returns to the Classic experience.
6363

6464
### Vendor Portal view vs. customer portal version
6565

66-
The **New Portal** / **Classic Portal** toggle at the top of the Enterprise Portal page in Vendor Portal controls which view *you* see as a vendor. It does not change which portal your customers see. Customer portal versions are controlled individually via the Portal Version toggle on each customer's EP access tab.
66+
The **New Portal** / **Classic Portal** toggle appears only in mixed mode. It controls the Vendor Portal view that you see. It does not change which portal your customers see. Use the Portal Version toggle on each customer's EP access tab to change their portal.

docs/vendor/enterprise-portal-v2-connect-repo.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Connect a Git Repo
22

33
:::important Alpha Feature
4-
Features described on this page are in alpha and subject to change. For access, contact your Replicated account representative.
4+
Features described on this page are in alpha and subject to change. Some capabilities might require additional access.
55
:::
66

77
Enterprise Portal content is driven by a GitHub repo you control. Connecting a repo is a prerequisite to offer versioned docs, advanced theming, and Terraform module delivery.
88

9+
The Content tab appears when your team has the New Enterprise Portal. The same setting enables the GitHub App workflow for content repositories. Use this workflow to create, authorize, and link repos.
10+
911
The Vendor Portal walks you through setup in three steps:
1012

1113
## Step 1: Create from template

docs/vendor/enterprise-portal-v2-invite.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Manage Customer Access
22

33
:::important Alpha Feature
4-
Features described on this page are in alpha and subject to change. For access, contact your Replicated account representative.
4+
Features described on this page are in alpha and subject to change. Some capabilities might require additional access.
55
:::
66

77
This topic describes how to control which customers can access the new Enterprise Portal and how to manage their portal users from the Vendor Portal.
@@ -11,10 +11,10 @@ This topic describes how to control which customers can access the new Enterpris
1111
For vendors using both Classic and New Enterprise Portal (mixed mode), customer access is controlled per-customer:
1212

1313
- On the customer's **Enterprise Portal access** tab, toggle **Enable Enterprise Portal for this customer** to grant access
14-
- Use the **Portal Version** toggle to choose whether the customer sees Classic or New
14+
- Team admins can use the **Portal Version** toggle to choose whether the customer sees Classic or New
1515
- Customers on the New portal access it at `{appSlug}.enterpriseportal.app` (or your custom domain)
1616

17-
For vendors on the New Enterprise Portal only, Enterprise Portal is always enabled for all customers. No per-customer enable toggle is needed.
17+
For vendors on the New Enterprise Portal only, all customers can access the portal. You do not need an app-level or per-customer enable toggle.
1818

1919
## Inviting users
2020

@@ -27,6 +27,8 @@ To invite a customer's end user to the portal:
2727

2828
You can also enable **Automatically invite customer email to Enterprise Portal on creation** so that every new customer with an email address receives an invite automatically.
2929

30+
For teams using only the New Enterprise Portal, go to **Enterprise Portal > Customer Access**. In the **Customer invitations** section, enable automatic invitations. In mixed mode, automatic invitations require the app-level **Enable Enterprise Portal for all customers** setting.
31+
3032
For vendors in mixed mode (both Classic and New enabled), the customer creation screen includes a **Use new Enterprise Portal for this customer** checkbox. When checked, the customer is enrolled in the New portal and any auto-invite email points them to the New portal URL instead of Classic. This checkbox is only visible to team admins. When unchecked or not visible, new customers default to Classic.
3133

3234
## Removing users

docs/vendor/releases-creating-customer.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,11 @@ To create a customer:
3131
1. (Optional) Disable the **Send Enterprise Portal invite to customer email** checkbox if you don't want the Enterprise Portal to automatically send this customer an invitation. If you disable the checkbox, you can manually invite the customer to the Enterprise Portal later.
3232

3333
:::note
34-
The **Send Enterprise Portal invite to customer email** checkbox appears only when the Enterprise Portal is enabled globally for all customers. For more information, see [Automatically invite customers on creation](enterprise-portal-invite#auto-invite) in _Manage Enterprise Portal customer access_.
34+
For teams using only the New Enterprise Portal, this checkbox appears for every customer. For teams using the Classic Enterprise Portal or mixed mode, this checkbox appears only after you enable Enterprise Portal globally for all customers. For more information, see [Automatically invite customers on creation](enterprise-portal-invite#auto-invite) in _Manage Enterprise Portal customer access_. See also [Inviting users](/vendor/enterprise-portal-v2-invite#inviting-users) in _Manage Customer Access_.
3535
:::
3636

37+
1. (Mixed mode only) To enroll this customer in the New Enterprise Portal, enable **Use new Enterprise Portal for this customer**. Only team admins see this option.
38+
3739
1. For **Assigned channel**, assign the customer to one of your channels. You can select any channel that has at least one release. The channel a customer is assigned to determines the application releases that they can install.
3840

3941
:::note
@@ -165,4 +167,4 @@ For more information about the data fields in the CSV downloads, see [Data Dicti
165167

166168
## Replace a license in an existing installation
167169

168-
Unless the existing customer is using a Community license, it is not possible to replace one license with another license without reinstalling the application. When you need to make changes to a customer's entitlements, Replicated recommends that you edit the customer's license details in the Vendor Portal, rather than issuing a new license. For more information, see [Community Licenses](licenses-about-types).
170+
You can replace a Community license with another license without reinstalling the application. For other license types, you must reinstall the application to replace a license. To change a customer's entitlements, edit the customer's license details in the Vendor Portal instead of issuing a new license. For more information, see [Community Licenses](licenses-about-types).

0 commit comments

Comments
 (0)