Commit 4827c6a1 authored by Mark Jordan's avatar Mark Jordan
Browse files

Updated README.md.

parent 497dea1a
......@@ -2,13 +2,13 @@
## Introduction
[BagIt](https://wiki.ucop.edu/display/Curation/BagIt) is a specification for packaging content and metadata about that content into a format that can be shared between applications. This module provides a framework for generating Bags for Islandora objects. It is Based on the [Islandora BagIt](https://github.com/Islandora/islandora_bagit) module. The main differences between it and this module are:
[BagIt](https://wiki.ucop.edu/display/Curation/BagIt) is a specification for packaging content and metadata about that content into a format that can be shared between applications. This module provides a simple Drush command for creating Bags for Islandora objects, and also provides a framework for writing submodules. It is based loosely on the [Islandora BagIt](https://github.com/Islandora/islandora_bagit) module. The main differences between it and this module are:
* this module does not provide a usere-facing option to generate Bags, it only provides a Drush command.
* this module does not provide a user-facing option to generate Bags, it only provides a Drush command.
* this module does not provide implementations of Islandora hooks to detect when an object or datastream has been ingested or modified.
* this module replaces Islandora BagIt's plugins with submodules.
Islandora sites can safely enable both this module and Islandora BagIt. However, if a site's requirements are met by Islandora BagIt, it is probably best to not enable this module as well.
Islandora sites can safely enable both this module and Islandora BagIt, but if a site's requirements are met by Islandora BagIt, it is probably best to not enable this module as well.
## Requirements
......@@ -140,6 +140,8 @@ This module is intended for users who have a fairly high level of permissions on
## Known Issues
Like Islandora Bagit, this module has some know issues:
* Fedora 3.8.0 fails to generate FOXML files requested using the 'archive' context ([JIRA ticket](https://jira.duraspace.org/browse/FCREPO-1384)). Earlier versions may succeed on exporting 'archive' FOXML files if the resulting FOXML is smaller than approximately 200 MB, but fail on larger files. The Islandora BagIt module triggers this set of errors if 'archive' FOXML files are generated from within one of its plugins ([JIRA ticket](https://jira.duraspace.org/browse/ISLANDORA-1193)). Until this issue is resolved in Fedora, users of the Islandora BagIt module should not use plugins that generate 'archive' FOXML, including plugin_object_foxml.inc distributed with versions of Islandora BagIt prior to 7.x-1.5. The other FOXML export contexts, 'public' and 'migrate' ([documentation](https://wiki.duraspace.org/display/FEDORA37/REST+API#RESTAPI-export)), can be used safely.
* Some Bags do not finish properly even with PHP CLI's php.ini set to ```max_input_time = -1``` ([JIRA ticket](https://jira.duraspace.org/browse/ISLANDORA-1403)). For better performance the CLI's php.ini should have the lines ```max_execution_time = 0``` and ```man_input_time = -1```, and well as including ```Timeout 86400``` in Apache2's apache2.conf.
......@@ -153,7 +155,14 @@ If you are having a problem with this module, please open an issue in its Github
## Development
Pull requests against this module are welcome, as are submodules. Please open an issue in this module's Github repo before opening a pull request.
Pull requests against this module are welcome, as are submodules (suggestions below). Please open an issue in this module's Github repo before opening a pull request.
Some submodules it would be useful to have include:
* A submodule to generate Bags for paged content
* A submodule to generate Bags for compound objects
* A submodule to add data from an object's MODS or DC datastreams to the `External-Description` bag-info.txt tag
* A submodule to generate PID files for all objects in a collection, with a given namespace, etc.
## License
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment