Table of Contents
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.
To set up a development environment, you will need the following pre-requisite software installed:
- Solr version >= 5.x (tested up to 6.4.1)
- Fedora Commons digital repository version >= 4.5.1 (tested up to 4.7.1)
- A SQL RDBMS (MySQL, PostgreSQL), though note that SQLite will be used by default if you're looking to get up and running quickly
- Redis, a key-value store
- ImageMagick with JPEG-2000 support
- 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)
NOTE: The Hyrax Development Guide has instructions for installing Solr and Fedora in a development environment.*
FITS can be installed on OSX using Homebrew by running the command:
brew install fits
- 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.
- Mark fits.sh as executable:
chmod a+x fits.sh
fits.sh -hfrom the command line and see a help message to ensure FITS is properly installed
- Give your Hyrax app access to FITS by:
- Adding the full fits.sh path to your PATH (e.g., in your .bash_profile), OR
config/initializers/hyrax.rbto point to your FITS location:
config.fits_path = "/<your full path>/fits.sh"
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.
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
This information shamelessly copied from the Hyrax Readme.
To run the Rails app locally, you will need to have PostgreSQL installed. For details on PostgreSQL installation, please see their documentation.
Once the pre-requisite software is installed launch your Hyrax server using the following command:
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
This will create the SQL databases that Sirenia uses. It will also create the following users in the database:
- Username: email@example.com
- Password: password
- Regular user:
- Username: firstname.lastname@example.org
- Password: password
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.