Oaipmh

SciCat supports querying published metadata via the OAI-PMH protocol

Configuration options

The oaipmh configuration is set by the config files .

Default configuration

In the default configuration .env file , the oaipmh is set to call the backend service available at backend.localhost (either v4 , by default, or v3 if specified otherwise by setting BE_VERSION ).

For an explanation of how setting BE_VERSION changes the environment creation see the configuration options in the root docs .

Enable additional features

Setting the BACKEND_HTTPS_URL env variables requires changing the backend URL used by the oaimph . This is managed in the env file ./config/.env .

When setting OAIPMH_HTTPS_URL it is likely you also want to set the BACKEND_HTTPS_URL , to allow the communication between the two wherever the browser is accessed.

--profile 'search' instructs docker compose to create this additional service.

DEV configuration

Running the service in DEV mode is supported, but be aware that the upstream tests fail, so npm run test will fail in the scicatlive oaipmh container as well.

When both backend and oaipmh are in DEV mode, and the backend is running v4, the openapigenerator is available in the DEV environment, and an SDK generation can be triggered from withing the oaipmh container by running generate_sdk in the shell.