Discovery and access application for archival material at University of Michigan Libraries.

A front-end for archival finding aids / collection guides built on the ArcLight Rails Engine.

The application currently runs at https://findingaids.lib.umich.edu.

alias dc="docker-compose"
alias dce="dc exec --"
alias abe="dce app bundle exec"

docker-compose build app

docker-compose up -d

NOTES

• The resque and resque-web containers will exit because we have yet to do a bundle install!.

Install bundler

docker-compose exec -- app gem install 'bundler:~>2.2.21'
docker-compose exec -- app bundle config --local build.sassc --disable-march-tune-native

This was moved into the Dockerfile, so it is no longer necessary but is left here as a reminder so it will not be forgotten.

Need to revisit why this is necessary in the first place!

docker-compose exec -- app bundle install

NOTES

• Environment variable BUNDLE_PATH is set to /var/opt/app/gems in the Dockerfile.

docker-compose exec -- app yarn install

NOTES

• Investigate using a volume for the node_modules directory like we do for gems

docker-compose exec -- app bundle exec rails db:setup

If you need to recreate the databases, run db:drop and then db:setup.

docker-compose exec -- app bundle exec rails db:drop
docker-compose exec -- app bundle exec rails db:setup

NOTES

• Names of the databases are defined in ./config/database.yml
• The environment variable DATABASE_URL takes precedence over configured values.

docker-compose exec -- solr solr create_core -d umich-arclight -c umich-arclight-development 
docker-compose exec -- solr solr create_core -d umich-arclight -c umich-arclight-test 

If you need to recreate a core, run delete and create_core (e.g., umich-arclight-test)

docker-compose exec -- solr solr delete -c umich-arclight-test
docker-compose exec -- solr solr create_core -d umich-arclight -c umich-arclight-test 

NOTES

• Names of the solr cores are defined in ./config/blacklight.yml file.
• The environment variable SOLR_URL takes precedence over configured values.

docker-compose restart resque
docker-compose restart resque-web

NOTES

• Resque.redis is assigned in the ./config/initializers/resque.rb file.
• The REDIS_URL is referenced in the ./config/cable.yml file.
• The environment variable REDIS_URL takes precedence over configured values.
• Environment variable REDIS_URL is set to redis://redis:6379 in the docker-compose.yml file.

docker-compose exec -- app cp -r data /var/opt/app/data

docker-compose exec -- app bundle exec rails s -b 0.0.0.0

Verify the application is running http://localhost:3000/

docker-compose down

docker-compose up -d

docker-compose exec -- app bundle exec rails s -b 0.0.0.0

The gems, database, solr, and redis use volumes to persit between the ups and downs of development. When things get flakey, you can delete any or all volumes after you bring it all down. If you remove all volumes, just repeat the Development quick start; otherwise you'll need to run the appropriate steps depending on which volumes you deleted:

• For gems run the Bundle install and Restart Resque and Resque-Web steps.
• For database run the Setup databases step.
• For solr run the Create solr cores step.
• For redis there is nothing else to do.

The application data directory contains the ead2002 directory which contains the 2002 specifications.

/var/opt/app/data/ead2002
  /related_optional
  dtd2schema.xsl
  ead.dtd
  ead2002.xsd

and the fonts directory which contains additional fonts used by the application.

/var/opt/app/data/fonts
  /UnifontExMono.woff

The convention is for EAD XML files to be located in the appropriate repository subdirectory under the ead directory in the application data directory where the repository slug is used as the subdirectory name.

/var/opt/app/data
  /ead
    /bhl
    /clarke
    /clements
    ...

If you don't have any particular EAD XML files, you can just copy the sample-ead directory into the application data directory.

docker-compose exec -- app cp -r sample-ead /var/opt/app/data/ead

NOTES

• Environment variable FINDING_AID_DATA is set to /var/opt/app/data in the Dockerfile.

docker-compose exec -- app bundle exec rake dul_arclight:reindex_everything

Background processing jobs for indexing may be monitored via resque-web http://localhost:8080/overview

docker-compose exec -- app bundle exec rake dul_arclight:reindex_repository REPOSITORY_ID=bhl

docker-compose exec -- app bundle exec rake arclight:index REPOSITORY_ID=bhl FILE=/var/opt/app/data/ead/bhl/umich-bhl-032.xml

docker-compose exec -- app bundle exec rake arclight:destroy_index_docs

NOTES

• Repositories are define in ./config/repositories.yml
• The default application data directory is /data and is declared in ./lib/dul_arclight.rb.
• The environment variable FINDING_AID_DATA takes precedence over the default value.
• Environment variable FINDING_AID_DATA is set to /var/opt/app/data in the Dockerfile.

Continuous integration is the default rake task and is defined in the ./lib/tasks/default.rake file.

docker-compose exec -- app bundle exec rake

It actually does nothing but is dependent on these rake tasks:

docker-compose exec -- app bundle exec rake lint

docker-compose exec -- app bundle exec rake rubocop

docker-compose exec -- app bundle exec rake test

docker-compose exec -- app bundle exec rake spec

docker-compose exec -- app yarn lint
docker-compose exec -- app bundle exec rubocop
docker-compose exec -- app bundle exec test
docker-compose exec -- app bundle exec rspec

docker-compose exec -- app bundle exec rake -T

docker-compose exec -- app env

• ArcLight on GitHub
• ArcLight project wiki
• Docker
• Rails
• Ruby