table of contents
KOPANO-MONITOR.CFG(5) | Kopano Core user reference | 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
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: /
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: 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 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_file¶
When logging to a file, specify the filename in this parameter. Use - (minus sign) for stderr output.
Default: /var/log/kopano/monitor.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
log_level¶
The level of output for logging in the range from 0 to 5. 0 means no logging, 5 means full logging.
Default: 2
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}
companyquota template: The name of the tenant which exceeded its quota
${KOPANO_QUOTA_FULLNAME}
tenantquota template: The name of the tenant which exceeded its quota
${KOPANO_QUOTA_COMPANY}
tenantquota template: The name of the tenant which exceeded its quota
${KOPANO_QUOTA_STORE_SIZE}
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}
Note: The size unit (KB,MB) is part of the variable
${KOPANO_QUOTA_SOFT_SIZE}
Note: The size unit (KB,MB) is part of the variable
${KOPANO_QUOTA_HARD_SIZE}
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
AUTHOR¶
Written by Kopano.
SEE ALSO¶
kopano-monitor(8)
November 2016 | Kopano 8 |