> For the complete documentation index, see [llms.txt](https://docs.umbraco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.umbraco.com/umbraco-search/installation/installation.md).

# Installation

Installing Umbraco Search into your Umbraco CMS

Learn how to install Umbraco Search into your Umbraco CMS.

## Requirements

Umbraco Search is compatible with Umbraco 17.

## NuGet Packages

Umbraco Search is installed from NuGet.

Multiple NuGet packages cover different aspects of search:

* [`Umbraco.Cms.Search.Core`](https://nuget.org/packages/Umbraco.Cms.Search.Core) contains the core functionality.
* [`Umbraco.Cms.Search.BackOffice`](https://nuget.org/packages/Umbraco.Cms.Search.BackOffice) allows Umbraco Search to power the backoffice content search.
* [`Umbraco.Cms.Search.DeliveryApi`](https://nuget.org/packages/Umbraco.Cms.Search.DeliveryApi) allows Umbraco Search to power the [Content Delivery API](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api).
* [`Umbraco.Cms.Search.Provider.Examine`](https://www.nuget.org/packages/Umbraco.Cms.Search.Provider.Examine) is the default search provider implementation.

## Basic functionality

To get started, install Umbraco Search and the Examine search provider from NuGet:

```bash
dotnet add package Umbraco.Cms.Search.Core
dotnet add package Umbraco.Cms.Search.Provider.Examine
```

With these packages installed, enable Umbraco Search using a composer:

{% code title="SiteComposer.cs" %}

```csharp
using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Search.Core.DependencyInjection;
using Umbraco.Cms.Search.Provider.Examine.DependencyInjection;

namespace My.Site.DependencyInjection;

public sealed class SiteComposer : IComposer
{
    public void Compose(IUmbracoBuilder builder)
    {
        builder
            // add core services for search abstractions
            .AddSearchCore()
            // add the Examine search provider
            .AddExamineSearchProvider();
    }
}
```

{% endcode %}

{% hint style="info" %}
See Examine specific configuration options in the [Examine search provider](/umbraco-search/getting-started/examine-search-provider.md) article.
{% endhint %}

### The backoffice search

To include the backoffice search:

1. Install the NuGet package:

   ```bash
   dotnet add package Umbraco.Cms.Search.BackOffice
   ```
2. Enable the package in the composer:

   <pre class="language-csharp" data-title="SiteComposer.cs"><code class="lang-csharp">// use Umbraco Search for backoffice search
   builder.AddBackOfficeSearch();
   </code></pre>

### The Content Delivery API

To include the Content Delivery API:

1. Install the NuGet package:

   ```bash
   dotnet add package Umbraco.Cms.Search.DeliveryApi
   ```
2. Enable the package in the composer:

   <pre class="language-csharp" data-title="SiteComposer.cs"><code class="lang-csharp">// use Umbraco Search for the Content Delivery API
   builder.AddDeliveryApiSearch();
   </code></pre>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.umbraco.com/umbraco-search/installation/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.