User documentation is available here.
- Clone the notebooks-deploy repository from GitHub using
git clone https://github.com/LabShare/notebooks-deploy
. - Install package dependencies using
npm i
.
- Create an .env file in your working directory. See the sample-env for an example. Docker-compose uses these environment variables to populate image and container arguments and environment variables.
- Build docker images using
npm run build
. - Start JupyterHub on
localhost:8000
usingnpm start
. - JupyterHub is setup with DummyAuthenticator by default. Use any username or password to login.
- To stop the running deployment use
npm run stop
.
- Create a
.env
file in the root of the repository, usingsample-env
as an example. - Configure
kubectl
with akubeconfig
pointing to the correct Kubernetes cluster. Optionally, pass the location of thekubeconfig
file in the.env
. This value defaults to the standardkubeconfig
location. - Run the script using:
./deploy.sh
.