Valkyrie::CloudSearch

An Amazon Web Services CloudSearch metadata backend for Valkyrie

Requirements

Ruby version

Ruby 2.3 or above

Installation

Add this line to your application's Gemfile:

gem 'valkyrie-cloud_search'

Usage

Follow the Valkyrie README to get a development or production environment up and running. To enable CloudSearch support, add the following to your application's config/initializers/valkyrie.rb:

Valkyrie::MetadataAdapter.register(
  Valkyrie::Persistence::CloudSearch::MetadataAdapter.new(
      cloud_search: Aws::CloudSearchDomain::Client.new(endpoint: CLOUDSEARCH_ENDPOINT),
      redis: Redis.new(host: REDIS_ELASTICACHE_ENDPOINT)
  ),
  :cloud_search
)

You can then use :cloud_search as a metadata adapter value in config/valkyrie.yml

Contributing

If you're working on a PR for this project, create a feature branch off of main.

This repository follows the Samvera Community Code of Conduct and language recommendations. Please do not create a branch called master for this repository or as part of your pull request; the branch will either need to be removed or renamed before it can be considered for inclusion in the code base and history of this repository.

License

Valkyrie::CloudSearch is available under the Apache 2.0 license.