Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jupyterhub/jupyter-server-proxy

Jupyter notebook server extension to proxy web services.
https://github.com/jupyterhub/jupyter-server-proxy

binder jupyter jupyter-notebook jupyterhub proxy

Last synced: about 2 months ago
JSON representation

Jupyter notebook server extension to proxy web services.

Host: GitHub
URL: https://github.com/jupyterhub/jupyter-server-proxy
Owner: jupyterhub
License: bsd-3-clause
Created: 2016-10-18T22:02:06.000Z (almost 8 years ago)
Default Branch: main
Last Pushed: 2024-04-11T12:02:23.000Z (5 months ago)
Last Synced: 2024-04-13T15:53:49.255Z (5 months ago)
Topics: binder, jupyter, jupyter-notebook, jupyterhub, proxy
Language: Python
Homepage: https://jupyter-server-proxy.readthedocs.io
Size: 1.32 MB
Stars: 324
Watchers: 18
Forks: 137
Open Issues: 78
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-jupyter-resources - GitHub - 39% open · ⏱️ 08.07.2022): (Jupyter拓展)
best-of-jupyter - GitHub - 36% open · ⏱️ 27.04.2024): (Jupyter Extensions)

README

        # Jupyter Server Proxy

[![ReadTheDocs badge](https://img.shields.io/readthedocs/jupyter-server-proxy?logo=read-the-docs)](https://jupyter-server-proxy.readthedocs.io/)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jupyterhub/jupyter-server-proxy/test.yaml?logo=github&branch=main)](https://github.com/jupyterhub/jupyter-server-proxy/actions)

[![PyPI badge](https://img.shields.io/pypi/v/jupyter-server-proxy.svg?logo=pypi)](https://pypi.python.org/pypi/jupyter-server-proxy)

[![Conda badge](https://img.shields.io/conda/vn/conda-forge/jupyter-server-proxy?logo=conda-forge)](https://anaconda.org/conda-forge/jupyter-server-proxy)

[![NPM badge](https://img.shields.io/npm/v/@jupyterhub/jupyter-server-proxy.svg?logo=npm)](https://www.npmjs.com/package/@jupyterhub/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](https://github.com/dask/dask-labextension) for

    [dask](https://www.dask.org/).

[The documentation](https://jupyter-server-proxy.readthedocs.io/)

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](https://github.com/jupyterhub/jupyter-server-proxy/pull/359#issuecomment-1350118197).

## Install

### Python package

#### `pip`

```bash

pip install jupyter-server-proxy

```

#### `conda`

```bash

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.

  - ![a screenshot of the JupyterLab Launcher](docs/source/_static/images/labextension-launcher.png "launch proxied servers as JupyterLab panels or new browser tabs")

#### 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

```bash

jupyter serverextension disable --sys-prefix jupyter_server_proxy

jupyter server extension disable --sys-prefix jupyter_server_proxy

```

### Notebook Classic extension

```bash

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

```

### JupyterLab extension

```bash

jupyter labextension disable @jupyterhub/jupyter-server-proxy

```

#### Local development

To setup a local development environment, see the [contributing guide](https://github.com/jupyterhub/jupyter-server-proxy/blob/main/CONTRIBUTING.md).