AUK; Archives Unleashed Cloud

Rails application for the Archives Unleashed Cloud.

Requirements

• Ruby 2.2.x to 2.4.x
• Rails 5.1.2 or later
• Apache Spark 2.3.2 or later
• GraphPass 0.3.0 or later
• NPM (For testing/ESlint)

Installation

Run the test suite

Ensure Rails is not running (ports 3000), then:

$ bundle exec rake

If you would like to make sure JavaScript files are linted:

$ npm install
$ bundle exec rake

Run a development server

$ rails s

Run the background job

In another command line tab, run the background job with:

bundle exec rake jobs:work

Or to simulate production environment with Delayed::Job:

bin/delayed_job --pool=spark,tasks:1 --pool=graphpass,tasks:1 --pool=seed,tasks:10 --pool=download,tasks:4 --pool=cleanup,tasks:2 --pool=textfilter,tasks:2 start

Then visit http://localhost:3000.

Delayed Job Dashboard

To take advantage of the Delayed Job Dashboard, set the DJW_USERNAME and DJW_PASSWORD in config/application.yml. Then visit http://localhost:3000/jobs.

Retry jobs

If you need to "retry" a stuck or failed job, you can use the "retry" method with a job id (1234):

$ RAILS_ENV=production rails console
Running via Spring preloader in process 19680
Loading production environment (Rails 5.1.4)
irb(main):001:0> Delayed::Job.find(1234).retry!

Configuration

This application makes use of figaro.

You will need a config/application.yml file in the root of the application.

Dashboard

Set the DASHBOARD_USER and DASHBOARD_PASS in config/application.yml. Then visit http://localhost:3000/dashboards.

Sitemap

To generate a sitemap:

bundle exec rake sitemap:refresh:no_ping

To generate a new sitemap, and submit to Google and Bing, setup a cronjob that runs the following:

bundle exec rake sitemap:refresh

Run a console

You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Please see contributing guidelines for details.

• Bug reports
• Pull requests are welcome on AUK

License

This application is available as open source under the terms of the Apache License, Version 2.0.

Acknowledgments

This work is primarily supported by the Andrew W. Mellon Foundation. Any opinions, findings, and conclusions or recommendations expressed are those of the researchers and do not necessarily reflect the views of the sponsors.