JupyterHub offers easy upgrade pathways between minor versions. This document describes how to do these upgrades.
If you are using a JupyterHub distribution, you should consult the distribution’s documentation on how to upgrade. This documentation is for those who have set up their JupyterHub without using a distribution.
This documentation is lengthy because it is quite detailed. Most likely, upgrading JupyterHub is painless, quick and with minimal user interruption.
The steps are discussed in detail, so if you get stuck at any step you can always refer to this guide.
Read the Changelog#
The changelog contains information on what has changed with the new JupyterHub release and any deprecation warnings. Read these notes to familiarize yourself with the coming changes. There might be new releases of the authenticators & spawners you use, so read the changelogs for those too!
Notify your users#
If you use the default configuration where
is managed by JupyterHub, your users will see service disruption during
the upgrade process. You should notify them, and pick a time to do the
upgrade where they will be least disrupted.
If you use a different proxy or run
independent of JupyterHub, your users will be able to continue using notebook
servers they had already launched, but will not be able to launch new servers or sign in.
Backup database & config#
Before doing an upgrade, it is critical to back up:
Your JupyterHub database (SQLite by default, or MySQL / Postgres if you used those). If you use SQLite (the default), you should backup the
Your users’ home directories. This is unlikely to be affected directly by a JupyterHub upgrade, but we recommend a backup since user data is critical.
Shut down JupyterHub#
Shut down the JupyterHub process. This would vary depending on how you
have set up JupyterHub to run. It is most likely using a process
supervisor of some sort (
supervisord or even
Use the supervisor-specific command to stop the JupyterHub process.
Upgrade JupyterHub packages#
There are two environments where the
jupyterhub package is installed:
The hub environment: where the JupyterHub server process runs. This is started with the
jupyterhubcommand, and is what people generally think of as JupyterHub.
The notebook user environments: where the user notebook servers are launched from, and is probably custom to your own installation. This could be just one environment (different from the hub environment) that is shared by all users, one environment per user, or the same environment as the hub environment. The hub launched the
jupyterhub-singleusercommand in this environment, which in turn starts the notebook server.
You need to make sure the version of the
jupyterhub package matches
in both these environments. If you installed
jupyterhub with pip,
you can upgrade it with:
python3 -m pip install --upgrade jupyterhub==<version>
<version> is the version of JupyterHub you are upgrading to.
If you used
conda to install
jupyterhub, you should upgrade it
conda install -c conda-forge jupyterhub==<version>
You should also check for new releases of the authenticator & spawner you are using. You might wish to upgrade those packages, too, along with JupyterHub or upgrade them separately.
Upgrade JupyterHub database#
Once new packages are installed, you need to upgrade the JupyterHub
database. From the hub environment, in the same directory as your
jupyterhub_config.py file, you should run:
This should find the location of your database, and run the necessary upgrades for it.
SQLite database disadvantages#
SQLite has some disadvantages when it comes to upgrading JupyterHub. These are:
upgrade-dbmay not work, and you may need to delete your database and start with a fresh one.
downgrade-dbwill not work if you want to rollback to an earlier version, so backup the
jupyterhub.sqlitefile before upgrading.
What happens if I delete my database?#
Losing the Hub database is often not a big deal. Information that resides only in the Hub database includes:
active login tokens (user cookies, service tokens)
users added via JupyterHub UI, instead of config files
info about running servers
If the following conditions are true, you should be fine clearing the Hub database and starting over:
users specified in the config file, or login using an external authentication provider (Google, GitHub, LDAP, etc)
user servers are stopped during the upgrade
don’t mind causing users to log in again after the upgrade
Once the database upgrade is completed, start the
Log in and start the server to make sure things work as expected.
Check the logs for any errors or deprecation warnings. You might have to update your
jupyterhub_config.pyfile to deal with any deprecated options.
Congratulations, your JupyterHub has been upgraded!