Changelog

4.5

v4.5.0 - 2026-03-31

New features added

• Integrating native-proxy #501 (@jwindgassen, @aktech, @jhgoebbert, @manics, @ryanlovett)

Enhancements made

• Make ServerProcess.timeout a Float #523 (@jwindgassen, @jhgoebbert, @manics)

Bugs fixed

• fix: serve launcher icons for svg and png #548 (@chengs, @jnywong)

• Rewrite Location header in redirect responses. #544 (@ryanlovett, @manics)

• Wrong path_info generation in LauncherEntry #522 (@jwindgassen, @manics)

• Allow ServerProcess.command to be a callable #519 (@jwindgassen, @manics)

Maintenance and upkeep improvements

• Make ServerProcess and LauncherEntry a HasTraits, update CLI flags for consistency #521 (@jwindgassen, @manics, @minrk)

• Make config.ServerProcess into a Configurable #507 (@manics, @jhgoebbert, @jwindgassen, @ryanlovett)

• Remove utils.Callable #506 (@manics, @yuvipanda)

Documentation improvements

• Fix openrefine example commands #532 (@yuvipanda)

• Add icon type description for the icon_path property under ServerProxy.servers #527 (@chengs, @yuvipanda)

• fix: update links #559 (@jnywong)

Continuous integration improvements

• npm publish –dry-run –tag test #554 (@manics)

• test config: use path relative to file #495 (@manics, @yuvipanda)

Contributors to this release

(GitHub contributors page for this release)

@aktech | @chengs | @consideRatio | @jhgoebbert | @jnywong | @jwindgassen | @manics | @minrk | @ryanlovett | @yuvipanda

4.4

v4.4.0 - 2024-08-29

New features added

• feat: support stream api #479 (@ganisback)

Bugs fixed

• fix: missing tornadoimport for rawsocket handler #491 (@imfing)

Maintenance and upkeep improvements

• labextension: refreeze yarn.lock #499 (@krassowski)

Documentation improvements

• Document unix_socket as a parameter for callables in config #497 (@takluyver)

Contributors to this release

(GitHub contributors page for this release)

@ganisback | @imfing | @krassowski | @manics | @takluyver | @yuvipanda

4.3

v4.3.0 - 2024-07-01

New features added

• feat: Allow Skipping of Activity Reporting #473 (@sdmichelini, @yuvipanda, @ryanlovett, @deser)

• Allow configuring jupyterlab launcher category #453 (@dylex, @yuvipanda, @bollwyvl, @imcovangent)

• Add raw_socket_proxy to directly proxy websockets to TCP/unix sockets #447 (@dylex, @yuvipanda, @manics)

Bugs fixed

• Fix failure to update __version__ #481 (@consideRatio)

• Prevent failed entrypoints from spoiling the launch #443 (@banesullivan-kobold, @yuvipanda)

Documentation improvements

• Detail fixes in RELEASE.md #487 (@consideRatio)

• Fixed jlpm to jupyter in bash command #478 (@imcovangent, @yuvipanda)

Continuous integration improvements

• ci: remove workaround running test in py311 instead of py312 #485 (@consideRatio)

• ci: reference node lts to avoid need to bump in october #484 (@consideRatio)

• ci: fix test failure on windows and error on bash pipe failures etc #483 (@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)

@banesullivan-kobold (activity) | @bollwyvl (activity) | @consideRatio (activity) | @costa (activity) | @deser (activity) | @dylex (activity) | @imcovangent (activity) | @manics (activity) | @ryanlovett (activity) | @sdmichelini (activity) | @yuvipanda (activity)

4.2

v4.2.0 - 2024-06-11

This release includes an important security patch for CVE-2024-35225 .

(full changelog)

Maintenance and upkeep improvements

• Require jupyter_server 1.24+, tornado 6.1+, traitlets 5.1+ #467 (@consideRatio)

• Test against Python 3.12 #450 (@consideRatio)

Documentation improvements

• Document the correct default value for new_browser_tab. #470 (@ryanlovett)

Contributors to this release

(GitHub contributors page for this release)

@consideRatio | @ryanlovett | @welcome

4.1

4.1.2 - 2024-03-13

Bugs fixed

• Keep proxying all requested subprotocols #462 (@consideRatio)

4.1.1 - 2024-03-13

This release includes an important security patch for the critical vulnerability GHSA-w3vc-fx9p-wp4v. The security patch is also available in version 3.2.3.

Bugs fixed

