For detailed changes from the prior release, click on the version number, and its link will bring up a GitHub listing of changes. Use git log on the command line for details.


JupyterHub follows Intended Effort Versioning (EffVer) for versioning, where the version number is meant to indicate the amount of effort required to upgrade to the new version.

Contributors to major version bumps in JupyterHub include:

  • Database schema changes that require migrations and are hard to roll back

  • Increasing the minimum required Python version

  • Large new features

  • Breaking changes likely to affect users



5.0.0 - 2024-05-25#

5.0.0 is a major release of JupyterHub. It has lots of cool new features.

For information about upgrading, see upgrading to 5.0 documentation.

Changes that are likely to require effort to upgrade:

  • New JupyterHub.subdomain_hook and default subdomain scheme is more reliable and should work for all usernames.

  • JupyterHub now requires Python 3.8

  • New Authenticator.allow_all and allow_existing_users configuration options. Implicitly allowing all authenticated users when no explicit allow config is provided is no longer the default.

  • bootstrap is upgraded to 5.3, which may require upgrading if you have custom page templates or use Spawner.options_form

(full changelog)

API and Breaking Changes#

New features added#

Enhancements made#

Bugs fixed#

Maintenance and upkeep improvements#

Documentation improvements#

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@Achele (activity) | @akashthedeveloper (activity) | @akhmerov (activity) | @aktech (activity) | @balajialg (activity) | @BenGig (activity) | @BhavyaT-135 (activity) | @bl-aire (activity) | @blink1073 (activity) | @cccs-nik (activity) | @consideRatio (activity) | @danilopeixoto (activity) | @davidbrochart (activity) | @diocas (activity) | @echarles (activity) | @eeeeeeeason (activity) | @fcollonval (activity) | @GeorgianaElena (activity) | @I-Am-D-B (activity) | @isaprykin (activity) | @jabbera (activity) | @jacobtomlinson (activity) | @jakirkham (activity) | @johncf (activity) | @johnpmayer (activity) | @jrdnbradford (activity) | @krassowski (activity) | @kreuzert (activity) | @ktaletsk (activity) | @kzgrzendek (activity) | @lahwaacz (activity) | @LexiJess (activity) | @lrlunin (activity) | @lumberbot-app (activity) | @mahendrapaipuri (activity) | @manics (activity) | @marcwit (activity) | @mathbunnyru (activity) | @mbiette (activity) | @MetRonnie (activity) | @minrk (activity) | @mxab (activity) | @nreith (activity) | @Ph0tonic (activity) | @rcthomas (activity) | @rizz-sd (activity) | @rschroll (activity) | @ryanlovett (activity) | @sgaist (activity) | @shubham0473 (activity) | @Temidayo32 (activity) | @uellue (activity) | @umka1332 (activity) | @varundhand (activity) | @willingc (activity) | @yuvipanda (activity)


4.1.5 - 2024-04-04#

(full changelog)

Bugs fixed#

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@consideRatio (activity) | @manics (activity) | @minrk (activity)

4.1.4 - 2024-03-30#

(full changelog)

Bugs fixed#

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@consideRatio (activity) | @minrk (activity)

4.1.3 - 2024-03-26#

(full changelog)

Bugs fixed#

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@consideRatio (activity) | @minrk (activity)

4.1.2 - 2024-03-25#

4.1.2 fixes a regression in 4.1.0 affecting named servers.

(full changelog)

Bugs fixed#

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@consideRatio (activity) | @minrk (activity)

4.1.1 - 2024-03-23#

4.1.1 fixes a compatibility regression in 4.1.0 for some extensions, particularly jupyter-server-proxy.

(full changelog)

Bugs fixed#

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@consideRatio (activity) | @minrk (activity)

4.1.0 - 2024-03-20#

JupyterHub 4.1 is a security release, fixing CVE-2024-28233. All JupyterHub deployments are encouraged to upgrade, especially those with other user content on peer domains to JupyterHub.

As always, JupyterHub deployments are especially encouraged to enable per-user domains if protecting users from each other is a concern.

For more information on securely deploying JupyterHub, see the web security documentation.

(full changelog)

Enhancements made#

  • Backport PR #4628 on branch 4.x (Include LDAP groups in local spawner gids) #4735 (@minrk)

  • Backport PR #4561 on branch 4.x (Improve debugging when waiting for servers) #4714 (@minrk)

  • Backport PR #4563 on branch 4.x (only set ‘domain’ field on session-id cookie) #4707 (@minrk)

Bugs fixed#

  • Backport PR #4733 on branch 4.x (Catch ValueError while waiting for server to be reachable) #4734 (@minrk)

  • Backport PR #4679 on branch 4.x (Unescape jinja username) #4705 (@minrk)

  • Backport PR #4630: avoid setting unused oauth state cookies on API requests #4697 (@minrk)

  • Backport PR #4632: simplify, avoid errors in parsing accept headers #4696 (@minrk)

  • Backport PR #4677 on branch 4.x (Improve validation, docs for token.expires_in) #4692 (@minrk)

  • Backport PR #4570 on branch 4.x (fix mutation of frozenset in scope intersection) #4691 (@minrk)

  • Backport PR #4562 on branch 4.x (Use user.stop to cleanup spawners that stopped while Hub was down) #4690 (@minrk)

  • Backport PR #4542 on branch 4.x (Fix include_stopped_servers in paginated next_url) #4689 (@minrk)

  • Backport PR #4651 on branch 4.x (avoid attempting to patch removed IPythonHandler with notebook v7) #4688 (@minrk)

  • Backport PR #4560 on branch 4.x (singleuser extension: persist token from ?token=… url in cookie) #4687 (@minrk)

Maintenance and upkeep improvements#

  • Backport publishing #4698 (@minrk)

  • Backport PR #4617: try to improve reliability of test_external_proxy #4695 (@minrk)

  • Backport PR #4618 on branch 4.x (browser test: wait for token request to finish before reloading) #4694 (@minrk)

  • preparing 4.x branch #4685 (@minrk, @consideRatio)

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@Achele (activity) | @akashthedeveloper (activity) | @balajialg (activity) | @BhavyaT-135 (activity) | @blink1073 (activity) | @consideRatio (activity) | @fcollonval (activity) | @I-Am-D-B (activity) | @jakirkham (activity) | @ktaletsk (activity) | @kzgrzendek (activity) | @lumberbot-app (activity) | @manics (activity) | @mbiette (activity) | @minrk (activity) | @rcthomas (activity) | @ryanlovett (activity) | @sgaist (activity) | @shubham0473 (activity) | @Temidayo32 (activity) | @willingc (activity) | @yuvipanda (activity)


4.0.2 - 2023-08-10#

(full changelog)

Enhancements made#

Bugs fixed#

Documentation improvements#

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@agelosnm (activity) | @consideRatio (activity) | @diocas (activity) | @grios-stratio (activity) | @jhgoebbert (activity) | @jtpio (activity) | @kosmonavtus (activity) | @kreuzert (activity) | @manics (activity) | @martinRenou (activity) | @minrk (activity) | @opoplawski (activity) | @Ph0tonic (activity) | @sgaist (activity) | @trungleduc (activity) | @yuvipanda (activity)

4.0.1 - 2023-06-08#

(full changelog)

Enhancements made#

Bugs fixed#

Maintenance and upkeep improvements#

Documentation improvements#

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@consideRatio (activity) | @diocas (activity) | @echarles (activity) | @goseind (activity) | @hsadia538 (activity) | @mahamtariq58 (activity) | @manics (activity) | @matuskosut (activity) | @minrk (activity) | @mouse1203 (activity) | @opoplawski (activity) | @rcthomas (activity) | @ryanlovett (activity) | @tfmark (activity) | @timeu (activity) | @yuvipanda (activity)

4.0.0 - 2023-04-20#

4.0 is a major release, but a small one.

Upgrade note

Upgrading from 3.1 to 4.0 should require no additional action beyond running jupyterhub --upgrade-db to upgrade the database schema after upgrading the package version. It is otherwise a regular jupyterhub upgrade.

