tl;dr

If you have Docker already installed on your system, you can install DBRepo with:

curl -sSL https://raw.githubusercontent.com/DBRepo-Project/dbrepo/refs/heads/main/.scripts/install.sh | bash

Documentation

Find a system description, component documentation and endpoint documentation online: https://dbrepo-project.github.io/dbrepo-docs.

Development

Contributions are always welcome and encouraged, please read the contribution overview.

Build

Build the java library from scratch (you have to do this only once unless something has changed in ./lib/java/):

make build-java-lib

Build the python library from scratch (you have to do this only once unless something has changed in ./lib/python/):

make build-python-lib

Build the docker images:

make build-images

Run

After building, run the docker containers:

docker compose up -d

When updating the configuration, you need to recreate the Gateway Service additionally: docker compose restart dbrepo-gateway-service.

docker compose logs -f

Release Checklist

Build the Helm Chart schema:

make build-helm

Build the OpenAPI docs:

make gen-openapi-doc

Acknowledgements

We want to thank the following organizations:

• ARI&Snet for their continuous support in project work and funding.
• TU.it & .digital office for their continuous support in project work, funding and compute resources provided in-kind.
• Bundesministerium für Bildung, Wissenschaft und Forschung (BMBWF) for funding during the call "Digitale und soziale Transformation in der Hochschulbildung".
• Deutsche Forschungsgemeinschaft (DFG) for funding the DBRepo aaS project.

License

The source code is licensed under Apache 2.0.