Repository files navigation

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

Note: This project used to be callednbserverproxy. Asnbserverproxy is an older version of jupyter-server-proxy, uninstallnbserverproxy before installing jupyter-server-proxy to avoid conflicts.

The primary use cases are:

1. Use with JupyterHub / Binder to allow launching users into webinterfaces that have nothing to do with Jupyter - such as RStudio,Shiny, or OpenRefine.
2. Allow access from frontend javascript (in classic notebook orJupyterLab extensions) to access web APIs of other processes runninglocally in a safe manner. This is used by theJupyterLabextension fordask.

The documentationcontains information on installation & usage.

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

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

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

For more insights, seeRyan Lovett's comment aboutit.

pip install jupyter-server-proxy

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

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

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

For historical compatibility ranges, see the table below:

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

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

jupyter labextension disable @jupyterhub/jupyter-server-proxy

To setup a local development environment, see thecontributing guide.