You can find our user documentation at

Check out our new API beta site!

Page tree
Skip to end of metadata
Go to start of metadata

For cPanel & WHM version 64


The /usr/local/cpanel/scripts/install_dovecot_fts script enables Internet Message Access Protocol (IMAP) Full-Text Search (FTS) Indexing (powered by Solr), which provides fast search capabilities for IMAP mailboxes. FTS significantly improves the speed and convenience of the search experience for iOS device, Microsoft Outlook®, SquirrelMail, Horde, Roundcube, and Mozilla Thunderbird users.

The /usr/local/cpanel/scripts/install_dovecot_fts script

To use this script, run the following command as the root user:



The /usr/local/cpanel/scripts/install_dovecot_fts script does not accept arguments.


The --help argument will not provide help documentation. Instead, the script will run as if you did not pass an argument.


When the script successfully completes, you will receive a message similar to the following:

Loaded plugins: fastestmirror, tsflags, universal-hooks
Loading mirror speeds from cached hostfile
 * EA4:
Resolving Dependencies
--> Running transaction check
--> Finished Dependency Resolution

Downloading packages:
Running transaction check
Running transaction test
Transaction test succeeded
  Installing : cpanel-dovecot-solr-6.4.0-23.1.noarch                        1/1

  Verifying  : cpanel-dovecot-solr-6.4.0-23.1.noarch                        1/1


The /usr/local/cpanel/scripts/uninstall_dovecot_fts script

To uninstall the Dovecot FTS indexing, run the following command:


Additional information - Update labels

There is no content with the specified labels

There is no content with the specified labels

There is no content with the specified labels

Error rendering macro 'contentbylabel'

parameters should not be empty