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 Tomcat server. We assume Tomcat is installed and configured to support HTTPS, Tomcat configuration is out of scope for this installation guide. Our reference implementation uses Tomcat 7.
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 |
Create eagle-i application home and configuration directory, ${EAGLE_I_HOME}
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 |
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 |
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 serverlocal-node.xml
- contains Institution-specific configurationDownload the samples for the type of node you're setting up from the examples directory and edit to reflect your environment, see Configuration Property Guide - pre 3.0.x. Place the three files in the configuration directory (defined in step 1 of the the Initial Procedure for all Applications section)
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 |
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:
eaglei.datatools.repository.url=https://foo.bar.edu |
SWEET will be available at:
https://foo.bar.edu/sweet |
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 |
eagle-i-apps.properties
and whoami.xml
reflect your institution's configurationsearchlogdb
(refer to the MySQL manual)eagle-i-apps.properties
and eagle-i-apps-credentials.properties
and edit the latter to reflect your database credentialsInstitutional search will be available at:
https://foo.bar.edu/insitution |
To upgrade the SWEET, online help, and institutional search applications, follow these simple steps:
Delete the wars from ${CATALINA_HOME}/webapps
:
cd ${CATALINA_HOME}/webapps rm -rf sweet* help* institution* |
${CATALINA_HOME}/webapps
, as described in the installation sections above.