Archival IIIF image core

Archival IIIF image core provides the core functionality to build a IIIF image server, but also provides a server ready-to-go.

IIIF Image API

The web server exposes an IIIF Image API 3.0 compliant service.

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

Method: GET

For example:

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

The optional max query parameter limits the image dimensions exposed to the request. It must be a positive integer:

http://localhost:3333/example.tif/full/max/0/default.jpg?max=5000

URL: /[id]/info.json

Method: GET

The endpoint returns IIIF Image API 3 metadata. It also accepts the same optional max parameter:

http://localhost:3333/example.tif/info.json
http://localhost:3333/example.tif/info.json?max=5000

URL: /viewer?iiif=[encoded-info.json-URI]

Method: GET

The bundled full-page OpenSeadragon viewer can be used to interact with the images using IIIF using the iiif query parameter. For example:

http://localhost:3333/viewer?iiif=http%3A%2F%2Flocalhost%3A3333%2Fexample.tif%2Finfo.json

Installation

1. Install
   • Node.js 24.x LTS
   • yarn or npm
2. Install dependencies

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

Run the provided image server

You can run the provided IIIF image server with the following possible arguments:

// with npm
npm run start -- [arguments]

// with yarn
yarn run start -- [arguments]

// with docker
docker run -d -p 3333:3333 [image] [arguments]

Arguments	Description	Default value
-d | --debug	Specify flag for debug messages	false
-p | --port	Server port	3333
-r | --root	Root path to images
-c | --concurrency	Control the number of threads libvips can use for image processing	0 (The number of CPU cores available)