Installing on Digital Ocean#

Goal#

By the end of this tutorial, you should have a JupyterHub with some admin users and a user environment with packages you want installed running on DigitalOcean.

Pre-requisites#

  1. A DigitalOcean account with a payment method attached.

Step 1: Installing The Littlest JupyterHub#

Let’s create the server on which we can run JupyterHub.

  1. Log in to DigitalOcean. You might need to attach a credit card or other payment method to your account before you can proceed with the tutorial.

  2. Click the Create button on the top right, and select Droplets from the dropdown menu. DigitalOcean calls servers droplets.

    Dropdown menu on clicking 'create' in top right corner

    This takes you to a page titled Create Droplets that lets you configure your server.

  3. Under Choose an image, select 22.04 x64 under Ubuntu.

    Select 22.04 x64 image under Ubuntu

  4. Under Choose a size, select the size of the server you want. The default (4GB RAM, 2CPUs, 24 USD / month) is not a bad start. You can resize your server later if you need.

    Check out our guide on How To Estimate Memory / CPU / Disk needed to help pick how much Memory, CPU & disk space your server needs.

  5. Open the Advanced Options, and check the box for Add Initialization scripts.

    Turn on User Data in advanced options

    This opens up a textbox where you can enter a script that will be run when the server is created. We will use this to set up The Littlest JupyterHub on this server.

  6. Copy the text below, and paste it into the user data text box. Replace <admin-user-name> with the name of the first admin user for this JupyterHub. This admin user can log in after the JupyterHub is set up, and can configure it to their needs. Remember to add your username!

    #!/bin/bash
curl -L https://tljh.jupyter.org/bootstrap.py \
  | sudo python3 - \
    --admin <admin-user-name>

    Note

    See What does the installer do? if you want to understand exactly what the installer is doing. Customizing the Installer documents other options that can be passed to the installer.

  7. Under the Finalize and create section, enter a hostname that descriptively identifies this server for you.

    Select suitable hostname for your server

  8. Click the Create button! You will be taken to a different screen, where you can see progress of your server being created.

    Server being created

  9. In a few seconds your server will be created, and you can see the public IP used to access it.

    Server finished creating, public IP available

  10. The Littlest JupyterHub is now installing in the background on your new server. It takes around 5-10 minutes for this installation to complete.

  11. Check if the installation is complete by copying the public ip of your server, and trying to access it with a browser. This will fail until the installation is complete, so be patient.

  12. When the installation is complete, it should give you a JupyterHub login page.

    JupyterHub log-in page

  13. Login using the admin user name you used in step 6, and a password. Use a strong password & note it down somewhere, since this will be the password for the admin user account from now on.

  14. Congratulations, you have a running working JupyterHub!

Step 2: Adding more users#

Most administration & configuration of the JupyterHub can be done from the web UI directly. Let’s add a few users who can log in!

  1. In the File menu select the entry for the Hub Control Panel.

    Hub Control panel entry in lab File menu

  2. In the control panel, open the Admin link in the top left.

    Admin button in control panel, top left

    This opens up the JupyterHub admin page, where you can add / delete users, start / stop peoples’ servers and see who is online.

  3. Click the Add Users button.

    Add Users button in the admin page

    A Add Users dialog box opens up.

  4. Type the names of users you want to add to this JupyterHub in the dialog box, one per line.

    Adding users with add users dialog

    You can tick the Admin checkbox if you want to give admin rights to all these users too.

  5. Click the Add Users button in the dialog box. Your users are now added to the JupyterHub! When they log in for the first time, they can set their password - and use it to log in again in the future.

Congratulations, you now have a multi user JupyterHub that you can add arbitrary users to!

Step 3: Install conda / pip packages for all users#

The User Environment is a conda environment that is shared by all users in the JupyterHub. Libraries installed in this environment are immediately available to all users. Admin users can install packages in this environment with sudo -E.

  1. Log in as an admin user and open a Terminal in your Jupyter Notebook.

    New Terminal button under New menu

  2. Install gdal from conda-forge.

    sudo -E conda install -c conda-forge gdal

    The sudo -E is very important!

  3. Install there with pip

    sudo -E pip install there

The packages gdal and there are now available to all users in JupyterHub. If a user already had a python notebook running, they have to restart their notebook’s kernel to make the new libraries available.

See Install conda, pip or apt packages for more information.