Page History
...
For more information see the Curation System details on Task Invocation.
Installation
Note | |||
---|---|---|---|
| |||
At this time, it's recommended to install the DSpace Replication Suite via #Maven-based Installation. This form of installation will ensure that DSpace Replication Suite doesn't require re-installation during your next upgradeThese instructions are still a work in progress. |
Maven-based Installation
Wiki Markup In your DSpace Source directory ({{\[dspace-src\]}}), you will modify two Maven {{pom.xml}} files:
Wiki Markup {{\[dspace-src\]/dspace/pom.xml}} (This POM controls dependencies of CommandLine scripts. Modifying it will let you run {{dspace-replicate}} from commandline)
Wiki Markup {{\[dspace-src\]/dspace/modules/xmlui/pom.xml}} (This POM controls dependencies of XMLUI. Modifying it will let you run {{dspace-replicate}} from XMLUI)
- For both of these pom.xml files, add the following
<dependency>
section at the end of the existing<dependencies>
section (just before the closing</dependencies>
tag):Code Block <dependency> <groupId>org.dspace</groupId> <artifactId>dspace-replicate</artifactId> <version>1.0-EA</version> </dependency>
Wiki Markup Once you've finished modifying both pom.xml files, rebuild DSpace by running the following from your {{\[dspace-src\]/dspace/}} folder:
Code Block mvn clean package
Wiki Markup You will need to update your existing DSpace 1.8.x installation, by running the following from your {{\[dspace-src\]/dspace/target/dspace-1.8.x-SNAPSHOT-build/}} directory
Code Block ant update
Note Alternatively, if you don't want to do a full DSpace update, you can just update your existing binaries & webapps by running the following two commands:
Wiki Markup {{ant update_code}} (Updates the existing \[dspace\]/lib/ directory)
Wiki Markup {{ant update_webapps}} (Updates the existing \[dspace\]/webapp/ directory)
- Copy the Replication Suite's configuration files to your DSpace configuration directory
Wiki Markup *Replication Suite Configuration File:* Copy {{\[dspace-replicate\]/config/modules/replicate.cfg}} to your {{\[dspace\]/config/modules/}} directory
Wiki Markup *METS-specific AIP Configuration Settings:* Copy {{\[dspace-replicate\]/config/modules/replicate-mets.cfg}} to your {{\[dspace\]/config/modules/}} directory
Wiki Markup *DuraCloud Configuration File:* Copy {{\[dspace-replicate\]/config/modules/duracloud.cfg}} to your {{\[dspace\]/config/modules/}} directory
- Finally, follow the Configuration settings instructions below to configure the Replication Suite based on your usage needs.
Wiki Markup There is a sample {{curate.cfg}} file provided in {{\[dspace-replicate\]/config/modules/curate.cfg}} which can be used as a reference. It is pre-configured to use the [DSpace AIP Format|DSDOC18:DSpace AIP Format] (METS-based packaging).
Manual Installation
Warning | ||
---|---|---|
| ||
This Manual Installation will only work properly until your next DSpace rebuild. The next time you run 'ant update', you will need to copy the DSpace-Replication Suite JAR files (see below) back over to your DSpace installation. For a more "permanent" installation option, see the #Maven-based Installation option above |
- Download the Replication Suite code
- "Early Access" release is available via SVN at: http://scm.dspace.org/svn/repo/modules/dspace-replicate/tags/dspace-replicate-1.0-EA/
- Experimental Trunk code is available via SVN at: http://scm.dspace.org/svn/repo/modules/dspace-replicate/
- "Early Access" release is available via SVN at: http://scm.dspace.org/svn/repo/modules/dspace-replicate/tags/dspace-replicate-1.0-EA/
- Build/Compile the Replication Suite, by running the following from the root directory
Code Block mvn package
- Copy the generated JAR files to your DSpace 1.8 installation.
Wiki Markup There are a total of 5 JARs that will need to be copied to your {{\[dspace\]/lib/}}
Wiki Markup {{\[dspace-replicate\]/target/dspace-replicate-\[version\].jar}} (The Replication Suite Plugin)
Wiki Markup {{\[dspace-replicate\]/target/lib/common-\[version\].jar}} (DuraCloud common libraries - required for DuraCloud integration)
Wiki Markup {{\[dspace-replicate\]/target/lib/commons-compress-\[version\].jar}} (Apache Commons Compress - prerequisite for Replication Suite plugin)
Wiki Markup {{\[dspace-replicate\]/target/lib/storageprovider-\[version\].jar}} (DuraCloud storage provider libraries - required for DuraCloud integration)
Wiki Markup {{\[dspace-replicate\]/target/lib/storeclient-\[version\].jar}} (DuraCloud store client libraries - required for DuraCloud integration)
Wiki Markup Also, copy the above 5 JARs also to your XMLUI web application's WEB-INF/lib directory (e.g. {{\[dspace\]/webapps/xmlui/WEB-INF/lib/}})
- Copy the Replication Suite's configuration files to your DSpace configuration directory
Wiki Markup *Replication Suite Configuration File:* Copy {{\[dspace-replicate\]/config/modules/replicate.cfg}} to your {{\[dspace\]/config/modules/}} directory
Wiki Markup *METS-specific AIP Configuration Settings:* Copy {{\[dspace-replicate\]/config/modules/replicate-mets.cfg}} to your {{\[dspace\]/config/modules/}} directory
Wiki Markup *DuraCloud Configuration File:* Copy {{\[dspace-replicate\]/config/modules/duracloud.cfg}} to your {{\[dspace\]/config/modules/}} directory
- Finally, follow the Configuration settings instructions below to configure the Replication Suite based on your usage needs.
Wiki Markup There is a sample {{curate.cfg}} file provided in {{\[dspace-replicate\]/config/modules/curate.cfg}} which can be used as a reference. It is pre-configured to use the [DSpace AIP Format|DSDOC18:DSpace AIP Format] (METS-based packaging).
...