There are three major changes that should be invisible to most users:

  1. Groups can now have ‘properties’, editable via the admin page, which can be used by Spawners for their operations. This requires a db schema upgrade, so remember to backup and upgrade your database!

  2. Often-problematic header-based checks for cross-site requests have been replaces with more standard use of XSRF tokens. Most folks shouldn’t notice this change, but if “Blocking Cross Origin API request” has been giving you headaches, this should be much improved.

  3. Improved support for Jupyter Server 2.0 by reimplementing jupyterhub-singleuser as a standard server extension. This mode is used by default with Jupyter Server >=2.0. Again, this should be an implementation detail to most, but it’s a big change under the hood. If you have issues, please let us know and you can opt-out by setting JUPYTERHUB_SINGLEUSER_EXTENSION=0 in your single-user environment.

In addition to these, thanks to contributions from this years Outreachy interns, we have reorganized the documentation according to diataxis, improved accessibility of JupyterHub pages, and improved testing.

(full changelog)

API and Breaking Changes#

New features added#

Enhancements made#

Bugs fixed#

Maintenance and upkeep improvements#

Documentation improvements#

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@3coins (activity) | @ajcollett (activity) | @ajpower (activity) | @alekseyolg (activity) | @alwasega (activity) | @betatim (activity) | @bl-aire (activity) | @choldgraf (activity) | @consideRatio (activity) | @crazytan (activity) | @dependabot (activity) | @fperez (activity) | @GeorgianaElena (activity) | @julietKiloRomeo (activity) | @ktaletsk (activity) | @manics (activity) | @mathbunnyru (activity) | @meeseeksdev (activity) | @meeseeksmachine (activity) | @minrk (activity) | @mouse1203 (activity) | @naatebarber (activity) | @pnasrat (activity) | @pre-commit-ci (activity) | @ryanlovett (activity) | @sgibson91 (activity) | @shaneknapp (activity) | @Sheila-nk (activity) | @stevejpurves (activity) | @TaofeeqatDev (activity) | @vladfreeze (activity) | @yuvipanda (activity)


3.1.1 - 2023-01-27#

3.1.1 has only tiny bugfixes, enabling compatibility with the latest sqlalchemy 2.0 release, and fixing some metadata files that were not being included in wheel installs.

(full changelog)

Bugs fixed#

  • Backport PR #4303 on branch 3.x: make sure event-schemas are installed #4317 (@minrk)

  • Backport PR #4302 on branch 3.x: sqlalchemy 2 compatibility #4315 (@minrk)

3.1.0 - 2022-12-05#

3.1.0 is a small release, fixing various bugs and introducing some small new features and metrics. See more details below.

Thanks to many Outreachy applicants for significantly improving our documentation! This release fixes a problem in the jupyterhub/jupyterhub docker image, where the admin page could be empty.

(full changelog)

New features added#

Bugs fixed#

Maintenance and upkeep improvements#

Documentation improvements#

API and Breaking Changes#

Contributors to this release#

(GitHub contributors page for this release)

@Achele | @AdrianaHelga | @alexanderchosen | @alwasega | @ArafatAbdussalam | @behrmann | @bl-aire | @Busayo-ojo | @chicken-biryani | @choldgraf | @Christiandike | @consideRatio | @danilopeixoto | @dependabot | @dietmarw | @Emenyi95 | @emmanuella194 | @ericdill | @Eshy10 | @EstherChristopher | @falyne | @GeorgianaElena | @Ginohmk | @github-actions | @Goodiec | @hjoliver | @hsadia538 | @ikeadeoyin | @iLynette | @Joel-Ando | @KaluBuikem | @kamzzy | @liliyao2022 | @lumenCodes | @Mackenzie-OO7 | @mahamtariq58 | @manics | @melissakirabo | @minrk | @miwig | @mouse1203 | @mriedem | @Neeraj-Natu | @NPDebs | @PoorvajaRayas | @pre-commit-ci | @ruqayaahh | @ryanlovett | @sgibson91 | @softkeldozy | @Teebarh | @Temidayo32 | @Teniola-theDev | @timeu | @ToobaJamal | @utkarshgupta137 | @Uzor13 | @willingc | @yamakat | @yuvipanda | @zeelyha


3.0.0 - 2022-09-08#

3.0 is a major upgrade, but a small one.

It qualifies as a major upgrade because of two changes:

  1. It includes a database schema change (jupyterhub --upgrade-db). The schema change should not be disruptive, but we’ve decided that any schema change qualifies as a major version upgrade.

  2. We’ve dropped support for Python 3.6, which reached End-of-Life in 2021. If you are using at least Python 3.7, this change should have no effect.

The database schema change is small and should not be disruptive, but downgrading is always harder than upgrading after a db migration, which makes rolling back the update more likely to be problematic.

Changes in RBAC#

The biggest changes in 3.0 relate to JupyterHub RBAC, which also means they shouldn’t affect most users. The users most affected will be JupyterHub admins using JupyterHub roles extensively to define user permissions.

After testing 2.0 in the wild, we learned that we had used roles in a few places that should have been scopes. Specifically, OAuth tokens now have scopes instead of roles (and token-issuing oauth clients now have allowed_scopes instead of allowed_roles). The consequences should be fairly transparent to users, but anyone who ran into the restrictions of roles in the oauth process should find scopes easier to work with. We tried not to break anything here, so any prior use of roles will still work with a deprecation, but the role will be resolved immediately at token-issue time, rather than every time the token is used.

This especially came up testing the new Custom scopes feature. Authors of JupyterHub-authenticated services can now extend JupyterHub’s RBAC functionality to define their own scopes, and assign them to users and groups via roles. This can be used to e.g. limit student/grader/instructor permissions in a grading service, or grant instructors read-only access to their students’ single-user servers starting with upcoming Jupyter Server 2.0.

Further extending granular control of permissions, we have added !service and !server filters for scopes (Self-referencing filters), like we had for !user.

Access to the admin UI is now governed by a dedicated admin-ui scope, rather than combined admin:servers and admin:users in 2.0. More info in Available scopes.

More highlights#

  • The admin UI can now show more detailed info about users and their servers in a drop-down details table:

    Details view in admin UI

  • Several bugfixes and improvements in the new admin UI.

  • Direct access to the Hub’s database is deprecated. We intend to change the database connection lifecycle in the future to enable scalability and high-availability (HA), and limiting where connections and transactions can occur is an important part of making that possible.

  • Lots more bugfixes and error-handling improvements.

(full changelog)

New features added#

Enhancements made#

Bugs fixed#

Maintenance and upkeep improvements#

Documentation improvements#

API and Breaking Changes#

Contributors to this release#

(GitHub contributors page for this release)

@ajcollett | @bbrauns | @benz0li | @betatim | @blink1073 | @brospars | @Carreau | @choldgraf | @cmd-ntrf | @code-review-doctor | @consideRatio | @cqzlxl | @dependabot | @fabianbaier | @GeorgianaElena | @github-actions | @hansen-m | @huage1994 | @jbaksta | @jgwerner | @jhermann | @johnkpark | @jwclark | @maluhoss | @manics | @mathematicalmichael | @meeseeksdev | @minrk | @mriedem | @naatebarber | @NarekA | @naveensrinivasan | @nicorikken | @nsshah1288 | @panruipr | @paulkerry1 | @possiblyMikeB | @pre-commit-ci | @rcthomas | @robnagler | @rpwagner | @ryogesh | @sgibson91 | @silenius | @SonakshiGrover | @superfive666 | @tharwan | @vpavlin | @willingc | @ykazakov | @yuvipanda | @zoltan-fedor


2.3.1 - 2022-06-06#

This release includes a selection of bugfixes.

Bugs fixed#

Contributors to this release#

(GitHub contributors page for this release)

