KOPANO-SPAMD.CFG(5)

💖 KOPANO-SPAMD.CFG(5) 💖

okay bestie, welcome to the Kopano Core user reference — this is the manual page for kopano-spamd.cfg, and yes, the whole section-5 situation is giving "config file" energy, no cap ✨

---

🌸 NAME 🌸

kopano-spamd.cfg — the Kopano Spamd configuration file. that's it, that's the name, slay 💅

---

🦋 SYNOPSIS 🦋

spamd.cfg

---

✨ DESCRIPTION ✨

so spamd.cfg is the config file for the Kopano Spamd Service. it's literally a little instruction manual for the software — it tells it how to set up the connection, the indexing, and the logging systems. three whole systems, one tiny file, we love a multitasker 🫶

---

🎀 FILE FORMAT 🎀

okay so the file is one big section, but the parameters can be grouped by what they actually do. functionally organized, iconic behavior ✨

parameters get 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 that starts with # is a comment and Kopano will just ignore it, like it's not even there 🙈

⚠️ parameter names are case sensitive. Spam_Dir and spam_dir are NOT the same thing bestie, do not play with me.

lines beginning with ! are directives.

directives look like this:

!directive [argument(s)]

here's the directive list, the whole thing, no skipping:

• include — include and process argument.

example: !include common.cfg

---

👑 EXPLANATION OF THE SERVICE SETTINGS PARAMETERS 👑

• run_as_user — after it starts up correctly, the server process becomes this user, which means it drops root privileges. important note: the log file has to be writeable by this user, and the directory too, so that new logfiles can be created after logrotation. you can also handle this by setting the correct group and permissions. default value is empty, which means it does not change the user after starting.
• run_as_group — after it starts up correctly, the server process becomes this group, dropping root privileges. default value is empty, which means it does not change the group after starting.
• pid_file — write the process ID number to this file. the init.d script uses this 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 you use the -F switch to run in the foreground, the directory will not be changed. default: /

---

🌈 EXPLANATION OF THE SERVER SETTINGS PARAMETERS 🌈

• server_socket — the socket used 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. pls go read the SSL section in the kopano-server(8) manual for how to actually create this file, i'm not doing that part for you 🥲 default: /etc/kopano/ssl/spamd.pem
• ssl_key_pass — put your password here when your key file has a password on it so it can be read. no default set.

---

⭐ EXPLANATION OF THE LOG SETTINGS PARAMETERS ⭐

• log_method — the method that should be used for logging. valid values are:
  • syslog — use the Linux system log. all messages get written to the mail facility. see also syslog.conf(5).
  • file — log to a file. the filename gets 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 at all, 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 when 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 get 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. the options are X-Spam-Flag, X-Spam-Status, X-Spam. default: X-Spam-Flag
• learn_ham — learn ham, which happens when the user moves emails from junk to inbox. enabled by default. default: yes
• ham_dir — the dir where ham mails get 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)

---

okay and that's the whole page bestie!! 🎀 Kopano 8, February 2018 — that's the version and the date this whole thing was stamped with, so if you're reading this and it's giving ancient artifact vibes, that's why 😭 go forth and configure, you absolute icon 👑💅