For AI agents: this page is also available as Markdown at /docs/integration-umbraco.md. Every docs page is: add .md to its URL. llms.txt lists them all.

Umbraco

WarpSearch.Umbraco.Search is a provider for Umbraco Search. It stores your content, media and member indexes in WarpSearch and answers searches from there, so you do not keep Examine (Lucene) indexes on your web servers. It is on NuGet and the Umbraco Marketplace.

It supports:

• Full-text search with Umbraco's relevance tiers (TextsR1 to TextsR3) and prefix matching as you type
• Keyword, integer, decimal and date filters, exact and range
• Exact and range facets with multi-select counts
• Sorting by score, text, keyword, number and date, and paging
• Culture and segment variants, and protected content by member and member group
• The backoffice index overview, health, rebuild and test search work as with any provider
• Load-balanced sites: every server reads the same collection, and only the server where a change happens writes it

#Requirements

Umbraco 18 with Umbraco Search (Umbraco.Cms.Search.Core 18.2 or later), and a WarpSearch collection and writer key from the shared setup.

#Install

dotnet add package WarpSearch.Umbraco.Search

Register the provider in Program.cs, after Umbraco Search:

using Umbraco.Cms.Search.Core.DependencyInjection;
using WarpSearch.Umbraco.Search.DependencyInjection;

builder.CreateUmbracoBuilder()
    .AddBackOffice()
    .AddWebsite()
    .AddDeliveryApi()
    .AddComposers()
    .AddSearchCore()
    .AddWarpSearchProvider()
    .Build();

Add the collection and key to appsettings.json. Keep the key in user secrets or the environment variable WarpSearch__ApiKey:

{
  "WarpSearch": {
    "ApiKey": "ws_...",
    "Collection": "mysite_prod"
  }
}

Start the site and rebuild the indexes from Settings > Search in the backoffice. From then on, content is indexed as editors save and publish it, and is searchable within a second.

#Configuration

All settings live under WarpSearch:

#Good to know

• Each culture of a content item is one document, so the backoffice document count counts cultures.
• A rebuild deletes and rewrites an index, so results are incomplete until it finishes.
• WarpSearch field names allow letters, digits and single underscores, so other characters in Umbraco field names are replaced.
• Suggestions and highlighting are not supported yet.

View this page as Markdown