KOPANO-SEARCH.CFG(5)

NAME
kopano-search.cfg - The Kopano Search configuration file

SYNOPSIS

search.cfg

DESCRIPTION

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 logging systems.

FILE FORMAT

The file consists of one big section, but parameters can be grouped by functionality.

The parameters are written in the form:

name = value

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
    Include and process argument

    Example: !include common.cfg

EXPLANATION OF THE SERVICE SETTINGS PARAMETERS

index_path
    Directory under which all index files will be placed.

    Default: /var/lib/kopano/index/

run_as_user
    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 permissions.

    Default value is empty, not changing the user after starting.

run_as_group
    After correctly starting, the server process will become this group, dropping root privileges.

    Default value is empty, not changing the group after starting.

pid_file
    Write the process ID number to this file. This is used by the init.d script to correctly stop/restart the service.

    Default: /var/run/kopano/search.pid

running_path
    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.

    Default: /

limit_results
    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.

    Default:0

EXPLANATION OF THE SERVER SETTINGS PARAMETERS

server_socket
    Socket to find the connection to the Kopano server.

    Default: file:///var/run/kopano/server.sock

ssl_key_file
    The file containing the private key and certificate. Please read the SSL section in the kopano-server(8) manual on how to create this file.

    Default: /etc/kopano/ssl/search.pem

ssl_key_pass
    Enter your password here when your key file contains a password to be readable.

    No default set.

EXPLANATION OF THE LISTEN SETTINGS PARAMETERS

server_bind_name
    Connection path to which other processes can connect with the kopano-search for performing search queries.

    Use http://0.0.0.0:port to listen as an HTTP service on all IPv4 interfaces on the given port number.

    Default: file:///var/run/kopano/search.sock

ssl_private_key_file
    kopano-search will use this file as private key for SSL TLS. This file can be created with: openssl genrsa -out /etc/kopano/search/privkey.pem 2048.

    Default: /etc/kopano/search/privkey.pem

ssl_certificate_file
    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.

    Default: /etc/kopano/search/cert.pem

EXPLANATION OF THE LOG SETTINGS PARAMETERS

log_method
    The method which should be used for logging. Valid values are:

    syslog
        Use the Linux system log. All messages will be written to the mail facility. See also syslog.conf(5).

    file
        Log to a file. The filename will be specified in log_file.

    Default: file

log_level
    The level of output for logging in the range from 0 to 5. 0 means no logging, 5 means full logging.

    Default: 3

log_file
    When logging to a file, specify the filename in this parameter. Use - (minus sign) for stderr output.

    Default: -

log_timestamp
    Specify whether to prefix each log line with a timestamp in 'file' logging mode.

    Default: 1

log_buffer_size
    Buffer logging in what sized blocks. The special value 0 selects line buffering.

    Default: 0

EXPLANATION OF THE ADVANCED SETTINGS PARAMETERS

search_engine
    Backend search engine (currently only xapian is supported).

    Default: xapian

term_cache_size
    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.

    Default: 64M

index_exclude_properties
    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 space separated.

    Default: 007D 0064 0C1E 0075 678E 678F

index_processes
    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.

    Default: 1

index_drafts
    Index drafts folders

    Default: yes

index_junk
    Index junk folders

    Default: yes

suggestions
    Prepare search suggestions ("did-you-mean?") during indexing. Junk folders are excluded. This takes up a large percentage of the used disk space.

    Default: yes

EXPLANATION OF THE ATTACHMENT SETTINGS PARAMETERS

index_attachments
    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.

    Default: no

index_attachment_max_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.

    Default: 5M

AUTHOR

Written by Kopano.

SEE ALSO

kopano-search(8)