Getting started with local development

This page contains a starting point for people who want to know more about the BinderHub deployment by playing around with a local development instance.

Local Kubernetes

You will need a local Kubernetes cluster. A few options are

• K3s

  • Kubernetes with Rancher Desktop

• minikube

• k3d

• kind

  • Kubernetes with Docker Desktop

Install Docker Desktop

Install Docker Desktop on Mac, Windows, or Linux. And turn on Kubernetes.

Set up kubectl to connect to Kubernetes

Once you have kubectl installed, you can connect it with your local Kubernetes. To do so, run the following command:

kubectl config use-context k8s-context-name

If using Docker Desktop, k8s-context-name is docker-desktop.

You can test this out by running:

kubectl get -A pods

and a list of all running pods should be printed.

Deploy mybinder.org to Kubernetes

Run the following command:

source cert-manager.env

for d in ./mybinder*/; do
    helm dependency update "$d"
done

chartpress --skip-build

deploy.py requires your IP address (represented by xxx.xxx.xxx.xxx in the next command).

python deploy.py localhost --local-ip xxx.xxx.xxx.xxx

Access your mybinder.org

Open http://xxx.xxx.xxx.xxx with your favourite web browser.