KOPANO-SPAMD.CFG(5)

NAME
kopano-spamd.cfg - The Kopano Spamd configuration file

SYNOPSIS

spamd.cfg

DESCRIPTION

The spamd.cfg is a configuration file for the Kopano Spamd Service. spamd.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

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/spamd.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: /

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/spamd.pem

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

    No default set.

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: /var/log/kopano/spamd.log

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

spam_dir
    The dir where spam mails are written to which are later picked up by the sa-learn program.

    Default: /var/lib/kopano/spamd/spam

spam_db
    Location for the database containing metadata on learned spam.

    Default: /var/lib/kopano/spamd/spam.db

header_tag
    Header tag for spam message. X-Spam-Flag, X-Spam-Status, X-Spam

    Default: X-Spam-Flag

learn_ham
    Learn ham, when the user moves emails from junk to inbox, enabled by default.

    Default: yes

ham_dir
    The dir where ham mails are written to which are later picked up by the sa-learn program

    Default: /var/lib/kopano/spamd/ham

sa_group
    Spamassassin group

    Default: amavis

AUTHOR

Written by Kopano.

SEE ALSO

kopano-spamd(8)