Sign inGet started

Getting started

Welcome to Deepnote

Connecting to data sources

Coding and analysis tools

SSH key

SSH key

If you want to create an SSH tunnel to your database, or internal service, we recommend using either built-in SSH tunneling capability in a supported Database integration, or use a standalone SSH Tunnel integration.

SSH key integration is the recommended way to store SSH keys in Deepnote. When you connect the integration to a project, Deepnote will add your private key as environment variable so you can use it to connect to remote machines, or create tunnels to service within cloud services not accessible on public internet.

This integration is useful if you already have a private key you want to use to connect to a private network, and you are not able to add the public key of your Deepnote workspace to the remote resource.


Copy the private key (commonly stored as .pem file) to the text box and give descriptive name to the integration (eg. AWS Redshift Tunnel key). After the integration is created, connect it to your project. Below is an example of using the key with an ssh-agent.

Replace $TEST_SSH_KEY with your integration's environment variable. To see the variable name, connect the integration to your project and click on "How to use" button.

eval "$(ssh-agent)" > /dev/null && \
source <(/compute-helpers/code/ && \
echo "$TEST_SSH_KEY" | ssh-add - > /dev/null && \
ssh <user>@<host>