amironoff / vc-module-search

Module implementing indexed search functionality with Lucene and ElasticSearch engines

VirtoCommerce.Search

VirtoCommerce.Search module provides indexed search functionality with Lucene and ElasticSearch engines. Key features:

• Lucene search engine support
• ElasticSearch engine support
• Microsoft Azure support

Documentation

User guide: trigger manual search index rebuild form Catalogs list in Manager.

Developer guide: Deploy Elasticsearch to dedicated server

Installation

Installing the module:

• Automatically: in VC Manager go to Configuration -> Modules -> Search module -> Install
• Manually: download module zip package from https://github.com/VirtoCommerce/vc-module-search/releases. In VC Manager go to Configuration -> Modules -> Advanced -> upload module package -> Install.

Settings

VirtoCommerce.Search.SearchConnectionString

Search configuration string. The string consists of two parts. First part is provider=XXXX, which specifies which provider to use for search. The remainder of the string is passed to provider's constructor. Currently 2 search providers supported: Elasticsearch and Lucene.

Elasticsearch

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

This provider stores documents on a standalone Elasticsearch server.

• server is a network address of the server.
• scope is a name of the index. One server can serve multiple indexes.

Lucene

provider=Lucene;server=~/App_Data/Lucene;scope=default

This provider stores documents in a local file system.

• server is a virtual or physical path to the root directory where indexed documents are stored.
• scope is a name of the index. In fact, this is the name of a subdirectory inside the root directory which can contain multiple indexes.

Available resources

• Module related service implementations as a NuGet package
• API client as a NuGet package
• API client documentation http://demo.virtocommerce.com/admin/docs/ui/index#!/Search_module

License

Copyright (c) Virtosoftware 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.