Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • DuraCloud
    • DuraStore - this web application provides the access to and management of storage resources, which includes handling the storage portion of the DuraCloud REST API
  • DuraCloud for Research
    • Rich Object Creation Service - a service that creates Fedora digital objects that organize and enhance resources, and ingests them into a Fedora Repository
    • Service Execution Environment - the integration framework on which the ROCS is deployed
    • UpSync Tool - a client tool that monitors a filesystem, and upload files and filesystem metadata to DuraCloud when files are added or changed
  • Sidora (Demonstrationfor demonstration)
    • Sidora Server - a Drupal plus Islandora-based "Virtual Research Environment" that provides a GUI for interacting with the resources to perform research, enhance and organize the data (for demonstration)
    • Fedora Repository - provides access to the Fedora digital objects and resources to Sidora (or other services), primarily from DuraCloud storage

This guide lays out the steps necessary to begin using DfR:

  1. Obtain user credentials for a running DuraStore instance
  2. Obtain user credentials for a running Fedora instance (this may be supplied by Sidora)
  3. Obtain the DfR applications
  4. Build and deploy the DfR applications
  5. Initialize the DfR applications
  6. Test your installation

Although this document is written from a Linux environment perspective, analogous builds/installations have been tested in Windows and OSX (but may have limitations, as noted below). Any comments or feedback are welcomed. In particular, UpSync runs in the end-users user's computing environment and is often deployed in a desktop operating system like Microsoft Windows or OSX.

...

  1. Maven 2.2.1 (build on Maven 3 have not been tested)
  2. Tomcat 6.x or above, or Jetty (pre-installed for deployment, Jetty is automatically deployed for testingused automatically during the build)
  3. Java 7
  4. Git 1.7 or higher

To run the UI tests (dfr-sync) you need to install:

...

  1. Clone the DfR repository from GitHub

    Code Block
    git clone https://github.com/duraspace/dfr.git
    
  2. Set environment variables

    Code Block
    export JAVA_OPTS="-XX:MaxPermSize=256m"
    export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=1024m"
    
  3. Configure Maven2 using your preferred method for configuring its properties
    1. Add tomcat user to $M2_HOME/conf/settings.xml

      No Format
      <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                            http://maven.apache.org/xsd/settings-1.0.0.xsd">
        <localRepository/>
        <interactiveMode/>
        <usePluginRegistry/>
        <offline/>
        <pluginGroups/>
        <servers/>
        <mirrors/>
        <proxies/>
        <profiles>
          <profile>
            <id>ocs-integration-test</id>
            <activation>
              <activeByDefault>false</activeByDefault>
            </activation>
            <properties>
              <fedora.baseurl>http://dfr.duracloud.org:8080/fedora</fedora.baseurl>
              <fedora.password>changeme!</fedora.password>
              <duracloud.password>changeme!</duracloud.password>
            </properties>
          </profile>
        </profiles>
        <activeProfiles/>
      </settings>
  4. Build
    1. From top of source tree

      Code Block
      mvn clean install
  5. Configure Tomcat Manager (for deployment)
    1. Add to $CATALINA_HOME/conf/tomcat-users.xml

      No Format
      <tomcat-users>
        <role rolename="manager"/>
        <role rolename="admin"/>
        <user username="[ANY-USERNAME]" password="[ANY-PASSWORD]" roles="admin,manager"/>
      </tomcat-users>
      
  6. Start tomcat

    Code Block
    $CATALINA_HOME/bin/startup.sh
    

     

  7. Install

    Use the Tomcat Manager application to deploy the dfr-webapp.war

Test your installation
  1. Once all of the above steps have been completed, your DfR installation should be ready to test.
  2. Congratulations! You now have a functional DuraCloud installation.

Optional items

Logging
  1. DfR uses the SLF4j logging framework backed by the LogBack implementation
  2. By adding either a logback.xml or logback-test.xml file on the classpath, logging configuration can be customized

...