This is an automated email from the ASF dual-hosted git repository. pgj pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/couchdb.git
commit 9324d3ad022fa03b86e83d3ef818d19f104dc08d Author: Gabor Pali <[email protected]> AuthorDate: Mon Aug 24 05:42:58 2026 +0200 docs: update Search installation instructions Clouseau 3.x has now become the supported version of Search, which works with more recent Java versions (in contrast to 2.x) and it features a new configuration file format (but with the same parameters). Update the respective part of the installation guide to chase these changes. --- src/docs/src/install/search.rst | 78 ++++++++++++++++++++--------------------- 1 file changed, 39 insertions(+), 39 deletions(-) diff --git a/src/docs/src/install/search.rst b/src/docs/src/install/search.rst index 07e0420e4..b53540b8f 100644 --- a/src/docs/src/install/search.rst +++ b/src/docs/src/install/search.rst @@ -18,16 +18,14 @@ Search Plugin Installation .. versionadded:: 3.0 -.. highlight:: ini - CouchDB can build and query full-text search indexes using an external Java service that embeds `Apache Lucene <http://lucene.apache.org>`_. 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. +The search plugin is runtime-compatible with Java JDKs 21 and later. Building a +release from source requires at least JDK 17. **It will not work with any older +version of Java.** Sorry about that. Installation of Binary Packages =============================== @@ -43,46 +41,48 @@ to the server command below. If clouseau is installed in ``/opt/clouseau`` the l -classpath '/opt/clouseau/*' -The service expects to find a couple of configuration files -conventionally called ``clouseau.ini`` and ``log4j.properties`` with the following -content: - -**clouseau.ini**:: - - [clouseau] - - ; the name of the Erlang node created by the service, leave this unchanged - [email protected] - - ; set this to the same distributed Erlang cookie used by the CouchDB nodes - cookie=brumbrum - - ; the path where you would like to store the search index files - dir=/path/to/index/storage - - ; the number of search indexes that can be open simultaneously - max_indexes_open=500 - -**log4j.properties**:: - - log4j.rootLogger=debug, CONSOLE - log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender - log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout - log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %c [%p] %m%n - -Once these files are in place the service can be started with an invocation like +The service expects to find its configuration file conventionally called ``clouseau.conf`` +with the following content: + +**clouseau.conf**:: + + logger: { + format: Raw + output: Stdout + level: debug + } + config: [ + { + node: { + # the name of the Erlang node created by the service, leave this unchanged + name: clouseau + domain: 127.0.0.1 + + # set this to the same distributed Erlang cookie used by the CouchDB nodes + cookie: brumbrum + } + clouseau: { + # the path where you would like to store the search index files + dir: /path/to/index/storage + + # the number of search indexes that can be open simultaneously + max_indexes_open: 500 + } + } + ] + +Once this file is in place the service can be started with an invocation like the following:: java -server \ -Xmx2G \ -Dsun.net.inetaddr.ttl=30 \ -Dsun.net.inetaddr.negative.ttl=30 \ - -Dlog4j.configuration=file:/path/to/log4j.properties \ - -XX:OnOutOfMemoryError="kill -9 %p" \ - -XX:+UseConcMarkSweepGC \ - -XX:+CMSParallelRemarkEnabled \ - com.cloudant.clouseau.Main \ - /path/to/clouseau.ini + -XX:+ExitOnOutOfMemoryError \ + -XX:+UseG1GC \ + -XX:+ParallelRefProcEnabled \ + com.cloudant.ziose.clouseau.Main \ + /path/to/clouseau.conf Chef ====
