Versions Compared

Key

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

...

Table of Contents
maxLevel2

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

...

Our reference implementation (used by the eagle-i Consortium) 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:
    Code Block
    
    CATALINA_HOME=/opt/tomcat
    
  • Optional: MySQL for search usage logging

...

General procedure

1. Create common configuration directory

Initial Procedure for all Applications

  1. Create some 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

...

  1. 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

...

  1. , if you installed the repository in {{ /opt/eaglei/repo}}, you would define the application home as /opt/eaglei
    Code Block
    
    mkdir /opt/eaglei/conf
    

2. edit catalina.properties 

...

  1. 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:
    Code Block
    
    common.loader=${catalina.base}/eaglei/conf,${catalina.base}/lib,...
    

...

  1. Add the definition of the eagle-i home property. This needs to be the full path, without using variables, for example:
    Code Block
    
    org.eaglei.home=/

...

  1. opt/eaglei

...

  1. 
    

...

3. Create application configuration files and place in the configuration directory. 

Examples for all configuration files are located in the examples directory of the code trunk

...

Instructions specific to SWEET

  1. create Dowlload the file sample datatools.properties (see file from the examples directory) and copy to the common configuration directoryplace 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 ba an https URL and include the port number)
  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 rename the war to sweet.war and drop in the tomcat place it in your Tomcat webapps directory:
    Code Block
    
    mv /tmp/eagle-i-webapp-sweet-[version].war ${CATALINA_HOME}/webapps/sweet.war
    
  3. Restart restart Tomcat
  4. SWEET will be available at:
    Code Block
    
    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:
    Code Block
    
    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.
  4. Restart
  5. create the following properties files and copy to the common configuration directory:
    • institution-registry.properties - contains the repository credentials for using the harvest service 
    • asynclogger.properties - contains the credentials for search usage database
  6. Wiki Markup
    \[instructions to set up logging database\]
  7. Wiki Markup
    \[instructions to set up solr home directory\]
  8. rename the war to institution.war and drop in the tomcat webapps directory
  9. restart Tomcat
  10. Institutional search will be available at:
    Code Block
    
    https://your.server/institution
    
  11. 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

...

Code Block
https://your.server/model

Instructions specific to the monitor

...