@archival-iiif/image-server-core

Archival IIIF image core

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

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. 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)