A Jupyter server extension to run additional processes and proxy to them that comes bundled JupyterLab extension to launch pre-defined processes.
Project description
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:
- Use with JupyterHub / Binder to allow launching users into web interfaces that have nothing to do with Jupyter - such as RStudio, Shiny, or OpenRefine.
- 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file jupyter_server_proxy-4.2.0.tar.gz.
File metadata
- Download URL: jupyter_server_proxy-4.2.0.tar.gz
- Upload date:
- Size: 133.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e4397eed637279a16ca7ab7c87bf276dc4422545f2d1aff9a0d10e5ebc7f012b |
|
| MD5 | 875ce16374d263c3467db4f675c3f4d8 |
|
| BLAKE2b-256 | 4730695fc652d9d7fd32103528bb258cfa6d20eeb1fd2cec969ab2f0760e38cf |
File details
Details for the file jupyter_server_proxy-4.2.0-py3-none-any.whl.
File metadata
- Download URL: jupyter_server_proxy-4.2.0-py3-none-any.whl
- Upload date:
- Size: 34.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 747567cc08ae22ca7decf9178f9893ab0f008de9b98726574f5dd11343a08c23 |
|
| MD5 | 67695c637b9461165bbf8b3758ce69d5 |
|
| BLAKE2b-256 | 4e09d9e42deb992b082b870bf0725fbaa8e16c1ab31c3140398460320482d739 |
