--- name: "kopano-monitor.cfg" section: "5" platform: "linux" package: "kopano-monitor" version: "8.7.0-3" release: "Debian 10 (Buster)" platforms: ["linux"] url: "https://new.carta.tech/kopano-monitor.cfg" --- # kopano-monitor.cfg(5) The Kopano monitor configuration file ## 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 After correctly starting, the monitor 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 monitor 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 value: /var/run/kopano/monitor.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: */* ### 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)](/kopano-coredump/5.md) 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)](/kopano-server/8.md) manual page on how to setup SSL keys. Default: value not set. ### sslkey\_pass The password of the SSL key file that is set in sslkey\_file. Default: value not set. ### 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)](/journald.conf/5.md) or [**syslog.conf**(5)](/syslog.conf/5.md). - **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. ## AUTHOR Written by Kopano. ## SEE ALSO [**kopano-monitor**(8)](/kopano-monitor/8.md)