Skip to content

mbuechner/dzp-fcs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SRU/CQL FCS 2.0 Endpoint for German Newspaper Portal

This application implements a Federated Content Search (FCS) endpoint for the German Newspaper Portal.

The aim of Federated Content Search is to enable a content search via distributed resources. The German Digital Library provides the German Newspaper Portal with a searchable corpus for this purpose.

The endpoint is published at the following URL: https://labs.deutsche-digitale-bibliothek.de/app/dzp-fcs

The following searches are given as examples.

The endpoint is used for:

Implementation

This Java servlet was implemented using the FCS Endpoint Archetype. Further information can be found there.

Build

The build automation tool "Maven" can be used to create the Web Application Archive (WAR). The following command, executed in the folder containing the pom.xml file, creates a publishable WAR file.

mvn [clean] package

Docker

Yes, there's a docker container for this application available at GitHub.

https://github.com/mbuechner/dzp-fcs/pkgs/container/dzp-fcs

Container build

  1. Checkout GitHub repository:
git clone https://github.com/mbuechner/dzp-fcs
  1. Go into folder:
cd dzp-fcs
  1. Run
docker build -t dzp-fcs .
  1. Start container with:
docker run -p 8080:8080 -P -e "TOMCAT_PASSWORD=verysecret" dzp-fcs
  1. Open browser: http://localhost:8080/

Environment variables

Variable Description Default value
TOMCAT_PASSWORD Apache Tomcat password.
See Apache Tomcat packaged by Bitnami
No default
DZP_FCS_SOLR_ENDPOINT Endpoint url for the Solr search engine of German Newspaper Portal https://api.deutsche-digitale-bibliothek.de/search/index/newspaper-issues/select
DZP_FCS_PATH_PREFIX Path prefix (if you change it to /myapp/*, the servlet will serve under http://localhost:8080/myapp/ /*