Installation

Minimum requirements

Each major version of ExamineX supports one major version of Umbraco. The Elasticsearch packages are three major versions behind the Azure AI Search ones, so ExamineX.ElasticSearch.Umbraco 7.x goes with ExamineX 10:

ExamineX.ElasticSearch.UmbracoPackage	.NET	Umbraco	Umbraco Forms (if used)
7.x	10	18.0.2+	18.0.4+
6.x	10	17.0.0+	17.0.1+
5.x	9	16.0.0+	16.0.0+
4.x	9	15.x	15.x
3.x	8	13.1.0+	13.0.0+

You’ll also need:

• Elastic Search subscription (or Free when using their Docker image)

Installation

Install and upgrade is done via dotnet CLI. You can leave out the version parameter to install or upgrade to the latest, or specify the --version you want to upgrade to.

dotnet add package ExamineX.ElasticSearch.Umbraco

You will then need to enter a couple configuration settings. Then you’ll need to enable the integration in your Startup.cs and add the .AddExamineXElasticSearch() call after the .AddComposers() call:

public void ConfigureServices(IServiceCollection services)
{
    services.AddUmbraco(_env, _config)
        .AddBackOffice()
        .AddWebsite()
        .AddDeliveryApi()
        .AddComposers()
        .AddExamineXElasticSearch()
        .Build();
}

Plugins

Forms

If you are using Umbraco Forms then you may also need the ExamineX.ElasticSearch.Umbraco.Forms package.

See the ExamineX for Elastic Search & Forms docs for installation and usage details.

See Licensing for more information about the types of licenses and what the limitations are without a license.