@bbrauns | @betatim | @blink1073 | @brospars | @Carreau | @choldgraf | @consideRatio | @fabianbaier | @GeorgianaElena | @github-actions | @hansen-m | @jbaksta | @jgwerner | @jhermann | @johnkpark | @maluhoss | @manics | @mathematicalmichael | @meeseeksdev | @minrk | @mriedem | @naatebarber | @NarekA | @nicorikken | @nsshah1288 | @panruipr | @paulkerry1 | @rcthomas | @robnagler | @ryogesh | @sgibson91 | @SonakshiGrover | @tharwan | @vpavlin | @welcome | @willingc | @yuvipanda | @zoltan-fedor

2.3.0 - 2022-05-06#

Enhancements made#

Bugs fixed#

Maintenance and upkeep improvements#

Documentation improvements#

Contributors to this release#

(GitHub contributors page for this release)

@choldgraf | @cmd-ntrf | @code-review-doctor | @consideRatio | @dependabot | @GeorgianaElena | @github-actions | @huage1994 | @johnkpark | @jwclark | @manics | @minrk | @NarekA | @pre-commit-ci | @sgibson91 | @ykazakov | @yuvipanda


2.2.2 2022-03-14#

2.2.2 fixes a small regressions in 2.2.1.

(full changelog)

Bugs fixed#

Continuous integration improvements#

Contributors to this release#

(GitHub contributors page for this release)

@consideRatio | @manics | @minrk | @NarekA

2.2.1 2022-03-11#

2.2.1 fixes a few small regressions in 2.2.0.

(full changelog)

Bugs fixed#

Maintenance and upkeep improvements#


Contributors to this release#

(GitHub contributors page for this release)

@choldgraf | @consideRatio | @minrk | @NarekA | @yuvipanda

2.2.0 2022-03-07#

JupyterHub 2.2.0 is a small release. The main new feature is the ability of Authenticators to manage group membership, e.g. when the identity provider has its own concept of groups that should be preserved in JupyterHub.

The links to access user servers from the admin page have been restored.

(full changelog)

New features added#

Enhancements made#

Bugs fixed#

Documentation improvements#

Behavior Changes#

Contributors to this release#

(GitHub contributors page for this release)

@blink1073 | @clkao | @consideRatio | @cqzlxl | @dependabot | @dtaniwaki | @fcollonval | @GeorgianaElena | @github-actions | @kshitija08 | @ktaletsk | @manics | @minrk | @NarekA | @pre-commit-ci | @rajat404 | @rcthomas | @ryogesh | @rzo1 | @satra | @thomafred | @tmtabor | @tobi45 | @ykazakov


2.1.1 2022-01-25#

2.1.1 is a tiny bugfix release, fixing an issue where admins did not receive the new read:metrics permission.

(full changelog)

Bugs fixed#

Contributors to this release#

(GitHub contributors page for this release)

@consideRatio | @dependabot | @manics | @minrk

2.1.0 2022-01-21#

2.1.0 is a small bugfix release, resolving regressions in 2.0 and further refinements. In particular, the authenticated prometheus metrics endpoint did not work in 2.0 because it lacked a scope. To access the authenticated metrics endpoint with a token, upgrade to 2.1 and make sure the token/owner has the read:metrics scope.

Custom error messages for failed spawns are now handled more consistently on the spawn-progress API and the spawn-failed HTML page. Previously, spawn-progress did not relay the custom message provided by exception.jupyterhub_message, and full HTML messages in exception.jupyterhub_html_message can now be displayed in both contexts.

The long-deprecated, inconsistent behavior when users visited a URL for another user’s server, where they could sometimes be redirected back to their own server, has been removed in favor of consistent behavior based on the user’s permissions. To share a URL that will take any user to their own server, use https://my.hub/hub/user-redirect/path/....

(full changelog)

Enhancements made#

  • relay custom messages in exception.jupyterhub_message in progress API #3764 (@minrk)

  • Add the capability to inform a connection to Alembic Migration Script #3762 (@DougTrajano)

Bugs fixed#

  • Fix loading Spawner.user_options from db #3773 (@IgorBerman)

  • Add missing read:metrics scope for authenticated metrics endpoint #3770 (@minrk)

  • apply scope checks to some admin-or-self situations #3763 (@minrk)

Maintenance and upkeep improvements#

  • DOCS: Add github metadata for edit button #3775 (@minrk)

Documentation improvements#

  • Improve documentation about spawner exception handling #3765 (@twalcari)

Contributors to this release#

(GitHub contributors page for this release)

@consideRatio | @dependabot | @DougTrajano | @IgorBerman | @minrk | @twalcari | @welcome


2.0.2 2022-01-10#

2.0.2 fixes a regression in 2.0.1 causing false positives rejecting valid requests as cross-origin, mostly when JupyterHub is behind additional proxies.

(full changelog)

Bugs fixed#

  • use outermost proxied entry when looking up browser protocol #3757 (@minrk)

Maintenance and upkeep improvements#

Documentation improvements#

Contributors to this release#

(GitHub contributors page for this release)

@choldgraf | @consideRatio | @github-actions | @jakob-keller | @manics | @meeseeksmachine | @minrk | @pre-commit-ci | @welcome


(full changelog)

2.0.1 is a bugfix release, with some additional small improvements, especially in the new RBAC handling and admin page.

Several issues are fixed where users might not have the default ‘user’ role as expected.

Enhancements made#

Bugs fixed#

  • initialize new admin users with default roles #3735 (@minrk)

  • Fix missing f-string modifier #3733 (@manics)

  • accept token auth on /hub/user/... #3731 (@minrk)

  • simplify default role assignment #3720 (@minrk)

  • fix Spawner.oauth_roles config #3717 (@minrk)

  • Fix error message about Authenticator.pre_spawn_start #3716 (@minrk)

  • admin: Pass Base Url #3715 (@naatebarber)

  • Grant role after user creation during config load #3714 (@a3626a)

  • Avoid clearing user role membership when defining custom user scopes #3708 (@minrk)

  • cors: handle mismatched implicit/explicit ports in host header #3701 (@minrk)

Maintenance and upkeep improvements#

  • clarify role argument in grant/strip_role #3727 (@minrk)

  • check for db clients before requesting install #3719 (@minrk)

  • run jsx tests in their own job #3698 (@minrk)

Documentation improvements#

Contributors to this release#

(GitHub contributors page for this release)

@a3626a | @betatim | @consideRatio | @github-actions | @kylewm | @manics | @minrk | @naatebarber | @pre-commit-ci | @sgaist | @welcome


JupyterHub 2.0 is a big release!

The most significant change is the addition of roles and scopes to the JupyterHub permissions model, allowing more fine-grained access control. Read more about it in the docs.

In particular, the ‘admin’ level of permissions should not be needed anymore, and you can now grant users and services only the permissions they need, not more. We encourage you to review permissions, especially any service or user with admin: true and consider assigning only the necessary roles and scopes.

JupyterHub 2.0 requires an update to the database schema, so make sure to read the upgrade documentation and backup your database before upgrading.

stop all servers before upgrading

Upgrading JupyterHub to 2.0 revokes all tokens issued before the upgrade, which means that single-user servers started before the upgrade will become inaccessible after the upgrade until they have been stopped and started again. To avoid this, it is best to shutdown all servers prior to the upgrade.

Other major changes that may require updates to your deployment, depending on what features you use:

  • List endpoints now support pagination, and have a max page size, which means API consumers must be updated to make paginated requests if you have a lot of users and/or groups.

  • Spawners have stopped specifying any command-line options to spawners by default. Previously, --ip and --port could be specified on the command-line. From 2.0 forward, JupyterHub will only communicate options to Spawners via environment variables, and the command to be launched is configured exclusively via Spawner.cmd and Spawner.args.

Other new features:

  • new Admin page, written in React. With RBAC, it should now be fully possible to implement a custom admin panel as a service via the REST API.

  • JupyterLab is the default UI for single-user servers, if available in the user environment. See more info in the docs about switching back to the classic notebook, if you are not ready to switch to JupyterLab.

  • NullAuthenticator is now bundled with JupyterHub, so you no longer need to install the nullauthenticator package to disable login, you can set c.JupyterHub.authenticator_class = 'null'.

  • Support jupyterhub --show-config option to see your current jupyterhub configuration.

  • Add expiration date dropdown to Token page