• Ensure no blank Sec-Websocket-Protocol headers and warn if websocket subprotocol edge case occur #458 (@consideRatio, @duytnguyendtn, @minrk, @benz0li)

• Fix double formatting of callables (command, environment, request_headers_override) #437 (@diocas, @consideRatio)

Maintenance and upkeep improvements

• labextension: refreeze yarn.lock #461 (@consideRatio)

• List tornado and traitlets as dependencies explicitly, and cleanup unreachable code #457 (@consideRatio, @minrk)

• Fix failure to upload code coverage reports #454 (@consideRatio)

• Update tests for notebook 7.1 #451 (@consideRatio)

• tests: fix failure to log error after all retries failed #441 (@consideRatio)

• Declare metadata in pyproject.toml, remove hatch-nodejs-version plugin #427 (@consideRatio, @bollwyvl, @manics)

Continuous integration improvements

• ci: upgrade to v4 of upload/download-artifact actions #455 (@consideRatio)

• ci: schedule test runs twice a week #452 (@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)

@benz0li (activity) | @bollwyvl (activity) | @consideRatio (activity) | @diocas (activity) | @duytnguyendtn (activity) | @goekce (activity) | @manics (activity) | @minrk (activity) | @rcthomas (activity) | @sk1p (activity) | @steverweber (activity) | @yuvipanda (activity)

4.1.0 - 2023-09-25

New features added

• Add extension for Jupyter Notebook 7 #425 (@bollwyvl, @consideRatio)

• Add JupyterLab 4 support for the extension #419 (@trungleduc, @consideRatio, @manics, @bollwyvl, @ryanlovett, @Khagesh16)

Bugs fixed

• Ensure proxying to Unix sockets constructs separate HTTP clients #415 (@takluyver, @manics)

Continuous integration improvements

• Work around incompatibility (missing firefox_profile arg) for acceptance tests #416 (@takluyver, @manics)

• ci: cleanup stashed SHA256 checksum before publish to PyPI #401 (@consideRatio)

• Test Windows #392 (@manics, @consideRatio, @bollwyvl)

Dependency updates

• labextension: refreeze yarn.lock #422 (@consideRatio)

• labextension: refreeze yarn.lock #400 (@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)

@bollwyvl (activity) | @cataluna84 (activity) | @consideRatio (activity) | @Khagesh16 (activity) | @manics (activity) | @oeway (activity) | @ryanlovett (activity) | @takluyver (activity) | @trungleduc (activity)

4.0

4.0.0 - 2023-04-20

Breaking changes

