Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Hydra Repository Rails Engine (requires Rails3)
Ruby JavaScript

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
assets
config
db/migrate
fedora/conf
fedora_conf/conf
jetty @ 2f144a1
lib
solr
solr_conf
tasks
test_support
tmp
vendor/cache
.gitignore
.gitmodules
.rvmrc
BLACKLIGHT_CONFIG.textile
DEVELOP_PLUGIN.textile
GIT_WORKFLOW.textile
Gemfile
Gemfile.lock
HISTORY.textile
HOW_DO_I.textile
HOW_TO_DEFINE_A_HYDRA_CONTROLLER.textile
HOW_TO_DEFINE_A_HYDRA_MODEL.textile
HOW_TO_GET_STARTED.textile
HYDRA_ACCESS_CONTROLS.textile
INITIAL_APP_MODS.textile
INSTALL_PREREQ.textile
LICENSE
README.textile
README_RAILS3_CHANGES.textile
README_RAKE_TASKS.textile
README_SUBTREE.textile
README_TERSE.textile
RELEASE_NOTES.textile
Rakefile
TESTING.textile
TESTING_PLUGIN.textile
Tools.textile
hydra-head.gemspec
init.rb
install.rb
uninstall.rb

README.textile

Hydra-Head

Hydra-Head is a Rails Engines plugin containing the core code for a Hydra application. The full hydra stack includes the following:

- Blacklight (a rails engines plugin) for the User Interface
- Solr (a java application, also ported to other languages) for the Search Engine
- ActiveFedora (a ruby gem) to let the rails application talk to fedora
- OM (a ruby gem) to streamline the metadata configuration
- Solrizer (a ruby gem) to write content to the Solr index
- SolrizerFedora (a ruby gem) to write Fedora content to the Solr index.
- HydraHead (a rails engines plugin) to glue it all together

For a more thorough overview of the Hydra framework, see HYDRA_OVERVIEW.textile.

This is a Ruby on Rails 3 gem.

Installation/Setup

Install Rails, Bundler and Devise

Currently hydra-head is compatible with Rails 3.0.x and incompatible with Rails 3.1

gem install 'rails' --version '~>3.0.11'
gem install 'bundler'

Generate a new rails application:

rails new my_hydra_head
cd my_hydra_head

Install Dependencies

First, add them to the Gemfile of your application:

  source 'http://rubygems.org'

  gem 'rails', '~>3.0.11'

  gem 'blacklight', '~> 3.1.2'
  gem 'hydra-head', '~> 3.2.0'

  # We will assume that you're using sqlite3 for testing/demo, 
  # but in a production setup you probably want to use a real sql database like mysql or postgres
  gem 'sqlite3'

  #  We will assume you're using devise in tutorials/documentation. 
  # You are free to implement your own User/Authentication solution in its place.
  gem 'devise'

  # For testing.  You will probably want to use all of these to run the tests you write for your hydra head
  group :development, :test do 
         gem 'solrizer-fedora', '>=1.0.1'
         gem 'ruby-debug'
         gem 'rspec'
         gem 'rspec-rails', '>=2.5.0'
         gem 'mocha'
         gem 'cucumber-rails'
         gem 'database_cleaner'
         gem 'capybara'
         gem 'bcrypt-ruby'
         gem "jettywrapper"
  end # (leave this comment here to catch a stray line inserted by blacklight!)

To install all of the dependencies, run:

bundle install

On some systems, you will have to install system libraries that various gems rely on. For example, in order to install the curl gem on ubuntu you have to first install libcurl4-openssl-dev and then re-run bundler.

Even if all of the dependencies are satisfied, this will take a very long time the first time you run it. IF you become impatient, hit Ctl+C then enter this:

  gem install blacklight
  gem install hydra-head -v 3.2.0

Then re-run bundle install and it will run slightly faster.

Run the generators and migrations:

Run the blacklight generator

rails g blacklight --devise

Run the hydra-head generator

rails g hydra:head -df

Run the database migrations

rake db:migrate
rake db:test:prepare

You’re done.

Congratulations. You’ve set up the code for your Hydra Head.

Read Tools for Developing and Testing, then read How to Get Started to get a sense of what you can do with your Hydra Head.

Modifying and Testing the hydra-head Gem

For those developers who want to or need to work on the hydra-head gem itself, see the Instructions for Contributors

Acknowledgements

Design & Strategic Contributions

The Hydra Framework would not exist without the extensive design effort undertaken by representatives of repository initiatives from Stanford University, University of Virginia, University of Hull and MediaShelf LLC. Contributors to that effort include Tom Cramer, Lynn McRae, Martha Sites, Richard Green, Chris Awre, and Matt Zumwalt.

Thorny Staples from Fedora Commons & DuraSpace deserves special thanks for putting all of these people in the same room together.

Something went wrong with that request. Please try again.