Enterprise portal docs (draft) #3218
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # About the Enterprise Portal (Alpha) | ||
|
|
||
| This topic provides an overview of the Replicated Enterprise Portal. | ||
|
|
||
| ## Overview | ||
|
|
||
| The Enterprise Portal is a customizable, web-based portal that provides a centralized location where your customers can: | ||
| * View application install and update instructions | ||
| * Manage their team members and service accounts | ||
| * Upload support bundles | ||
| * View insights about their active and inactive instances | ||
| * And more | ||
|
|
||
| Your customers can access the Enterprise Portal outside their application installation environment at a custom domain that you specify, making it easier for teams to manage instances and get support. | ||
|
|
||
| For information about using the Enterprise Portal, see [Access and Use the Enterprise Portal](enterprise-portal-use). | ||
|
|
||
| The following shows an example of the Enterprise Portal dashboard: | ||
|
|
||
|  | ||
|
|
||
| [View a larger version of this image](/images/enterprise-portal-dashboard.png) | ||
|
|
||
| ## Limitations | ||
|
|
||
| * The Enterprise Portal is Alpha. 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 vendor uploads a support bundle for that instance. 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. | ||
|
|
||
| You can migrate existing customers from the Download Portal to the Enterprise Portal by enabling the Enterprise Portal for their license. For more information, see [Manage Enterprise Portal Access](enterprise-portal-invite). | ||
|
|
||
| For more information about the Download Portal, see [Access a Customer's Download Portal](/vendor/releases-share-download-portal). | ||
|
|
||
| ## About Customizing the Enterprise Portal | ||
|
|
||
| You can configure the Enterprise Portal to use a custom domain, add links and contact information, customize the look and feel of the Enterprise Portal, edit the content of invitation and notification emails, and more. Customizing the Enterprise Portal helps ensure that your customers have a consistent branding experience and can access application- and vendor-specific information. | ||
|
|
||
| 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). | ||
|
|
||
| ## About Instance Reporting with the Enterprise Portal | ||
|
|
||
| This section describes the instance reporting functionality of the Enterprise Portal. | ||
|
|
||
| ### Active and Inactive Instances | ||
|
|
||
| The Enterprise Portal provides insights to end users about their active and inactive instances, including the application version installed, the instance status, computed metrics like the first and most recent times the instance sent data to the Vendor Portal, and more. For more information about the instance insights available in the Enterprise Portal, see [View Active and Inactive Instances](/vendor/enterprise-portal-use#view-active-and-inactive-instances) in _Access and Use the Enterprise Portal_. | ||
|
|
||
|  | ||
| [View a larger version of this image](/images/enterprise-portal-instance-status-details.png) | ||
|
|
||
| ### Customer Reporting | ||
|
|
||
| The Enterprise Portal sends insights back to the Vendor Portal, which are surfaced on the **Customer Reporting** page. For more information, see [Enterprise Portal](/vendor/customer-reporting#enterprise-portal) in _Customer Reporting_. | ||
|
|
||
| These insights include details about the customer's install attempts. The Enterprise Portal tracks and reports on install attempts by creating unique, _just-in-time_ service accounts. These service accounts allow the Enterprise Portal to send data back to the Vendor Portal when the user starts and completes the installation or takes other actions that are specific to the installation type. The service accounts also provide realtime feedback to the user on their installation progress using checkboxes and status indicators, and allow users to pause and return to an installation attempt. For more information, see [Install Attempts](/vendor/customer-reporting#install-attempts) in _Customer Reporting_. | ||
|
|
||
| The following shows an example of the **Install Attempts** section: | ||
|
|
||
| <img alt="Install attempts section of customer reporting page" src="/images/customer-reporting-install-attempts-expanded.png" width="700px"/> | ||
|
|
||
| [View a larger version of this image](/images/customer-reporting-install-attempts-expanded.png) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| # Customize the Enterprise Portal (Alpha) | ||
|
|
||
| This topic describes how to customize the Enterprise Portal, including using a custom domain, changing the branding, editing the content of invitation and notification emails, and adding custom documentation. | ||
|
|
||
| ## Manage Enterprise Portal Settings | ||
|
|
||
| You can edit the settings for the Enterprise Portal to use a custom domain, provide custom links and contact information, customize the look and feel of the Enterprise Portal, and more. | ||
|
|
||
| To manage Enterprise Portal settings: | ||
|
|
||
| 1. In the Vendor Portal, go to **Enterprise Portal > Settings**. | ||
|
|
||
|  | ||
|
|
||
| [View a larger version of this image](/images/enterprise-portal-settings.png) | ||
|
|
||
| 1. Edit the settings as desired: | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th>Field</th> | ||
| <th>Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td>URL</td> | ||
| <td>The URL where customers can access the Enterprise Portal. You can change the URL to use a custom domain. For information, see [Use Custom Domains](custom-domains-using).</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Title</td> | ||
| <td>The title of the Enterprise Portal. The title is displayed at the top of each page in the Enterprise Portal and is also used in email notifications.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Page overview</td> | ||
| <td>An overview of the Enterprise Portal.</td> | ||
|
There was a problem hiding this comment. ^ I don't think I saw where this appears in the Enterprise Portal There was a problem hiding this comment. it doesn't yet... i should decide if we're going to include it :) |
||
| </tr> | ||
| <tr> | ||
| <td>Support portal link</td> | ||
| <td>The URL for the portal that your customers can use to get support. This link is provided on the Enterprise Portal **Support** page.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Contact email</td> | ||
| <td>The email address that customers can use to contact you. This email address is provided on the Enterprise Portal **Support** page.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Logo</td> | ||
| <td>Upload a custom PNG logo for the Enterprise Portal. The minimum size for the logo is 160px by 160px.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Favicon</td> | ||
| <td>Upload a custom favicon for the Enterprise Portal. The favicon is displayed in the browser tab.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Background</td> | ||
| <td>Select or customize the background for the Enterprise Portal.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Colors</td> | ||
| <td>Set the primary and secondary colors for the Enterprise Portal.</td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| 1. Click **Save**. | ||
|
|
||
| ## Configure Invitation and Notification Emails {#configure-customer-emails} | ||
|
|
||
| You can customize the invitation and notification emails that are sent to your customers. | ||
|
|
||
| To configure customer emails: | ||
|
|
||
| 1. In the Vendor Portal, go to **Enterprise Portal > Customer emails**. | ||
|
|
||
|  | ||
|
|
||
| [View a larger version of this image](/images/enterprise-portal-customer-emails.png) | ||
|
|
||
| 1. For **Email Sender Verification**, in **From email address**, add the email address that you want to use as the sender for all system notifications sent to your customers, then click **Continue**. Adding a sender address helps ensure that your emails are delivered and are not marked as spam. | ||
|
|
||
| After the domain is verified automatically, the email address is displayed under **Verified Sender Address**. | ||
| 1. For **Customer Emails**, customize the subject line and body of the emails that are sent to your customers for various system events. | ||
|
|
||
|  | ||
|
|
||
| [View a larger version of this image](/images/enterprise-portal-customer-emails-edit.png) | ||
|
|
||
| ## Customize Documentation | ||
|
|
||
| The install and update instructions available in the Enterprise Portal are automatically generated based on the install types and options enabled in the customer's license. For more information about managing the installation types and options, see [Manage Install Types for a License](/vendor/licenses-install-types). | ||
|
|
||
| You can also customize the documentation that is displayed in the Enterprise Portal by including a link to your installation instructions or by adding your own pre- and post-installation instructions. | ||
|
|
||
| To customize documentation: | ||
|
|
||
| 1. In the Vendor Portal, go to **Enterprise Portal > Knowledge Base**. | ||
|
|
||
|  | ||
|
|
||
| [View a larger version of this image](/images/enterprise-portal-knowledge-base.png) | ||
|
|
||
| 1. In the panel on the left, select the installation type. | ||
|
|
||
| 1. Customize the documentation for the selected installation type as desired: | ||
| 1. In the documentation links section, add a link to your installation documentation. The link is displayed on the Enterprise Portal **Install** page. | ||
| 1. In the documentation content section, add pre- and post-installation instructions in markdown format. Click **Preview** to see a preview of your changes. | ||
| 1. Click **Save changes**. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
^ On the About Custom Domains page, add Enterprise Portal to list of endpoints you can alias with a custom domain