Git Product home page Git Product logo

m-hemmings / jupyter-server-proxy Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jupyterhub/jupyter-server-proxy

0.0 0.0 0.0 1.19 MB

Fork of Jupyter notebook server extension to proxy web services.

Home Page: https://jupyter-server-proxy.readthedocs.io

License: BSD 3-Clause "New" or "Revised" License

JavaScript 2.22% Python 89.32% TypeScript 4.76% RobotFramework 3.57% HTML 0.13%

jupyter-server-proxy's Introduction

Jupyter Server Proxy

ReadTheDocs badge GitHub Workflow Status PyPI badge Conda badge NPM badge

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

Requirements

  • jupyterlab>=2 or notebook

Python package

pip

pip install jupyter-server-proxy

conda

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

Local development

See the contributing guide.

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 @jupyterhub/jupyter-server-proxy

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

jupyter-server-proxy's People

Contributors

athornton avatar betatim avatar bollwyvl avatar cmd-ntrf avatar consideratio avatar dependabot[bot] avatar derekheldtwerle avatar dipanjank avatar gbrault avatar heatwole avatar iagomez avatar ian-r-rose avatar jacobtomlinson avatar janjagusch avatar janjaguschqc avatar jtpio avatar lsetiawan avatar mahnerak avatar manics avatar maresb avatar minrk avatar oeway avatar rcthomas avatar rmorshea avatar rschroll avatar ryanlovett avatar ryshoooo avatar willingc avatar xhochy avatar yuvipanda avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.