jupyter-server-proxy

Jupyter Server Proxy

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.
  • 

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.