Skip to content
ExamineX
These docs are for ExamineX 11 · Umbraco 19 (pre-release). For the current release see ExamineX 6–10 · Umbraco 13–18.

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 Program.cs and add the .AddExamineXElasticSearch() call after the .AddComposers() call:

builder.CreateUmbracoBuilder()
.AddBackOffice()
.AddWebsite()
.AddDeliveryApi()
.AddComposers()
.AddExamineXElasticSearch()
.Build();

Umbraco 19 indexes content with Umbraco Search and its Examine search provider. ExamineX replaces that provider’s Lucene indexes with Elasticsearch indexes, so the Umbraco Search APIs, the backoffice search and the Delivery API all use Elasticsearch. Umbraco 19 has 5 indexes: Umb_Content, Umb_PublishedContent, Umb_Media, Umb_Members and Umb_Elements, see Index and field names. Rebuilds use ExamineX’s own zero downtime rebuilds, so Umbraco’s ZeroDowntimeIndexing setting is turned off.

You can also use Elasticsearch for some indexes and Azure AI Search for others, see Using both products together. See Known limitations for what isn’t supported yet.

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.