Skip to content

Latest commit

 

History

History
228 lines (187 loc) · 7.47 KB

README.md

File metadata and controls

228 lines (187 loc) · 7.47 KB

Introduction

Miiify is designed to serve web annotations from a git repository. This means that all new content can go through a review process before going public. Some example output is available here.

Features

  • Annotation content can be accessed in IIIF viewers or directly from a git repository
  • Annotations can be added or edited using standard git flow mechanisms such as a pull request
  • Tools such as boriiis can patch a repository with new content automated via an OCR pipeline

Quick start

Run pre-built Docker image:

docker pull jptmoore/miiify
./deploy.sh

Build from source and launch Docker container (note this will take some time the first run and sometimes breaks on build changes):

./deploy-from-source.sh

Create an annotation container:

curl -k -d @test/container1.json https://localhost/annotations/ -H Slug:my-container
{
  "@context": [
    "http://www.w3.org/ns/anno.jsonld",
    "http://www.w3.org/ns/ldp.jsonld"
  ],
  "type": [
    "BasicContainer",
    "AnnotationCollection"
  ],
  "label": "A Container for Web Annotations",
  "id": "https://localhost/annotations/my-container",
  "created": "2022-04-26T14:12:39Z"
}

Write some annotations to the container:

curl -k -d @test/annotation1.json https://localhost/annotations/my-container/
curl -k -d @test/annotation1.json https://localhost/annotations/my-container/
curl -k -d @test/annotation1.json https://localhost/annotations/my-container/

Retrieve the contents of the container but display only the links to the annotations it contains:

curl -k "https://localhost/annotations/my-container?page=0" -H Prefer:'return=representation;include="http://www.w3.org/ns/oa#PreferContainedIRIs"'
{
  "@context": [
    "http://www.w3.org/ns/anno.jsonld",
    "http://www.w3.org/ns/ldp.jsonld"
  ],
  "id": "https://localhost/annotations/my-container?page=0",
  "type": "AnnotationPage",
  "partOf": {
    "id": "https://localhost/annotations/my-container/",
    "created": "2022-04-26T14:12:39Z",
    "modified": "2022-04-26T14:24:05Z",
    "total": 3,
    "label": "A Container for Web Annotations"
  },
  "startIndex": 0,
  "items": [
    "https://localhost/annotations/my-container/354b14bd-8ad5-4261-8e81-dd70a6758c2f",
    "https://localhost/annotations/my-container/56c3df84-da68-40b3-8d22-d37cd5ec3571",
    "https://localhost/annotations/my-container/c6f45c55-58d0-4510-b978-39585f22fd1d"
  ]
}

Add an annotation called foobar to the container:

curl -k -d @test/annotation1.json https://localhost/annotations/my-container/ -H Slug:foobar
{
  "@context": "http://www.w3.org/ns/anno.jsonld",
  "type": "Annotation",
  "body": "http://example.org/post1",
  "target": "http://example.com/page1",
  "id": "https://localhost/annotations/my-container/foobar",
  "created": "2022-04-26T14:30:26Z"
}

Retrieve the annotation called foobar:

curl -k https://localhost/annotations/my-container/foobar
{
  "type": "Annotation",
  "target": "http://example.com/page1",
  "id": "https://localhost/annotations/my-container/foobar",
  "created": "2022-04-26T14:30:26Z",
  "body": "http://example.org/post1",
  "@context": "http://www.w3.org/ns/anno.jsonld"
}

Update the contents of the annotation called foobar:

curl -k -X PUT -d @test/annotation2.json https://localhost/annotations/my-container/foobar
{
  "@context": "http://www.w3.org/ns/anno.jsonld",
  "id": "https://localhost/annotations/my-container/foobar",
  "type": "Annotation",
  "body": "http://example.org/post2",
  "target": "http://example.com/page2",
  "modified": "2022-04-26T14:35:25Z"
}

IIIF

Miiify can be used to store annotations to display within IIIF viewers such as Mirador. This requires obtaining the array of annotation items from a container and applying them to a specific canvas. To achieve this we can apply a query parameter filter to select a specific target canvas. For example:

curl https://miiify.rocks/annotations/cats\?target\=https://miiify.rocks/iiif/cats/canvas/p1

Note this assumes that the target field is a string.

To see how this works within Mirador you can examine the manifest used here:

https://projectmirador.org/embed/?iiif-content=https://miiify.rocks/manifest/cats

IIIF viewers will need CORS enabled on the server. Miiify does not directly support this but is typically deployed behind a read-only proxy which should enable this. For example miiify.rocks sits behind the Kong gateway. Details on how to deploy Miiify using Kubernetes this way can be found here.

Caching

ETag support is added for supporting caching of resources as well as ensuring that an update or delete operation takes places on the intended resource without subsequent unknown modifications. ETag support works by using the value obtained from a GET or HEAD request and then using this in future requests.

curl -k -I https://localhost/annotations/my-container/foobar
HTTP/2 200 
etag: "c25c28a70db07c843253001dabfab6d8ebc7a76f"
content-type: application/ld+json; profile="http://www.w3.org/ns/anno.jsonld"
link: <http://www.w3.org/ns/ldp#Resource>; rel="type"

Note that your ETag hashes will be different from these examples:

curl -k -I https://localhost/annotations/my-container/foobar -H If-None-Match:c25c28a70db07c843253001dabfab6d8ebc7a76f

If there is no change to an annotation or container collection the server will respond back with a Not Modified status to inform the client that the cached version of the response is still good to use:

HTTP/2 304

To safely update the resource earlier we could have supplied the ETag as follows:

curl -k -X PUT -d @test/annotation2.json https://localhost/annotations/my-container/foobar -H If-Match:c25c28a70db07c843253001dabfab6d8ebc7a76f

This ensures we really are updating the resource that we think we are.

Manifests

Miiify provides a simple Key/Value interface for working with manifests which are also stored using Git in a directory called '.manifest'.

To store a manifest using key 'foo':

curl -k -X POST -d @test/manifest1.json https://localhost/manifest/foo

To update a manifest using key 'foo':

curl -k -X PUT -d @test/manifest2.json https://localhost/manifest/foo

To retrieve a manifest using key 'foo':

curl -k -X GET https://localhost/manifest/foo

To delete a manifest using key 'foo':

curl -k -X DELETE https://localhost/manifest/foo

API

The API has been described using OpenAPI.

Configuration

The server can be started with the command flag --config=<file> to specify a JSON configuration file. The sample below shows all the fields with their default values when not included:

{
  "tls": true,
  "interface": "0.0.0.0",
  "scope": "",
  "port": 8080,
  "certificate_file": "server.crt",
  "key_file": "server.key",
  "repository_name": "db",
  "repository_author": "miiify.rocks",
  "container_page_limit": 200,
  "container_representation": "PreferContainedDescriptions"
}

Testing

Tests can be run using the Airborne test framework:

docker compose up -d
cd test
rspec integration.rb -fd
docker compose down