Registry

This project is an implementation of an IVOA publishing registry. It uses BaseX a native XML database as the document store.

It supports the OAI-PMH interface for harvesting.

The development framework that is used to create the application is Quarkus. If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./gradlew quarkusDev

NOTE:

• Quarkus ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.
• there is also a Swagger UI to run all the endpoints http://localhost:8080/q/swagger-ui/

Adding content

In a deployment it is possible to add entries to the registry using the admin endpoints - these are basicauth protected with

• user: admin
• password: passwordchangeme

this can be changed in a deployment by setting the following environment variable

QUARKUS_SECURITY_USERS_EMBEDDED_USERS__admin__ = betterpassword

Harvesting

to specify a cache directory for the harvesting process, set the following environment variable

IVOA_HARVESTING_CACHE=/path/to/cache/directory

Running in Docker

An image called javastro/publishing-registry will be created and run with

./gradlew quarkusBuild 
docker-compose up

Helm chart

./gradlew build

Helm chart will be generated in build/helm

Environment variables

# Only effects helm chart generation
ENABLE_MONITORING - enable prometheus metrics (true/false), false by default