Atla Digital Library

Atla staff use this repository as their digital library.

Table of Contents

• Running the stack
  • Versions
  • Important URL's
  • With Docker
    • Install Docker
    • Start the server
    • Run migrations and seed the database
    • Stop the app and services
    • RSpec
• Statistics Not Updating
• Backups
  • Backup Tools
  • What is Backed Up
    • Hyrax
  • Backup Schedule

• Restore Procedure

  Running the stack

  Versions

• Ruby 2.5.3
• Rails 5.1.6
• Hyrax 2.3.3

Important URL's

• Local site
  • http://atla.test
  • Without dory: localhost:3000
  • There is no "admin" link so you must go to http://atla.test/dashboard (or http://localhost:3000/dashboard if not using dory) to access the backend
• Staging site: http://dl-staging.atla.com
• Production site:
• Solr:
• Delayed Jobs:

With Docker

We use docker compose in this repository, the main file is:

• docker-compose.yml

Install Docker

• Download Docker Desktop and log in

Configure Dory

On OS X or Linux we recommend running Dory. It acts as a proxy allowing you to access domains locally such as hyku.test or tenant.hyku.test, making multitenant development more straightforward and prevents the need to bind ports locally. Be sure to adjust your ~/.dory.yml file to support the .test tld. You can still run in development via docker with out Dory. To do so, copy docker-compose.override-nodory.yml to docker-compose.override.yml before starting doing docker-compose up. You can then see the application at the loopback domain 'lvh.me:3000'.

gem install dory
dory up

Start the server

This project has a containerized development environment managed with with stack_car.

git clone git@github.com:scientist-softserv/atla_digital_library.git
cd atla_digital_library
docker compose pull
docker compose build
dory up
docker compose up

The app should now be available at http://atla.test.

Run migrations and seed the database

You should not need to do any of this manual setup due to the initialize_app step in the docker compose file that will run migrations and seed your database automatically, but in case you need to know how to do this manually you can:

docker compose exec web bash
bundle exec rails db:create db:schema:load db:migrate db:seed

Once these are done, you may need to stop and start the containers to ensure Delayed Job is picking up the database migration.

Stop the app and services

• Press Ctrl + C in the terminal where you started your container with docker compose up
• When that's done docker compose stop shuts down the running containers

RSpec

In a new tab/window:

docker compose exec web bash
rails spec

Troubleshooting

• if you see the following error: mesg: ttyname failed: Inappropriate ioctl for device and a list of files that already exist, for example cp: cannot create regular file './public/uv/dist/lib/p-p4r1bdpj.system.entry.js': File exists

  • run yarn (in local shell, not inside container)

• If you rails db:seed will not run, or you get the following bulkrax error when trying to edit an importer: Faraday::ConnectionFailed in Bulkrax::Importers::Edit

  • run docker compose restart fcrepo

• If you are not able to run the seeds/not able to see the seeded importer, run:

  • rails hyrax:default_collection_types:create
  • rails hyrax:default_admin_set:create
  • rails db:seed

Statistics Not Updating

Statistics can be updated manually by running UpdateStatisticalDataJob.perform_later in the rails console.

Once run, the job will automatically schedule itself to run again in the future.

Backups

Backup Tools

We use the backup gem to perform our backups. It has a lot of built in tools for dealing with most of the stack and runs very dependably. An email is sent at the end of each daily backup. This is set as a cron job on the Tomcat server and configured via the ops/roles/notch8.backups role.

What is Backed Up

Hyrax

For Hyrax we backup the database that Hyrax uses directly (to store users and session info), along with the database that Fedora uses. We back up all config files and derivatives (to speed restoration). Code is already in Gitlab and thus does not need separate backup. The Solr indexes are not backed up currently as they can be regenerated and are large.

Backup Schedule

Currently backups are taken nightly. This can be scaled up or down easily by editing the cron jobs on the servers.

Restore Procedure

Backups are encrypted and stored in S3. To restore backups, first download the correct backup files from S3. At that point the backup needs to be decrypted as per instructions here. Password is found in the secure env files under backup_password. After the tar file is decrypted Postgresql restore is done via the psql command and uploaded files can be copied back in to place manually. At that point Fedora, Solr and Passenger can all be restarted.