kopano-search.cfg - The Kopano Search configuration file
The search.cfg is a configuration file for the Kopano Search Service. search.cfg
contains instructions for the software to set up the connection, indexing and
The file consists of one big section, but parameters can be grouped by
The parameters are written in the form:
The file is line-based. Each newline-terminated line represents either a
comment, nothing, a parameter or a directive. A line beginning with `#' is
considered a comment, and will be ignored by Kopano. Parameter names are case
sensitive. Lines beginning with `!' are directives.
Directives are written in the form:
! directive [argument(s)]
The following directives exist:
Include and process argument
Example: !include common.cfg
Directory under which all index files will be
After correctly starting, the server process
will become this user, dropping root privileges. Note that the log file needs
to be writeable by this user, and the directory too to create new logfiles
after logrotation. This can also be achieved by setting the correct group and
Default value is empty, not changing the user after starting.
After correctly starting, the server process
will become this group, dropping root privileges.
Default value is empty, not changing the group after starting.
Write the process ID number to this file. This
is used by the init.d script to correctly stop/restart the service.
Change directory to this path when running in
daemonize mode. When using the -F switch to run in the foreground the
directory will not be changed.
Limit the number of results returned to the
server. If set to a nonzero value, only the N most relevant results will be
returned to the server. This in turn limits the number of results that the
user will see. If the limit is set to 0, all results will be returned.
Socket to find the connection to the Kopano
The file containing the private key and
certificate. Please read the SSL section in the kopano-server
on how to create this file.
Enter your password here when your key file
contains a password to be readable.
No default set.
Connection path to which other processes can
connect with the kopano-search for performing search queries.
to listen as an HTTP service on all IPv4
interfaces on the given port
kopano-search will use this file as private
key for SSL TLS. This file can be created with: openssl genrsa -out
kopano-search will use this file as
certificate for SSL TLS. A self-signed certificate can be created with:
openssl req -new -x509 -key /etc/kopano/search/privkey.pem -out
/etc/kopano/search/cert.pem -days 1095
The method which should be used for logging.
Valid values are:
Use the Linux system log. All messages will be
written to the mail facility. See also syslog.conf(5).
Log to a file. The filename will be specified
The level of output for logging in the range
from 0 to 5. 0 means no logging, 5 means full logging.
When logging to a file, specify the filename
in this parameter. Use -
(minus sign) for stderr output.
Specify whether to prefix each log line with a
timestamp in 'file' logging mode.
Buffer logging in what sized blocks. The
special value 0 selects line buffering.
Backend search engine (currently only xapian
The size in bytes of the term cache used when
writing terms to the index. A larger term cache will increase indexing speed
when indexing large number of documents in a single store. This will barely
affect incremental updates after the initial indexing has finished. This value
may contain a k, m or g multiplier.
Some properties are ignored because they
contain unrelated information for users to find their messages on. A default
set of ignored property ids is set here, but can be expanded. Only the id part
of a property is needed, and must be string typed properties. The field is
Default: 007D 0064 0C1E 0075 678E 678F
Number of indexing processes used during
initial indexing. Setting this to a higher value can greatly speed up initial
indexing, especially when attachments are indexed.
Index junk folders
Prepare search suggestions
("did-you-mean?") during indexing. Junk folders are excluded. This
takes up a large percentage of the used disk space.
Enable indexing of attachments. When
attachments are being indexed, searching for keywords in the body of a message
will automatically cause the attachment to be searched as well.
This will slow down the indexing process, require more system memory and
increases index file size.
Maxiumum file size for attachments to be
indexed. Any attachment larger then this amount will not be indexed. This
value may contain a k, m or g multiplier.
Written by Kopano.