Commit 0e33b433 authored by Sebastian Schüpbach's avatar Sebastian Schüpbach
Browse files

Update README

parent e78ac9c8
Pipeline #29045 passed with stages
in 4 minutes and 38 seconds
# IIIF Manifest Creator
Creates a IIIF manifest based on received metadata
Creates a [IIIF manifest](https://iiif.io/api/presentation/2.1/) based on received metadata
## Mapping
The service extracts and maps certain values in the original metadata (which is in JSON-LD) to the IIIF manifest model. In order to perform this task, there are two main components at work:
* [_Extractors_](https://gitlab.switch.ch/memoriav/memobase-2020/services/postprocessing/iiif-manifest-creator/-/blob/master/src/main/scala/ch/memobase/Extractors.scala) for filtering the relevant values in the original metadata
* A [_manifest builder_](https://gitlab.switch.ch/memoriav/memobase-2020/services/postprocessing/iiif-manifest-creator/-/blob/master/src/main/scala/ch/memobase/Manifest.scala)
## Configuration
In order to work correctly, some environment variables have to be set:
* `APPLICATION_ID`: Id used by Kafka Streams application (see [Kafka documentation](https://kafka.apache.org/documentation/#streamsconfigs_application.id) for details)
`TOPIC_IN`: Name of Kafka topic where messages are read from
`TOPIC_OUT`: Name of Kafka topic where messages are written to (without environment postfix)
`TOPIC_PROCESS`: Name of Kafka topic where status reports are written to
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment