1.8. Search Plugin Installation

CouchDB can build and query full-text search indexes using an external Java service that embeds Apache Lucene. Typically, this service is installed on the same host as CouchDB and communicates with it over the loopback network.

The search plugin is runtime-compatible with Java JDKs 6, 7 and 8. Building a release from source requires JDK 6. It will not work with any newer version of Java. Sorry about that.

Binary packages that bundle all the necessary dependencies of the search plugin are available on . The files in each release should be unpacked into a directory on the Java classpath. If you do not have a classpath already set, or you wish to explicitly set the classpath location for Clouseau, then add the line:

The service expects to find a couple of configuration files conventionally called and with the following content:

clouseau.ini:

log4j.properties:

The CouchDB cookbook can build the search plugin from source and install it on a server alongside CouchDB.

Users running CouchDB on Kubernetes via the can add the search service to each CouchDB Pod by setting in the chart values.

The Search User Guide provides detailed information on creating and querying full-text indexes using this plugin.