/umbraco-examine-config

The simplest way to configure Examine in Umbraco 8

Primary LanguageC#MIT LicenseMIT

Umbraco Examine Config

Umbraco Examine Config

NuGet release Our Umbraco project page

The simplest way to configure Examine in Umbraco 8!

In Umbraco 7 Examine was configured via the friendly ExamineIndexes.config and ExamineSettings.config config files. However in Umbraco 8 this configuration has moved into code, making it more difficult to configure Examine as desired. This project aims to replicate many of the helpful features of the Umbraco 7 Examine config files within Umbraco 8.

Getting started

This package is supported on Umbraco 8.4+.

Most of the core functionality is provided by Examine.Config, with some Umbraco specific options sprinkled on top.

Installation

The package is available from Our Umbraco, NuGet, or as a manual download directly from GitHub.

Our Umbraco repository

You can find a downloadable package, along with a discussion forum for this package, on the Our Umbraco site.

NuGet package repository

To install from NuGet, run the following command in your instance of Visual Studio.

PM> Install-Package Our.Umbraco.ExamineConfig

Usage

The package can be used to configure settings for the "Internal", "External" and "Media" Examine indexes in Umbraco.

It is possible to configure the following settings per index:

Name Type Default
ParentId Integer -1
IncludeItemTypes Array Everything
ExcludeItemTypes Array Nothing
SupportProtectedContent Boolean false

Settings are configured within the appsettings section of your web.config file for your Umbraco install. Appsetting names follow a convention of: Umbraco.Examine.{INDEX-NAME}.{SETTING-NAME}.

For example, to enable SupportProtectedContent for the "External" the name would be Umbraco.Examine.ExternalIndex.SupportProtectedContent.

Contribution guidelines

To raise a new bug, create an issue on the GitHub repository. To fix a bug or add new features, fork the repository and send a pull request with your changes. Feel free to add ideas to the repository's issues list if you would to discuss anything related to the library.

Who do I talk to?

This project is maintained by Callum Whyte and contributors. If you have any questions about the project please get in touch on Twitter, or by raising an issue on GitHub.

Credits

The package logo uses the Search icon from the Noun Project by Mochammad Kafi, licensed under CC BY 3.0 US.

License

Copyright © 2020 Callum Whyte, and other contributors

Licensed under the MIT License.