Archival IIIF image server

Archival IIIF image server is an implementation of the IIIF Image API.

Web API

See also the IIIF Image API 2.1 and the IIIF Image API 3.0

URL: /[id]/[region]/[size]/[rotation]/[quality].[format]

Method: GET

E.g. http://localhost:3333/example.jpg/full/!100,100/0/default.jpg

Installation

1. Install
   • Node.js 18.x LTS
   • yarn or npm
2. Set up the configuration (See .env.example for the example configuration)
   • Copy .env.example to .env and set up the parameters for development
   • Set up the environment variables for production (see above) with the environment variables
3. Install dependencies

   // with npm
   npm install
   
   // with yarn
   yarn install

Usage

1. Copy your images into the data folder, you defined in the .env file (IIIF_IMAGE_ROOT_PATH).
2. Start the application:

   // with npm
   npm run start
   
   // with yarn
   yarn run start

Configuration

Key	Description	Example | Values
NODE_ENV	Environment type	development or production
IIIF_IMAGE_PORT	Server Port	E.g. 3333
IIIF_IMAGE_ROOT_PATH	Path to images	E.g. /data
IIIF_IMAGE_CONCURRENCY	Parameter which controls the number of threads libvips can use for image processing	By default it takes the number of CPU cores available. Specify 0 to make it explicit.