You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

Contents


Once you have an eagle-i repository to talk to (see repository installation and administration guide), installing the rest of the applications of the eagle-i suite is relatively straightforward.This guide will walk you through the configuration and installation of the following applications:

  1. SWEET - Semantic Web Editing and Entry Tool
  2. Institutional Search
  3. Ontology Browser

The eagle-i applications run in a web application container. We assume a container is installed and configured to support HTTPS. Container configuration is out of scope for this installation guide.

Our reference implementation uses Tomcat 6.This installation guide references Tomcat file names and property files in its examples; equivalent details for other application containers are out of scope.


Prerequisites

  • Tomcat with the eagle-i repository installed.
    Locate Tomcat's home directory (usually dictated by your OS) and set an environment variable  CATALINA_HOME, for example: 
    CATALINA_HOME=/opt/tomcat
  • Optional: MySQL for search usage logging
  • Optional: Jira for feedback


Initial Procedure for all Applications

  1. Create a few repository users
    Log in as an administrator to your eagle-i repository at https://your.server/repository/admin . Navigate to the Manage User Accounts page and create the following users:
    1. an anonymous user with no roles, to be used by the search application
    2. a sample user with Resource Navigator role (to collect data)
    3. a sample user with Curator role (to curate and publish data)
  2. Create eagle-i application home and configuration directory
    Create a directory to place eagle-i application data and configuration files. You may want to reuse part of the path used when installing the eagle-i repository. For example, if you installed the repository in /opt/eaglei/repo,  
    mkdir /opt/eaglei/conf
  3. edit catalina.properties 
    Open the file ${CATALINA_HOME/conf/catalina.properties in your favorite text editor. 
    Add the eagle-i configuration directory to the common class loader. Note that catalina.properties should already have a common.loader definition, you only need to add the eagle-i configuration directory, for example: 
    common.loader=/opt/eaglei/conf,${catalina.base}/lib,...
    Add the definition of the eagle-i home property, where the conf directory was created. This needs to be the full path, without using variables, for example: 
    org.eaglei.home=/opt/eaglei


Property and configuration files (as of release 1.6 MS3 - January 2012)

The following three files are necessary to configure the eagle-i applications:

  • eagle-i-apps.properties - contains basic properties for all applications 
  • eagle-i-apps-credentials.properties - contains various back-end credentials (e.g. optional logging database and Jira feedback). As a good practice, this file should be placed in an access-restricted directory of your server
  • whoami.xml - contains Institution-specific configuration

Download the samples from the examples directory and edit to reflect your environment. Please pay attention to the instructions in the file. Place the three files in the configuration directory (defined in step 1 of the the Initial Procedure for all Applications section)


Instructions specific to SWEET

  1. Dowlload the sample datatools.properties file from the examples directory and place it in the eagle-i configuration directory (defined in step 1 of the Initial Procedure for all Applications section). This file contains the URL of the repository where data will be entered. Edit it to reflect your installation (note that the URL must be an https URL and include the port number) (this file to be superseded by eagle-i-apps.properties as of 1.6 MS3)
  2. Download the SWEET war file from our Software download page (choosing the version you need, usually you will want the latest release) and place in a temporary location, e.g. /tmp. Rename the war to sweet.war and place it in your Tomcat webapps directory: 
    mv /tmp/eagle-i-webapp-sweet-[version].war ${CATALINA_HOME}/webapps/sweet.war
  3. Restart Tomcat
  4. SWEET will be available at: 
    https://your.server/sweet
  5. Log in as one of the test users created in the Initial Procedure for all Applications and explore the SWEET. You can invoke the user help from the link on the top right hand corner.


Instructions specific to Institutional Search

  1. Download the sample whoami.xml file from the examples directory and place it in the eagle-i configuration directory (defined in step 1 of the Initial Procedure for all Applications). Edit this file to reflect your institution's information. Please pay attention to the instructions in the file.
  2. Download the Institutional search war file from our Software download page (choosing the version you need, usually you will want the latest release) and place in a temporary location, e.g. /tmp. Rename the war to institution.war and place it in your Tomcat webapps directory: 
    mv /tmp/eagle-i-webapp-institution-[version].war ${CATALINA_HOME}/webapps/institution.war
  3. Optional: set up a database for logging search activity
    1. Create a database named searchlogdb (refer to the MySQL manual)
    2. Dowlload the sample asynclogger.properties file from the examples directory and place it in the eagle-i configuration directory (defined in step 1 of the initial procedure for all applications). Edit it to reflect your MySQL user name and password. 
      This file to be superseded by eagle-i-apps.properties and eagle-i-apps-credentials.properties as of 1.6 MS3
  4. Restart Tomcat
  5. Institutional search will be available at: 
    https://your.server/institution
  6. Log in as one of the test users created in the Initial Procedure for all Applications and explore the search application. You can invoke the user help from the link on the top right hand corner.


Instructions specific to the ontology browser

  1. Download the ontology browser war file from our Software download page (choosing the version you need, usually you will want the latest release) and place in a temporary location, e.g. /tmp. Rename the war to model.war and place it in your Tomcat webapps directory: 
    mv /tmp/eagle-i-webapp-model-[version].war ${CATALINA_HOME}/webapps/model.war
  2. Restart Tomcat
  3. The ontology browser will be available at: 
    https://your.server/model
  • No labels