LANL Research Library
 

Getting Started

Pre-Installation


1) Download the aDORe Federation installer from Download section.

2) Untar contents to a temp directory

3) From the temp dir, follow the installation instructions below.

Installation


1) Change DB Passwords defined in createdb.sql
- Open the createdb.sql file located in the installer directory
- Replace each instance of 'password' with a password of your preference.
- Save file.

2) Log-in to mysql command line utility
- Use command 'mysql -u root -p' to log-in as root
- Enter root password when prompted

3) Run source command to create arc_registry, tape_registry, id_locator, and service_registry databases and associated database users.
- Use command 'source <adoreFederationInstaller>/createdb.sql'
# You'll also need to create the Service Registry Database in this fashion...
- Use command 'source <adoreFederationInstaller>/sql/Metadata.sql';
- Use command 'source <adoreFederationInstaller>/sql/Metadata-defaults.sql';

4) To launch the installer, run the following:

For Linux / Mac OS-X:
Console Install:
sh install.sh text

GUI Installer:
sh install.sh

For Windows:
- Double-click install.cmd to launch installer

IMPORTANT: Windows File Path References should use forward slashes (/) instead of back slashes (\) i.e. c:/apps/adoreArchive. 

Installation Structure


<root>
 |- adore-arcfile - Source/Build Environment for aDORe ARCfile Library
 |- adore-arcfile-registry - Source/Build Environment for aDORe ARCfile Registry Service
 |- adore-arcfile-resolver - Source/Build Environment for aDORe ARCfile Resolver Service
 |- adore-archive - Source/Build Environment for aDORe Archive &amp; Data Storage Location
    |-etc
    | |- moai - Contains oai-repo-accessor OAI-PMH Properties
    | |- demo - Contains sample XMLtapes/ARCfiles for demonstration purposes
    |-data
      |- arc - Default ARCfile Storage Directory
      |- tape - Default XMLtape Storage Directory
 |- adore-archive-accessor - Source/Build Environment for aDORe multiple XMLtape OAI-PMH Service 
 |- adore-disseminator - Source/Build Environment for aDORe OpenURL Disseminator Services
 |- adore-federation - Source/Build Environment for aDORe Federation &amp; Configuration Location
    |-bin 
    | |- env.sh - System environment set-up, called by main script
    | |- log4j.properties - Defines debug level for application
    | |- adoreFederation.sh - Main Adore Federation Application (Linux/Unix)
    | |- demo.sh - Demonstration Script (Linux/Unix)
    |-etc
    | |- moai - Contains oai-repo-accessor 
    | |- demo - Contains sample XMLtapes/ARCfiles for demonstration purposes
    | |- adore.properties - Main aDORe Federation &amp; aDORe Archive Properties File
    |-lib - Necessary libraries for application
 |- adore-federator - Source/Build Environment for aDORe OAI-PMH Federator Service
 |- adore-harvester-oai - Source/Build Environment for aDORe OAI-PMH Harvester Application
 |- adore-id-locator - Source/Build Environment for aDORe Identifier Locator Service
 |- adore-repo-oaidb - Source/Build Environment for generic aDORe OAI-PMH Framework
 |- adore-service-registry - Source/Build Environment for aDORe Service Registry Service
 |- adore-xmltape - Source/Build Environment for aDORe XMLtape Library
 |- adore-xmltape-registry - Source/Build Environment for aDORe XMLtape Registry Service
 |- adore-xmltape-resolver - Source/Build Environment for aDORe OpenURL XMLtape Resolver Service
 |- adore-xmltape-xquery - Source/Build Environment for aDORe XMLtape XQuery Service

Demonstration

For a walk-through demonstration of the aDORe Federation ingestion process and the resulting resources, click here.

Tutorial

For a tutorial on how to create a custom ProfileProcessor implementation, click here.