From 41e8bd5c3f1072054b0f6d0131051fdf756d733e Mon Sep 17 00:00:00 2001 From: Ralf Schmid Date: Wed, 22 Jul 2026 11:46:31 +0200 Subject: [PATCH 1/2] Add ES reindexing for Docker restore process --- .../backup-and-restore/docker-compose.rst | 21 ++++++++++--------- .../connect-configure-elasticsearch.rst | 3 ++- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/appendix/backup-and-restore/docker-compose.rst b/appendix/backup-and-restore/docker-compose.rst index a7fb9d39..15d64a34 100644 --- a/appendix/backup-and-restore/docker-compose.rst +++ b/appendix/backup-and-restore/docker-compose.rst @@ -49,15 +49,16 @@ Restore built-in backup method. Don't provide the ``latest_zammad_*.gz`` files because they link to an unknown location for the restore process. #. Start the stack. The restore process is triggered in the ``zammad-backup`` - service if the ``restore`` directory is detected and the backup files are in place. - - .. hint:: - As a part of this process, the cache will be cleared and any pre-existing - Elasticsearch indexes will be dropped. - All other containers will be waiting for the restore to finish. When that is the case, - they will resume their normal operations, which includes an automatic Elasticsearch - reindexing (depending on the ENV variables). You can check the container logs for - details. - + service if the ``restore`` directory is detected and the backup files are in + place. As a part of this process, the Rails cache will be cleared. All other + containers wait for the restore to finish before they resume their normal + operations. #. After the restore process has finished, the ``restore`` directory got renamed. You can safely delete it now. +#. Rebuild the Elasticsearch index. You can use Zammad while the rebuild is + running, but search performance is degraded and some data may be temporarily + unavailable in search results. + + .. include:: /install/elasticsearch/connect-configure-elasticsearch.rst + :start-after: es-reindex-command: + :end-before: Optional settings diff --git a/install/elasticsearch/connect-configure-elasticsearch.rst b/install/elasticsearch/connect-configure-elasticsearch.rst index 3586d660..929e3a17 100644 --- a/install/elasticsearch/connect-configure-elasticsearch.rst +++ b/install/elasticsearch/connect-configure-elasticsearch.rst @@ -85,6 +85,8 @@ Build/rebuild the searchindex - Consider specifying a number of CPU cores to be used for the rebuild (see example below). + .. _es-reindex-command: + Without specifying CPU cores: .. code-block:: console @@ -97,7 +99,6 @@ Build/rebuild the searchindex $ zammad run rake zammad:searchindex:rebuild[8] - Optional settings ----------------- From 8a465826f0f564afeb34e3d4b45dd366753e407e Mon Sep 17 00:00:00 2001 From: Ralf Schmid Date: Wed, 22 Jul 2026 13:57:36 +0200 Subject: [PATCH 2/2] Fixed command; added link to install instructions --- appendix/backup-and-restore/docker-compose.rst | 11 +++++++---- .../elasticsearch/connect-configure-elasticsearch.rst | 2 -- install/update.rst | 3 +++ 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/appendix/backup-and-restore/docker-compose.rst b/appendix/backup-and-restore/docker-compose.rst index 15d64a34..41b8d88d 100644 --- a/appendix/backup-and-restore/docker-compose.rst +++ b/appendix/backup-and-restore/docker-compose.rst @@ -57,8 +57,11 @@ Restore You can safely delete it now. #. Rebuild the Elasticsearch index. You can use Zammad while the rebuild is running, but search performance is degraded and some data may be temporarily - unavailable in search results. + unavailable in search results. Use the command below for Docker Compose + deployments. When using GUIs like portainer, have a look at the + :ref:`docker-run-commands` section in + the installation documentation. - .. include:: /install/elasticsearch/connect-configure-elasticsearch.rst - :start-after: es-reindex-command: - :end-before: Optional settings + .. include:: /install/update.rst + :start-after: **Docker Compose:** + :end-before: **Portainer:** diff --git a/install/elasticsearch/connect-configure-elasticsearch.rst b/install/elasticsearch/connect-configure-elasticsearch.rst index 929e3a17..11c85008 100644 --- a/install/elasticsearch/connect-configure-elasticsearch.rst +++ b/install/elasticsearch/connect-configure-elasticsearch.rst @@ -85,8 +85,6 @@ Build/rebuild the searchindex - Consider specifying a number of CPU cores to be used for the rebuild (see example below). - .. _es-reindex-command: - Without specifying CPU cores: .. code-block:: console diff --git a/install/update.rst b/install/update.rst index 9dcdbdab..41de68d7 100644 --- a/install/update.rst +++ b/install/update.rst @@ -211,6 +211,9 @@ using `Zammad hosting`_ for your and your customers' safety. Only needed if the release note tells you to rebuild the Elasticsearch index. + .. Rebuild commands used in appendix/backup-and-restore/docker-compose-rst + .. When changing, make sure to adjust the reference there as well + **Docker Compose:** Without specifying CPU cores: