| commit | 479efb460fd5def0bd16787e7e711bb89965f1e2 | [log] [tgz] |
|---|---|---|
| author | Akron <nils@diewald-online.de> | Wed Jan 11 16:39:14 2023 +0100 |
| committer | Akron <nils@diewald-online.de> | Wed Jan 11 16:39:14 2023 +0100 |
| tree | f5416aca68b5a5c48f20eddaf75114d980e88d2d | |
| parent | f09fc56873f87ccea0532319a7336ee1d47c4adc [diff] |
Update readme after GitHub Release Change-Id: Ic4ff4f444fc108cf28a887e4636da6dcf85c98f0
Kalamar-Plugin-ExternalResources is a web service that integrates in the plugin framework of Kalamar, to allow linking texts by their text sigle to external data providers, mainly for full text access.
Kalamar-Plugin-ExternalResources is meant to be a basic plugin and should demonstrate and evaluate the plugin capabilities of Kalamar.
Go 1.19 or later
To build the latest version of Kalamar-Plugin-ExternalResources, do ...
$ git clone https://github.com/KorAP/Kalamar-Plugin-ExternalResources $ cd Kalamar-Plugin-ExternalResources $ go test . $ go build .
The binary can be started without prerequisites. The templates folder has to be kept in the root directory.
Registration of the plugin in Kalamar is not yet officially supported - but it works by passing the JSON blob generated at /plugin.json to the plugin registration handler.
To index further data, the mappings need to be stored in a csv-file, like
"WPD11/A00/00001","Wikipedia","http://de.wikipedia.org/wiki/Alan_Smithee" "WPD11/A00/00003","Wikipedia","http://de.wikipedia.org/wiki/Actinium" "WPD11/A00/00005","Wikipedia","http://de.wikipedia.org/wiki/Ang_Lee"
Then run the indexation with:
$ ./Kalamar-Plugin-ExternalResources data.csv
The following environment variables can be set either as environment variables or via .env file in the calling directory.
KORAP_SERVER: The server URL of the hosting service.KORAP_EXTERNAL_RESOURCES_PORT: The port the service should be listen to.KORAP_EXTERNAL_RESOURCES: The exposed URL the service is hosted.Currently no official Docker image is provided. To build an image based on the provided Dockerfile, run
$ docker build \ -f Dockerfile \ -t korap/kalamar-plugin-externalresources .
To create a container on Linux based on the image with a mounted database in db and a configuration file, run
$ docker run \ --rm \ --network host \ -v ${PWD}/db/:/db/:z \ -v ${PWD}/.env:/.env korap/ \ kalamar-plugin-externalresources
Copyright (c) 2023, IDS Mannheim, Germany
Author: Nils Diewald
Kalamar-Plugin-ExternalResources is developed as part of the KorAP Corpus Analysis Platform at the Leibniz Institute for the German Language (IDS).
Kalamar-Plugin-ExternalResources is published under the BSD-2 License.