Skip to content

Latest commit

 

History

History
119 lines (87 loc) · 5.41 KB

README.md

File metadata and controls

119 lines (87 loc) · 5.41 KB
Raw

Islandora Islandora

Minimum PHP Version Build Status Contribution Guidelines LICENSE codecov

Introduction

This is the core module of Islandora's digital repository ecosystem. The islandora module provides:

  • Fedora 5 integration via the flysystem module
  • Integration with the context module to control your digital repository's behaviour
  • Publishing messages to a queue so they can be processed in the background

islandora contains several submodules and features:

  • islandora_core_feature (required)
    • Configuration required by the islandora module
  • islandora_image
    • Integrates with a Houdini (Imagemagick) server for image processing
  • islandora_audio and islandora_video
    • Integrate with a Homarus (ffmpeg) server for audio/video processing
  • islandora_text_extraction and islandora_text_extraction_defaults
    • Integrate with a Hypercube (tessseract and pdftotext) server for text extraction
  • islandora_breadcrumbs
    • Provides breadcrumbs following collection structure
  • islandora_iiif
    • Provides IIIF manifests for repository content

Requirements

Installing via composer will download all required libraries and modules. However, for reference, islandora requires the following drupal modules:

It also requires the following PHP libraries:

Installation

For a full digital repository solution, see our installation documentation.

To download/enable just this module, use the following from the command line:

$ composer require islandora/islandora
$ drush en islandora_core_feature
$ drush mim islandora_tags

Configuration

image

You can set the following configuration at admin/config/islandora/core:

  • Broker URL
    • The URL to your message broker (i.e. Activemq)
  • JWT Expiry
    • Set to increase the amount of time that authorization tokens remain valid. If you have a long running derivative processes or a migration, you may need to set this to be a very long time, e.g. 500d. Otherwise, it's best to leave it alone.
  • Gemini URL
    • The URL to your Gemini server, which keeps track of where Islandora content is in Fedora.
  • Fedora URL Display
    • Selected bundles can display the Fedora URL for repository content.

Documentation

Further documentation for this module is available on the Islandora 8 documentation site.

Troubleshooting/Issues

Having problems or solved a problem? Check out the Islandora google groups for a solution.

Maintainers

Current maintainers:

Sponsors

  • UPEI
  • discoverygarden inc.
  • LYRASIS
  • McMaster University
  • University of Limerick
  • York University
  • University of Manitoba
  • Simon Fraser University
  • PALS
  • American Philosophical Society
  • Common Media Inc.

Development

If you would like to contribute, please get involved by attending our weekly Tech Call. We love to hear from you!

If you would like to contribute code to the project, you need to be covered by an Islandora Foundation Contributor License Agreement or Corporate Contributor License Agreement. Please see the Contributors pages on Islandora.ca for more information.

We recommend using the islandora-playbook to get started.

License

GPLv2