Skip to content

Add details on using ssh keys #279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ameliaholcomb wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add details on using ssh keys #279

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4f5edd
Add details on using ssh keys
ameliaholcomb Jun 2, 2026
2010878
Remove github intermediary, add info for custom server names
ameliaholcomb Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 35 additions & 13 deletions user-guide/scientific-computing/ssh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,34 +27,56 @@ We are exploring two options for using VS Code on the VEDA JupyterHub. These opt
Treat this token like you would treat a password to your JupyterHub instance!
:::

### Setup your local `~/.ssh/config`
### Setup your local `~/.ssh/config` and ssh keys

Before your first time remotely connecting to the VEDA JupyterHub, you need to configure your local ssh.

1. Add an entry that looks like the following to the end of your ~/.ssh/config. Create it if it does not exist.
1. Create a set of ssh keys for logging into the Hub.

```bash
Host hub.openveda.cloud
ssh-keygen -t ed25519 -C "your_email@example.com" -f ~/.ssh/id_ed25519_hub
```

This creates `~/.ssh/id_ed25519_hub` and `~/.ssh/id_ed25519_hub.pub` on your local machine.

2. Add an entry like the following to the end of your ~/.ssh/config. Create it if it does not exist.

```bash
Host veda-hub.default
HostName hub.openveda.cloud
User jovyan
IdentityFile ~/.ssh/id_ed25519_hub
Comment thread
ameliaholcomb marked this conversation as resolved.
IdentitiesOnly yes
ProxyCommand websocat --binary -H='Authorization: token <YOUR-JUPYTERHUB-TOKEN>' asyncstdio: wss://%h/user/<YOUR-JUPYTERHUB-USERNAME>/sshd/
```

2. Replace `<YOUR-JUPYTERHUB-TOKEN>` with the token you created earlier.
3. Replace `<YOUR-JUPYTERHUB-USERNAME>` with your VEDA JupyterHub username.
3. Replace `<YOUR-JUPYTERHUB-TOKEN>` with the token you created earlier.
4. Replace `<YOUR-JUPYTERHUB-USERNAME>` with your VEDA JupyterHub username.
5. If using a custom named Veda server, add additional entries to your ssh config, specifying `<SERVER_NAME>` in the Host short name and the ProxyCommand fields:
```bash
Host veda-hub.<SERVER_NAME>
HostName hub.openveda.cloud
User jovyan
IdentityFile ~/.ssh/id_ed25519_hub
IdentitiesOnly
ProxyCommand websocat --binary -H='Authorization: token <YOUR-JUPYTERHUB-TOKEN>' asyncstdio: wss://%h/user/<YOUR-JUPYTERHUB-USERNAME>/<SERVER_NAME>/sshd/
```

### Setup ssh keys on your JupyterHub server

You need to put some ssh public keys in `~/.ssh/authorized_keys` after you start your JupyterHub server and have completed the [setup of your private keys on your local machine](#setup-your-local-.sshconfig).
Put your ssh public key in `~/.ssh/authorized_keys` after you start your JupyterHub server and have completed the [setup of your private keys on your local machine](#setup-your-local-sshconfig-and-ssh-keys).

1. Launch a server from the [VEDA JupyterHub home page](https://hub.openveda.cloud/) if you don't already have one running.
2. Open a terminal in JupyterLab
3. Run the following commands, replacing <YOUR-GITHUB-USERNAME> with your github username:
2. Open a terminal in JupyterLab and run the following commands

```bash
mkdir -p ~/.ssh
wget https://github.com/<YOUR-GITHUB-USERNAME>.keys -O ~/.ssh/authorized_keys
chmod 0600 ~/.ssh/authorized_keys
mkdir -p ~/.ssh && chmod 700 ~/.ssh
cat >> ~/.ssh/authorized_keys
# copy-paste the contents of ~/.ssh/id_ed25519_hub.pub from your local machine
# then type Ctrl-D
chmod 600 ~/.ssh/authorized_keys
```
This ssh key will be shared across all of your VEDA servers.

## Connect to JupyterHub

Expand All @@ -66,7 +88,7 @@ There are two ways to connect to JupyterHub: [Connect to the JupyterHub using VS
2. Open a new VS Code Window on your local maachine.
3. Open the command prompt (command + shift + P on macOS)
4. Enter `Remote-SSH: Connect to Host...`
5. Select `hub.openveda.cloud`
5. Select `veda-hub.default` (or your custom server name, if you have set one up above)
6. Select "Open Folder" and select the specific folder that you want to work in.

Now you're connected and ready to develop using VS Code! You may need to [install some extensions in the SSH server](#install-extensions) to use your regular development workflows.
Expand Down Expand Up @@ -105,7 +127,7 @@ Exiting VS Code will also close the remote connection.

1. Launch a server from the [VEDA JupyterHub home page](https://hub.openveda.cloud/) if you don't already have one running.
2. Open a new terminal on your local machine.
3. Enter `ssh hub.openveda.cloud`
3. Enter `ssh veda-hub.default`

You are now ssh'd into the JupyterHub! If you enter a command (e.g., `touch am-i-on-the-jupyterhub`), it will be run on the remote server.

Expand Down