Skip to content
This repository has been archived by the owner on Jun 21, 2023. It is now read-only.
/ docker-template Public archive

template repository for creating a hackweek docker image

License

Notifications You must be signed in to change notification settings

uwhackweek/docker-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docker-template

This repository builds a JupyterHub environment with Repo2Docker GitHub Actions CI

Action Status Docker Pulls BinderHub

How to use this template repository

  1. Click 'Use this Template' to create a copy of the configuration under your organization
  2. Edit README.md
  3. Edit .env and docker-compose.yml with your container storage org/repository
  4. Ensure you have GitHub Secrets for DOCKER_USERNAME and DOCKER_PASSWORD
  5. Build with GitHub Actions simply by pushing to GitHub:
    • Commits to 'main' branch build image, by git commit sha and 'latest', and push to DockerHub and Quay.io
    • Pull Requests trigger image building without pushing to DockerHub
git clone https://github.com/uwhackweek/docker-template
cd docker-template
git checkout dev
# make sure dev branch is up-to-date with master
git merge master
# modify environment.yml or other files in binder/
git commit -a -m "modified binder/environment to my liking"
git push
# go to github.com and create a pull request to merge dev changes into master

Pull your image to run a local JupyterLab session

docker compose up
# Do things in JupyterLab w/ files in local directory
docker compose down

Pull image from respository

  • From DockerHub: docker pull uwhackweek/template:latest
  • From Quay: docker pull quay.io/uwhackweek/template:latest

Point to a specific tagged image in JupyterHub config

https://zero-to-jupyterhub.readthedocs.io/en/latest/reference/reference.html?highlight=profile_list#singleuser-profilelist

About

template repository for creating a hackweek docker image

Topics

Resources

License

Stars

Watchers

Forks

Languages