Documentation

Here you can find documentation for the Truffler .NET API as well as our EPiServer integration. Use the menu to the right to find what you're looking, the overview link above to see all available pages or the search box below.

Getting started

We don't think trying out Truffler could be any easier. If you think it could, let us know!

1 - Create an account

Anyone can create a Truffler account free of charge. Use the link at the top right of the site (or click here) to create an account. Once you're signed up you'll receive an e-mail for verifying your e-mail address.

2 - Create a free Developer Service

Head over to the My Services section and select 'Add Developer Service'. Enter an index name and, optionally one or two languages which will be used for stemming. Your service will be created and ready to use within a minute and you'll instantly see everything you need to start using it.

3 - Download the Truffler .NET API or EPiServer integration

Use NuGet to download our .NET API. You can also use NuGet, after having added EPiServer's NuGet feed, to download our EPiServer integration.

4 - Add your index information to app.config/web.config

While we believe strongly in convention over configuration your app does have to know the URL of the cluster that hosts your index as well as your index name. Luckily you'll find all the configuration you need ready to cut and paste on your index page.

5 - Index and search for object, all strongly typed

Use the Client class to index any CLR object. If you're using our EPiServer integration pages will automatically be indexed for you, but you may want to run our scheduled job to index existing pages.

More Truffler

Sample site

Our sample site illustrates various search functionality that can easily be built with the Truffler .NET API. The site uses an index with information about a number of famous restaurants and demonstrates everything from a very basic search page to functionality that allows visitors to search by drawing on a map.

Truffler on Herding Code

In episode 125 of Herding Code we were interviewed by the Jon Galloway, Scott Allen and Kevin Dente. During the interview we talked about our backgrounds, how and why we created Truffler.

Introducing Truffler - Advanced search made easy

In this blog post one of our co-founders, Joel Abrahamsson, introduces Truffler. The post gives a brief introduction to what Truffler is both from a technical and product perspective. Joel also illustrate how the Truffler .NET API can be used to indexed ordinary CLR objects with zero configuration or mapping.