Skip to content

Overview

Developing for DSP-API requires a complete local installation of Knora. The different parts are:

  1. The cloned DSP-API Github repository
  2. Fuseki - supplied triplestore in the DSP-API Github repository.
  3. Sipi by building from source or using the docker image

Knora Github Repository

$ git clone https://github.com/dasch-swiss/dsp-api

Triplestore

A number of triplestore implementations are available, including free software as well as proprietary options. DSP-API is designed to work with any standards-compliant triplestore. It is primarily tested with Apache Jena Fuseki.

Sipi

Build Sipi Docker Image

The Sipi docker image needs to be build by hand, as it requires the Kakadu distribution.

To build the image, and push it to the docker hub, follow the following steps:

$ git clone https://github.com/dhlab-basel/docker-sipi
(copy the Kakadu distribution ``v7_8-01382N.zip`` to the ``docker-sipi`` directory)
$ docker build -t daschswiss/sipi
$ docker run --name sipi --rm -it -p 1024:1024 daschswiss/sipi
(Ctrl-c out of terminal will stop and delete container)
$ docker push daschswiss/sipi

Pushing the image to the docker hub requires prior authentication with $ docker login. The user needs to be registered on hub.docker.com. Also, the user needs to be allowed to push to the dblabbasel organisation.

Running Sipi

To use the docker image stored locally or on the docker hub repository type:

$ docker run --name sipi -d -p 1024:1024 daschswiss/sipi

This will create and start a docker container with the daschswiss/sipi image in the background. The default behaviour is to start Sipi by calling the following command:

$ /sipi/local/bin/sipi -config /sipi/config/sipi.test-config.lua

To override this default behaviour, start the container by supplying another config file:

$ docker run --name sipi \
             -d \
             -p 1024:1024 \
             daschswiss/sipi \
             /sipi/local/bin/sipi -config /sipi/config/sipi.config.lua

You can also mount a directory (the local directory in this example), and use a config file that is outside of the docker container:

$ docker run --name sipi \
             -d \
             -p 1024:1024 \
             -v $PWD:/localdir \
             daschswiss/sipi \
             /sipi/local/bin/sipi -config /localdir/sipi.test-config.lua

Redis Server

The DSP-API server uses Redis for caching.

On macOS you can install Redis through Homebrew:

$ brew install redis

If you don't want to use Redis, you can disable caching in application.conf via the app.use-redis-cache key, by setting it to false.

Last update: 2022-06-22