From 6308e6b8161f3eedd57c9d861c9d59308fb74790 Mon Sep 17 00:00:00 2001 From: Karl Hobley Date: Thu, 14 Dec 2017 15:31:19 +0000 Subject: [PATCH] Docs update for Elasticsearch 6 support --- docs/topics/search/backends.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/topics/search/backends.rst b/docs/topics/search/backends.rst index e98865cc44..3a3d45ae03 100644 --- a/docs/topics/search/backends.rst +++ b/docs/topics/search/backends.rst @@ -97,12 +97,18 @@ Elasticsearch Backend Support for Elasticsearch 5.x was added -Elasticsearch versions 2 and 5 are supported. Use the appropriate backend for your version: +.. versionchanged:: TODO ADD VERSION HERE + + Support for Elasticsearch 6.x was added + +Elasticsearch versions 2, 5 and 6 are supported. Use the appropriate backend for your version: ``wagtail.search.backends.elasticsearch2`` (Elasticsearch 2.x) ``wagtail.search.backends.elasticsearch5`` (Elasticsearch 5.x) +``wagtail.search.backends.elasticsearch6`` (Elasticsearch 6.x) + Prerequisites are the `Elasticsearch`_ service itself and, via pip, the `elasticsearch-py`_ package. The major version of the package must match the installed version of Elasticsearch: .. _Elasticsearch: https://www.elastic.co/downloads/elasticsearch @@ -115,6 +121,10 @@ Prerequisites are the `Elasticsearch`_ service itself and, via pip, the `elastic pip install "elasticsearch>=5.0.0,<6.0.0" # for Elasticsearch 5.x +.. code-block:: sh + + pip install "elasticsearch>=6.0.0,<7.0.0" # for Elasticsearch 6.x + The backend is configured in settings: .. code-block:: python