Skip to content
This repository was archived by the owner on Jul 30, 2025. It is now read-only.

tulibraries/quick_search-contentdm

Repository files navigation

Quick Search Contentdm Plugin

A plugin for Quick Search that allows you to search a ContentDM. The ContentDM instance's API must be publicly available.

This project is not actively maintained. It might still work, it might not.

Usage

Add the gem to your quick search application's Gemfile a then follow the instructions outlined in the Quick Search Configuring Searchers docs.

Configuration options

This plugin provides a few configuration points.

api_url: Required Base URL to your contentDM backend server where your ContentDM Api is publicly available.

records_url: Required Base URL to your public facing ContentDM site.

custom_sort: Optional Field you want records sorted by. Defaults to 'relevance'

collections: Optional A list of collectinos you would lke the search limited to. By default it searches all colelctions except unpublished colelctions.

Example Config

defaults: &defaults
  api_url: "http://backend.contentdm.org"
  records_url: "http://frontend.contentdm.org"
  sort: title
  collections:
    - collection1
    - collection2
    - collections3

development:
  <<: *defaults

test:
  <<: *defaults

staging:
  <<: *defaults

production:
  <<: *defaults

Installation

Add this line to your application's Gemfile:

gem 'quick_search-contentdm'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install quick_search-contentdm

Contributing

Contribution directions go here.

License

The gem is available as open source under the terms of the MIT License.

About

Plugin for https://github.com/NCSU-Libraries/quick_search to search contentdm

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •