Page History
...
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 6.
Prerequisites
- Tomcat with the eagle-i repository installed
Locate Tomcat's home directory (usually dictated by your OS) and set an environment variableCATALINA_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
- Create a few repository users
Log in as an administrator to your eagle-i repository, e.g. if your server is foo.bar.edu, the URL of the repository admin is: https://foo.bar.edu/repository/admin . Navigate to the Manage User Accounts page and create the following users:- an anonymous user with no roles, to be used by the search application
- a sample user with Resource Navigator role (to collect data)
- a sample user with Curator role (to curate and publish data)
- 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
- 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 thatcatalina.properties
should already have a common.loader definition, you only need to add the eagle-i configuration directory, for example:
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 common.loader=/opt/eaglei/conf,${catalina.base}/lib,...
Code Block org.eaglei.home=/opt/eaglei
Property and configuration files
The following three files are necessary to configure the eagle-i applications:
...
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
- 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 tosweet.war
and place it in your Tomcat webapps directory:Code Block mv /tmp/eagle-i-webapp-sweet-[version].war ${CATALINA_HOME}/webapps/sweet.war
- Make sure the property
eaglei.datatools.repository.url
is set ineagle-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
- Restart Tomcat
- SWEET will be available at:
Code Block https://foo.bar.edu/sweet
- Log in as one of the test users created as part of the Initial 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
- 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 toinstitution.war
and place it in your Tomcat webapps directory:Code Block mv /tmp/eagle-i-webapp-institution-[version].war ${CATALINA_HOME}/webapps/institution.war
- Make sure the files
eagle-i-apps.properties
andwhoami.xml
reflect your institution's configuration - Optional: set up a database for logging search activity
- Create a database named
searchlogdb
(refer to the MySQL manual) - Uncomment the asynchronous logging properties in
eagle-i-apps.properties
andeagle-i-apps-credentials.properties
and edit the latter to reflect your database credentials
- Create a database named
- Restart Tomcat
- Institutional search will be available at:
Code Block https://foo.bar.edu/insitution
- Log in as one of the test users created in the Initial Steps for all Applications and explore the search application.
Instructions specific to Online help
- 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 tohelp.war
and place it in your Tomcat webapps directory:Code Block mv /tmp/eagle-i-webapp-model-[version].war ${CATALINA_HOME}/webapps/help.war
- Restart Tomcat
- The online help browser will be available at:
The online help is also linked from the SWEET and institutional search menus (top right corner menu)Code Block https://foo.bar.edu/help
Upgrade procedure
To upgrade the SWEET, Institutional Search an Online help applications, follow these simple steps:
...
Overview
Content Tools