Solr search engine integration for Plone
Python JavaScript RobotFramework Other
Latest commit 38689b2 Aug 16, 2016 @tomgross tomgross committed on GitHub Merge pull request #134 from collective/gforcada-uncomment-test
Uncoment doctests and fixed copy & paste error
Permalink
Failed to load latest commit information.
docs Add date filter robot test Jul 4, 2016
etc Add language specific Solr configuration with custom German configura… Aug 26, 2013
src/collective fixed setting of search timeout and reduced timeout in tests to make … Aug 16, 2016
.coveragerc coverage: ignore tests package Dec 8, 2015
.gitattributes Change everything I complained about in the original PR Feb 19, 2015
.gitignore Add ignores Jul 4, 2016
.travis.yml Fix robot. Jul 4, 2016
CHANGES.rst Back to development: 5.0.4 Jun 5, 2016
MANIFEST.in Fix MANIFEST.in Dec 11, 2015
README.rst Provide full buildout conf in README. Apr 18, 2016
base.cfg use released version of plone.restapi Jul 24, 2016
better-defaults.diff add todo-diff for better defaults - it's currently too hard to integr… Jul 10, 2011
bootstrap-buildout.py Clean up buildout structure. Jun 25, 2015
buildout-german.cfg Add language specific Solr configuration with custom German configura… Aug 26, 2013
buildout.cfg Make Plone 5 the new default buildout. Jul 4, 2016
plone-4.3.x.cfg Upgrade to Plone 4.3.9. Apr 15, 2016
plone-5.0.x.cfg update to Plone 5.0.5 and add missing comma Jul 25, 2016
setup.py update egg requirements Jul 27, 2016
solr-3.6.x.cfg
solr-4.10.x.cfg Clean up buildout structure. Jun 25, 2015
solr-4.3.x.cfg Clean up buildout structure. Jun 25, 2015
solr-4.4.x-german.cfg Comment out StemmerOverride since this seems to cause problems. Sep 16, 2013
solr-4.4.x.cfg Use solr.SearchHandler instead of solr.SpellCheckComponent since the … Oct 29, 2013
solr-5.0.x.cfg Add solr-5.0.x.cfg. Feb 24, 2015
solr-5.1.x.cfg Add Solr 5.1 cfg. Jun 25, 2015
solr-5.2.x.cfg Clean up buildout structure. Jun 25, 2015
solr.cfg Port atomic update feature from ftw.solr into collective.solr. Dec 16, 2015
tox.ini use `tox` to run tests against various solr versions Aug 27, 2013
travis.cfg Clean up buildout structure. Jun 25, 2015
versions.cfg use released version of plone.restapi Jul 24, 2016

README.rst

collective.solr - Solr integration for the Plone CMS

https://secure.travis-ci.org/collective/collective.solr.png?branch=master https://coveralls.io/repos/collective/collective.solr/badge.png?branch=master Downloads Latest Version Egg Status License

collective.solr integrates the Solr search engine with Plone.

Apache Solr is based on Lucene and is the enterprise open source search engine. It powers the search of sites like Twitter, the Apple and iTunes Stores, Wikipedia, Netflix and many more.

Solr does not only scale to any level of content, but provides rich search functionality, like faceting, geospatial search, suggestions, spelling corrections, indexing of binary formats and a whole variety of powerful tools to configure custom search solutions. It has integrated clustering and load-balancing to provide a high level of robustness.

collective.solr comes with a default configuration and setup of Solr that makes it extremely easy to get started, yet provides a vastly superior search quality compared to Plone's integrated text search based on ZCTextIndex.

Features

Solr Features

  • Schema and Schemaless Configuration
  • Information Retrieval System
  • Speed (in comparission to ZCTextIndex)

Features of Solr Integration into Plone

Search Enhancements

  • Facets
  • Indexing of binary documents
  • Spellchecking / suggestions
  • Wildcard searches
  • Exclude from search
  • Elevation

Detailed Documentation

A full Documentation of the Solr integration of Plone could be found on collectivesolr.readthedocs.org.

Installation & Configuration

Download the latest default Solr configuration from github:

$ wget https://github.com/collective/collective.solr/raw/master/solr.cfg
$ wget https://raw.githubusercontent.com/collective/collective.solr/master/solr-4.10.x.cfg

Extend your buildout to use those files and make sure collective.solr is added to the eggs in your instance section. Your full buildout file should look something like this:

[buildout]
parts += instance
extends =
    http://dist.plone.org/release/4.3.8/versions.cfg
    solr.cfg
    solr-4.10.x.cfg

[instance]
recipe = plone.recipe.zope2instance
http-address = 8080
user = admin:admin
eggs =
    Plone
    collective.solr

[versions]
collective.recipe.solrinstance = 5.3.2

After saving this to let's say buildout.cfg the buildout can be run and the Solr server and Plone instance started:

$ python bootstrap-buildout.py
$ bin/buildout
...
$ bin/solr-instance start
$ bin/instance start

Next you should activate the collective.solr (site search) add-on in the add-on control panel of Plone. After activation you should review the settings in the new Solr Settings control panel. To index all your content in Solr you can call the provided maintenance view:

http://localhost:8080/plone/@@solr-maintenance/reindex

Solr connection configuration in ZCML

The connections settings for Solr can be configured in ZCML and thus in buildout. This makes it easier when copying databases between multiple Zope instances with different Solr servers.

Example:

zcml-additional =
    <configure xmlns:solr="http://namespaces.plone.org/solr">
        <solr:connection host="localhost" port="8983" base="/solr/plone"/>
   </configure>

Current Project Status

The code is used in production in many sites and considered stable. This add-on can be installed in a Plone 4.1 (or later) site to enable indexing operations as well as searching (site and live search) using Solr. Doing so will not only significantly improve search quality and performance - especially for a large number of indexed objects, but also reduce the memory footprint of your Plone instance by allowing you to remove the SearchableText, Description and Title indexes from the catalog. In large sites with 100000 content objects and more, searches using ZCTextIndex often taken 10 seconds or more and require a good deal of memory from ZODB caches. Solr will typically answer these requests in 10ms to 50ms at which point network latency and the rendering speed of Plone's page templates are a more dominant factor.

Bug Reporting & Development

Releases can be found on the Python Package Index at http://pypi.python.org/pypi/collective.solr. The code and issue trackers can be found on GitHub at https://github.com/collective/collective.solr.

For outstanding issues and features remaining to be implemented please see the issue tracker.