KOPANO-SEARCH.CFG(5)

📦 version 8.7.0, in ubuntu jammy

💖 KOPANO-SEARCH.CFG(5) 💖

okay bestie, welcome to the manual page for kopano-search.cfg — yes the (5) means it's a file format page, and yes we're gonna read the whole thing together, no skimming, i got you 🫶

✨ NAME ✨

kopano-search.cfg — the Kopano Search configuration file. it's the config file, the whole personality of your search service lives in here 💅

🌸 SYNOPSIS 🌸

search.cfg

🦋 DESCRIPTION 🦋

so search.cfg is literally the configuration file for the Kopano Search Service. it holds the instructions the software uses to set up the connection, the indexing, and the logging systems. three whole systems, one little file, main character energy fr fr ✨

🎀 FILE FORMAT 🎀

the file is one big section, but ngl you can group the parameters by functionality so it doesn't look like a wall of text (organization is self-care, periodt).

parameters are written in this form:

name = value

the file is line-based. every newline-terminated line is either a comment, nothing, a parameter, or a directive. that's the whole menu 🍓

a line that begins with # counts as a comment and gets completely ignored by Kopano. also important: parameter names are case sensitive, so don't get cute with the capitals 🙈

lines beginning with ! are directives.

directives are written like this:

!directive [argument(s)]

and here's the tea, the directives that exist are:

  • include — include and process argument

Example: !include common.cfg

👑 EXPLANATION OF THE SERVICE SETTINGS PARAMETERS 👑

  • index_path — the directory where all the index files get placed. that's it, that's the whole vibe.

Default: /var/lib/kopano/index/

  • run_as_user — after it starts correctly, the server process becomes this user, dropping root privileges. heads up though: the log file has to be writeable by this user, and so does the directory, because new logfiles need to be created after logrotation. you can also pull this off by setting the right group and permissions.

Default value is empty, meaning the user is not changed after starting.

  • run_as_group — same deal but for groups: after correctly starting, the server process becomes this group, dropping root privileges.

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

  • pid_file — writes the process ID number into this file. the init.d script uses it to correctly stop/restart the service, so like... it's important, don't lose it 💀

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

  • running_path — change directory to this path when running in daemonize mode. but if you use the -F switch to run in the foreground, the directory will not be changed. fyi.

Default: /

  • limit_results — limit the number of results returned to the server. if you set it to a nonzero value, only the N most relevant results go back to the server, which in turn limits how many results the user will see. if the limit is set to 0, all results will be returned — everything, the whole pile, no cap.

Default: 0

💜 EXPLANATION OF THE SERVER SETTINGS PARAMETERS 💜

  • server_socket — the socket used 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. pls read the SSL section in the kopano-server(8) manual for how to create this file, they explain it better than i ever could 🧚

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

  • ssl_key_pass — put your password here when your key file contains a password so it can be readable. yes, the password. the secret one. 🤫

No default set.

🌈 EXPLANATION OF THE LISTEN SETTINGS PARAMETERS 🌈

  • server_bind_name — the connection path that other processes can connect to with 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. you can create this file 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 that 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 gets 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. so 5 is the yapper setting, 0 is the silent treatment 😭

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 — the 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 numbers of documents in a single store. it 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 get ignored because they contain unrelated information for users to find their messages on. a default set of ignored property ids is set here, but it can be expanded. only the id part of a property is needed, and they must be string typed properties. the field is space separated.

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

  • index_processes — the 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. more cores, more slay 🔥

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. heads up: this takes up a large percentage of the used disk space. it's giving storage-hungry 👀

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.
okay but real talk: this will slow down the indexing process, require more system memory, and increase index file size. trade-offs, bestie, trade-offs 😭

Default: no

  • index_attachment_max_size — maximum file size for attachments to be indexed. any attachment larger than 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)

and that's the whole page!! this was Kopano 8, dated November 2016 — ty for reading with me, you absolutely ate this config file, go index something gorgeous 💅✨🫶

📦 where this page comes from