https://github.com/takluyver/hello_jupyter_proxy

A minimal example server to run with jupyter-server-proxy
https://github.com/takluyver/hello_jupyter_proxy

jupyter-server-proxy

Last synced: 14 days ago
JSON representation

A minimal example server to run with jupyter-server-proxy

• Host: GitHub
• URL: https://github.com/takluyver/hello_jupyter_proxy
• Owner: takluyver
• License: mit
• Created: 2022-02-14T11:06:04.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-09T10:21:27.000Z (over 1 year ago)
• Last Synced: 2024-12-28T01:46:56.137Z (16 days ago)
• Topics: jupyter-server-proxy
• Language: Python
• Homepage:
• Size: 16.6 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Jupyter Server Proxy Demo

=========================

This is a demo package showing how to run a web app through

`Jupyter Server Proxy `_.

This mechanism allows a user to run a separate web app through JupyterHub.

To try it, install this package into the same Python environment which is

used to launch your single-user server::

    pip install hello_jupyter_proxy

If your server is already running use the JupyterHub control panel

(``/hub/home``) to stop and start it. You should have a new 'hello' option in

the 'New' menu (classic notebook) or the launcher (Jupyterlab). You can also

go directly to ``https://(your-jhub-server)/user-redirect/hello/`` .

Building applications to proxy

------------------------------

This is meant as a starting point for building useful applications to run in

Jupyter Server Proxy. See `the JSP docs

`_ and especially the

`examples page `_

for more information.

For real web applications in Python, you will want a web framework rather than

the low-level ``http.server`` module. There are many choices, but `Tornado

`_ (used by Jupyter) and `Flask

`_ are two well known ones.

**Security**: This example uses a Unix socket between Jupyter and the proxied

application, which is a new option in Jupyter Server Proxy 4.0. This is set up

so that only the user running the application can connect to it. If you choose

to use a TCP socket instead, pay attention to whether other users can connect to

it and what it might allow them to do.