Enable web terminal

Preview

This feature is in Public Preview.

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 Advanced tab.
  3. Click the Enable button next to Web Terminal.
  4. Refresh the page.

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.

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

Security considerations

When you log out of a Databricks workspace (or the feature is disabled on a workspace), your active web terminal session continues to be active until you refresh the page or it times out. This is a known issue.

When a cluster owner removes another user’s permission for Can Attach To on a cluster, the user’s active web terminal sessions continue to be active until the page is refreshed or it times out due to inactivity. This is a known issue.

Both vulnerabilities can be mitigated by restarting affected clusters, which forces the web terminal session to terminate.

Requirements

Databricks web terminal is available in Databricks Runtime 7.0 and above with a few exceptions as noted in limitations.