Ant Brown
bd377ee7d4
|
7 months ago | |
---|---|---|
.github | 8 months ago | |
config | 1 year ago | |
css | 2 years ago | |
migrate | 4 years ago | |
modules | 8 months ago | |
src | 7 months ago | |
tests | 7 months ago | |
.gitignore | 4 years ago | |
CONTRIBUTING.md | 3 years ago | |
COPYRIGHT | 5 years ago | |
LICENSE | 8 years ago | |
README.md | 2 years ago | |
composer.json | 11 months ago | |
drush.services.yml | 4 years ago | |
islandora.info.yml | 11 months ago | |
islandora.install | 1 year ago | |
islandora.libraries.yml | 2 years ago | |
islandora.links.action.yml | 4 years ago | |
islandora.links.menu.yml | 4 years ago | |
islandora.module | 7 months ago | |
islandora.permissions.yml | 7 years ago | |
islandora.post_update.php | 2 years ago | |
islandora.routing.yml | 2 years ago | |
islandora.services.yml | 7 months ago | |
islandora.tokens.inc | 1 year ago | |
islandora.views.inc | 2 years ago | |
phpunit.xml | 1 year ago |
README.md
Islandora
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
- Configuration required by the
islandora_image
- Integrates with a Houdini (Imagemagick) server for image processing
islandora_audio
andislandora_video
- Integrate with a Homarus (
ffmpeg
) server for audio/video processing
- Integrate with a Homarus (
islandora_text_extraction
andislandora_text_extraction_defaults
- Integrate with a Hypercube (
tessseract
andpdftotext
) server for text extraction
- Integrate with a Hypercube (
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:
- context
- search_api
- jsonld
- jwt
- filehash
- prepopulate
- eva
- features
- migrate_plus
- migrate_source_csv
- flysystem
It also requires the following PHP libraries:
If you are using a Drush version less than 10.4 you will also need to install and enable migrate_tools separately.
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
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.
- 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.
- 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
- American Philosophical Society
- Born-Digital, Inc.
- discoverygarden inc.
- LYRASIS
- McMaster University
- PALS
- University of Limerick
- University of Manitoba
- UPEI
- Simon Fraser University
- York University
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 Contributor License Agreements page on the islandora-community wiki for more information.
We recommend using the islandora-playbook to get started.