Wrap an arbitrary webapp so it can be used in place of jupyter-singleuser in a JupyterHub setting
Project description
jhsingle-native-proxy
Wrap an arbitrary webapp so it can be used in place of jupyter-singleuser in a JupyterHub setting.
Within JupyterHub this allows similar operation to jupyter-server-proxy except it also removes the Jupyter notebook itself, so is working directly with the arbitrary web service.
OAuth authentication is enforced based on JUPYTERHUB_* environment variables.
This is a very basic alpha version.
Install and Run
Install using pip.
pip install jhsingle-native-proxy
The process to start is specified on the command line, for example a streamlit web app:
jhsingle-native-proxy streamlit hello
By default the jhsingle-native-proxy server will listen on port 8888, forwarding to port 8500.
But you will normally need to tell jhsingle-native-proxy which port the end process will run in, and maybe tell the end process which port you want it to use (which you can do with the substitution variable {port}).
Note the use of -- to signal the end of command line options to jhsingle-native-proxy. Then the third party command line itself can contain options starting with dashes. An alternative is to use the substitution {--}
jhsingle-native-proxy -- streamlit hello --server.port {port} --server.headless True --server.enableCORS False
To run jhsingle-native-proxy itself listening on a different port use:
jhsingle-native-proxy --port 8000 streamlit hello
To run jhsingle-native-proxy on port 8000, and the end process on 8505:
jhsingle-native-proxy --port 8000 --destport 8505 -- streamlit hello --server.port {port} --server.headless True --server.enableCORS False
Use the JUPYTERHUB_SERVICE_PREFIX env var to specify the first part of the URL to listen to (and then strip before forwarding). E.g. JUPYTERHUB_SERVICE_PREFIX=/user/dan will mean requests on http://localhost:8888/user/dan/something will forward to http://localhost:8500/something
You can also specify --ip 0.0.0.0 for the address to listen on.
Below we use the substitution {--} for the command to run, allowing us to specify --ip to jhsingle-native-proxy instead of the command being run.
jhsingle-native-proxy --port 8000 --destport 8505 streamlit hello {--}server.port {port} {--}server.headless True {--}server.enableCORS False --ip 0.0.0.0
Similarly, use e.g. {-}m to represent -m in the final command.
Voila example:
Running voila at the subfolder URL e.g. /user/dan/:
python -m jhsingle_native_proxy.main --destport 0 voila ./Presentation.ipynb {--}port={port} {--}no-browser {--}Voila.server_url=/ {--}Voila.base_url={base_url}/ {--}debug
'destport 0' above instructs jhsingle-native-proxy to choose a random free port on which to run the sub-process (Voila), and of course substitutes that as {port} in the Voila command line so it knows which port to listen on.
Authentication
The above examples all assume OAuth will be enforced, as per the JUPYTERHUB_* env vars.
Alternatives can be specified via the authtype flag:
Same as default:
jhsingle-native-proxy --authtype=oauth streamlit hello
No auth required at all:
jhsingle-native-proxy --authtype=none streamlit hello
Specifying Authorized Users
The env vars JUPYTERHUB_USER and JUPYTERHUB_GROUP can be used, as typical for any JupyterHub single server, to specify user/groups of JupyterHub that should be allowed access via OAuth. There is an additional bespoke env var called JUPYTERHUB_ANYONE which can be set to 1 to allow any authenticated user access. (i.e. anyone who has an account on the JupyterHub)
Changelog
v0.1.2 released 29 May 2020
- Now allows single-dash placeholder, e.g. {-}m translates to -m in the final subprocess command.
Development install
git clone https://github.com/ideonate/jhsingle-native-proxy.git
cd jhsingle-native-proxy
pip install -e .
To run directly in python: python -m jhsingle_native_proxy.main <rest of command line>
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
Hashes for jhsingle-native-proxy-0.1.2.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ac5387abb8e1dd21b2d7f96ef3d3112f7431a7b8993959eb4a2eec14a6fd21b0 |
|
| MD5 | 1d6a1aefe3382d8535efe1220694a6dd |
|
| BLAKE2b-256 | 7f16a26650290e7b0c7e940e238d4b1dd39eb6937d728ba42383723d05f7ef85 |
Hashes for jhsingle_native_proxy-0.1.2-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | aa6cdfa2084f282e95daa64ab9e54f4ddc64ba7c75d7d1323bdee14b2eac3694 |
|
| MD5 | d0394f15428d18979b2228ca38d8ba20 |
|
| BLAKE2b-256 | bb1be517dd24165823b2e27f05bd976c426103aff45217c17effabf9ca1f57bf |
