Skip to content
Christopher Hanna Johnson edited this page Nov 17, 2018 · 3 revisions
logo

Collections-UI is a discovery and presentation interface for IIIF Manifests.

Deployment

The interface can be deployed behind a reverse proxy with Docker Compose. HTTPS is required on the front-end. See the nginx configuration for details.

Docker

An image can be built from the master branch root with this command:

$ docker build --no-cache -t {your-org/your-image-name} .

Dependencies

The search interface requires Elasticsearch. A turn-key Elasticsearch deployment is provided using this docker composition. A Redis instance is also provided. Redis will be used to store user-generated annotations.

The viewer interface resolves UUIDs to manifest URIs using a Firebase realtime database. A manifest identifier is a version 5 UUID in the url namespace that is generated from the URI.

Authentication is provided using Firebase Authentication

Environment

The build requires a .env file with the following key to exist in the packages/collections-ui-app directory:

REACT_APP_ELASTICSEARCH_HOST=
REACT_APP_OSD_COMPONENT_BASE=/view
REACT_APP_FIREBASE_KEY=
REACT_APP_VISION_API_KEY=

https://es.iiif.cloud/ is the reference REACT_APP_ELASTICSEARCH_HOST implementation

Clone this wiki locally