Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 3.85 KB

README.md

File metadata and controls

92 lines (61 loc) · 3.85 KB

Akubra Adapter

License: GPL v3

Introduction

Facilitates the access of Fedora3 data directly from Akubra-flavored filesystem storage.

Table of Contents

Requirements

This module requires the following modules/libraries:

Installation

Install as usual, see this for further information.

Configuration

Configuration to be done in site's settings.php files to configure the services:

Key Description Default
akubra_adapter_datastream_basepath The path to the datastream store to be read. (none; requires configuration)
akubra_adapter_datastream_pattern The folder/directory structure created within the datastream store. ##
akubra_adapter_object_basepath The path to the object store to be read. (none; requires configuration)
akubra_adapter_object_pattern The folder/directory structure created within the object store. ##

So, assuming a Fedora's "data" directory is mounted to /nfs/fedora_data, you might add to settings.php:

$settings['akubra_adapter_datastream_basepath'] = '/nfs/fedora_data/datastreamStore';
$settings['akubra_adapter_object_basepath'] = '/nfs/fedora_data/objectStore';

Ultimately, the *_pattern values need to match the configuration of the source data. For additional detail on their particular meaning, it might be easiest to reference the inline comments of the original Java code.

Environment variable Description Default
AKUBRA_ADAPTER_WRITE_PARANOIA Due to how migrations (or more specifically, rolling back migrations) might operate, it can be prudent to avoid allowing items through that are writable or in writable directories, such that they cannot potentially be deleted. By passing something false-y here, we will avoid pre-filtering when iterating over objects. (unset, which enables paranoia by default)

Usage

This module provides services that are collected by service collectors in the FOXML module. there's no direct usage outside of configuring it.

Troubleshooting/Issues

Having problems or solved one? contact discoverygarden.

Maintainers and Sponsors

Current maintainers:

Sponsors:

Development/Contribution

If you would like to contribute to this module, please check out github's helpful Contributing to projects documentation and Islandora community's Documention for developers to create an issue or pull request and/or contact discoverygarden.

License

GPLv3