Skip to content

Fixes #725 - Add rails command to add ES certificate #726

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 16, 2025
Merged

Fixes #725 - Add rails command to add ES certificate #726

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
70425ca
Added rails command to add certificate; small changes
ralf401 Oct 16, 2025
93bbf0d
Removed sudo for zammad run rails command
ralf401 Oct 16, 2025
fa59aa4
Removed 'requires an installed Zammad'
ralf401 Oct 16, 2025
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
34 changes: 21 additions & 13 deletions install/elasticsearch/connect-configure-elasticsearch.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,23 +52,31 @@ 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)
This step requires a running Zammad. If you are installing a new Zammad
instance, go on with the :doc:`installation <../package>` and come back here
when you can access the admin settings in the browser.
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:

Show and copy the auto-generated certificate from Elasticsearch and add it
to Zammad. Make sure to copy/paste the delimiters
(e.g. ``-----BEGIN CERTIFICATE-----``) too.
.. code-block:: console

.. code-block:: console
$ sudo cat /etc/elasticsearch/certs/http_ca.crt | zammad run rails r "SSLCertificate.create!(certificate: STDIN.read)"

Add it via **UI**:
In case you already have a running and configured Zammad, you can add the
certificate in Zammad's
:admin-docs:`admin settings </settings/security/ssl-certificates.html>`
(*Settings > Security > SSL Certificates*) as an alternative.
To show and copy the auto-generated certificate from Elasticsearch, run:

.. code-block:: console

$ sudo cat /etc/elasticsearch/certs/http_ca.crt

$ sudo cat /etc/elasticsearch/certs/http_ca.crt
To add it in Zammad, either upload the certificate file or paste the
content in the dialog. Make sure to copy/paste the delimiters
(e.g. ``-----BEGIN CERTIFICATE-----``) too.

To add it in Zammad, go to *Settings > Security > SSL Certificates* in the
:admin-docs:`admin settings </settings/security/ssl-certificates.html>` and
add your copied certificate. Either upload the certificate file or paste the
content in the dialog. After saving the certificate, Zammad is now able to
connect to and access the Elasticsearch index.
In any case, you can find the certificate in the UI. This looks like
this:

.. figure:: /images/install/elasticsearch/admin-certificate-management.png
:alt: Screenshot shows certificate management in Zammad's admin panel
Expand Down