SSH instructions #67
SSH instructions #67
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive SSH access documentation for NASA-Openscapes and NMFS-Openscapes JupyterHubs. The guide enables users to remotely access their JupyterHub servers via SSH from local machines or IDEs like VSCode and Positron, using the jupyter-sshd-proxy tool.
Key changes:
- Added detailed setup instructions including websocat installation, SSH key configuration, and JupyterHub token creation
- Documented platform-specific nuances, particularly for Windows users
- Included connection instructions for both terminal and IDE-based access
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| ssh-into-hub.qmd | New comprehensive guide covering SSH setup and connection procedures for JupyterHub access |
| _quarto.yml | Added new SSH guide to the website navigation menu |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
jules32
left a comment
jules32
left a comment
There was a problem hiding this comment.
Hi Andy! I think this looks good in terms of tone and style. My one comment was that on the other Access articles, the intro lines says
"This page is written primarily for workshop leads (mentors and other partners) who will be inviting participants to sign in to the hub on the day of the workshop, without using GitHub for authentication."
Could you add something similar here – is this for workshop leads, or would researchers ever use this in a workshop? I'm also wondering if it was sparked from Mikala's tutorials, is it better suited for the Cookbook?
|
@ateucher any chance you'd be willing to let us adapt this for our community docs at docs.2i2c.org ? I'd probably basically do this:
If you'd rather we not, that's totally fine! I promise I won't be upset! (e.g., you might want to choose this if you want openscapes to be the thought leaders here, and would prefer for 2i2c to link directly to this content instead of hosting a version of our own) |
|
Thanks @jules32 that's a great addition, I'll do that. It wasn't necessarily sparked from Mikala's tutorials... It could fit in the cookbook as well, though since it's not strictly NASA earthdata related and more specific to our hubs, I felt like it fit better here. But we should at least link to it from cookbook. |
That all sounds good Andy, I was misremembering the connection. Thanks for writing it and posting it here! |
|
@choldgraf that would be super, we're definitely happy if you do that! I will also credit 2i2c more prominently in ours, as I just realized I only mentioned it implicitly, a bad oversight 🤦 |
I've tried to write up a fairly comprehensive guide to ssh-ing into the hub. For setting up SSH keys initially, I've deferred to the GitHub documentation, which is pretty good - I added a couple of contextual comments specific to our use case.
I've run through it from scratch on a Windows PC and found a few nuances there, which I have tried to highlight, but it did work pretty smoothly.
@stefaniebutland @jules32 would love your input on how it's all presented, and I'll totally understand if you don't have the capacity to actually set it up.
@yuvipanda - if you have capacity I would love your thoughts on this, but also understand if you don't have time to look at it. Thank you so much for the
jupyter-ssh-proxytool, and documentation. It's amazing!The deploy preview is here: https://deploy-preview-67--openscapes-cloud-preview.netlify.app/ssh-into-hub
Closes #65