Dash App Portal

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.

This page applies to Dash Enterprise 5. If your organization uses Dash Enterprise 4, view information about the Portal at https://<your-dash-enterprise-server>/Docs/dash-enterprise/portal.

The Dash App Portal is a way for the users of Dash 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.

Displaying Your App in the Portal

By default, apps have their Visible in Portal setting set to Yes. This setting respects viewer access: 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.

<img>

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.

Setting Your App’s Portal Rank

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.

Known issue: Changing the rank from a value that isn’t 0 or Not set to 0 causes the app to appear first in the Portal.

Setting Your App’s Display Information

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.

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

Customizing the Portal is an administrator action and requires the admin role.

To customize the Portal, go to https://&lt;your-dash-enterprise-server&gt;/portal; then select Admin > Customize Portal.

<img>

In the General tab, you can set a title and description that appear at the top of the Portal. The title you set here is also applied to the browser tab.

In the Branding tab, you can change the logo displayed in the top left of the Portal. Uploading a new logo changes the Dash Enterprise logo to your custom one, even if you leave Hide Plotly Branding and App Manager Links off.

The Hide Plotly Branding and App Manager Links setting hides elements related to Plotly and Dash Enterprise, and also removes the links for navigating to the App Manager (note that the link removal is visual only;
authenticated Dash Enterprise users can still access the App Manager by going directly to pages like https://&lt;your-dash-enterprise-server&gt;/apps). If you do not upload your own logo, no logo is displayed. The Dash Enterprise favicon is hidden, but only after you refresh your browser.

In the Portal Access tab, you can set whether login is required to view the Portal. By default, login is not required. This 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. We recommend letting app owners know if you require login to view the Portal, 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.