Skip to content

Commit bae42b7

Browse files
authored
Fixes #670 - Added Elasticsearch 9 support
1 parent faf93e9 commit bae42b7

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

install/elasticsearch.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@ recommended**).
1212
Step 1: Installation
1313
--------------------
1414

15-
Elasticsearch offers different versions. Currently, the versions 7 and 8
15+
Elasticsearch offers different versions. Currently, the versions 7, 8 and 9
1616
are supported by Zammad. For installation instructions, you should first and
1717
foremost follow
18-
`Elastic's installation documentation <https://www.elastic.co/guide/en/elasticsearch/reference/8.x/setup.html>`_.
19-
Use the dropdown in the top left corner to choose which version you want to
18+
`Elastic's installation documentation <https://www.elastic.co/docs/deploy-manage/deploy/self-managed/installing-elasticsearch>`_.
19+
Use the dropdown in the top right corner to choose which version you want to
2020
install.
2121

2222
However, if you want go with Elasticsearch 7 (which is slightly easier to
2323
install), you can find the consolidated installation steps below.
2424
Be aware that the maintenance of version 7 might be stopped earlier than for
2525
later versions, which also come with some additional security features.
2626

27-
.. hint:: If you are installing Elasticsearch 8 and want to follow our
27+
.. hint:: If you are installing Elasticsearch 8 or newer and want to follow our
2828
standard configuration in step 2, make sure to copy/save the password which
2929
is shown while installing Elasticsearch.
3030

@@ -240,16 +240,15 @@ Elasticsearch URL
240240
241241
$ sudo zammad run rails r "Setting.set('es_url', 'http://localhost:9200')"
242242
243-
Elasticsearch 8:
243+
Elasticsearch 8+:
244244

245245
.. code-block:: sh
246246
247247
$ sudo zammad run rails r "Setting.set('es_url', 'https://localhost:9200')"
248248
249249
250250
Elasticsearch user and password (only for Elasticsearch >= 8)
251-
Now you need your password which was shown to you while installing
252-
Elasticsearch.
251+
Now you need your password which was shown during the installation.
253252

254253
Set Elasticsearch user:
255254

prerequisites/software.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -171,11 +171,11 @@ Please follow the official guides and ensure to set it up in a secure way.
171171
2.6 Elasticsearch (optional)
172172
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
173173

174-
Zammad uses Elasticsearch to
174+
Zammad uses Elasticsearch to:
175175

176-
1) make the search faster
177-
2) support advanced features like reports
178-
3) search for content of email attachments
176+
1) make the search faster,
177+
2) support advanced features like reports,
178+
3) search for content of email attachments.
179179

180180
This becomes increasingly important the higher the number of tickets in your
181181
system gets.
@@ -187,18 +187,12 @@ system gets.
187187
the search will be very limited. We recommend using Elasticsearch, as it will
188188
boost the usage of Zammad greatly!
189189

190-
.. hint:: 📦 **If you install Zammad via package manager...**
191-
192-
It's perfectly safe to manually override the Elasticsearch dependency.
193-
The appropriate command line flag will depend on your platform
194-
(e.g. ``--force``, ``--ignore-depends``, ``--skip-broken``);
195-
check your package manager's manpage to find out.
196-
197190
.. csv-table:: Zammad/Elasticsearch version compatibility
198191
:header: "Zammad", "Elasticsearch"
199192
:widths: 20, 20
200193

201-
"5.2+", ">= 7.8, < 9"
194+
"7.0+", ">= 7.8, < 10"
195+
"5.2 - 6.5", ">= 7.8, < 9"
202196
"5.0 - 5.1", ">= 7.8, < 8"
203197
"4.0-4.1", ">= 6.5, <= 7.12"
204198
"3.4-3.6", ">= 5.5, <= 7.9"
@@ -211,6 +205,13 @@ An Elasticsearch plugin is required for version 7 or older to index the
211205
contents of email attachments: ``ingest-attachment``. Starting with
212206
Elasticsearch 8, it is included by default.
213207

208+
.. hint:: You can override the Elasticsearch dependency for package
209+
installations (not recommended!)
210+
211+
It depends on your system how to manually override the Elasticsearch
212+
dependency (e.g. ``--force``, ``--ignore-depends``, ``--skip-broken``);
213+
check your package manager's manpage to find out.
214+
214215
2.7 Memcached
215216
^^^^^^^^^^^^^
216217

0 commit comments

Comments
 (0)