KOPANO-MONITOR.CFG(5)

NAME
kopano-monitor.cfg - The Kopano monitor configuration file

SYNOPSIS

monitor.cfg

DESCRIPTION

The monitor.cfg is a configuration file for the Kopano Monitor. monitor.cfg contains instructions for the software to set up the logging system.

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

The types of parameters for the spooler are: server, smtp and log.

EXPLANATION OF EACH PARAMETER

  quota_check_interval

Set the interval (in minutes) for checking the quota for all Kopano users.

Default: 15

  mailquota_resend_interval

Send interval of a quota mail in days when a user reache his warning, soft or hard quota.

Default: 1

  server_socket

Connection URL to find the connection to the Kopano server.

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

  run_as_user, run_as_group

User/group identity to switch to on startup. Can be user/group name or numeric UID/GID. The log file and directory need to be writeable by this user.

Default user: kopano

Default group: kopano

  coredump_enabled

When a crash occurs or an assertion fails, a coredump file can be generated by the system for use with a crash report. For details, see the kopano-coredump(5) manpage.

Default: systemdefault

  sslkey_file

Use this file as key to logon to the server. This is only used when server_socket is set to an HTTPS transport. See the kopano-server(8) manual page on how to setup SSL keys.

Default: (empty)

  sslkey_pass

The password of the SSL key file that is set in sslkey_file.

Default: (empty)

  log_method

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

syslog
    Use the syslog service. Messages will be sent using the "mail" facility tag. See also journald.conf(5) or syslog.conf(5).

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

auto
    Autoselect mode: If log_file is set, that will be used. Else, syslog will be used if it looks like it is available. Else, stderr.

Default: auto

  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

  log_level

The level of output for logging in the range from 0 to 6. "0" means no logging, "1" for critical messages only, "2" for error or worse, "3" for warning or worse, "4" for notice or worse, "5" for info or worse, "6" debug.

Default: 3

  userquota_warning_template, companyquota_warning_template

These templates are read by the kopano-monitor when a user or tenant exceeds a particular quota level. In these templates multiple variables can be used which will be replaced before sending the quota warning email.

These files should be saved in the UTF-8 charset. UTF-8 is compatible with US-ASCII, so if you only use western characters, there is no need for special measurements.

${KOPANO_QUOTA_NAME}
    userquota template: The name of the user who exceeded his quota

    companyquota template: The name of the tenant which exceeded its quota

${KOPANO_QUOTA_FULLNAME}
    userquota template: The fullname for the user who exceeded his quota

    tenantquota template: The name of the tenant which exceeded its quota

${KOPANO_QUOTA_COMPANY}
    userquota template: The name of the tenant to which the user belongs

    tenantquota template: The name of the tenant which exceeded its quota

${KOPANO_QUOTA_STORE_SIZE}
    userquota template: The total size of the user's store

    companyquota template: The total size of all stores (including the public store) which belong to this tenant

    Note: The size unit (KB,MB) is part of the variable

${KOPANO_QUOTA_WARN_SIZE}
    The quota warning level

    Note: The size unit (KB,MB) is part of the variable

${KOPANO_QUOTA_SOFT_SIZE}
    The quota soft level

    Note: The size unit (KB,MB) is part of the variable

${KOPANO_QUOTA_HARD_SIZE}
    The quota hard limit

    Note: The size unit (KB,MB) is part of the variable

RELOADING

The following options are reloadable by sending the kopano-monitor process a HUP signal:

log_level, mailquota_resend_interval

FILES

/etc/kopano/monitor.cfg
    The Kopano monitor configuration file.

SEE ALSO

kopano-monitor(8)