Skip to content
Snippets Groups Projects
Verified Commit 28dc5574 authored by Martin Weise's avatar Martin Weise
Browse files

Added metadata docs

parent 5254afca
No related branches found
No related tags found
3 merge requests!231CI: Remove build for log-service,!228Better error message handling in the frontend,!223Release of version 1.4.0
...@@ -9,7 +9,7 @@ author: Martin Weise ...@@ -9,7 +9,7 @@ author: Martin Weise
If you have [Docker](https://docs.docker.com/engine/install/) already installed on your system, you can install DBRepo with: If you have [Docker](https://docs.docker.com/engine/install/) already installed on your system, you can install DBRepo with:
```shell ```shell
curl -sSL https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/dev/install.sh | bash curl -sSL https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/install.sh | bash
``` ```
## Requirements ## Requirements
......
...@@ -37,13 +37,32 @@ data ingest operations. ...@@ -37,13 +37,32 @@ data ingest operations.
### Identifiers ### Identifiers
The service is responsible for creating and resolving a *persistent identifier* (PID) attached to a query to The service is responsible for creating and resolving a *persistent identifier* (PID) attached to a database, subset,
obtain the metadata attached to it and allow re-execution of a query. We store both the query and hashes of the query table or view to obtain the metadata attached to it and allow reproduction of the exact same result.
and result set to allow equality checks of the originally obtained result set and the currently obtained result set. In
the reference implementation we currently only use a numerical id column and plan to integrate *digital object
identifier* (DOI) through our institutional library soon.
This service provides an OAI-PMH endpoint for metadata aggregators. This service also provides an OAI-PMH endpoint for metadata aggregators
(e.g. [OpenAIRE Graph](https://graph.openaire.eu/)). Through the User Interface, it also exposes metadata through
JSON-LD to metadata aggregators (e.g. [Google Datasets](https://datasetsearch.research.google.com/)). PID metadata
is always exposed, even for private databases.
The service generates internal PIDs, essentially representing internal URIs in
the [DataCite Metadata Schema 4.4](https://doi.org/10.14454/3w3z-sa82). This can be enhanced with activating the
external DataCite Fabrica system to generate DOIs, this is disabled by default.
To activate DOI minting, pass your DataCite Fabrica credentials in the environment variables:
```yaml title="docker-compose.yml"
services:
dbrepo-metadata-service:
image: docker.io/dbrepo/metadata-service:1.4.0
environment:
spring_profiles_active: doi
DATACITE_URL: https://api.datacite.org
DATACITE_PREFIX: 10.12345
DATACITE_USERNAME: username
DATACITE_PASSWORD: password
...
```
### Queries ### Queries
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment