Bleve Search (Experimental)

Available in Mattermost Free and Starter subscription plans. Available for Mattermost Cloud deployments. Available for Mattermost Self-Hosted deployments.

Bleve is a search engine that uses Lucene-style full-text search and indexing. This style of search and indexing helps overcome limitations of the default database search such as challenges with characters and advanced search capabilities.

The Bleve search engine works as a library integrated into the Mattermost codebase. As it generates indexes in the filesystem of the server that it is running on, it doesn’t require an external server to function. Because of this, Bleve should not be enabled in High Availability deployments.

Note

From Mattermost v6.1, Bleve search uses the scorch index type on newly-created indexes. This new index type features efficiency improvements and indexes that use significantly less disk space.

To use this new type of index on your existing indexes, first upgrade Mattermost Server to version to v6.1 or later. Then go to System Console > Experimental > Bleve and select Purge Index to run a purge operation. When that’s complete, select Index Now to reindex. Bleve remains compatible with existing indexes, so currently indexed data will continue to work if a purge and reindex isn’t run.

Configuring Bleve in Mattermost

Follow these steps to configure the Mattermost server to use Bleve and generate required indexes. Once the configuration is saved, new posts made to the database will be automatically indexed with Bleve.

Note: During indexing, search results may be incomplete until the indexing job is complete.

  1. Open System Console > Experimental > Bleve.

  2. Set Enable Bleve Indexing to true to enable the other settings on the page.

  3. Set the directory path to use for storing Bleve indexes (e.g.: /var/opt/mattermost/bleveindexes). The user running Mattermost should have permissions to access the directory. See our Configuration Settings documentation for details.

  4. Save the configuration.

  5. Select Index Now. All users, channels, and posts in the database will be indexed oldest to newest.

  6. Set Enable Bleve for search queries to true.

  7. Set Enable Bleve for autocomplete queries to true.

Note

Search results for files shared before upgrading to Mattermost Server v5.35 may be incomplete until an extraction command is run using the CLI, or using the mmctl. After running this command, the search index must be rebuilt. Go to System Console > Experimental > Bleve > Bulk Indexing, then select Index Now to rebuild the search index to include older file contents.