Skip to main content
Version: Next

OpenSearch Client Setup

info

This bundle requires OpenSearch 2.7 or a later 2.x release. The bundled pimcore/opensearch-client pins the PHP client below 2.4, which does not support OpenSearch 3.

Set up OpenSearch via the Pimcore OpenSearch Client bundle. The configuration has two parts:

  1. Configuring an OpenSearch client.
  2. Define the client to be used by simple rest API.
# Configuring an OpenSearch client
pimcore_open_search_client:
    clients:
        default:
            hosts: ['https://opensearch:9200']
            password: 'admin'
            username: 'admin'
            ssl_verification: false


# Define the client to be used by simple rest API
pimcore_data_hub_simple_rest:
    client_name: default  # default is default value here, just need to be specified when other client should be used.

If nothing is configured, a default client connecting to localhost:9200 is used.

For further client configuration, see the Pimcore OpenSearch Client documentation.