Skip to content
Blacklight provides a discovery interface for any Solr ( index.
Branch: master
Clone or download
jcoyne Merge pull request #2075 from projectblacklight/search-service-contro…

Pass the context through to the search service to restore function…
Latest commit 037633c Feb 27, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Merge pull request #2075 from projectblacklight/search-service-contro… Feb 27, 2019
config Remove unnecessary route Nov 20, 2018
db/migrate Add Rails migration compatibility version to migrations Apr 25, 2017
spec Merge pull request #2075 from projectblacklight/search-service-contro… Feb 27, 2019
.gitignore Compile javascript assets (#1727) Mar 30, 2018
.jshintrc remove comments for valid json (#1668) Apr 20, 2017
.npmignore Compile javascript assets (#1727) Mar 30, 2018
.solr_wrapper.yml Use the latest version of solr Jun 7, 2018
Rakefile Add frozen_string_literal: true in all files Jun 29, 2018
blacklight.gemspec Upgrade to rubocop 0.63.0 Feb 9, 2019
package.json update to Java 8 and add some documentation to the vagrant provision … Nov 9, 2015
template.demo.rb Remove unused generator argument Jan 5, 2019


Build Status Gem Version Test Coverage

Blacklight is an open source Solr user interface discovery platform. You can use Blacklight to enable searching and browsing of your collections. Blacklight uses the Apache Solr search engine to search full text and/or metadata. Blacklight has a highly configurable Ruby on Rails front-end. Blacklight was originally developed at the University of Virginia Library and is made public under an Apache 2.0 license.


Add Blacklight to your Gemfile:

gem "blacklight"

Run the install generator which will copy over some initial templates, migrations, routes, and configuration:

rails generate blacklight:install

Documentation, Information and Support


  • Ruby 2.2+
  • Bundler
  • Rails 5.1+

Configuring Apache Solr

You'll also want some information about how Blacklight expects Apache Solr to run, which you can find in README_SOLR

Building the javascript

The javascript is built by npm from sources in app/javascript into a bundle in app/assets/javascripts/blacklight/blacklight.js. This file should not be edited by hand as any changes would be overwritten. When any of the javascript components in the gem are changed, this bundle should be rebuild with the following steps:

  1. Install npm
  2. run npm install to download dependencies
  3. run npm run js-compile-bundle to build the bundle
  4. run npm publish to push the javascript package to

Using the javascript

Blacklight ships with Javascript that can be compiled either by Webpacker or by Sprockets. To use Webpacker see the directions at

If you prefer to use Sprockets, simply run the install generator, which will run the assets generator. For details see

You can’t perform that action at this time.