Setting Up SSH Keys for Dash Enterprise

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.

Dash Enterprise supports app deployments over HTTPS and SSH.

If you are deploying with the Dash Enterprise CLI or Git commands over HTTPS, then you do not
need to set up SSH keys and can go straight to
Initialize Apps on Dash Enterprise.

If you are the app owner and want to deploy from a workspace, an SSH key is automatically
set up for you when you create the workspace.

There are a few reasons SSH deployments might make more sense for you:
- If your administrator has configured Dash Enterprise authentication with SAML or OpenID Connect (OIDC), then the
HTTPS method will not work.
- SSH is often less susceptible to timeouts than HTTPS, so it can prove more reliable if you are
experiencing connectivity issues due to network latency.

To deploy over SSH, you need to add an SSH public key to
Dash Enterprise. Dash Enterprise uses the key to authenticate your Git
session with the server.


Adding the SSH Public Key to Dash Enterprise

In this step, you’ll add the SSH public key to Dash Enterprise using the Dash Enterprise UI.

  1. Go to Dash Enterprise and log in if you aren’t already.

  2. Select your username > Personal Settings.

  3. Under SSH Public Keys, select Add Key.

  4. In Label, enter a name for your key.

  5. In SSH Public Key, paste the contents you copied in step 1.


  1. Select Save. The key appears in the list of SSH Public Keys.


If your Dash administrator has chosen to use the default port for Git SSH (22), then you are ready to deploy apps over SSH.

Modifying Your Local SSH Config

Modifying your local SSH config is only required if your administrator has customized the port that Dash Enterprise uses for Git SSH.

Your SSH config file is located at ~/.ssh/config. If it’s not there, then create it. Add the following lines to this file, replacing your-dash-enterprise-server with the domain of your Dash Enterprise server (without https://).

Host your-dash-enterprise-server
    Port 3022

replacing 3022 with the port that your admninistrator has chosen.

Be careful not to save your SSH config as a .txt file as it will not be recognized by Git. If you are using Notepad to create your SSH config, you can force the removal of the .txt extension by naming the file “config”, including the quotes, in the Save As dialog box.

If you will also be deploying over SSH from workspaces, and your workspace was created before your administrator customizaed the Git SSH port, then you’ll need to rebuild your workspace.