https://github.com/torressa/jupyter-stacks-voila

Minimal working example of deployment of a jupyter notebook using voila, jupyter/docker-stacks and nginx
https://github.com/torressa/jupyter-stacks-voila

docker docker-compose docker-compose-template jupyter-docker-stacks nginx-docker voila

Last synced: 9 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/torressa/jupyter-stacks-voila
• Owner: torressa
• License: mit
• Created: 2020-06-26T07:33:54.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-03T09:53:03.000Z (over 4 years ago)
• Last Synced: 2023-03-02T21:32:48.622Z (over 1 year ago)
• Topics: docker, docker-compose, docker-compose-template, jupyter-docker-stacks, nginx-docker, voila
• Language: Jupyter Notebook
• Homepage:
• Size: 73.2 KB
• Stars: 9
• Watchers: 2
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jupyter-stacks-voila

(Minimal) working example to learn how to deploy a jupyter notebook

(ran on [jupyter/docker-stacks](https://github.com/jupyter/docker-stacks))

using [voila](https://github.com/voila-dashboards/voila/tree/stable) and [nginx](https://docs.nginx.com/).

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

```bash

cd scripts/

./run_notebook

```

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

```bash

cd scripts/

./deploy_notebook

```

# Structure

- [`data/`](data/) - folder with data that is mounted and used inside the notebook. Contains a test csv file with the iris data set.

- [`docker/`](docker/) - all necessary docker and docker-compose files.

- [`my_module/`](my_module/) - some python module that is required in the notebook.

- [`nginx/conf.d/`](nginx/conf.d/) - configuration files for nginx.

- [`notebooks/`](notebooks/) - jupyter notebook to show.

- [`scripts/`](scripts/) - bash scripts to docker-compose up the necessary stuff.

Please see the [docs](docs/) for more information.