• jupyter-server-proxy now requires Python 3.8+ (#350, #387)

• jupyter-server-proxy’s JupyterLab extension dropped support for JupyterLab 2 (#394)

• jupyter-server-proxy’s JupyterLab extension renamed from @jupyterlab/server-proxy to @jupyterhub/jupyter-server-proxy (#368)

New features added

• Accept an unset command to proxy to an already started process (unmanaged process) #339 (@ryshoooo)

• Support proxying to a server process via a Unix socket #337 (@takluyver)

Bugs fixed

• Use pytest.fixtures for starting servers, use importlib*metadata #396 (@bollwyvl)

Maintenance and upkeep improvements

• maint: update package description to not claim windows support #398 (@consideRatio)

• Use pytest.fixtures for starting servers, use importlib*metadata #396 (@bollwyvl)

• maint, breaking: drop support for jupyterlab 2 #394 (@consideRatio)

• Fix editable install and update CONTRIBUTING.md #391 (@mahendrapaipuri)

• pre-commit: add config and small fixes #390 (@consideRatio)

• Drop support for Python 3.7 #387 (@consideRatio)

• dependabot: monthly updates of github actions #385 (@consideRatio)

• Adopt hatchling, plugins for python package build #371 (@bollwyvl)

• Rename @jupyterlab/server-proxy to @jupyterhub/jupyter-server-proxy #368 (@consideRatio)

• Update labextension build #355 (@bollwyvl)

• Refine RELEASE.md with tbump #353 (@consideRatio)

• Drop support for Python 3.6 #350 (@consideRatio)

Documentation improvements

• docs: convert .rst to MyST based markdown files #393 (@consideRatio)

• Fix imshields link README.md #375 (@prabhakk-mw)

• docs: remove outdated release docs in favor of RELEASE.md #369 (@consideRatio)

• README: warn about unlimited local network access #359 (@manics)

• docs: switch from alabaster to sphinx-book-theme, and misc docs build system maintenance #352 (@consideRatio)

• Fix config filename in config via traitlets doc #344 (@cmd-ntrf)

Continuous integration improvements

• Fix tests against jupyter_server 2 #366 (@bollwyvl)

• ci: use ubuntu-22.04, firefox and geckodriver now available #364 (@consideRatio)

• ci: update github actions, small refactors, add dependabot for gha #351 (@consideRatio)

• ci: test against modern python versions and fix broken test suite #348 (@consideRatio)

Dependency updates

• build(deps): bump webpack from 5.75.0 to 5.76.1 in /labextension #380 (@dependabot)

• build(deps): bump http-cache-semantics from 4.1.0 to 4.1.1 in /labextension #376 (@dependabot)

• build(deps): bump json5 from 2.2.1 to 2.2.2 in /jupyterlab-server-proxy #365 (@dependabot)

• build(deps): bump loader-utils from 3.2.0 to 3.2.1 in /jupyterlab-server-proxy #357 (@dependabot)

Contributors to this release

(GitHub contributors page for this release)

@bollwyvl | @choldgraf | @cmd-ntrf | @consideRatio | @dependabot | @ellisonbg | @Finesim97 | @jhgoebbert | @mahendrapaipuri | @manics | @prabhakk-mw | @ryanlovett | @ryshoooo | @takluyver | @yuvipanda

3.2

3.2.3 - 2024-03-13

This is a security release for GHSA-w3vc-fx9p-wp4v.

3.2.2 - 2022-09-08

Bugs fixed

• add allow-downloads and allow-modals to sandbox #335 (@djangoliv)

• allow empty PUT body #331 (@pepijndevos)

• [bugfix] Hop by hop header handling #328 (@mahnerak)

Documentation improvements

• Yarn link malformed. #320 (@matthew-brett)

Continuous integration improvements

• Install notebook<7 for notebook test #340 (@manics)

• Run publish workflow for tags #318 (@manics)

Dependency updates

• Bump terser from 5.10.0 to 5.14.2 in /jupyterlab-server-proxy #342 (@dependabot)

• Bump moment from 2.29.2 to 2.29.4 in /jupyterlab-server-proxy #341 (@dependabot)

• Bump moment from 2.29.1 to 2.29.2 in /jupyterlab-server-proxy #336 (@dependabot)

• Bump minimist from 1.2.5 to 1.2.6 in /jupyterlab-server-proxy #334 (@dependabot)

• Bump url-parse from 1.5.3 to 1.5.7 in /jupyterlab-server-proxy #327 (@dependabot)

Contributors to this release

(GitHub contributors page for this release)

@austinmw | @bollwyvl | @consideRatio | @dependabot | @djangoliv | @jhgoebbert | @mahnerak | @manics | @matthew-brett | @meeseeksmachine | @pepijndevos | @ryanlovett | @ryshoooo | @takluyver | @yuvipanda

3.2.1 - 2022-01-24

3.2.1 is a security release, fixing a vulnerability GHSA-gcv9-6737-pjqw where allowed_hosts were not validated correctly.

Maintenance and upkeep improvements

• Remove empty JupyterLab style #314 (@bollwyvl)

• Modernize docs without making changes to its content #313 (@consideRatio)

• Remove no longer needed logic involving six #312 (@consideRatio)

• Update language, from master to main #311 (@consideRatio)

Continuous integration improvements

• ci: avoid triggering ci twice on pre-commit.ci/dependabot prs #310 (@consideRatio)

Contributors to this release

(GitHub contributors page for this release)

@bollwyvl | @consideRatio | @yuvipanda

3.2.0 - 2021-11-29

New features added

• Add rewrite_response #209 (@maresb)

Enhancements made

• rewrite_response hook: (HTTP status) code updates should sometimes automatically update reason #304 (@maresb)

• Enable rewrite_response to modify status and headers #300 (@ryanlovett)

• Apply request_headers_override to websocket requests #287 (@sk1p)

Bugs fixed

• fix: do not follow redirects when checking if server is up #299 (@ableuler)

• propagate check_origin of JupyterHandler to enable CORS websocket access #295 (@fhoehle)

• fix path_info for JupyterLab #294 (@jhgoebbert)

• keep gzip-encoded content compressed #290 (@axelmartenssonmodelon)

Maintenance and upkeep improvements

• resolve yarn.lock, bump builder version, some packaging metadata #307 (@bollwyvl)

• Change the rewrite_response function signature to take a RewritableResponse object #301 (@maresb)

• Simplify wait logic for websocket connection #292 (@mcg1969)

Documentation improvements

• Fix link to contributing.md #291 (@kinow)

Continuous integration improvements

• Test with lab #298 (@maresb)

• Open browser not required for running pytests #273 (@candlerb)

Dependency updates

• Bump tar from 6.1.5 to 6.1.11 in /jupyterlab-server-proxy #293 (@dependabot)

• Bump path-parse from 1.0.6 to 1.0.7 in /jupyterlab-server-proxy #285 (@dependabot)

• Bump tar from 6.1.0 to 6.1.5 in /jupyterlab-server-proxy #284 (@dependabot)

Contributors to this release

(GitHub contributors page for this release)

@ableuler | @axelmartenssonmodelon | @bollwyvl | @candlerb | @consideRatio | @fhoehle | @jhgoebbert | @kinow | @manics | @maresb | @mcg1969 | @minrk | @pisymbol | @ryanlovett | @sk1p | @yuvipanda

3.1

3.1.0 - 2021-07-02

New features added

• Add path_info option under launcher_entry #279 (@ryanlovett)

• Add request_headers_override configuration #252 (@ryanlovett)

Bugs fixed

• More precise regexp matching for /proxy/absolute/: #271 (@candlerb)

Maintenance and upkeep improvements

• Reduce (and test) sdist size #263 (@bollwyvl)

Continuous integration improvements

• Add acceptance testing with robotframework(-jupyterlibrary) #269 (@bollwyvl)

Dependency updates

• Bump postcss from 7.0.35 to 7.0.36 in /jupyterlab-server-proxy #277 (@dependabot)

• Bump normalize-url from 4.5.0 to 4.5.1 in /jupyterlab-server-proxy #276 (@dependabot)

• Bump ws from 7.4.4 to 7.4.6 in /jupyterlab-server-proxy #275 (@dependabot)

• Bump browserslist from 4.16.3 to 4.16.6 in /jupyterlab-server-proxy #274 (@dependabot)

Contributors to this release

(GitHub contributors page for this release)

@bollwyvl | @candlerb | @jhgoebbert | @jtpio | @manics | @ryanlovett | @yuvipanda

3.0

3.0.2 - 2020-03-16

Bugs fixed

• Include jupyterlab-server-proxy in the sdist #260 (@xhochy)

Contributors to this release

@xhochy

3.0.1 - 2020-03-16

Bugs fixed

• Fix PyPI url #259 (@janjagusch)

Contributors to this release

@janjagusch

3.0.0 - 2020-03-15

This release drops support for Python 3.5 and now packages the JupyterLab extension with the Python package for use with JupyterLab 3. The JupyterLab extension is still available on NPM for use with JupyterLab 2 but support for JupyterLab 1 is dropped.

The Python package version jumps from 1.6.0 to 3.0.0, and the NPM package version jumps from 2.1.2 to 3.0.0.

Enhancements made

• Package jupyter lab extension #245 (@janjagusch)

Maintenance and upkeep improvements

• Breaking: Replace host_whitelist with host_allowlist #256 (@manics)

• Switch from notebook to jupyter-server #254 (@manics)

Continuous integration improvements

• Move build.yaml into test.yaml #255 (@manics)

• Fix build.yaml workflow #249 (@manics)

• Add publish PyPI and NPM workflow #247 (@manics)

• tests: remove bad test, add new clarifying current behavior #240 (@consideRatio)

Contributors to this release

(GitHub contributors page for this release)

@AlJohri | @consideRatio | @ian-r-rose | @janjagusch | @JanJaguschQC | @jtpio | @manics | @maresb | @minrk | @ryanlovett | @todo | @yuvipanda

1.6

1.6.0 - 2021-02-10

This release adds support for JupyterLab 3.

At this point, the Jupyterlab extension of version 2.1.2, needs to be installed alongside the Python package for JupyterLab launcher buttons to show up as the extension isn’t yet bundled with the python package.

Enhancements made

• Add Jupyter Server extension data file (JupyterLab 3 support) #235 (@jtpio)

• Update dependencies to include jupyterlab 3.x.x (JupyterLab 3 support) #229 (@dipanjank)

Documentation improvements

• Bump to 1.6.0 (setup.py) and add CHANGELOG.md #238 (@consideRatio)

• Replace server-process list with linkable headings #236 (@manics)

• Rename the mamba-navigator example to gator in the documentation #234 (@jtpio)

Contributors to this release

@consideRatio | @janjagusch | @JanJaguschQC | @jtpio | @manics | @ryanlovett | @yuvipanda