Skip to main content

Jupyter server extension to supervise and proxy web services

Project description

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 (@jupyterlab/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.



  • jupyterlab>=2 or notebook

Python package


pip install jupyter-server-proxy


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

JupyterLab extension

Note that as the JupyterLab extension only is a graphical interface to launch registered applications in the python package, the extension requires the python package to be installed.

As of version 3.0.0 the Python package ships with a JupyterLab 3 compatible extension, making this step only needed for JupyterLab 2.

jupyter labextension install @jupyterlab/server-proxy


Server extension

jupyter serverextension disable jupyter_server_proxy

Notebook classic extension

jupyter nbextension disable --py jupyter_server_proxy

JupyterLab extension

Note that the extension name provided to the command (jupyterlab-server-proxy) does not correspond to the extension package name (@jupyterlab/server-proxy). The jupyter labextension list will incorrectly report the extension as still being enabled after executing the disable command. This will be fixed in the next major release of jupyter-server-proxy.

jupyter labextension disable jupyterlab-server-proxy

Local development


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter-server-proxy-3.2.2.tar.gz (121.4 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page