SSH/SFTP Access

Using jupyterhub-ssh QHub has the ability for remotely accessing the cluster and a juypterlab environment via ssh. In addition user’s can easily transfter files back and forth via sftp. QHub provides a secure manner for users to login and provides additional ways to connect to the cluster. This enables using terminal based editors e.g. emacs/vim along with the ability to automate tasks on the cluster without requiring browser access. For more detailed docs on using jupyterhub-ssh please refer to the documentation.

In order to login via ssh a user needs to generate an api token. Visit https://<qhub-url>/hub/token. Where qhub-url is the domain name of your QHub cluster. You will be shown a screen similar to the once shown bellow. This step is only required once to generate an api token. Afterwards you can reuse the same token.

qhub api token

Click on Request new API token with a note describing the use of the token e.g. ssh login token. Copy down the generate api token (in this case f0b80688484a4ac79a21b38ec277ca08).

qhub api token generated

Now you can login to the QHub cluster via a terminal and ssh. Note from the api generation screen in the top right hand corner you can see the username that you should use for login. Ssh handles usernames with an @ symbol weirdly thus you will need to provide the username explicitly in ssh. Notice the 8022 port used for ssh.

$ ssh -o User=costrouchov@quansight.com training.qhub.dev -p 8022 
The authenticity of host '[training.qhub.dev]:8022 ([35.223.107.201]:8022)' can't be established.
RSA key fingerprint is SHA256:mKy546LpI0cbqm/IY8dQR0B5QcbEziWLjLglern5G+U.
This key is not known by any other names
Are you sure you want to continue connecting (yes/no/[fingerprint])? yes
Warning: Permanently added '[training.qhub.dev]:8022' (RSA) to the list of known hosts.
(costrouchov@quansight.com@training.qhub.dev) Password:
costrouchov@quansight.com@jupyter-costrouchov-40quansight-2ecom:~$ 

The sftp port is available on 8023.