Versions Compared

Old Version 45

changes.mady.by.user Michael Spalti

Saved on

compared with

New Version 46

changes.mady.by.user Michael Spalti

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleIIIF Image Server

Running IIIF in production requires an IIIF-compatible image server. You are free to use any compatible image server you choose. However, instructions for configuring the Cantaloupe Image Server are included below. A preconfigured Cantaloupe image server is included in the Docker build to simplify evaluation and testing. 


Sample with Single ImageImage RemovedImage Added

Enable IIIF Support on Backend

...

PropertyDescription
iiif.enabledEnables the DSpace IIIF service.
iiif.image.serverBase URL path for the IIIF image server. e.g. http://localhost:8182/iiif/2/
iiif.document.viewing.hintDefault viewing hint. Can be overridden with the metadata setting described below.

iiif.logo.image

Optional URL for a small image. This will be included in all IIIF manifests.

iiif.cors.allowed-originsComma separated list of allowed CORS origins. The list must include the default value:  ${dspace.ui.url}.
iiif.metadata.itemSets the Dublin Core metadata that will be added to the IIIF resource manifest. This property can be repeated.
iiif.metadata.bitstreamSets the Bitstream metadata that will be added to the IIIF canvas metadata for individual images. This property can be repeated.
iiif.license.uri

Sets the metadata used for information about the resource usage rights.

iiif.attribution

The text to use as attribution in the iiif manifests. Defaults to:  ${dspace.name}

iiif.document.viewing.hint

Either "individuals", "paged" or "continuous". Can be overridden with the metadata setting described below.

iiif.canvas.default-width

Default value for the canvas size. Can be overridden at the item, bundle or bitstream level.

iiif.canvas.default-height

Default value for the canvas size. Can be overridden at the item, bundle or bitstream level.


Info
titleCanvas Dimensions

As of 7.2, the canvas dimension options (iiif.canvas.default-width and iiif.canvas.default-height) are updated with additional behaviors.

  • If you do not provide your own default dimensions in iiif.cfg, DSpace will attempt to optimize canvas dimensions when dimension metadata is missing from the first bitstream in the item. This will often produce more accurate viewer layouts, but note that it is not sufficient to assure accurate layouts in all cases. 
  • If you decide to add your own default dimensions in iiif.cfg file your dimensions are used for every bitstream that lacks dimension metadata.
  • You may also set both default dimensions in iiif.cfg to the value -1. In this case, DSpace creates accurate default dimensions for every bitstream that lacks dimension metadata. Note that this impacts performance.

It is recommended that width and height metadata be added to every image bitstream to assure accurate layout and top performance. Default dimension configurations are intended to improve the user experience when dimension metadata has not yet been added to bitstreams.

CORS Configuration

By default, the DSpace IIIF backend is configured to accept requests only from the Angular client origin. To facilitate the repository interoperability that IIIF promises, you can configure additional CORS origins using the iiif.cors.allowed-origins property defined in iiif.cfg. Currently, DSpace does not support the "*" wildcard but you are free to add multiple, comma-separated origins to the list.

...