Install Elasticsearch 7

TIP

Are you tired of complex setup, configuration, backup and update tasks? Let us handle this stuff for you! 🚀

The easiest and often most cost-effective way to operate Zammad is our cloud service. Give it a try with a free trial instance!

Introduction

Elasticsearch is technically not required to run Zammad, but highly recommended.

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.

INFO

If you are installing Elasticsearch 8 and want to follow our standard configuration, make sure to copy/save the password which is shown while installing Elasticsearch.

Install Elasticsearch 7

apt install apt-transport-https sudo wget curl gnupg

echo "deb [signed-by=/etc/apt/trusted.gpg.d/elasticsearch.gpg] https://artifacts.elastic.co/packages/7.x/apt stable main"| \
  tee -a /etc/apt/sources.list.d/elastic-7.x.list > /dev/null

curl -fsSL https://artifacts.elastic.co/GPG-KEY-elasticsearch | \
  gpg --dearmor | tee /etc/apt/trusted.gpg.d/elasticsearch.gpg> /dev/null

apt update

apt install elasticsearch

Install the ingest-attachment plugin:

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

Increase Virtual Memory Map Limit:

sysctl -w vm.max_map_count=262144

Adjust /etc/elasticsearch/elasticsearch.yml:

# /etc/elasticsearch/elasticsearch.yml

# Tickets above this size (articles + attachments + metadata)
# may fail to be properly indexed (Default: 100mb).
#
# When Zammad sends tickets to Elasticsearch for indexing,
# it bundles together all the data on each individual ticket
# and issues a single HTTP request for it.
# Payloads exceeding this threshold will be truncated.
#
# Performance may suffer if it is set too high.
http.max_content_length: 400mb

# Allows the engine to generate larger (more complex) search queries.
# Elasticsearch will raise an error or deprecation notice if this value is
# too low, but setting it too high can overload system
# resources (Default: 1024).
#
# Available in version 6.6+ only.
indices.query.bool.max_clause_count: 2000

Enable it by default and start it:

systemctl enable elasticsearch --now

Next Steps

Go on with connecting Elasticsearch with Zammad.