Skip to content
Hyku: A multi-tenant Hyrax application built on the latest and greatest Samvera community components. Brought to you by the Hydra-in-a-Box project partners and IMLS; maintained by the Hyku Interest Group.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ebextensions Fixes honeybadger deployment notification Sep 28, 2017
.github Update GitHub support documents Sep 26, 2017
app Add Blacklight OAI to Hyku (#1579) Mar 22, 2019
bin Merge pull request #1314 from samvera-labs/graphviz Mar 29, 2018
config
db
lib
public WIP remove IIIF code from Hyku, rely on Hyrax functionality Feb 25, 2019
solr/config
spec
vendor/assets
.coveralls.yml Add .coveralls.yml Mar 28, 2016
.fcrepo_wrapper
.gitignore Ignore postgres artifacts Jan 24, 2017
.hound.yml Hounds do not bark at rubies Jun 2, 2017
.rspec
.rubocop.yml
.rubocop_todo.yml Coerce UploadedFile to an array and use upstream Job Jul 11, 2018
.scss-lint.yml Allow BEM-style class names in CSS selectors Jan 24, 2017
.solr_wrapper Rename Lerna to Hyku. Fixes #461 Nov 7, 2016
.travis.yml
CODE_OF_CONDUCT.md add required info for promotion out of labs Nov 30, 2018
CONTRIBUTING.md
Dockerfile
Gemfile
Gemfile.lock
LICENSE Fill in Apache license; fixes #3 Apr 11, 2016
README.md
Rakefile Use with_server from active-fedora Oct 7, 2016
SUPPORT.md
config.ru
docker-compose.yml Hyrax 2.1 upgrade (#1529) Jul 26, 2018
fits.log

README.md

Hyku, the Hydra-in-a-Box Repository Application

Code: Build Status Coverage Status Stories in Ready

Docs: Documentation Contribution Guidelines Apache 2.0 License

Jump In: Slack Status


Table of Contents


Running the stack

For development

solr_wrapper
fcrepo_wrapper
postgres -D ./db/postgres
redis-server /usr/local/etc/redis.conf
bin/setup
DISABLE_REDIS_CLUSTER=true bundle exec sidekiq
DISABLE_REDIS_CLUSTER=true bundle exec rails server -b 0.0.0.0

For testing

See the Hyku Development Guide for how to run tests.

Working with Translations

You can log all of the I18n lookups to the Rails logger by setting the I18N_DEBUG environment variable to true. This will add a lot of chatter to the Rails logger (but can be very helpful to zero in on what I18n key you should or could use).

$ I18N_DEBUG=true bin/rails server

On AWS

AWS CloudFormation templates for the Hyku stack are available in a separate repository:

https://github.com/hybox/aws

With Docker

We distribute a docker-compose.yml configuration for running the Hyku stack and application using docker. Once you have docker installed and running, launch the stack using e.g.:

docker-compose up -d

With Vagrant

The samvera-vagrant project provides another simple way to get started "kicking the tires" of Hyku (and Hyrax), making it easy and quick to spin up Hyku. (Note that this is not for production or production-like installations.) It requires VirtualBox and Vagrant.

Switching accounts

The recommend way to switch your current session from one account to another is by doing:

AccountElevator.switch!('repo.example.com')

Development Dependencies

Postgres

Hydra-in-a-Box supports multitenancy using the apartment gem. apartment works best with a postgres database.

Importing

from CSV:

./bin/import_from_csv localhost spec/fixtures/csv/gse_metadata.csv ../hyku-objects

from purl:

./bin/import_from_purl ../hyku-objects bc390xk2647 bc402fk6835 bc483gc9313

Compatibility

  • Ruby 2.4 or the latest 2.3 version is recommended. Later versions may also work.
  • Rails 5 is required. We recommend the latest Rails 5.1 release.

Product Owner

orangewolf

Help

The Samvera community is here to help. Please see our support guide.

Acknowledgments

This software was developed by the Hydra-in-a-Box Project (DPLA, DuraSpace, and Stanford University) under a grant from IMLS.

This software is brought to you by the Samvera community. Learn more at the Samvera website.

Samvera Logo

You can’t perform that action at this time.