This is a finding aid viewer intended to be used as part of a digital library. It is written to run on Linux and has not been tested with other operating systems, but should run on most Unix-like operating systems.

This is written specifically for the University of Kentucky Libraries and includes some highly local assumptions. You are welcome to use and reuse this code according to the terms of the license, but you should be aware of its opinionated nature.

• Composer

• JSMin

1. Install the dependencies.

2. Extract the repository.

   git clone https://github.com/uklibraries/findingaid.git /path/to/findingaid

3. Descend into the findingaid repository.

   cd /path/to/findingaid

4. Use Composer to install needed packages.

5. Generate minified JavaScript.

   bash exe/build.sh

6. Install your finding aid data set in the xml directory. The finding aids must be arranged in a PairTree hierarchy. The files are not pure EAD, but must be preprocessed using a different program. For an example, install the sample data (which expands to just shy of a gigabyte):

   wget https://nyx.uky.edu/fa/findingaid/xml.tar.gz
   tar zxf xml.tar.gz

7. Create the cache directory. This must be writeable by your web server.

   mkdir public/cache
   chown apache:apache public/cache # or appropriate similar command

8. Connect the public directory to your website. For example, if your website uses /var/www/html as its document root and permits symlinks, then the following commands should make the finding aid viewer accessible. Some commands might require you to become root.

   cd /var/www/html
   ln -s /path/to/findingaid/public ./findingaid

This program is Copyright (C) 2016-2023 MLE Slone. For details, consult LICENSE.txt.

This program uses the following libraries:

• Luis Almeida's unveil.js
• Tim Down's Rangy
• John Dyer's MediaElement.js
• Marcus Ekwall's reveal.js
• Justin Hileman's Mustache.php
• Jan Sorgalla's Lity
• Bootstrap
• jQuery
• jQuery UI