Jupyter server extension to supervise and proxy web services
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 (@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:
- 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.
Install
Requirements
jupyterlab>=2ornotebook
Python package
pip
pip install jupyter-server-proxy
conda
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
Disable
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
See CONTRIBUTING.md.
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-3.2.3.tar.gz.
File metadata
- Download URL: jupyter-server-proxy-3.2.3.tar.gz
- Upload date:
- Size: 125.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8ef97d682cdef2c1ae5afece446e471d4614859c13d9ceb51601801594c37fee |
|
| MD5 | f0b918b649e3c5553b7b9dc622c5574a |
|
| BLAKE2b-256 | 05015cc639f821a509dab2e34a7f4c4a93d065a2de97d575d18111df13702d7e |
File details
Details for the file jupyter_server_proxy-3.2.3-py3-none-any.whl.
File metadata
- Download URL: jupyter_server_proxy-3.2.3-py3-none-any.whl
- Upload date:
- Size: 36.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d42ab08dea840d1a27504b5e3c7f2e1d7307b93ad6997dfa0721b7e6aca2238b |
|
| MD5 | 3987c235c04b7cfad6de53e66e3a9179 |
|
| BLAKE2b-256 | 225cb42536aad29e6e1cc19003a25eaaa4296099af74a96701b8eb3c24d0a375 |
