Skip to main content

Jupyter Server Proxy

ReadTheDocs badge GitHub Workflow Status PyPI badge Conda badge NPM badge

Jupyter Server Proxy lets you run arbitrary external processes (such as RStudio, Shiny Server, Syncthing, PostgreSQL, Code Server, etc) alongside your notebook server and provide authenticated web access to them using a path like /rstudio next to others like /lab. Alongside the python package that provides the main functionality, the JupyterLab extension (@jupyterhub/jupyter-server-proxy) provides buttons in the JupyterLab launcher window to get to RStudio for example.

Note: This project used to be called nbserverproxy. As nbserverproxy is an older version of jupyter-server-proxy, uninstall nbserverproxy before installing jupyter-server-proxy to avoid conflicts.

The primary use cases are:

  1. Use with JupyterHub / Binder to allow launching users into web interfaces that have nothing to do with Jupyter - such as RStudio, Shiny, or OpenRefine.
  2. Allow access from frontend javascript (in classic notebook or JupyterLab extensions) to access web APIs of other processes running locally in a safe manner. This is used by the JupyterLab extension for dask.

The documentation contains information on installation & usage.

Security warning

Jupyter Server Proxy is often used to start a user defined process listening to some network port (e.g. http://localhost:4567) for a user starting a Jupyter Server that only that user has permission to access. The user can then access the started process proxied through the Jupyter Server.

For safe use of Jupyter Server Proxy, you should ensure that the process started by Jupyter Server proxy can't be accessed directly by another user and bypass the Jupyter Server's authorization!

A common strategy to enforce access proxied via Jupyter Server is to start Jupyter Server within a container and only allow network access to the Jupyter Server via the container.

For more insights, see Ryan Lovett's comment about it.

Install

Python package

pip

pip install jupyter-server-proxy

conda

conda install -c conda-forge jupyter-server-proxy

Jupyter Client Extensions

A JupyterLab and Notebook extension is bundled with the Python package to provide:

  • servers in the New dropwdown of the Notebook Tree view
  • launch buttons in JupyterLab's Launcher panel for registered server processes.
    • a screenshot of the JupyterLab Launcher

Client compatibility

For historical compatibility ranges, see the table below:

jupyter-server-proxy notebook jupyterlab
4.1.x >=6,<8 >=3,<5
4.0.x >=6,<7 >=3,<4
3.x >=6,<7 >=2,<4

Disable

Server extension

jupyter serverextension disable --sys-prefix jupyter_server_proxy
jupyter server extension disable --sys-prefix jupyter_server_proxy

Notebook Classic extension

jupyter nbextension disable --sys-prefix --py jupyter_server_proxy

JupyterLab extension

jupyter labextension disable @jupyterhub/jupyter-server-proxy

Local development

To setup a local development environment, see the contributing guide.

Metadata

Release files for jupyter-server-proxy 4.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jupyter-server-proxy 4.6.1
File Size Uploaded Provenance Actions
jupyter_server_proxy-4.6.1.tar.gz 138.5 kB With provenance Details for jupyter_server_proxy-4.6.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for jupyter-server-proxy 4.6.1
File Interpreter ABI Platform Actions
jupyter_server_proxy-4.6.1-py3-none-any.whl Python 3 none any Details for jupyter_server_proxy-4.6.1-py3-none-any.whl

Total release size: 185.3 kB

Release files / jupyter_server_proxy-4.6.1.tar.gz

Download URL jupyter_server_proxy-4.6.1.tar.gz
Size 138.5 kB
Tags Source
SHA-256 checksum
How to use checksums
29bb49d932908f32fd39304ad60d28c1c328b812b427fb65282fec3c400a3487
BLAKE2b-256 checksum
How to use checksums
aae28ae03027650640dd8f6780c92ca14217d3c669bfa047b8b34a820bbd468d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Release files / jupyter_server_proxy-4.6.1-py3-none-any.whl

Download URL jupyter_server_proxy-4.6.1-py3-none-any.whl
Size 46.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b171160e4e1ede23472631bff8547b8621464d856f7bb2d1acca73462ed98874
BLAKE2b-256 checksum
How to use checksums
d2ea9d050ae73b541d76202ba0a93bba64a2ce22d4d577fa3691187cd4134628
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Security for jupyter-server-proxy 4.6.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for jupyter_server_proxy-4.6.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

4.6.1 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page