Installation

Supported platforms:

  • Linux: x86_64 only
  • MacOS X: 10.13 - 10.1x (64-bit only)
  • Windows: Not supported

Minimum hardware:

  • ~4GB of free RAM or 6GB if Elasticsearch is running on the same machine.
  • 2GB for App Server.
  • 2GB for Worker.
  • 50Mb for Filebeat and other processes.
  • 5GB of disk space available.

Dependencies:

Running App Search

First, you’ll need to get Elasticsearch up and running:


Step 1. Download Elasticsearch 7.7.x and navigate to the newly unpacked directory.


Step 2. Start Elasticsearch:

$ bin/elasticsearch

We must now configure Enterprise Search:

Step 3. Download Enterprise Search 7.7.x and navigate to the newly unpacked directory.


Step 4. Locate the config/enterprise-search.yml file and add the following line. It allows Enterprise Search to create the appropriate indices for the target Elasticsearch cluster:

allow_es_settings_modification: true

allow_es_settings_modification: true can be used safely if the cluster is used for Enterprise Search only. An alternative option is to set auto_create_index at the cluster level. See Elasticsearch Cluster Settings for more information.


Step 5. You must also set at least one encryption key in the same config/enterprise-search.yml configuration file (256-bit key recommended), as an array:

secret_management.encryption_keys: [{encryption_key1}, {encryption_key2}, {...}]

For more information on encryption keys for Enterprise Search, refer to the Configuring Encryption Keys guide.


Step 6. Run the following command to start Enterprise Search.

$ bin/enterprise-search

Step 7. Head to http://localhost:3002.

From the Enterprise Search home screen, choose Launch App Search.

Voilà! You’re up and running, and ready to take on your App Search project. Continue with the Getting Started guide.

Elasticsearch Cluster Settings

Enterprise Search makes alterations to the auto_create_index persistent and transient settings within Elasticsearch when using allow_es_settings_modification: true. Avoid making changes to those settings as it may result in unintended consequences.

An alternative approach involves setting the auto_create_index configuration in elasticsearch.yml for the target Elasticsearch cluster:

action.auto_create_index: ".ent-search-*-logs-*,-.ent-search-*,-test-.ent-search-*,+*"

Using this alternative approach allows you to maintain all Elasticsearch-specific settings at the cluster level.

Password Reset Tips

Run the binary with an attached --reset-auth command:

  • Standard Auth: Resets login and generates new random password.
  • elasticsearch-native and elasticsearch-saml: Removes the current role mappings. All users are granted the owner role.