stjordanis / vc-module-elastic-search

VirtoCommerce.ElasticSearch

VirtoCommerce.ElasticSearch module implements ISearchProvider defined in the VirtoCommerce.Core module and uses Elasticsearch engine which stores indexed documents on a standalone Elasticsearch or Elastic Cloud server.

Version History

1.1.0

• Added support of Elastic Cloud server, Getting started with Elastic Cloud
• Added HTTPS and basic authentication support for elasticsearch

Installation

Installing the module:

• Automatically: in VC Manager go to Modules > Available, select the Elasticsearch module and click Install.
• Manually: download module ZIP package from https://github.com/VirtoCommerce/vc-module-elastic-search/releases. In VC Manager go to Modules > Advanced, upload module package and click Install.

Configuration

VirtoCommerce.Search.SearchConnectionString

The search configuration string is a text string consisting of name/value pairs seaprated by semicolon (;). Name and value are separated by equal sign (=).

For Elasticsearch provider the configuration string must have three parameters:

provider=Elasticsearch;server=localhost:9200;scope=default

For Elastic Cloud, the configuration string must have four parameters:

provider=Elasticsearch;server=https://4fe3ad462de203c52b358ff2cc6fe9cc.europe-west1.gcp.cloud.es.io:9243;scope=default;key={SECRET_KEY}

• provider should be Elasticsearch
• server is a network address and port of the Elasticsearch server v5.x.
• scope is a common name (prefix) of all indexes. Each document type is stored in a separate index. Full index name is scope-documenttype. One server can serve multiple indexes.
• user is a user name for either elastic cloud cluster or private elastic server. Optional. Default value is elastic.
• key is a password for either elastic cloud cluster or private elastic server. Optional.

You can configure the search configuration string either in the VC Manager UI or in VC Manager web.config. Web.config has higher priority.

• VC Manager: Settings > Search > General > Search configuration string
• web.config: connectionStrings > SearchConnectionString:

<connectionStrings>
    <add name="SearchConnectionString" connectionString="provider=Elasticsearch;server=localhost:9200;scope=default" />
</connectionStrings>

License

Copyright (c) Virto Solutions LTD. All rights reserved.

Licensed under the Virto Commerce Open Software License (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://virtocommerce.com/opensourcelicense

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.