Versions Compared

Key

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

...

  • 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:
    No Format
    CATALINA_HOME=/opt/tomcat
    
  • An outgoing e-mail server (SMTP) or a Jira server_ _for processing user feedback. 
  • 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, 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:
    1. an anonymous user with no roles, to be used by the search applicationSWEET backend
    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, {$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
    No Format
    mkdir /opt/eaglei/conf
    

...

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

...

  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:
    No Format
    mv /tmp/eagle-i-webapp-help-[version].war ${CATALINA_HOME}/webapps/help.war
    
  2. Restart Tomcat
  3. The online help browser will be available at: 
    No Format
    https://foo.bar.edu/help
    
    The online help is also linked from the SWEET and institutional search menus (top right corner menu)


Instructions specific to Institutional Search (optional)

  1. 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:
    No Format
    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. Uncomment the asynchronous logging properties in  eagle-i-apps.properties and eagle-i-apps-credentials.properties and edit the latter to reflect your database credentials
  4. Restart Tomcat
  5. Institutional search will be available at:
    No Format
    https://foo.bar.edu/insitution
    
  6. Log in as one of the test users created in the Initial Steps for all Applications and explore the search application.

...