| Information | Links |
|---|---|
| Project |   |
| Community |   |
| CI |  |
This repository contains the source code for Docker (container) images used by the Nebari platform. It also contains an automated means of building and pushing these images to public container registries through GitHub actions. Currently, these images are built and pushed to the following registries:
GitHub Container Registry (ghcr.io)
Quay Container Registry (quay.io)
Whether you want to contribute to this project or whether you wish use these images, to get started, fork this repo and then clone the forked repo onto your local machine.
-
docker, make sure to read the Docker official documentation on how to install Docker on your machine. -
pre-commit, which can be installed with:
pip install pre-commit # or using conda conda install -c conda-forge pre-commit
From the repository's root folder, you can build these images locally by running the listed commands on your terminal.
-
For JupyterLab:
docker build -f Dockerfile.jupyterlab \ -t nebari-jupyterlab:latest . -
For JupyterHub:
docker build -f Dockerfile.jupyterhub \ -t nebari-jupyterhub:latest . -
For Dask-Worker:
docker build -f Dockerfile.dask-gateway \ -t nebari-dask-gateway:latest .
NOTE It is extremely important to pin specific packages
dask-gatewayanddistributedas they need to run the same version for thedask-workersto work as expected.
This repository uses the prettier pre-commit hook to standardize our YAML and markdown structure.
To install and run it, use these commands from the repository root:
# install the pre-commit hooks
pre-commit install
# run the pre-commit hooks
pre-commit run --all-filesIf you encounter an issue or want to make suggestions on how we can make this project better, feel free to open an issue on this repository's issue tracker.
Thinking about contributing to this repository or any other in the Nebari org? Check out our Contribution Guidelines.