Versions Compared

Key

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

...

  1. SWEET - Semantic Web Editing and Entry Tool
  2. Institutional Search
  3. Online help
  4. Institutional Search (optional, but useful if your institution will not be indexed by eagle-i's central search)Online help

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


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:
    No Format
    CATALINA_HOME=/opt/tomcat
    
  • Optional: MySQL for search usage logging
  • Optional: Jira for feedback

...

  1. 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:
    No Format
    mv /tmp/eagle-i-webapp-sweet-[version].war ${CATALINA_HOME}/webapps/sweet.war
    
  2. 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:
    No Format
    eaglei.datatools.repository.url=https://foo.bar.edu
    
  3. Restart Tomcat
  4. SWEET will be available at:
    No Format
    https://foo.bar.edu/sweet
    
  5. 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

...

Online help

  1. Download the Institutional search 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 institutionhelp.war and place it in your Tomcat webapps directory:
    No Format
    mv /tmp/eagle-i-webapp-institutionhelp-[version].war ${CATALINA_HOME}/webapps/institutionhelp.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
  4. Create a database named searchlogdb (refer to the MySQL manual)
  5. 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
  6. Restart Tomcat
  7. Institutional search The online help browser will be available at: 
    No Format
    https://foo.bar.edu/insitutionhelp
    
    Log in as one of the test users created in the Initial Steps for all Applications and explore the search application. 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 online help 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 helpinstitution.war and place it in your Tomcat webapps directory:
    No Format
    mv /tmp/eagle-i-webapp-helpinstitution-[version].war ${CATALINA_HOME}/webapps/helpinstitution.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. The online help browser Institutional search 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)
    insitution
    
  6. Log in as one of the test users created in the Initial Steps for all Applications and explore the search application.


Upgrade procedure

To upgrade the SWEET, Institutional Search an Online help online help, and institutional search applications, follow these simple steps:

  1. Stop Tomcat.
  2. Delete the wars from ${CATALINA_HOME}/webapps:
    No Format
    cd ${CATALINA_HOME}/webapps
    rm -rf sweet* institutionhelp* helpinstitution*
    
  3. Download the desired release of the three application wars and copy into ${CATALINA_HOME}/webapps, as described in the installation sections above.
  4. Refer to the release notes for possible property files changes (this is uncommon)
  5. Start Tomcat.
  6. Navigate to the application URLs and verify the updated release number in the footer.