/jupyter-stacks-voila

Minimal working example of deployment of a jupyter notebook using voila, jupyter/docker-stacks and nginx

Primary LanguageJupyter NotebookMIT LicenseMIT

jupyter-stacks-voila

(Minimal) working example to learn how to deploy a jupyter notebook (ran on jupyter/docker-stacks) using voila and nginx.

Requirements

  • Docker and docker-compose
  • bash

Quick start

To run and edit the notebooks in notebooks/ on a jupyter/docker-stacks container (in case you don't have jupyter locally)

cd scripts/
./run_notebook

To serve your notebook on voila through nginx on http://localhost:80,

cd scripts/
./deploy_notebook

Structure

  • data/ - folder with data that is mounted and used inside the notebook. Contains a test csv file with the iris data set.
  • docker/ - all necessary docker and docker-compose files.
  • my_module/ - some python module that is required in the notebook.
  • nginx/conf.d/ - configuration files for nginx.
  • notebooks/ - jupyter notebook to show.
  • scripts/ - bash scripts to docker-compose up the necessary stuff.

Please see the docs for more information.