Skip to content
A Hyrax-based application to provide a Digital Asset Management system for the Georgia State University Library
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Refactor bulk upload collection membership (#304) Apr 19, 2019
bin
config
db
lib
log
public
solr
spec
vendor/assets
.fcrepo_wrapper
.gitignore Feature/collection display changes (#215) Nov 29, 2018
.rspec Feature/add workflow test (#147) Aug 9, 2018
.solr_wrapper
.solr_wrapper.yml
.travis.yml
Capfile
FETCH_HEAD
Gemfile
Gemfile.lock
README.md
Rakefile
config.ru
fits.log

README.md

Sirenia

sirenia

Table of Contents

About Sirenia

Sirenia is a Hyrax-based application created by Georgia State University. It will act as our Digital Asset Management System

The name is based on the relationship between Sirenia and Hyraxes. From Wikipedia:

  • Hyraxes share several unusual characteristics with elephants and the Sirenia (manatees and dugongs), which have resulted in their all being placed in the taxon Paenungulata.

Setup

To set up a development environment, you will need the following pre-requisite software installed:

  1. Solr version >= 5.x (tested up to 6.4.1)
  2. Fedora Commons digital repository version >= 4.5.1 (tested up to 4.7.1)
  3. A SQL RDBMS (MySQL, PostgreSQL), though note that SQLite will be used by default if you're looking to get up and running quickly
  4. Redis, a key-value store
  5. ImageMagick with JPEG-2000 support
  6. FITS version 1.0.x (1.0.5 is known to be good, 1.1.0 is known to be bad: https://github.com/harvard-lts/fits/issues/140)
  7. LibreOffice
  8. ffmpeg
  9. PostgreSQL

NOTE: The Hyrax Development Guide has instructions for installing Solr and Fedora in a development environment.*

Characterization

FITS can be installed on OSX using Homebrew by running the command: brew install fits

OR

  1. Go to http://projects.iq.harvard.edu/fits/downloads and download a copy of FITS (see above to pick a known working version) & unpack it somewhere on your machine.
  2. Mark fits.sh as executable: chmod a+x fits.sh
  3. Run fits.sh -h from the command line and see a help message to ensure FITS is properly installed
  4. Give your Hyrax app access to FITS by:
    1. Adding the full fits.sh path to your PATH (e.g., in your .bash_profile), OR
    2. Changing config/initializers/hyrax.rb to point to your FITS location: config.fits_path = "/<your full path>/fits.sh"

Derivatives

Install LibreOffice. If which soffice returns a path, you're done. Otherwise, add the full path to soffice to your PATH (in your .bash_profile, for instance). On OSX, soffice is inside LibreOffice.app. Your path may look like "/path/to/LibreOffice.app/Contents/MacOS/"

You may also require ghostscript if it does not come with your compiled version LibreOffice. brew install ghostscript should resolve the dependency on an OSX-based machine with Homebrew installed.

NOTE: Derivatives are served from the filesystem in Hyrax.

Transcoding

Hyrax includes support for transcoding audio and video files with ffmpeg > 1.0 installed.

On OSX, you can use Homebrew to install ffmpeg:

brew install ffmpeg --with-fdk-aac --with-libvpx --with-libvorbis

Otherwise, to compile ffmpeg yourself, see the ffmpeg compilation guide.

Once ffmpeg has been installed, enable transcoding by setting config.enable_ffmpeg = true in config/initializers/hyrax.rb. You may also configure the location of ffmpeg using config.ffmpeg_path.

This information shamelessly copied from the Hyrax Readme.

Postgres

To run the Rails app locally, you will need to have PostgreSQL installed. For details on PostgreSQL installation, please see their documentation.

Database Setup

Once the pre-requisite software is installed launch your Hyrax server using the following command:

rails hydra:server

Once your server is running, run the following terminal commands to set up the SQL database:

rails db:create
rails db:migrate
rails db:seed

or

rails db:setup

This will create the SQL databases that Sirenia uses. It will also create the following users in the database:

This will also create a default admin set. In order to see the 'add new work' button, you will need to restart your server after the database is seeded.

You can’t perform that action at this time.