boxwalker

Installation and usage

Docker

Services shell

cp env.example .env
# Then add the RAILS_MASTER_KEY value to .env
docker compose --profile app build
docker compose --profile app up

Command shell

# Create the blacklight-collection
/bin/bash ./solr/dev-init.sh 

Indexing a directory

# Inside the container
docker compose exec app bash
DIR=<your directory path> REPOSITORY=<repository id> rake um_arclight:index_dir

# Outside the container
SOLR_URL=http://localhost:8983/solr/blacklight-collection DIR=./<location> REPOSITORY_ID=<repository shortname> rake um_arclight:index_dir

Docker Hybrid development

Use hybrid for quick rebuilds of Rails (outside a container) without repeatedly spinning up Solr/Zookeeper for each reset.

Services shell

# Build resque-web and resque images  
docker compose build
# Start zookeeper, solr, redis, resque and resque-web containers
docker compose up 

Rails shell

# Create the blacklight-collection
/bin/bash ./solr/dev-init.sh 
# Bundle install the gems outside of the container
bundle install
# Migrate the database and prepare it for GUI finding aid indexing
# NOTE: This command is run via bin/docker-entrypoint when resque is brought up
# bin/rails db:prepare 
# Development Rails server using Solr container
SOLR_URL=http://localhost:8983/solr/blacklight-collection bin/dev

Browser Resque Web

Open http://localhost:5678 in your browser

Command shell

# List all available tasks
bin/rails --task

# Index sample-ead
rsync -av --progress sample-ead/ data/ead/
FINDING_AID_DATA=./data bin/rails arclight:ingest_everything 

Troubleshooting

If you encounter this indexing error post-Boxrunner merge

. . . .rake aborted!
Bundler::GemRequireError: There was an error while trying to load the gem 'ruby-vips'. (Bundler::GemRequireError)
Gem Load Error is: Could not open library 'vips.42': dlopen(vips.42, 0x0005): tried: 'vips.42' (no such file), '/System/Volumes/Preboot/Cryptexes/OSvips.42' (no such file), '/usr/lib/vips.42' (no such file, not in dyld cache), 'vips.42' (no such file), '/usr/local/lib/vips.42' (no such file), '/usr/lib/vips.42' (no such file, not in dyld cache).

I solved it by installing vips using brew install vips.
Then run bundle install