The following features available in Dash Enterprise 4.X are not supported in 5.X or behave differently:
Dash Enterprise upgrades: Because Dash Enterprise 5 is built on a completely new architecture, it is not possible to upgrade from 4.X to 5.X using an Upgrade button. Migrating to Dash Enterprise 5 instead requires a new installation and a customized migration script. Customer Success will reach out to you with more details.
User management and authentication: Dash Enterprise 5 introduces Keycloak to help administrators manage users and configure user authentication. Configurations you set up in Dash Enterprise 4, including any identity provider integrations, do not carry over to Dash Enterprise 5. To set up authentication in Dash Enterprise 5, you need to use Keycloak.
Self-service seat license allocation: In Dash Enterprise 4, certain user actions like initializing an app or visiting the documentation trigger a seat license assignment. In Dash Enterprise 5, administrators need to assign license seats to users in advance.
Dash Enterprise packages URL: Dash Enterprise packages like Dash Design Kit are available at a different URL. This URL is available in the package installation documentation that comes with Dash Enterprise.
Default Python version: In Dash Enterprise 5.0.0 and 5.1.0, deployed Dash apps and workspaces default to Python 3.8.12. In Dash Enterprise 5.1.1, they default to Python 3.8.16.
runtime.txt: Replaced by
project.toml in Dash Enterprise 5.X. If the default Python version is not suitable for your app, create a
project.toml file in your root directory and specify a different Python version:
name = 'BP_CPYTHON_VERSION'
value = '3.6.*' # any valid semver constraints (e.g. 3.6.7, 3.*) are acceptable
Known issue: It is not possible to use environment variables like the one above to customize the build behaviour in workspaces. If you customize the Python version for your deployed app, the same app will still use Python 3.8.12 if you preview it in workspaces.
Default pip version: In Dash Enterprise 5.X, deployed Dash apps default to pip 21.2.4. In 5.0.0 and 5.1.0, Workspaces default to 21.1.1. In 5.1.1, Workspaces default to 22.0.4. Note that you can set a different pip version for your deployed apps using the
BP_PIP_VERSION environment variable.
conda-requirements.txt: Replaced by
environment.yml (Conda-native) in Dash Enterprise 5.X.
Learn how to generate an
apt-packages: Replaced by
Aptfile in Dash Enterprise 5.X.
Aptfile includes the equivalent functionality of
app.json: Replaced by
project.toml in Dash Enterprise 5.X. Add predeploy and/or postdeploy scripts under
predeploy = "predeploy.sh"
postdeploy = "postdeploy.sh"
DOKKU_SCALE: No longer needed in Dash Enterprise 5.X (
DOKKU_SCALE was commonly used to start
worker processes in Dash Enterprise 4.X, but with 5.X,
worker processes start by default). Scale processes by going to the App Info > Scale > Edit Resources. Any existing
DOKKU_SCALE files will be ignored as of 5.X. No changes are needed if your
Procfile includes web processes only.
GraphQL API: The GraphQL API in Dash Enterprise 5.X will not be compatible with that of Dash Enterprise 4.X.
dokku CLI for managing Dash apps: Not supported in Dash Enterprise 5.X. Dash Enterprise 5 runs and schedules with a new event-based backend architecture rather than
git push plotly master command: Replaced by
git push plotly main in Dash Enterprise 5.X. If you are working off
master, then you can use
git push plotly master:main.
SSH port: Dash Enterprise 5.X uses the standard port 22 for SSH deploys. If you had set a custom port in your SSH config to deploy apps to Dash Enterprise 4.X (usually 3022), remove it before deploying to Dash Enterprise 5.X.
Directory mapping and mounts: Work differently in Dash Enterprise 5.X. See persistent filesystems for details.
Using one database for many Dash apps: In Dash Enterprise 5.X, databases and apps are one-to-one. If you’re currently using this feature in DE 4.X and are interested in upgrading to 5.X, please get in touch to discuss workarounds.
For a guide on adapting apps deployed to Dash Enterprise 4.X to make them compatible with Dash Enterprise 5.X, see DE4 to DE5 Migration.