Skip to content

Latest commit

 

History

History
145 lines (98 loc) · 3.43 KB

README.md

File metadata and controls

145 lines (98 loc) · 3.43 KB
Raw

archives_online

Archives Online, an application supporting discovery of archival materials, based on ArcLight

  • Arclight * A Rails engine supporting discovery of archival materials, based on Blacklight

Getting Started

Docker

Note: You may need to add your user to the "docker" group:

sudo gpasswd -a $USER docker
newgrp docker

Installation

  1. Clone the repository and checkout the last release:

    git clone [email protected]:scientist-softserv/archives_online.git
cd archives_online

  2. Set up DNS:

    Dory Installation

    gem install dory
dory up

  3. Build the Docker images:

    docker compose build

Configuration

archives_online configuration is primarily found in the .env file, which will get you running out of the box.

Running the Application

Starting

docker compose up

It will take some time for the application to start up, and a bit longer if it's the first startup. When you see Passenger core running in multi-application mode. or Listening on tcp://0.0.0.0:3000 in the logs, the application is ready.

If you used Dory, the application will be available from the browser at http://archives-online.test.

You are now ready to start using archives_online!

Stopping

docker compose down

Testing

The full spec suite can be run in docker locally. There are several ways to do this, but one way is to run the following:

In Docker

docker compose exec web bash
bundle exec rake

Without Docker

bundle exec rake

Locally without Docker

Please note that this is unused by SoftServ

Compatibility

  • Ruby 3.0.3 or later
  • Rails 7.0 or later
  • Solr 8.1 or later
solr_wrapper
bundle exec rails server -b 0.0.0.0

Kubernetes

archives_online relies on helm charts for deployment to kubernetes containers. We also provide a basic helm deployment script. archives_online currently needs some additional volumes and ENV vars over the base Blacklight application.

Ingesting Data

EAD Files

In Docker

There are 2 files pre-loaded and in order to run them you need to be inside the web container:

docker compose exec web bash
bundle exec traject -u http://solr:8983/solr/${SOLR_CORE} -i xml -c lib/arclight/traject/ead2_config.rb data/VAD8042.xml
bundle exec traject -u http://solr:8983/solr/${SOLR_CORE} -i xml -c lib/arclight/traject/ead2_config.rb data/InU-Li-VAD1572.xml

Without Docker

bundle exec traject -u http://solr:8983/solr/${SOLR_CORE} -i xml -c lib/arclight/traject/ead2_config.rb data/VAD8042.xml
bundle exec traject -u http://solr:8983/solr/${SOLR_CORE} -i xml -c lib/arclight/traject/ead2_config.rb data/InU-Li-VAD1572.xml

Debugging

To use a debugger, create a docker-compose.override.yml file with the following contents

services:
  web:
    environment:
      - VIRTUAL_HOST=archives-online.test
      - VIRTUAL_PORT=3000
    command: sleep infinity
    volumes:
    - .:/home/app/webapp
    - ./generate-init.sh:/home/app/webapp/generate-init.sh

Manually start the application and go into docker's bash:

docker compose up -d && docker compose exec web bash

To use the debugger command, you may need to add the following to the file:

require 'debug'; debugger