KOPANO-MONITOR.CFG(5)

✨ KOPANO-MONITOR.CFG(5) ✨

okay bestie, welcome to section 5 of the Kopano Core user reference — this is the page for kopano-monitor.cfg, aka the glow-up manual for the Kopano Monitor's very own config file. it's giving "calm, organized, log-savvy" and honestly? we're obsessed. 💅

---

🌸 NAME 🌸

kopano-monitor.cfg — The Kopano monitor configuration file. that's it, that's the name, no notes. 💖

---

🦋 SYNOPSIS 🦋

monitor.cfg

---

💫 DESCRIPTION 💫

so monitor.cfg is the configuration file for the Kopano Monitor. inside it are the instructions the software needs to set up the logging system. that's the whole vibe: it tells the monitor how to behave, and honestly it does it beautifully. ✨

---

🎀 FILE FORMAT 🎀

the file is one big section, but ngl you can group the parameters by functionality if you want — it's a free country, organize your little heart out. 🫶

parameters are written like this:

name = value

the file is line-based. every newline-terminated line is one of four things: a comment, nothing at all, a parameter, or a directive. a line starting with # is a comment and Kopano will straight-up ignore it (as it should 💀). parameter names are case sensitive, so don't get cute with the capitalization.

lines starting with ! are directives, written like:

!directive [argument(s)]

the following directives exist:

📥 include

include and process the argument.

example: !include common.cfg

and psst — the types of parameters for the spooler are: server, smtp and log. yes, it says spooler. we're just relaying the lore, no cap. 🧚

---

👑 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

the send interval of a quota mail, in days, for when a user reaches his warning, soft or hard quota.

default: 1

🔌 server_socket

the connection URL to find the connection to the Kopano server.

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

🙋♀️ run_as_user

after starting correctly, the monitor process will become this user, dropping root privileges. heads up bestie: the log file needs to be writeable by this user, and so does the directory, so new logfiles can be created after logrotation. you can also achieve this by setting the correct group and permissions. ✨

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

👯 run_as_group

after starting correctly, the monitor process will become this group, dropping root privileges.

default value is empty, meaning the group is not changed after starting.

🪪 pid_file

write the process ID number to this file. this is what the init.d script uses 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 you use 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 the details, see the kopano-coredump(5) manpage.

default: systemdefault

🔑 sslkey_file

use this file as the 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 for how to set up 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 that 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's 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. inside these templates you can use multiple variables, which will be replaced before the quota warning email is sent.

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's no need for special measurements. slay. 🌈

• ${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 🔄

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

log_level, mailquota_resend_interval

like, live-updating your config without a restart? main character energy. ✨

---

📁 FILES 📁

• /etc/kopano/monitor.cfg — the Kopano monitor configuration file.

---

🖋️ AUTHOR 🖋️

written by Kopano. 💜

---

👀 SEE ALSO 👀

kopano-monitor(8)

---

reminder bestie: don't rename, merge or invent options — the config file is iconic exactly as it is. 🫶

and that's the whole page!! this manual is from <b>Kopano 8</b>, dated <b>November 2016</b> — yeah it's a lil vintage, but vintage is a vibe. mwah, ily, go set your log_level responsibly. 💖✨🎀🦋