diff --git a/install/elasticsearch.rst b/install/elasticsearch.rst index 87e7969..7fb7525 100644 --- a/install/elasticsearch.rst +++ b/install/elasticsearch.rst @@ -13,16 +13,22 @@ setup `_ or :doc:`deploy Zammad via Docker `_. +Elasticsearch offers two versions. Currently, the versions 7 and 8 +are maintained. For installation instructions, you should first and foremost +follow +`Elastic's installation documentation `_. +Use the dropdown in the top left corner to choose which version you want to +install. + +However, if you want go with Elasticsearch 7 (which is slightly easier to +install), you can find the consolidated installation steps below. +Be aware that the maintenance of version 7 might be stopped earlier than for +version 8, which also comes with some additional security features. .. hint:: If you are installing Elasticsearch 8 and want to follow our standard configuration in step 2, make sure to copy/save the password which is shown while installing Elasticsearch. -For a standard setup, you additionally can find the installation steps for -Elasticsearch 7 below. - .. tabs:: .. tab:: Ubuntu @@ -90,11 +96,8 @@ Elasticsearch 7 below. or see the `installation guide `_ for in-depth instructions. Ensure to also install the fitting - (and mandatory!) attachment plugin for elasticsearch. - - If you prefer the Open Source version of Elasticsearch, please use the - `Elasticsearch-OSS `_ - download page. + (and mandatory!) attachment plugin for elasticsearch, if installing + version 7. .. code-block:: sh @@ -183,10 +186,15 @@ commands, as this will fail otherwise. Elasticsearch URL .. code-block:: sh - # Set the Elasticsearch server address - # It has to be "https" starting with ES8 + # Set the Elasticsearch server address; adapt it to your scenario. + + # Elasticsearch 7: + $ sudo zammad run rails r "Setting.set('es_url', 'http://localhost:9200')" + + # Elasticsearch 8: $ sudo zammad run rails r "Setting.set('es_url', 'https://localhost:9200')" + Elasticsearch user and password (only for Elasticsearch >= 8) Now you need your password which was shown to you while installing Elasticsearch.