Hyrax: A Digital Repository Framework

Code:

Docs:

Jump in:

Table of Contents

• What is Hyrax?
• Getting Help and Asking Questions
• How to Run the Code
• Contribute
• Release Process
• Deploy
• Acknowledgments
• License

What is Hyrax?

Hyrax is a Ruby on Rails Engine built by the Samvera community. Hyrax provides a foundation for creating many different digital repository applications.

Note: As a Rails Engine, Hyrax is not a web application. To build your digital repository using Hyrax you must mount the Hyrax engine within a Rails application. We call an application that mounts Hyrax a "Hyrax-based application" (or sometimes a "Hyrax Application").

Hyrax offers the ability to:

• Create repository object types on demand
• Deposit content via multiple configurable workflows
• Describe content with flexible metadata
• Enable/disable optional features via an administrative dashboard
• And more (https://hyrax.samvera.org/about/)

Getting Help and Asking Questions

More detailed documentation about Hyrax is available on the Hyrax Github Wiki but if you have questions or need help, please email the Samvera community tech list or stop by the #dev channel in the Samvera community Slack team. You can also get in touch with the Hyrax Maintenance Working Group, including the Hyrax Product Owner and Hyrax Tech Lead.

Reporting Issues

How to Run the Code

Run Hyrax Locally Using Docker

Hyrax can also work running prerequisite dependencies separately. The following describe ways to do this:

• Developing Your Hyrax-based Application

Contribute

We'd love to accept your contributions. Please see our guide to contributing to Hyrax.

Installing Analytics

Release Process

See the release management process.

We also have a Maintenance Policy.

Deploy

Steps to deploy a Hyrax-based application to production will vary depending on your particular ecosystem but here are some methods and things to consider:

• Hyrax Management Guide (provides guidance for things to keep in mind in production environments)
• Helm Chart to deploy Hyrax-based application (for cloud-based Kubernetes-style deployments)

Acknowledgments

This software has been developed by and is brought to you by the Samvera community. Learn more at the Samvera website.

This project is tested with Browserstack.

License

Hyrax is available under the Apache 2.0 license.