This documentation is for Dash Enterprise.
Dash Enterprise is the fastest way to write & deploy Dash apps and
Jupyter notebooks.
10% of the Fortune 500 uses Dash Enterprise to productionize AI and
data science apps. Find out if your company is using Dash Enterprise.
The App Portal is a way for the users of apps you’ve deployed to browse several apps in one place. It is available at https://<your-dash-enterprise-server>/portal and opens when you log in to Dash Enterprise.
This page describes how to edit your app’s portal visiblity and display information using the App Manager, but you can also use the Dash Enterprise CLI.
By default, apps have their Visible in Portal setting set to No.
<img>
The portal visibility setting respects viewer access. When you set Visible in Portal to Yes, only those users who have viewer access to the app are able to see it in the Portal. The default viewer access level is Restricted, so only owners and administrators can access your app from the Portal unless you add users or change the viewer access level. Learn more in viewer access.
Administrators can require users to log in to access the Portal. This means that even if you set the viewer access level to Unauthenticated and Visible in Portal to Yes, not everyone is necessarily able to view your app from the Portal.
When the Portal requires login and the app user does not have a Dash Enterprise account, you’ll need to send them the app URL.
If Visible in Portal is set to No, anyone who has viewer access to the app—and isn’t the app owner, app co-owner, or an administrator—needs to use the app URL.
Control where your app appears in the Portal by setting a rank. The lower the number you enter as your app’s rank, the higher it appears in the Portal.
<img>
A rank of 0 or the default Not set causes the app to be displayed last. When several apps have the same rank, the order is determined at random.
Provide display information in Settings to improve the experience for app users browsing the Portal.
<img>
Title sets a display name that is applied to your app in the Portal as well as the App Manager. Using the searchbar in the Portal or App Manager searches over both name and title.
Description allows you to add a description that is displayed to app users who browse apps in the Portal.
Tags can help organize your apps and are displayed to app users who browse apps in the Portal. Using the searchbar in the Portal searches over tags.
Contact sets a name and email address that are displayed to users who browse apps in the Portal. Set this information to encourage app users to contact you for help with your app.
Thumbnail allows you to upload an image that serves as the thumbnail for your app in the Portal. The maximum allowed size for the image is 100 KB.
Customizing the Portal is an administrator action and requires the admin role.
To customize the Portal, go to https://<your-dash-enterprise-server>/portal; then select Admin > Customize Portal.
<img>
In the General tab, you can set a title, description, and footer for the Portal. The title that you set here is also applied to the browser tab. The description and footer content cannot exceed 1000 characters.
In the Look & Feel tab, many Portal styling options are available:
Upload a custom logo: Replace the Plotly Dash Enterprise logo with a custom one. The recommended aspect ratio for the logo is 82x24 px. The file that you upload cannot exceed 100 KB.
Upload a custom favicon: Replace the Plotly Dash Enterprise favicon with a custom one. The file that you upload cannot exceed 100 KB.
Known limitation: The custom favicon is not displayed for users accessing the Portal on Safari.
Change the Portal experience for app viewers: You can choose to enable Custom branding and Portal-only mode for app viewers, which takes custom branding a few steps further:
Removes the links for navigating to the App Manager (authenticated Dash Enterprise users with the licensed_user or admin role can still access the App Manager by going directly to pages like https://<your-dash-enterprise-server>/apps).
Redirects users with the viewer role only to the Portal if they try to navigate to any other part of Dash Enterprise such as the App Manager.
Removes the Plotly Dash Enterprise logo and favicon (we recommend uploading a custom logo and favicon).
Customize the page background color, header/footer background color, and border (dividers) color.
Customize the font for the title, description, and footer text.
Customize the font size for the description, footer text, and menu items in the header.
Customize the color and hover color of the “Open App” button on app cards. The button color remains grey when the app is not running.
Customize the alignment of the title, footer text, and app card text.
Customize the footer text color.
Customize the tag background color and text color.
Known issue: Selecting Reset to defaults changes the settings back to what you previously saved, not the Plotly defaults.
In the Portal Access tab, you can set whether login is required to view the Portal. By default, login is required. We recommend letting app owners know if you keep this default, because depending on how the app owner has configured viewer access and who the app users are, it can mean that app owners need to send their apps’ URLs to app users. The Portal Access setting does not affect which apps are displayed in the Portal, nor does it affect the login actions required to access them via their direct URLs.