This guide documents the tasks associated with installing and configuring "The Littlest Jupyterhub" (TLJH) on Nimbus. It is assumed you've already created a VM and are able to log on to it using ssh. The developer's documentation for TLJH is available at https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/custom-server.html.
|Table of Contents|
Jupyterhub will require the standard HTTPS port and we also want to redirect HTTP to HTTPS, so we need to open these ports:
- From your Nimbus dashboard, under the "network" section of the left-hand navigation bar, select "security groups", then click on "create security group" on the right hand side:
- Name: give it a meaningful name (eg jupyterhub)
- Description: open ports to allow jupyterhub to communicate
Once created, click on "manage rules" for that security group, then click on "add rule" in the top right, click Rule and then select HTTP from the drop-down menu.
- Repeat for HTTPS, then it should look like this –
ssh into the VM and check if Python 3, curl, and git are installed using the following command (should be installed by default with latest Ubuntu):
Code Block language bash
apt list python3 git curl
Download and run the installer using the following code, making sure to replace <admin username> with the username of the account that will act as adminstrator. If you have yet to create any accounts on the VM simply use "ubuntu".
Code Block language bash
curl https://raw.githubusercontent.com/jupyterhub/the-littlest-jupyterhub/master/bootstrap/bootstrap.py | sudo -E python3 - --admin <admin username>
If everything runs as it should you'll see the following output with the final message being "Done!"
- You can then access the jupyterhub from the public IP associated with your VM, for eg. http://220.127.116.11, and you should see the sign-in page shown below. Note we will resolve the security warning next. If you fail to connect to the jupyterhub check that the security group created in the network setup section has been added to your instance.
In order to set up HTTPS using TLJH and Lets encrypt you need a domain name for your hub. You may be able to arrange one with your institution, however if you just want a free and easy solution you can use a DNS service provider. I use Dynu, its free, has a good selection of features, no pesky reminders to register every month, and great documentation. See below for an example of my DNS control panel: