Installation

Preface

The Hub and Spoke Tool Suite consists of a number of components that can be used individually or in tandem to help enable digital-repository interoperability. The binary distribution on SourceForge includes the Hub and Spoke Core and LRCRUD service for D-space, Fedora, and ePrints. Included in the package is also a METS Profile Validator. It however is not part of the main tools package and is not offically maintained or supported.

Prerequisites

At minimum you will need Sun Java 1.5 SDK or later, but certain components may require other applications be installed. If you are building from source or installing the LRCRUD service Apache Ant (tested version 1.6.5) is required.

Document Conventions

Throughout this document we will use the following convention to refer to the location where this distribution was unpacked: [install-dir].

Installation Navigation

Hub and Spoke Core

Overview

These components are responsible for transforming, validating, and creating EchoDep artifacts.

Prerequisites

Download

You can find the binary distribution of these core tools in the downloads section of our SourceForge page.

Install

After obtaining hubandspoke.tar.gz:

Using Hub and Spoke Core

DSpace LRCRUD Web Service

Overview

The Lightweight Repository Create Retrieve Update Delete service can be installed on the server where your repository is running to handle ingestion of Hub and Spoke packages into said repository. This is a REST style web service and is described by a general specification.

Prerequisites

LRCRUD was developed, tested, and depends on the following software:

Ensure these components are installed before installing LRCRUD.

It is best to run installation tasks as your local system's Tomcat user. If this is not possible, ensure that the temp directory is writable by the Tomcat user.

Installing the DSpace Service

NOTE: By default, the base URL of the service will be http://my.server.edu:8080/dspace-lrcrud. If you would like to change this, or any other defaults of the Tomcat configuration, you must modify the web.xml in the WEB-INF folder created for this project in your Tomcat webapps directory.

You can test the service by visiting the base URL in a web browser. If successfully installed, you will be prompted by your browser for your DSpace username and password.

NOTE: This service uses Basic Authentication which sends passwords in the clear. It is advised to use this service with HTTPS.

Using Hub and Spoke DSpace LRCRUD

Fedora LRCRUD Web Service

Overview

The Lightweight Repository Create Retrieve Update Delete service can be installed on the server where your repository is running to handle ingestion of Hub and Spoke packages into said repository. This is a REST style web service and is described by a general specification.

Prerequisites

LRCRUD was developed, tested, and depends on the following software:

Ensure these components are installed before installing LRCRUD.

It is best to run installation tasks as your local system's Tomcat user. If this is not possible, ensure that the temp directory is writable by the Tomcat user.

Installing the Fedora Service

NOTE: By default, the base URL of the service will be http://my.server.edu:8080/fedora-lrcrud. If you would like to change this, or any other defaults of the Tomcat configuration, you must modify the web.xml in the WEB-INF folder created for this project in your Tomcat webapps directory.

You can test the service by visiting the base URL in a web browser. If successfully installed, you will be prompted by your browser for your Fedora username and password.

NOTE: This service uses Basic Authentication which sends passwords in the clear. It is advised to use this service with HTTPS.

Using Hub and Spoke Fedora LRCRUD

EPrints LRCRUD Web Service

Overview

The Lightweight Repository Create Retrieve Update Delete service can be installed on the server where your repository is running to handle ingestion of Hub and Spoke packages into said repository. This is a REST style web service and is described by a general specification.

Prerequisites

LRCRUD was developed, tested, and depends on the following software:

Ensure these components are installed before installing LRCRUD.

The EPrints LRCRUD service uses the following Perl Packages and all dependencies that are not already installed on your machine (from CPAN) :
Note: Don't worry. You will be able to determine what Perl packages above are not installed via the EPrints LRCRUD service installation process as instructed below.

It is best to run installation tasks as a local user and using the sudo command when necessary (e.g., when reloading Apache 2).

Installing the EPrints Service

You can test this service by going into the [eprints_lrcrud_install_dir] /test directory and running some scripts there. The main script is a command-line script that tests any lrcrud service. It's called eprints_lrcrud_test.pl.

NOTE: By default, the base URL of the service will be http://my.server.edu:8080/eprints-lrcrud. If you would like to change this, or any other defaults of the Tomcat configuration, you must modify the web.xml in the WEB-INF folder created for this project in your Tomcat webapps directory.

You can test the service by visiting the base URL in a web browser. If successfully installed, you will be prompted by your browser for your EPrints username and password.

NOTE: This service uses Basic Authentication which sends passwords in the clear. It is advised to use this service with HTTPS.

Using Hub and Spoke EPrints LRCRUD

Validator

This web application was developed to facilitate testing and validating EchoDep METS files by our project partners. This is not a part of the main tools package, is not officially maintained or supported, and should be used with caution.

To install the Profile Validator:

You should then be able to access the service at http://my.server.edu:8080/hubvalidator.