The Data Science and Engineering Society

---

lab-template

A repository for launching laboratories.

Table of contents

• Launching this laboratory on a binderhub instance
  • Jupyter
  • JupyterLab
  • Rstudio
  • Shiny
  • Nteract
  • Stencila
• Launch this laboratory locally using Docker
  • Via our Docker image
  • Via repo2docker
  • Accessing your Docker container
• Contributing
• License

Launching this laboratory on a binderhub instance

Binderhub uses repo2docker for launching and serving the computational environments. Repo2docker supports the following interfaces:

• Jupyter
• JupyterLab
• Rstudio
• Nteract
• Shiny
• Stencila

The list below contains the known binderhub instances.

• gke.mybinder.org
• ovh.mybinder.org
• binder.gesis.org
• binder.pangeo.io

The list below provides the badges and the hyperlinks for launching one of the specific interfaces in one of the binderhub instances.

Jupyter

• 

• 

• 

• 

JupyterLab

• 

• 

• 

• 

Rstudio

• 

• 

• 

• 

Shiny

• 

• 

• 

• 

Nteract

• 

• 

• 

• 

Stencila

• 

• 

• 

• 

Launch this laboratory locally using Docker

We offer here two options for launching this lab locally: via our Docker image or via repo2docker. Before firing up your container, make sure your local user is in the docker group. Please refer to this Docker documentation for more details. It is strongly advised to not to run the container as root.

Via our Docker image

You can run a containerized instance of this lab from our own Docker image. Please refer to this link for installing Docker. Then, try:

docker run -it -p 8888:8888 thedatasociety/lab-template \
           jupyter lab --ip 0.0.0.0 --NotebookApp.token='dstoken1234567' 

Alternatively, you can map you local home folder into the container:

docker run -it -p 8888:8888  \
           -v $(echo ~):/jupyter/data/local-home \
           thedatasociety/lab-template \
           jupyter lab --ip 0.0.0.0 --NotebookApp.token='dstoken1234567'

The Dockerfile used to build the image can be found here.

Please read the section Accessing your Docker container for more details about running/accessing your container.

Via repo2docker

You can also launch this laboratory locally using Docker and repo2docker. Please refer to this link for installing Docker and this link for installing repo2docker. Use the commands below to build a Docker image and start a container from it.

repo2docker -p 8888:8888 \
            -v $(echo ~):$(echo ~)/local-home \
            https://github.com/thedatasociety/lab-template \
            jupyter lab --ip 0.0.0.0 --NotebookApp.token='dstoken1234567'

Please read the section Accessing your Docker container for details about running/accessing your container.

Accessing your Docker container

Both options above will launch a container on port 8888. They will also create a Docker volume that maps the user's home into the container (in the container, look for the local-home folder).

Please also be aware that the --ip 0.0.0.0 directive will start a sever which will accept connections from any ip. For security purposes the --NotebookApp.token='dstoken1234567' directive forces the need of a token for accessing any interface. Use the dstoken1234567 to login or feel free to set a stronger token.

Each interface will be available at a specific path, as follows:

• Jupyter: http://0.0.0.0:8888/tree

• JupyterLab: http://0.0.0.0:8888/lab

• Nteract: http://0.0.0.0:8888/nteract

• Stencila:http://0.0.0.0:8888/stencila

• Rstudio: http://0.0.0.0:8888/rstudio

• Shiny: http://0.0.0.0:8888/shiny

See the repo2docker documentation for more details regarding the use of multiple interfaces.

Contributing

License