Search Aggregation Engine

Search Aggregation Engine (SAGE), consisting of a service back-end and a client front-end, is developed and maintained by Texas A&M University Libraries.

SAGE's feature set includes both the ability aggregate disparate searchable sources into a common Solr index, as well as the ability expose Solr indexes through a dynamic user interface.

User Documentation

SAGE user documentation can be found in the wiki.

For more technical users, deployment related configurations are described in the Deployment Guide.

Deployment

A quick and easy deployment method using docker-compose is described in the Deployment Guide.

For advanced use cases, or when docker-compose is unavailable, the use of docker or npm/mvn is also described in the Deployment Guide.

Deployment, in general, may look something like this:

Starting Solr

# Switch into solr directory.
cd solr/

# Create and use a local volume.
mkdir -vp volume/solr-data_var/data/sage-1_0
docker volume create solr-data_var
cp -vR configsets volume/solr-data_var/data/
cp -v core.properties volume/solr-data_var/data/sage-1_0/

# Run the Docker, using the desired pre-built image, such as solr:9.3.0-slim.
docker run --name local_solr --mount source=solr-data_var,target=/var/solr/ -p 8983:8983 -it solr:9.3.0-slim

Starting Sage

cp example.env .env
cp example.env.client .env.client
cp example.env.service .env.service

# Make any changes to the .env, .env.client, and .env.service files before here.
docker-compose up

_{* Note: It may be necessary to disable caching during build by passing --no-cache to the docker-compose up command.}

Notes on Dependencies

SAGE utilizes the angular-openseadragon library when displaying some media types. This dependency was removed from npm, so the original JavaScript is now packaged in the SAGE code base at src/main/webapp/app/resources/scripts/ng-openseadragon/build/angular-openseadragon.js.

Additional Resources

• Contributors Documentation
• Deployment Documentation
• API Documentation

Please feel free to file any issues concerning SAGE to the issues section of the repository.

Any questions concerning SAGE can be directed to helpdesk@library.tamu.edu.

Copyright © 2022 Texas A&M University Libraries under the MIT License.