Skip to content

Latest commit

 

History

History
75 lines (45 loc) · 2.14 KB

README.md

File metadata and controls

75 lines (45 loc) · 2.14 KB
Raw

IllumiDesk Docker Stacks for General Assembly

This repo is used to manage General Assembly's docker images for the IllumiDesk learning environment. This image is used both with the Canvas LMS integration and as a stand-alone notebook.

Pre Requisits

Quickstart

  1. Install dependencies
make venv
  1. Build images
make build-all
  1. Run:

Running the image standalone is helpful for testing:

docker run -p 8888:8888 illumidesk/ga-notebook:latest

Then, navigate to http://127.0.0.1:8888 to access your Jupyter Notebook server.

Refer to docker's documentation for additional docker run ... options.

Customize the Image

  1. Rebuild end-user and grader images with make build-all.

  2. (Optional) Push images to DockerHub

This step requires creating an Organization account in DockerHub or other docker image compatible registry. The docker push ... command will push the image to the DockerHub registry by default. Please refer to the official Docker documentation if you would like to push another registry.

For example, assuming the DockerHub organization is illumidesk, the source files are in the ga-notebook folder, and the tag is latest, then the full namespace for the image would be illumidesk/ga-notebook:latest. Assuming the image has been built, push the image to DockerHub or any other docker registry with the docker push <image-namespace>:<image-tag> command:

docker login
docker push illumidesk/ga-notebook:latest

Development and Testing

  1. Create your virtual environment and install dev-requirements:
make venv
  1. Check Dockerfiles with linter:
make lint-all

References

These images are based on the jupyter/docker-stacks images. Refer to their documentation for the full set of configuration and testing options.

Attributions

License

MIT