Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions appendix/proxy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,7 @@ NO_PROXY
ES_JAVA_OPTS
Variable for setting a proxy for Elasticsearch. By default, Elasticsearch
does not communicate to external systems during the operation. However,
there can be cases where this is needed, for example when downloading the
ingest plugin for Elasticsearch versions below 8. Example:
there can be cases where this is needed. Example:

.. code-block:: sh

Expand All @@ -80,7 +79,6 @@ configuration):
:header: "Address", "Comment"
:widths: 40, 70

"artifacts.elastic.co", "Download of the ingest plugin (only ES < 8)"
"dl.packager.io", "Download of OS package (package installation)"
"go.packager.io", "As above; new package hosting service"
"geo.zammad.com", "Used for geo data"
Expand Down
13 changes: 2 additions & 11 deletions install/elasticsearch/connect-configure-elasticsearch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,11 @@ commands, as this will fail otherwise.
Elasticsearch URL
Set the Elasticsearch server address; adapt it to your scenario.

Elasticsearch 7:

.. code-block:: console

$ zammad run rails r "Setting.set('es_url', 'http://localhost:9200')"

Elasticsearch 8 and newer:

.. code-block:: console

$ zammad run rails r "Setting.set('es_url', 'https://localhost:9200')"


Elasticsearch user and password (Elasticsearch 8 and newer)
Elasticsearch user and password
Now you need your password which was shown during the installation.

Set Elasticsearch user:
Expand All @@ -51,7 +42,7 @@ Elasticsearch user and password (Elasticsearch 8 and newer)

$ zammad run rails r "Setting.set('es_password', '<password>')"

Add certificate to Zammad (Elasticsearch 8 and newer)
Add certificate to Zammad
Add it via **Rails console**:
In case you are installing a new Zammad and didn't run through the
getting started wizard already, add the certificate via console:
Expand Down
33 changes: 2 additions & 31 deletions install/elasticsearch/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If you are experiencing this issue and installed Elasticsearch according to
:doc:`/install/elasticsearch`, please follow these steps to make sure
Elasticsearch is working correctly.

Step 1: Verify Elasticsearch is running
Verify Elasticsearch is running
Check Elasticsearch status:

.. code-block:: console
Expand Down Expand Up @@ -57,36 +57,7 @@ Step 1: Verify Elasticsearch is running
| Try completely purging and reinstalling Elasticsearch according
to :doc:`/install/elasticsearch`


Step 2: Verify the ingest-attachment plugin is installed correctly
List installed Elasticsearch plugins:

.. code-block:: console

$ /usr/share/elasticsearch/bin/elasticsearch-plugin list

The output should include ``ingest-attachment``.

Otherwise, try reinstalling the ``ingest-attachment`` plugin and check
again:

.. code-block:: console

$ /usr/share/elasticsearch/bin/elasticsearch-plugin remove ingest-attachment

.. code-block:: console

$ /usr/share/elasticsearch/bin/elasticsearch-plugin install ingest-attachment

.. code-block:: console

$ sudo systemctl restart elasticsearch

.. code-block:: console

$ /usr/share/elasticsearch/bin/elasticsearch-plugin list

Step 3: Verify Zammad can access Elasticsearch and rebuild the indexes
Verify Zammad can access Elasticsearch and rebuild the indexes
Without specifying CPU cores to use:

.. code-block:: console
Expand Down
5 changes: 0 additions & 5 deletions install/update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,11 +149,6 @@ using `Zammad hosting`_ for your and your customers' safety.
`documentation <https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html>`_
and follow the instructions.

In case your are using plugins for Elasticsearch, make sure they are
updated as well (note: starting with Elasticsearch 8, the
ingest-attachment is no longer a plugin, it's now included in
Elasticsearch).

Step 6: Rebuild Elasticsearch index (optional)
Only needed if the release note tells you to rebuild the Elasticsearch
index.
Expand Down
23 changes: 10 additions & 13 deletions prerequisites/software.rst
Original file line number Diff line number Diff line change
Expand Up @@ -217,19 +217,16 @@ system gets.
:header: "Zammad", "Elasticsearch"
:widths: 20, 20

"7.0+", ">= 7.8, < 10"
"5.2 - 6.5", ">= 7.8, < 9"
"5.0 - 5.1", ">= 7.8, < 8"
"4.0-4.1", ">= 6.5, <= 7.12"
"3.4-3.6", ">= 5.5, <= 7.9"
"3.3", ">= 2.4, <=7.6"
"3.2", ">= 2.4, <=7.5"
"3.1", ">= 2.4, <=7.4"
"2.0-3.0", ">= 2.4, <=5.6"

An Elasticsearch plugin is required for version 7 or older to index the
contents of email attachments: ``ingest-attachment``. Starting with
Elasticsearch 8, it is included by default.
"7.2+", ">= 8.11, < 10"
"7.0 - 7.1", ">= 7.8, < 10"
"5.2 - 6.5", ">= 7.8, < 9"
"5.0 - 5.1", ">= 7.8, < 8"
"4.0-4.1", ">= 6.5, <= 7.12"
"3.4-3.6", ">= 5.5, <= 7.9"
"3.3", ">= 2.4, <=7.6"
"3.2", ">= 2.4, <=7.5"
"3.1", ">= 2.4, <=7.4"
"2.0-3.0", ">= 2.4, <=5.6"

.. hint:: You can override the Elasticsearch dependency for package
installations (not recommended!)
Expand Down
Loading