Crawl and Index Your Website with Laravel Site Search

Packages

October 21st, 2021

laravel-site-search-featured.png

Laravel Site Search is a package by Spatie to create a full-text search index by crawling your site. You can think of it as a private Google search for your sites to crawl and index all your content and provide a highly customizable, indexed search.

Using this package, you can create an index via the provided artisan command, which will prompt you for the name of the index you'd like to make, the URL of the site, etc.

Once you have your index, you can crawl the site using a queued job with the provided console command. Lastly, you can search against the index—the following are a few examples:

1use Spatie\SiteSearch\Search;
2 
3$searchResults = Search::onIndex($indexName)
4 ->query('your query')
5 ->get();
6 
7// Limit results
8$searchResults = Search::onIndex('my-index')
9 ->query('your query')
10 ->limit(20)
11 ->get(); // returns the first 20 results
12 
13// Pagination (defaults to 20 results per page)
14$searchResults = Search::onIndex('my-index')
15 ->query('your query')
16 ->paginate(20);

Under the hood, Laravel Site Search is powered by Meilisearch, which provides exceptionally fast search speeds and various customization options like synonyms and custom properties.

Learn More

You can learn more about this package and view the source code on GitHub. The documentation is an excellent place to start for setup instructions and all the details to start using this fantastic package.

Filed in:

Paul Redmond

Full stack web developer. Author of Lumen Programming Guide and Docker for PHP Developers.