Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1.77 KB

index.rst

File metadata and controls

66 lines (45 loc) · 1.77 KB

Welcome to Jupyter Server Proxy's documentation!

Jupyter Server Proxy lets you run arbitrary external processes (such as RStudio, Shiny Server, syncthing, PostgreSQL, etc) alongside your notebook, and provide authenticated web access to them.

Note

This project used to be called nbserverproxy. if you have an older version of nbserverproxy installed, remember to uninstall it before install jupyter-server-proxy - otherwise they may conflict

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.

Contents

install server-process launchers arbitrary-ports

This repository contains various python packages set up with appropriate entrypoints <server-process/package> so pip installing them automatically sets up common config for popular applications.

convenience/packages/theia

Making and contributing a new convenience package <convenience/new> is very much appreciated.

Contributing

Contributions of all kinds - documentation, issues, blog posts, code, are most welcome!

contributing/release convenience/new