Quick Start Guide - International Image Interoperability Framework™

See also complete list of IIIF Specifications, including drafts.

The following is a quick-start guide for image repository managers and engineers who are interested in making their image repository interoperable, or just experimenting with IIIF.

The basic steps to getting started with IIIF are:

  1. Deploy an image server that supports the IIIF Image API
  2. Publish metadata about your image-based objects that complies to IIIF Presentation API
  3. Deploy and integrate software that allows you to discover and display IIIF-compliant image resources

Deploy an image server

In this step you will either deploy an image server for the first time, or adapt your existing image server. In either case your goal is to deploy an image server that fully supports delivery of images via URLs as specified in the IIIF Image API v2.1.

Just experimenting or trying to set up an interoperable image server for the first time? Try one of these:

  • Loris is an open source, Python-based image server that supports the IIIF Image API versions 2.0, 1.1, and 1.0. It supports JPEG, JPEG2000 and TIFF source images.
  • IIPImage Server is an open source Fast CGI module written in C++ that is designed to be embedded within a host web server such as Apache, Lighttpd, MyServer or Nginx. It supports TIFF and JPEG2000 source images. IIIF support is available on the master branch.

Do you currently have an image server based on djatoka, Aware, Luratech or FSI?

These are common image server technologies that drive many image repositories in the cultural heritage community, and chances are that someone in the IIIF community has already built a shim or translator to make these IIIF compatible. Email the IIIF Discuss Google Group to find out. We will add documentation and pointers to these translators in the future. For example:

  • This Ruby on Rails gem translates djatoka URIs to IIIF-compatible URIs.

Once you have deployed your image server, we highly recommend that you validate it to confirm that it complies with the IIIF Image API, and to determine its level of compliance.

Publish metadata

Now that you have an image server that delivers IIIF-compliant image URIs, you need to publish presentation based metadata about your image-based objects using the IIIF Presentation API.

You can also validate your presentation API resources to confirm that they comply with the specifications.

Deploy and integrate software

Now that you have an image server and published metadata, it's time to deploy software that makes use of the IIIF technology stack. Ultimately you will want to integrate these services and supporting software into your existing infrastructure, but there are some simple ways to experiment with your new IIIF support:

  • Deploy an image viewer that natively supports IIIF. Try to open your images in OpenSeadragon or IIPMooViewer, for example.
  • Deploy a version of Mirador and try to compare your image resources with images hosted by another IIIF-compatible repository. Write the IIIF Discuss list and we’ll supply you with sample data.

Implementation Tips & Tricks