Welcome to Haystack!¶

Haystack provides modular search for Django. It features a unified, familiar API that allows you to plug in different search backends (such as Solr, Elasticsearch, Whoosh, Xapian, etc.) without having to modify your code.

Note

This documentation represents the development version of Haystack. For old versions of the documentation: 1.2, 1.1.

Getting Started¶

If you’re new to Haystack, you may want to start with these documents to get you up and running:

Getting Started with Haystack

Advanced Uses¶

Once you’ve got Haystack working, here are some of the more complex features you may want to include in your application.

Reference¶

If you’re an experienced user and are looking for a reference, you may be looking for API documentation and advanced usage as detailed in:

Developing¶

Finally, if you’re looking to help out with the development of Haystack, the following links should help guide you on running tests and creating additional backends:

Requirements¶

Haystack has a relatively easily-met set of requirements.

Python 2.5+
Django 1.3+

Additionally, each backend has its own requirements. You should refer to Installing Search Engines for more details.

Commercial Support¶

If you’re using Haystack in a commercial environment, paid support is available from Toast Driven. Services offered include:

Advice/help with setup
Implementation in your project
Bugfixes in Haystack itself
Features in Haystack itself

If you’re interested, please contact Daniel Lindsley (daniel@toastdriven.com).