The install_dovecot_fts Script

Valid for versions 108 through the latest version

Version:

108

Last modified: September 21, 2022


Looking for this interface?
Note:

Your hosting provider can enable or disable this interface for resellers in WHM's Edit Reseller Nameservers and Privileges interface (WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges).

Overview

The /usr/local/cpanel/scripts/install_dovecot_fts script enables Internet Message Access Protocol (IMAP) Full-Text Search (FTS) Indexing (powered by Apache 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®, Roundcube, and Mozilla Thunderbird users.

Run the script

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

/usr/local/cpanel/scripts/install_dovecot_fts

Options

This script does not accept options.

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

Output

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
Loaded plugins: fastestmirror, tsflags, universal-hooks
Loading mirror speeds from cached hostfile
 * EA4: 208.74.121.37
Resolving Dependencies
--> Running transaction check
--> Finished Dependency Resolution


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

  Verifying  : cpanel-dovecot-solr-6.6.2-8.1.noarch                        1/1

Complete!

Uninstall FTS

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

/usr/local/cpanel/scripts/uninstall_dovecot_fts

Additional Documentation