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. .. _Solr: http://lucene.apache.org/solr/ .. _Elasticsearch: http://elasticsearch.org/ .. _Whoosh: https://bitbucket.org/mchaput/whoosh/ .. _Xapian: http://xapian.org/ .. note:: This documentation represents the development version of Haystack (2.0.x). For old versions of the documentation: `1.2`_, `1.1`_. .. _`1.2`: http://django-haystack.readthedocs.org/en/v1.2.6/index.html .. _`1.1`: http://django-haystack.readthedocs.org/en/v1.1/index.html Getting Started --------------- If you're new to Haystack, you may want to start with these documents to get you up and running: .. toctree:: :maxdepth: 2 tutorial .. toctree:: :maxdepth: 1 views_and_forms templatetags glossary management_commands faq who_uses other_apps installing_search_engines debugging migration_from_1_to_2 python3 contributing Advanced Uses ------------- Once you've got Haystack working, here are some of the more complex features you may want to include in your application. .. toctree:: :maxdepth: 1 best_practices highlighting faceting autocomplete boost signal_processors multiple_index rich_content_extraction spatial 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: .. toctree:: :maxdepth: 2 searchqueryset_api searchindex_api inputtypes searchfield_api searchresult_api searchquery_api searchbackend_api architecture_overview backend_support settings utils 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: .. toctree:: :maxdepth: 1 running_tests creating_new_backends Requirements ------------ Haystack has a relatively easily-met set of requirements. * Python 2.6+ or Python 3.3+ * Django 1.5+ Additionally, each backend has its own requirements. You should refer to :doc:`installing_search_engines` for more details.