Configure Magento to use Elasticsearch

This section discusses the minimum settings you must choose to test Elasticsearch with Magento 2. For additional details about configuring Elasticsearch, see the Magento EE User Guide.

To configure Magento to use Elasticsearch:

  1. Log in to the Magento Admin as an administrator.
  2. Click Stores > Settings > Configuration > Catalog > Catalog > Catalog Search.
  3. From the Search Engine list, click Elasticsearch as the following figure shows.

  4. The following table discusses only the configuration options required to test the connection with Magento.

    Unless you changed Elasticsearch server settings, the defaults should work. Skip to the next step.

    Option Description
    Elasticsearch Server Hostname

    Enter the fully qualified host name or IP address of the machine running Elasticsearch.

    Magento Enterprise Cloud Edition: Get this value from your integration system.

    Elasticsearch Server Port

    Enter the Elasticsearch web server proxy port. In our example, the port is 8080 but if you're using a secure proxy, it's typically 443.

    Magento Enterprise Cloud Edition: Get this value from your integration system.

    Enable Elasticsearch HTTP Auth Click Yes only if you enabled authentication for your Elasticsearch server. If so, provide a user name and password in the provided fields.
  5. Click Test Connection.

One of the following displays:

Result Meaning
Magento successfully connected to the Elasticsearch server. Continue with Configure Apache and Elasticsearch or Configure nginx and Elasticsearch.

Try the following:

  • Make sure the Elasticsearch server is running.
  • If the Elasticsearch server is on a different host from Magento, log in to the Magento server and ping the Elasticsearch host. Resolve network connectivity issues and test the connection again.
  • Examine the command window in which you started Elasticsearch for stack traces and exceptions. You must resolve those before you continue.
    In particular, make sure you started Elasticsearch as a user with root privileges.
  • Make sure that UNIX firewall and SELinux are both disabled, or set up rules to enable Elasticsearch and Magento to communicate with each other.
  • Verify the value of the Elasticsearch Server Hostname field. Make sure the server is available. You can try the server's IP address instead.
  • Use the command netstat -an | grep listen-port command to verify that the port specified in the Elasticsearch Server Port field is not being used by another process.
    For example, to see if Elasticsearch is running on its default port, use the following command:
    netstat -an | grep 9200
    If Elasticsearch is running on port 9200, it displays similar to the following:
    tcp        0      0 :::9200            :::*          LISTEN

Reindexing catalog search and refreshing the full page cache

After you change Magento’s Elasticsearch configuration, you must reindex the catalog search index and refresh the full page using the Admin or command line.

To refresh the cache using the Admin:

  1. In the Admin, click System > Cache Management.
  2. Select the check box next to Page Cache.
  3. From the Actions list in the upper right, click Refresh.
    The following figure shows an example.

To clean the cache using the command line, use the magento cache:clean command.

To reindex using the command line:

  1. Log in to your Magento server as, or switch to, the Magento file system owner.
  2. Enter any of the following commands:

    Enter the following command to reindex the catalog search index only:

    php <your Magento install dir>/bin magento indexer:reindex catalogsearch_fulltext
    

    Enter the following command to reindex all indexers:

    php <your Magento install dir>/bin magento indexer:reindex
    
  3. Wait while the reindexing completes.

Unlike the cache, indexers are updated by a cron job. Make sure cron is enabled before you start using Elasticsearch.