Enable the web terminal

To use the web terminal on your clusters, a workspace administrator must enable the web terminal as follows:

  1. Go to the admin console.

  2. Click the Workspace settings tab.

  3. In the Advanced section, click the Web Terminal toggle.

  4. Click Confirm.

Note

After you enable the feature in the admin console, you may need to wait a few minutes for the configuration value to propagate to all clusters. You also need to refresh your page for changes to take effect in your local session.

Manage the web terminal per cluster

To prevent users from accessing a cluster using the web terminal:

  • Do not grant any users Can Attach To permission.

  • To enable notebook access but not web terminal, set the DISABLE_WEB_TERMINAL=true environment variable in the cluster configuration.

    Cluster config

Auto termination

When you log out of a Databricks workspace or the feature is disabled in a workspace, active web terminal sessions terminate within 2 minutes.

When a cluster owner removes another user’s permission for Can Attach To on a cluster or the user is removed from the workspace, the user’s active web terminal sessions terminate within 2 minutes.

WAF configuration

If your Databricks deployment uses a Web Application Firewall (WAF), you must add the path /driver-proxy/* to its allow list.

Requirements

Databricks web terminal is available with a few exceptions as noted in limitations.