dbrepo/database-service repository overview

⁠Quick Reference

• Maintained by:

  the DBRepo Maintainers⁠

• Where to get help:

  the official documentation⁠, ICoDSE'22 paper⁠, IJDC'22 paper⁠, iPRES'21 paper⁠

⁠Supported tags

• 1.3⁠
• latest⁠

⁠Non-supported tags

• 1.2
• 1.1

⁠Quick reference (cont.)

• Where to file issues:

  Send us an email⁠

• Supported architectures:

  amd64

• Source of this description:

  docs repo's dockerhub/ directory⁠ (history⁠)

• Verify image signature

  mweise.pub⁠

⁠What is DBRepo?

We present a database repository system that allows researchers to ingest data into a central, versioned repository through common interfaces, provides efficient access to arbitrary subsets of data even when the underlying data store is evolving, allows reproducing of query results and supports findable-, accessible-, interoperable- and reusable (FAIR) data.

⁠How to use this image

$ docker run -p 9092:9092 -v /var/run/docker.sock:/var/run/docker.sock dbrepo/database-service:1.3

⁠Customization

Change the default behavior by setting the following environment variables to different values:

• METADATA_DB, default: fda

  The metadata database⁠ database name.

• METADATA_USERNAME, default: root

  The metadata database⁠ database username.

• METADATA_PASSWORD, default: mariadb

  The metadata database⁠ database password.

• BROKER_USERNAME, default: fda

  The broker service⁠ username of a user that has administrator tags associated to the account.

• BROKER_PASSWORD, default: fda

  The broker service⁠ password of a user that has administrator tags associated to the account.

• ELASTIC_USERNAME, default elastic

  The username of the user that can create the search indexes and update them in the search database.

• ELASTIC_PASSWORD, default elastic

  The password of the user that can create the search indexes and update them in the search database.

• GATEWAY_ENDPOINT, default: http://gateway-service⁠

  The gateway endpoint.

• LOG_LEVEL, default: debug

  The minimum logging level for the service.

• CLIENT_ID, default: dbrepo-client

  The client id of the authentication service⁠.

• DBREPO_CLIENT_SECRET, default: MUwRc7yfXSJwX8AdRMWaQC3Nep1VjwgG

  The client secret of the client with the above client id. This value needs to be changed by regenerating the client secret in the authentication service⁠:

  Realm dbrepo > Clients > dbrepo-client > Credentials > Client Secret > Regenerate

• JWT_ISSUER, default: http://localhost/realms/dbrepo

  The address in the iss (issuer) field of the JWT token must match this value.

• JWT_PUBKEY, default: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqqnHQ2BWWW9vDNLRCcxD++xZg/16oqMo/c1l+lcFEjjAIJjJp/HqrPYU/U9GvquGE6PbVFtTzW1KcKawOW+FJNOA3CGo8Q1TFEfz43B8rZpKsFbJKvQGVv1Z4HaKPvLUm7iMm8Hv91cLduuoWx6Q3DPe2vg13GKKEZe7UFghF+0T9u8EKzA/XqQ0OiICmsmYPbwvf9N3bCKsB/Y10EYmZRb8IhCoV9mmO5TxgWgiuNeCTtNCv2ePYqL/U0WvyGFW0reasIK8eg3KrAUj8DpyOgPOVBn3lBGf+3KFSYi+0bwZbJZWqbC/Xlk20Go1YfeJPRIt7ImxD27R/lNjgDO/MwIDAQAB

  This value needs to be changed to the RS256 public key from the authentication-service⁠ in the admin console for public deployments under:

  dbrepo > Realm settings > Keys > Algorithm > RS256 > Public key

⁠Actuator Endpoints

• Info Actuator:

  http://localhost:9092/actuator/info⁠

• Health Actuator:

  http://localhost:9092/actuator/health⁠

• Prometheus Actuator:

  http://localhost:9092/actuator/prometheus⁠

⁠Swagger Endpoints

• OpenAPI:

  http://localhost:9092/swagger-ui/index.html⁠

• OpenAPI .json:

  http://localhost:9092/v3/api-docs/⁠

• OpenAPI .yaml:

  http://localhost:9092/v3/api-docs.yaml⁠

⁠License

View license information⁠ for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.