and major bug fixes:

  • Improve database rollback recovery on broken connections

and other changes:

  • Requests to a not-running server (e.g. visiting /user/someuser/) will return an HTTP 424 error instead of 503, making it easier to monitor for real deployment problems. JupyterLab in the user environment should be at least version 3.1.16 to recognize this error code as a stopped server. You can temporarily opt-in to the older behavior (e.g. if older JupyterLab is required) by setting c.JupyterHub.use_legacy_stopped_server_status_code = True.

Plus lots of little fixes along the way.

2.0.0 - 2021-12-01#

(full changelog)

New features added#

Enhancements made#

Bugs fixed#

  • Hub: only accept tokens in API requests #3686 (@minrk)

  • Forward-port fixes from 1.5.0 security release #3679 (@minrk)

  • raise 404 on admin attempt to spawn nonexistent user #3653 (@minrk)

  • new user token returns 200 instead of 201 #3646 (@joegasewicz)

  • Added base_url to path for jupyterhub-session-id cookie #3625 (@albertmichaelj)

  • Fix wrong name of auth_state_hook in the exception log #3569 (@dolfinus)

  • Stop injecting statsd parameters into the configurable HTTP proxy #3568 (@paccorsi)

  • explicit DB rollback for 500 errors #3566 (@nsshah1288)

  • don’t omit server model if it’s empty #3564 (@minrk)

  • ensure admin requests for missing users 404 #3563 (@minrk)

  • Avoid zombie processes in case of using LocalProcessSpawner #3543 (@dolfinus)

  • Fix regression where external services api_token became required #3531 (@consideRatio)

  • Fix allow_all check when only allow_admin is set #3526 (@dolfinus)

  • Bug: save_bearer_token ( passes a float value to the expires_at field (int) #3484 (@weisdd)

Maintenance and upkeep improvements#

Documentation improvements#

Contributors to this release#

(GitHub contributors page for this release)

@0mar | @AbdealiJK | @albertmichaelj | @betatim | @bollwyvl | @choldgraf | @consideRatio | @cslocum | @danlester | @davidbrochart | @dependabot | @diurnalist | @dolfinus | @echarles | @edgarcosta | @ellisonbg | @eruditehassan | @icankeep | @IvanaH8 | @joegasewicz | @manics | @meeseeksmachine | @minrk | @mriedem | @naatebarber | @nsshah1288 | @octavd | @OrnithOrtion | @paccorsi | @panruipr | @pre-commit-ci | @rpwagner | @sgibson91 | @support | @twalcari | @VaishnaviHire | @warwing | @weisdd | @welcome | @willingc | @ykazakov | @yuvipanda


JupyterHub 1.5 is a security release, fixing a vulnerability ghsa-cw7p-q79f-m2v7 where JupyterLab users with multiple tabs open could fail to logout completely, leaving their browser with valid credentials until they logout again.

A few fully backward-compatible features have been backported from 2.0.

1.5.1 2022-12-05#

This is a patch release, improving db resiliency when certain errors occur, without requiring a jupyterhub restart.

(full changelog)

Merged PRs#

Contributors to this release#

(GitHub contributors page for this release)

@mriedem | @minrk | @nsshah1288

1.5.0 2021-11-04#

(full changelog)

New features added#

  • Backport #3636 to 1.4.x (opt-in support for JupyterHub.use_legacy_stopped_server_status_code) #3639 (@yuvipanda)

  • Backport PR #3552 on branch 1.4.x (Add expiration date dropdown to Token page) #3580 (@meeseeksmachine)

  • Backport PR #3488 on branch 1.4.x (Support auto login when used as a OAuth2 provider) #3579 (@meeseeksmachine)

Maintenance and upkeep improvements#

Documentation improvements#

  • use_legacy_stopped_server_status_code: use 1.* language #3676 (@manics)

Contributors to this release#

(GitHub contributors page for this release)

@choldgraf | @consideRatio | @manics | @meeseeksmachine | @minrk | @support | @welcome | @yuvipanda


JupyterHub 1.4 is a small release, with several enhancements, bug fixes, and new configuration options.

There are no database schema changes requiring migration from 1.3 to 1.4.

1.4 is also the first version to start publishing docker images for arm64.

In particular, OAuth tokens stored in user cookies, used for accessing single-user servers and hub-authenticated services, have changed their expiration from one hour to the expiry of the cookie in which they are stored (default: two weeks). This is now also configurable via JupyterHub.oauth_token_expires_in.

The result is that it should be much less likely for auth tokens stored in cookies to expire during the lifetime of a server.

1.4.2 2021-06-15#

1.4.2 is a small bugfix release for 1.4.

(full changelog)

Bugs fixed#

  • Fix regression where external services api_token became required #3531 (@consideRatio)

  • Bug: save_bearer_token ( passes a float value to the expires_at field (int) #3484 (@weisdd)

Maintenance and upkeep improvements#

Documentation improvements#

Contributors to this release#

(GitHub contributors page for this release)

@consideRatio | @davidbrochart | @icankeep | @minrk | @weisdd

1.4.1 2021-05-12#

1.4.1 is a small bugfix release for 1.4.

(full changelog)

Enhancements made#

Bugs fixed#

  • define Spawner.delete_forever on base Spawner #3454 (@minrk)

  • patch base handlers from both jupyter_server and notebook #3437 (@minrk)

Maintenance and upkeep improvements#

Documentation improvements#

Contributors to this release#

(GitHub contributors page for this release)

@0mar | @betatim | @consideRatio | @danlester | @davidbrochart | @IvanaH8 | @manics | @minrk | @naatebarber | @OrnithOrtion | @support | @welcome

1.4.0 2021-04-19#

(full changelog)

New features added#

Enhancements made#

Bugs fixed#

  • always start redirect count at 1 when redirecting /hub/user/:name -> /user/:name #3377 (@minrk)

  • Always raise on failed token creation #3370 (@minrk)

  • make_singleuser_app: patch-in HubAuthenticatedHandler at lower priority #3347 (@minrk)

  • Fix pagination with named servers #3335 (@rcthomas)

Maintenance and upkeep improvements#

Documentation improvements#

Contributors to this release#

(GitHub contributors page for this release)

@00Kai0 | @8rV1n | @akhilputhiry | @alexal | @analytically | @andreamazzoni | @andrewisplinghoff | @BertR | @betatim | @bitnik | @bollwyvl | @carluri | @Carreau | @consideRatio | @davidedelvento | @dhirschfeld | @dmpe | @dsblank | @dtaniwaki | @echarles | @elgalu | @eran-pinhas | @gaebor | @GeorgianaElena | @gsemet | @gweis | @hynek2001 | @ianabc | @ibre5041 | @IvanaH8 | @jhegedus42 | @jhermann | @jiajunjie | @jtlz2 | @kafonek | @katsar0v | @kinow | @krinsman | @laurensdv | @lits789 | @m-alekseev | @mabbasi90 | @manics | @manniche | @maxshowarth | @mdivk | @meeseeksmachine | @minrk | @mogthesprog | @mriedem | @nsshah1288 | @olifre | @PandaWhoCodes | @pawsaw | @phozzy | @playermanny2 | @rabsr | @randy3k | @rawrgulmuffins | @rcthomas | @rebeca-maia | @rebenkoy | @rkdarst | @robnagler | @ronaldpetty | @ryanlovett | @ryogesh | @sbailey-auro | @sigurdurb | @SivaAccionLabs | @sougou | @stv0g | @sudi007 | @support | @tathagata | @timgates42 | @trallard | @vlizanae | @welcome | @whitespaceninja | @whlteXbread | @willingc | @yuvipanda | @Zsailer


JupyterHub 1.3 is a small feature release. Highlights include:

  • Require Python >=3.6 (jupyterhub 1.2 is the last release to support 3.5)

  • Add a ?state= filter for getting user list, allowing much quicker responses when retrieving a small fraction of users. state can be active, inactive, or ready.

  • prometheus metrics now include a jupyterhub_ prefix, so deployments may need to update their grafana charts to match.

  • page templates can now be async!


(full changelog)

Enhancements made#

  • allow services to call /api/user to identify themselves #3293 (@minrk)

  • Add optional user agreement to login screen #3264 (@tlvu)

  • [Metrics] Add prefix to prometheus metrics to group all jupyterhub metrics #3243 (@agp8x)

  • Allow options_from_form to be configurable #3225 (@cbanek)

  • add ?state= filter for GET /users #3177 (@minrk)

  • Enable async support in jinja2 templates #3176 (@yuvipanda)

Bugs fixed#

Maintenance and upkeep improvements#

Documentation improvements#

Contributors to this release#

(GitHub contributors page for this release)

@0mar | @agp8x | @alexweav | @belfhi | @betatim | @cbanek | @cmd-ntrf | @coffeebenzene | @consideRatio | @danlester | @fcollonval | @GeorgianaElena | @ianabc | @IvanaH8 | @manics | @meeseeksmachine | @mhwasil | @minrk | @mriedem | @mxjeff | @olifre | @rcthomas | @rgbkrk | @rkdarst | @Sangarshanan | @slemonide | @support | @tlvu | @welcome | @yuvipanda


1.2.2 2020-11-27#

(full changelog)

Enhancements made#

  • Standardize “Sign in” capitalization on the login page #3252 (@cmd-ntrf)

Bugs fixed#

  • Fix RootHandler when default_url is a callable #3265 (@danlester)

  • Only preserve params when ?next= is unspecified #3261 (@minrk)

  • [Windows] Improve robustness when detecting and closing existing proxy processes #3237 (@alexweav)

Maintenance and upkeep improvements#

Documentation improvements#

  • Update to use jupyterhub_idle_culler #3257 (@manics)

Contributors to this release#

(GitHub contributors page for this release)

@alexweav | @belfhi | @betatim | @cmd-ntrf | @consideRatio | @danlester | @fcollonval | @GeorgianaElena | @ianabc | @IvanaH8 | @manics | @meeseeksmachine | @minrk | @mriedem | @olifre | @rcthomas | @rgbkrk | @rkdarst | @slemonide | @support | @welcome | @yuvipanda

1.2.1 2020-10-30#

(full changelog)

Bugs fixed#

  • JupyterHub services’ oauth_no_confirm configuration regression in 1.2.0 #3234 (@bitnik)

Contributors to this release#

(GitHub contributors page for this release)


1.2.0 2020-10-29#

JupyterHub 1.2 is an incremental release with lots of small improvements. It is unlikely that users will have to change much to upgrade, but lots of new things are possible and/or better!

There are no database schema changes requiring migration from 1.1 to 1.2.


  • Deprecate black/whitelist configuration fields in favor of more inclusive blocked/allowed language. For example: c.Authenticator.allowed_users = {'user', ...}

  • More configuration of page templates and service display

  • Pagination of the admin page improving performance with large numbers of users

  • Improved control of user redirect

  • Support for jupyter-server-based single-user servers, such as Voilà and latest JupyterLab.

  • Lots more improvements to documentation, HTML pages, and customizations

(full changelog)

Enhancements made#

Bugs fixed#

  • Fix #2284 must be sent from authorization page #3219 (@elgalu)

  • avoid specifying default_value=None in Command traits #3208 (@minrk)

  • Prevent OverflowErrors in exponential_backoff() #3204 (@kreuzert)

  • update prometheus metrics for server spawn when it fails with exception #3150 (@yhal-nesi)

  • jupyterhub/utils: Load system default CA certificates in make_ssl_context #3140 (@chancez)

  • admin page sorts on spawner last_activity instead of user last_activity #3137 (@lydian)

  • Fix the services dropdown on the admin page #3132 (@pabepadu)

  • Don’t log a warning when slow_spawn_timeout is disabled #3127 (@mriedem)

  • Work around incompatibility between Tornado 6 and asyncio proactor event loop in python 3.8 on Windows #3123 (@alexweav)

  • jupyterhub/user: clear spawner state after post_stop_hook #3121 (@rkdarst)

  • fix for stopping named server deleting default server and tests #3109 (@kxiao-fn)

  • Hide hamburger button menu in mobile/responsive mode and fix other minor issues #3103 (@kinow)

  • Rename Authenticator.white/blacklist to allowed/blocked #3090 (@minrk)

  • Include the query string parameters when redirecting to a new URL #3089 (@kinow)

  • Make delete_invalid_users configurable #3087 (@fcollonval)

  • Ensure client dependencies build before wheel #3082 (@diurnalist)

  • make Spawner.environment config highest priority #3081 (@minrk)

  • Changing start my server button link to spawn url once server is stopped #3042 (@rabsr)

  • Fix CSS on admin page version listing #3035 (@vilhelmen)

  • Fix user_row endblock in admin template #3015 (@jtpio)

  • Fix –generate-config bug when specifying a filename #2907 (@consideRatio)

  • Handle the protocol when ssl is enabled and log the right URL #2773 (@kinow)

Maintenance and upkeep improvements#

Documentation improvements#

Contributors to this release#

(GitHub contributors page for this release)

@0nebody | @1kastner | @ahkui | @alexdriedger | @alexweav | @AlJohri | @Analect | @analytically | @aneagoe | @AngelOnFira | @barrachri | @basvandervlies | @betatim | @bigbosst | @blink1073 | @Cadair | @Carreau | @cbjuan | @ceocoder | @chancez | @choldgraf | @Chrisjw42 | @cmd-ntrf | @consideRatio | @danlester | @diurnalist | @Dmitry1987 | @dsblank | @dylex | @echarles | @elgalu | @fcollonval | @gatoniel | @GeorgianaElena | @hnykda | @itssimon | @jgwerner | @JohnPaton | @joshmeek | @jtpio | @kinow | @kreuzert | @kxiao-fn | @lesiano | @limimiking | @lydian | @mabbasi90 | @maluhoss | @manics | @matteoipri | @mbmilligan | @meeseeksmachine | @mhwasil | @minrk | @mriedem | @nscozzaro | @pabepadu | @possiblyMikeB | @psyvision | @rabsr | @rainwoodman | @rajat404 | @rcthomas | @reneluria | @rgbkrk | @rkdarst | @rkevin-arch | @romainx | @ryanlovett | @ryogesh | @sdague | @snickell | @SonakshiGrover | @ssanderson | @stefanvangastel | @steinad | @stephen-a2z | @stevegore | @stv0g | @subgero | @sudi007 | @summerswallow | @support | @synchronizing | @thuvh | @tritemio | @twalcari | @vchandvankar | @vilhelmen | @vlizanae | @weimin | @welcome | @willingc | @xlotlu | @yhal-nesi | @ynnelson | @yuvipanda | @zonca | @Zsailer


1.1.0 2020-01-17#

1.1 is a release with lots of accumulated fixes and improvements, especially in performance, metrics, and customization. There are no database changes in 1.1, so no database upgrade is required when upgrading from 1.0 to 1.1.

Of particular interest to deployments with automatic health checking and/or large numbers of users is that the slow startup time introduced in 1.0 by additional spawner validation can now be mitigated by JupyterHub.init_spawners_timeout, allowing the Hub to become responsive before the spawners may have finished validating.

Several new Prometheus metrics are added (and others fixed!) to measure sources of common performance issues, such as proxy interactions and startup.

1.1 also begins adoption of the Jupyter telemetry project in JupyterHub, See The Jupyter Telemetry docs for more info. The only events so far are starting and stopping servers, but more will be added in future releases.

There are many more fixes and improvements listed below. Thanks to everyone who has contributed to this release!


  • LocalProcessSpawner should work on windows by using psutil.pid_exists #2882 (@ociule)

  • trigger auth_state_hook prior to options form, add auth_state to template namespace #2881 (@minrk)

  • Added guide ‘install jupyterlab the hard way’ #2110 #2842 (@mangecoeur)

  • Add prometheus metric to measure hub startup time #2799 (@rajat404)

  • Add Spawner.auth_state_hook #2555 (@rcthomas)

  • Link services from jupyterhub pages #2763 (@rcthomas)

  • JupyterHub.user_redirect_hook is added to allow admins to customize /user-redirect/ behavior #2790 (@yuvipanda)

  • Add prometheus metric to measure hub startup time #2799 (@rajat404)

  • Add prometheus metric to measure proxy route poll times #2798 (@rajat404)

  • PROXY_DELETE_DURATION_SECONDS prometheus metric is added, to measure proxy route deletion times #2788 (@rajat404)

  • Service.oauth_no_confirm is added, it is useful for admin-managed services that are considered part of the Hub and shouldn’t need to prompt the user for access #2767 (@minrk)

  • JupyterHub.default_server_name is added to make the default server be a named server with provided name #2735 (@krinsman)

  • JupyterHub.init_spawners_timeout is introduced to combat slow startups on large JupyterHub deployments #2721 (@minrk)

  • The configuration uids for local authenticators is added to consistently assign users UNIX id’s between installations #2687 (@rgerkin)

  • JupyterHub.activity_resolution is introduced with a default value of 30s improving performance by not updating the database with user activity too often #2605 (@minrk)

  • HubAuth’s SSL configuration can now be set through environment variables #2588 (@cmd-ntrf)

  • Expose spawner.user_options in REST API. #2755 (@danielballan)

  • add block for scripts included in head #2828 (@bitnik)

  • Instrument JupyterHub to record events with jupyter_telemetry [Part II] #2698 (@Zsailer)

  • Make announcements visible without custom HTML #2570 (@consideRatio)

  • Display server version on admin page #2776 (@vilhelmen)


  • Bugfix: pam_normalize_username didn’t return username #2876 (@rkdarst)

  • Cleanup if spawner stop fails #2849 (@gabber12)

  • Fix an issue occurring with the default spawner and internal_ssl enabled #2785 (@rpwagner)

  • Fix named servers to not be spawnable unless activated #2772 (@bitnik)

  • JupyterHub now awaits proxy availability before accepting web requests #2750 (@minrk)

  • Fix a no longer valid assumption that MySQL and MariaDB need to have innodb_file_format and innodb_large_prefix configured #2712 (@chicocvenancio)

  • Login/Logout button now updates to Login on logout #2705 (@aar0nTw)

  • Fix handling of exceptions within pre_spawn_start hooks #2684 (@GeorgianaElena)

  • Fix an issue where a user could end up spawning a default server instead of a named server as intended #2682 (@rcthomas)

  • /hub/admin now redirects to login if unauthenticated #2670 (@GeorgianaElena)

  • Fix spawning of users with names containing characters that needs to be escaped #2648 (@nicorikken)

  • Fix TOTAL_USERS prometheus metric #2637 (@GeorgianaElena)

  • Fix RUNNING_SERVERS prometheus metric #2629 (@GeorgianaElena)

  • Fix faulty redirects to 404 that could occur with the use of named servers #2594 (@vilhelmen)

  • JupyterHub API spec is now a valid OpenAPI spec #2590 (@sbrunk)

  • Use of --help or --version previously could output unrelated errors #2584 (@minrk)

  • No longer crash on startup in Windows #2560 (@adelcast)

  • Escape usernames in the frontend #2640 (@nicorikken)



1.0.0 2019-05-03#

JupyterHub 1.0 is a major milestone for JupyterHub. Huge thanks to the many people who have contributed to this release, whether it was through discussion, testing, documentation, or development.

Major new features#

  • Support TLS encryption and authentication of all internal communication. Spawners must implement .move_certs method to make certificates available to the notebook server if it is not local to the Hub.

  • There is now full UI support for managing named servers. With named servers, each jupyterhub user may have access to more than one named server. For example, a professor may access a server named research and another named teaching.

    named servers on the home page

  • Authenticators can now expire and refresh authentication data by implementing Authenticator.refresh_user(user). This allows things like OAuth data and access tokens to be refreshed. When used together with Authenticator.refresh_pre_spawn = True, auth refresh can be forced prior to Spawn, allowing the Authenticator to require that authentication data is fresh immediately before the user’s server is launched.

New features#

  • allow custom spawners, authenticators, and proxies to register themselves via ‘entry points’, enabling more convenient configuration such as:

    c.JupyterHub.authenticator_class = 'github'
    c.JupyterHub.spawner_class = 'docker'
    c.JupyterHub.proxy_class = 'traefik_etcd'
  • Spawners are passed the tornado Handler object that requested their spawn (as self.handler), so they can do things like make decisions based on query arguments in the request.

  • SimpleSpawner and DummyAuthenticator, which are useful for testing, have been merged into JupyterHub itself:

    # For testing purposes only. Should not be used in production.
    c.JupyterHub.authenticator_class = 'dummy'
    c.JupyterHub.spawner_class = 'simple'

    These classes are not appropriate for production use. Only testing.

  • Add health check endpoint at /hub/health

  • Several prometheus metrics have been added (thanks to Outreachy applicants!)

  • A new API for registering user activity. To prepare for the addition of alternate proxy implementations, responsibility for tracking activity is taken away from the proxy and moved to the notebook server (which already has activity tracking features). Activity is now tracked by pushing it to the Hub from user servers instead of polling the proxy API.

  • Dynamic options_form callables may now return an empty string which will result in no options form being rendered.

  • Spawner.user_options is persisted to the database to be re-used, so that a server spawned once via the form can be re-spawned via the API with the same options.

  • Added c.PAMAuthenticator.pam_normalize_username option for round-tripping usernames through PAM to retrieve the normalized form.

  • Added c.JupyterHub.named_server_limit_per_user configuration to limit the number of named servers each user can have. The default is 0, for no limit.

  • API requests to HubAuthenticated services (e.g. single-user servers) may pass a token in the Authorization header, matching authentication with the Hub API itself.

  • Added Authenticator.is_admin(handler, authentication) method and Authenticator.admin_groups configuration for automatically determining that a member of a group should be considered an admin.

  • New c.Authenticator.post_auth_hook configuration that can be any callable of the form async def hook(authenticator, handler, authentication=None):. This hook may transform the return value of Authenticator.authenticate() and return a new authentication dictionary, e.g. specifying admin privileges, group membership, or custom allowed/blocked logic. This hook is called after existing normalization and allowed-username checking.

  • Spawner.options_from_form may now be async

  • Added JupyterHub.shutdown_on_logout option to trigger shutdown of a user’s servers when they log out.

  • When Spawner.start raises an Exception, a message can be passed on to the user if the exception has a .jupyterhub_message attribute.


  • Authentication methods such as check_whitelist should now take an additional authentication argument that will be a dictionary (default: None) of authentication data, as returned by Authenticator.authenticate():

    def check_whitelist(self, username, authentication=None):

    authentication should have a default value of None for backward-compatibility with jupyterhub < 1.0.

  • Prometheus metrics page is now authenticated. Any authenticated user may see the prometheus metrics. To disable prometheus authentication, set JupyterHub.authenticate_prometheus = False.

  • Visits to /user/:name no longer trigger an implicit launch of the user’s server. Instead, a page is shown indicating that the server is not running with a link to request the spawn.

  • API requests to /user/:name for a not-running server will have status 503 instead of 404.

  • OAuth includes a confirmation page when attempting to visit another user’s server, so that users can choose to cancel authentication with the single-user server. Confirmation is still skipped when accessing your own server.


  • Various fixes to improve Windows compatibility (default Authenticator and Spawner still do not support Windows, but other Spawners may)

  • Fixed compatibility with Oracle db

  • Fewer redirects following a visit to the default / url

  • Error when progress is requested before progress is ready

  • Error when API requests are made to a not-running server without authentication

  • Avoid logging database password on connect if password is specified in JupyterHub.db_url.

Development changes#

There have been several changes to the development process that shouldn’t generally affect users of JupyterHub, but may affect contributors. In general, see for contribution info or ask if you have questions.

  • JupyterHub has adopted black as a code autoformatter and pre-commit as a tool for automatically running code formatting on commit. This is meant to make it easier to contribute to JupyterHub, so let us know if it’s having the opposite effect.

  • JupyterHub has switched its test suite to using pytest-asyncio from pytest-tornado.

  • OAuth is now implemented internally using oauthlib instead of python-oauth2. This should have no effect on behavior.


0.9.6 2019-04-01#

JupyterHub 0.9.6 is a security release.

  • Fixes an Open Redirect vulnerability (CVE-2019-10255).

JupyterHub 0.9.5 included a partial fix for this issue.

0.9.4 2018-09-24#

JupyterHub 0.9.4 is a small bugfix release.

  • Fixes an issue that required all running user servers to be restarted when performing an upgrade from 0.8 to 0.9.

  • Fixes content-type for API endpoints back to application/json. It was text/html in 0.9.0-0.9.3.

0.9.3 2018-09-12#

JupyterHub 0.9.3 contains small bugfixes and improvements

  • Fix token page and model handling of expires_at. This field was missing from the REST API model for tokens and could cause the token page to not render

  • Add keep-alive to progress event stream to avoid proxies dropping the connection due to inactivity

  • Documentation and example improvements

  • Disable quit button when using notebook 5.6

  • Prototype new feature (may change prior to 1.0): pass requesting Handler to Spawners during start, accessible as self.handler

0.9.2 2018-08-10#

JupyterHub 0.9.2 contains small bugfixes and improvements.

  • Documentation and example improvements

  • Add Spawner.consecutive_failure_limit config for aborting the Hub if too many spawns fail in a row.

  • Fix for handling SIGTERM when run with asyncio (tornado 5)

  • Windows compatibility fixes

0.9.1 2018-07-04#

JupyterHub 0.9.1 contains a number of small bugfixes on top of 0.9.

  • Use a PID file for the proxy to decrease the likelihood that a leftover proxy process will prevent JupyterHub from restarting

  • c.LocalProcessSpawner.shell_cmd is now configurable

  • API requests to stopped servers (requests to the hub for /user/:name/api/...) fail with 404 rather than triggering a restart of the server

  • Compatibility fix for notebook 5.6.0 which will introduce further security checks for local connections

  • Managed services always use localhost to talk to the Hub if the Hub listening on all interfaces

  • When using a URL prefix, the Hub route will be JupyterHub.base_url instead of unconditionally /

  • additional fixes and improvements

0.9.0 2018-06-15#

JupyterHub 0.9 is a major upgrade of JupyterHub. There are several changes to the database schema, so make sure to backup your database and run:

jupyterhub upgrade-db

after upgrading jupyterhub.

The biggest change for 0.9 is the switch to asyncio coroutines everywhere instead of tornado coroutines. Custom Spawners and Authenticators are still free to use tornado coroutines for async methods, as they will continue to work. As part of this upgrade, JupyterHub 0.9 drops support for Python < 3.5 and tornado < 5.0.


  • Require Python >= 3.5

  • Require tornado >= 5.0

  • Use asyncio coroutines throughout

  • Set status 409 for conflicting actions instead of 400, e.g. creating users or groups that already exist.

  • timestamps in REST API continue to be UTC, but now include ‘Z’ suffix to identify them as such.

  • REST API User model always includes servers dict, not just when named servers are enabled.

  • server info is no longer available to oauth identification endpoints, only user info and group membership.

  • User.last_activity may be None if a user has not been seen, rather than starting with the user creation time which is now separately stored as User.created.

  • static resources are now found in $PREFIX/share/jupyterhub instead of share/jupyter/hub for improved consistency.

  • Deprecate .extra_log_file config. Use pipe redirection instead:

    jupyterhub &>> /var/log/jupyterhub.log
  • Add JupyterHub.bind_url config for setting the full bind URL of the proxy. Sets ip, port, base_url all at once.

  • Add JupyterHub.hub_bind_url for setting the full host+port of the Hub. hub_bind_url supports unix domain sockets, e.g. unix+http://%2Fsrv%2Fjupyterhub.sock

  • Deprecate JupyterHub.hub_connect_port config in favor of JupyterHub.hub_connect_url. hub_connect_ip is not deprecated and can still be used in the common case where only the ip address of the hub differs from the bind ip.


  • Spawners can define a .progress method which should be an async generator. The generator should yield events of the form:

      "message": "some-state-message",
      "progress": 50,

    These messages will be shown with a progress bar on the spawn-pending page. The async_generator package can be used to make async generators compatible with Python 3.5.

  • track activity of individual API tokens

  • new REST API for managing API tokens at /hub/api/user/tokens[/token-id]

  • allow viewing/revoking tokens via token page

  • User creation time is available in the REST API as User.created

  • Server start time is stored as Server.started

  • Spawner.start may return a URL for connecting to a notebook instead of (ip, port). This enables Spawners to launch servers that setup their own HTTPS.

  • Optimize database performance by disabling sqlalchemy expire_on_commit by default.

  • Add python -m jupyterhub.dbutil shell entrypoint for quickly launching an IPython session connected to your JupyterHub database.

  • Include User.auth_state in user model on single-user REST endpoints for admins only.

  • Include Server.state in server model on REST endpoints for admins only.

  • Add Authenticator.blacklist for blocking users instead of allowing.

  • Pass c.JupyterHub.tornado_settings['cookie_options'] down to Spawners so that cookie options (e.g. expires_days) can be set globally for the whole application.

  • SIGINFO (ctrl-t) handler showing the current status of all running threads, coroutines, and CPU/memory/FD consumption.

  • Add async Spawner.get_options_form alternative to .options_form, so it can be a coroutine.

  • Add JupyterHub.redirect_to_server config to govern whether users should be sent to their server on login or the JupyterHub home page.

  • html page templates can be more easily customized and extended.

  • Allow registering external OAuth clients for using the Hub as an OAuth provider.

  • Add basic prometheus metrics at /hub/metrics endpoint.

  • Add session-id cookie, enabling immediate revocation of login tokens.

  • Authenticators may specify that users are admins by specifying the admin key when return the user model as a dict.

  • Added “Start All” button to admin page for launching all user servers at once.

  • Services have an info field which is a dictionary. This is accessible via the REST API.

  • JupyterHub.extra_handlers allows defining additional tornado RequestHandlers attached to the Hub.

  • API tokens may now expire. Expiry is available in the REST model as expires_at, and settable when creating API tokens by specifying expires_in.


  • Remove green from theme to improve accessibility

  • Fix error when proxy deletion fails due to route already being deleted

  • clear ?redirects from URL on successful launch

  • disable send2trash by default, which is rarely desirable for jupyterhub

  • Put PAM calls in a thread so they don’t block the main application in cases where PAM is slow (e.g. LDAP).

  • Remove implicit spawn from login handler, instead relying on subsequent request for /user/:name to trigger spawn.

  • Fixed several inconsistencies for initial redirects, depending on whether server is running or not and whether the user is logged in or not.

  • Admin requests for /user/:name (when admin-access is enabled) launch the right server if it’s not running instead of redirecting to their own.

  • Major performance improvement starting up JupyterHub with many users, especially when most are inactive.

  • Various fixes in race conditions and performance improvements with the default proxy.

  • Fixes for CORS headers

  • Stop setting .form-control on spawner form inputs unconditionally.

  • Better recovery from database errors and database connection issues without having to restart the Hub.

  • Fix handling of ~ character in usernames.

  • Fix jupyterhub startup when getpass.getuser() would fail, e.g. due to missing entry in passwd file in containers.


0.8.1 2017-11-07#

JupyterHub 0.8.1 is a collection of bugfixes and small improvements on 0.8.


  • Run tornado with AsyncIO by default

  • Add jupyterhub --upgrade-db flag for automatically upgrading the database as part of startup. This is useful for cases where manually running jupyterhub upgrade-db as a separate step is unwieldy.

  • Avoid creating backups of the database when no changes are to be made by jupyterhub upgrade-db.


  • Add some further validation to usernames - / is not allowed in usernames.

  • Fix empty logout page when using auto_login

  • Fix autofill of username field in default login form.

  • Fix listing of users on the admin page who have not yet started their server.

  • Fix ever-growing traceback when re-raising Exceptions from spawn failures.

  • Remove use of deprecated bower for javascript client dependencies.

0.8.0 2017-10-03#

JupyterHub 0.8 is a big release!

Perhaps the biggest change is the use of OAuth to negotiate authentication between the Hub and single-user services. Due to this change, it is important that the single-user server and Hub are both running the same version of JupyterHub. If you are using containers (e.g. via DockerSpawner or KubeSpawner), this means upgrading jupyterhub in your user images at the same time as the Hub. In most cases, a

pip install jupyterhub==version

in your Dockerfile is sufficient.


  • JupyterHub now defined a Proxy API for custom proxy implementations other than the default. The defaults are unchanged, but configuration of the proxy is now done on the ConfigurableHTTPProxy class instead of the top-level JupyterHub. TODO: docs for writing a custom proxy.

  • Single-user servers and services (anything that uses HubAuth) can now accept token-authenticated requests via the Authentication header.

  • Authenticators can now store state in the Hub’s database. To do so, the authenticate method should return a dict of the form

        'username': 'name',
        'state': {}

    This data will be encrypted and requires JUPYTERHUB_CRYPT_KEY environment variable to be set and the Authenticator.enable_auth_state flag to be True. If these are not set, auth_state returned by the Authenticator will not be stored.

  • There is preliminary support for multiple (named) servers per user in the REST API. Named servers can be created via API requests, but there is currently no UI for managing them.

  • Add LocalProcessSpawner.popen_kwargs and LocalProcessSpawner.shell_cmd for customizing how user server processes are launched.

  • Add Authenticator.auto_login flag for skipping the “Login with…” page explicitly.

  • Add JupyterHub.hub_connect_ip configuration for the ip that should be used when connecting to the Hub. This is promoting (and deprecating) DockerSpawner.hub_ip_connect for use by all Spawners.

  • Add Spawner.pre_spawn_hook(spawner) hook for customizing pre-spawn events.

  • Add JupyterHub.active_server_limit and JupyterHub.concurrent_spawn_limit for limiting the total number of running user servers and the number of pending spawns, respectively.


  • more arguments to spawners are now passed via environment variables (.get_env()) rather than CLI arguments (.get_args())

  • internally generated tokens no longer get extra hash rounds, significantly speeding up authentication. The hash rounds were deemed unnecessary because the tokens were already generated with high entropy.

  • JUPYTERHUB_API_TOKEN env is available at all times, rather than being removed during single-user start. The token is now accessible to kernel processes, enabling user kernels to make authenticated API requests to Hub-authenticated services.

  • Cookie secrets should be 32B hex instead of large base64 secrets.

  • pycurl is used by default, if available.


So many things fixed!

  • Collisions are checked when users are renamed

  • Fix bug where OAuth authenticators could not logout users due to being redirected right back through the login process.

  • If there are errors loading your config files, JupyterHub will refuse to start with an informative error. Previously, the bad config would be ignored and JupyterHub would launch with default configuration.

  • Raise 403 error on unauthorized user rather than redirect to login, which could cause redirect loop.

  • Set httponly on cookies because it’s prudent.

  • Improve support for MySQL as the database backend

  • Many race conditions and performance problems under heavy load have been fixed.

  • Fix alembic tagging of database schema versions.


  • End support for Python 3.3


0.7.2 - 2017-01-09#


  • Support service environment variables and defaults in jupyterhub-singleuser for easier deployment of notebook servers as a Service.

  • Add --group parameter for deploying jupyterhub-singleuser as a Service with group authentication.

  • Include URL parameters when redirecting through /user-redirect/


  • Fix group authentication for HubAuthenticated services

0.7.1 - 2017-01-02#


  • Spawner.will_resume for signaling that a single-user server is paused instead of stopped. This is needed for cases like DockerSpawner.remove_containers = False, where the first API token is re-used for subsequent spawns.

  • Warning on startup about single-character usernames, caused by common set('string') typo in config.


  • Removed spurious warning about empty next_url, which is AOK.

0.7.0 - 2016-12-2#


  • Implement Services API #705

  • Add /api/ and /api/info endpoints #675

  • Add documentation for JupyterLab, pySpark configuration, troubleshooting, and more.

  • Add logging of error if adding users already in database. #689

  • Add HubAuth class for authenticating with JupyterHub. This class can be used by any application, even outside tornado.

  • Add user groups.

  • Add /hub/user-redirect/... URL for redirecting users to a file on their own server.


  • Always install with setuptools but not eggs (effectively require pip install .) #722

  • Updated formatting of changelog. #711

  • Single-user server is provided by JupyterHub package, so single-user servers depend on JupyterHub now.


  • Fix docker repository location #719

  • Fix swagger spec conformance and timestamp type in API spec

  • Various redirect-loop-causing bugs have been fixed.


  • Deprecate --no-ssl command line option. It has no meaning and warns if used. #789

  • Deprecate %U username substitution in favor of {username}. #748

  • Removed deprecated SwarmSpawner link. #699


0.6.1 - 2016-05-04#

Bugfixes on 0.6:

  • statsd is an optional dependency, only needed if in use

  • Notice more quickly when servers have crashed

  • Better error pages for proxy errors

  • Add Stop All button to admin panel for stopping all servers at once

0.6.0 - 2016-04-25#

  • JupyterHub has moved to a new jupyterhub namespace on GitHub and Docker. What was jupyter/jupyterhub is now jupyterhub/jupyterhub, etc.

  • jupyterhub/jupyterhub image on DockerHub no longer loads the in an ONBUILD step. A new jupyterhub/jupyterhub-onbuild image does this

  • Add statsd support, via c.JupyterHub.statsd_{host,port,prefix}

  • Update to traitlets 4.1 @default, @observe APIs for traits

  • Allow disabling PAM sessions via c.PAMAuthenticator.open_sessions = False. This may be needed on SELinux-enabled systems, where our PAM session logic often does not work properly

  • Add Spawner.environment configurable, for defining extra environment variables to load for single-user servers

  • JupyterHub API tokens can be pregenerated and loaded via JupyterHub.api_tokens, a dict of token: username.

  • JupyterHub API tokens can be requested via the REST API, with a POST request to /api/authorizations/token. This can only be used if the Authenticator has a username and password.

  • Various fixes for user URLs and redirects

0.5 - 2016-03-07#

  • Single-user server must be run with Jupyter Notebook ≥ 4.0

  • Require --no-ssl confirmation to allow the Hub to be run without SSL (e.g. behind SSL termination in nginx)

  • Add lengths to text fields for MySQL support

  • Add Spawner.disable_user_config for preventing user-owned configuration from modifying single-user servers.

  • Fixes for MySQL support.

  • Add ability to run each user’s server on its own subdomain. Requires wildcard DNS and wildcard SSL to be feasible. Enable subdomains by setting JupyterHub.subdomain_host = 'https://jupyterhub.domain.tld[:port]'.

  • Use for local communication instead of localhost, avoiding issues with DNS on some systems.

  • Fix race that could add users to proxy prematurely if spawning is slow.


0.4.1 - 2016-02-03#

Fix removal of /login page in 0.4.0, breaking some OAuth providers.

0.4.0 - 2016-02-01#

  • Add Spawner.user_options_form for specifying an HTML form to present to users, allowing users to influence the spawning of their own servers.

  • Add Authenticator.pre_spawn_start and Authenticator.post_spawn_stop hooks, so that Authenticators can do setup or teardown (e.g. passing credentials to Spawner, mounting data sources, etc.). These methods are typically used with custom Authenticator+Spawner pairs.

  • 0.4 will be the last JupyterHub release where single-user servers running IPython 3 is supported instead of Notebook ≥ 4.0.

0.3 - 2015-11-04#

  • No longer make the user starting the Hub an admin

  • start PAM sessions on login

  • hooks for Authenticators to fire before spawners start and after they stop, allowing deeper interaction between Spawner/Authenticator pairs.

  • login redirect fixes

0.2 - 2015-07-12#

  • Based on standalone traitlets instead of IPython.utils.traitlets

  • multiple users in admin panel

  • Fixes for usernames that require escaping

0.1 - 2015-03-07#

First preview release