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:

...

The eagle-i applications run in a web application containerTomcat server. We assume a container Tomcat is installed and configured to support HTTPS. Container , Tomcat 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:

  Code Block
  CATALINA_HOME=/opt/tomcat

• Optional: MySQL for search usage logging
• Optional: Jira for feedback

Installation Procedure

Initial

...

steps for all

...

applications

1. Create a few repository users
   Log in as an administrator to your eagle-i repository at , e.g. if your server is foo.bar.edu, the URL of the repository admin is: https://yourfoo.bar.serveredu/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, 

   Code Block
   mkdir /opt/eaglei/conf

3. edit editcatalina.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=/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:

   Code Block
   org.eaglei.home=/opt/eaglei

Property and configuration files

...

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)

Installation 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:

   Code Block
   mv /tmp/eagle-i-webapp-sweet-[version].war ${CATALINA_HOME}/webapps/sweet.war

3. Make sure the property eaglei.datatools.repository.url is set in eagle-i-apps.properties, to reflect the base address of your repository installation. Note that the URL must be an https URL, for example:

   Code Block
   eaglei.datatools.repository.url=https://foo.bar.edu

4. Restart Tomcat
5. SWEET will be available at:

   Code Block
   https://yourfoo.bar.serveredu/sweet

6. Log in as one of the test users created in as part of the Initial Procedure Steps 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. This file to be superseded by new whoami.xml as of 1.6 MS3Download 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

2. Make sure the files eagle-i-apps.properties and  whoami.xml reflect your institution's configuration
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 Uncomment the asynchronous logging properties in  eagle-i-apps.properties and and eagle-i-apps-credentials.properties as of 1.6 MS3 and edit the latter to reflect your database credentials
4. Restart Tomcat
5. Institutional search will be available at:

   Code Block
   https://yourfoo.bar.serveredu/institutioninsitution

6. Log in as one of the test users created in the Initial Procedure for all Applications and explore the search application.

...

1. Download the online help 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 help.war and place it in your Tomcat webapps directory:

   Code Block
   mv /tmp/eagle-i-webapp-model-[version].war ${CATALINA_HOME}/webapps/help.war

2. Restart Tomcat
3. The online help browser will be available at: 

   Code Block
   https://yourfoo.bar.serveredu/help

   The online help is also linked from the SWEET and institutional search menus (top right corner menu)

Upgrade procedure

To upgrade SWEET, institutional search an online help, follow these simple steps:
#Stop Tomcat.
#Delete the wars from ${CATALINA_HOME}/webapps:

cd ${CATALINA_HOME}/webapps
rm -rf sweet* institution* help*

#Download the desired release of the three application wars and copy into ${CATALINA_HOME}/webapps, as described in the installation sections above.
#Refer to the release notes for possible property files changes (this is uncommon)
#Start Tomcat.
#Navigate to the application URLs and verify the release number in the footer.