Add details on using ssh keys#279
Open
ameliaholcomb wants to merge 2 commits into
Open
Conversation
Add missing steps to the ssh instructions: - An ssh key needs to be generated locally and added to github before adding it to authorized_keys on the hub - The local ssh config needs IdentityFile pointing to the private key on the local machine
maxrjones
reviewed
Jun 2, 2026
Contributor
There was a problem hiding this comment.
Thanks for fixing this gap! One suggestions:
Keep GitHub out of the loop.
Pasting the public key directly into authorized_keys keeps the hub key single-purpose, such that it can't also authenticate to GitHub for git operations, and hub access no longer depends on your GitHub key
list:
# local machine
ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519_hub -C "veda-hub"# in a JupyterLab terminal on the hub
mkdir -p ~/.ssh && chmod 700 ~/.ssh
cat >> ~/.ssh/authorized_keys # paste contents of id_ed25519_hub.pub, Ctrl-D
chmod 600 ~/.ssh/authorized_keysI haven't manually tested this suggestions, and recommend checking that it works as expected before putting them in the doc.
Author
|
While I was testing, I noticed that different instructions are also needed if you create a custom named server. All commands tested on my computer (Mac). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add missing steps to the ssh instructions: