KOPANO-BACKUP.CFG(5)

💖 KOPANO-BACKUP.CFG(5) 💖

okay bestie, welcome to the Kopano Core user reference for kopano-backup.cfg — yes that's the manual name, and yes it's giving "I read the docs so you don't have to" energy 🎀

---

✨ NAME ✨

kopano-backup.cfg — the Kopano Backup configuration file. that's it, that's the name, no cap 💅

---

🌸 SYNOPSIS 🌸

backup.cfg

---

🦋 DESCRIPTION 🦋

backup.cfg is a configuration file for the Kopano Backup service. literally just the settings file the backup service reads when it wakes up and does its little tasks ✨

---

🎀 FILE FORMAT 🎀

So the file is one big section, right? but the parameters can still be grouped by functionality, so you can keep your faves together and it's still valid 🫶

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 (yes, really, Log_Level is not log_level, don't do that to yourself 😭). 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

---

👑 EXPLANATION OF THE SERVER SETTINGS PARAMETERS 👑

• server_socket — the socket used to find the connection to the Kopano server. it's how backup finds its people 💫

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

• ssl_key_file — the file containing the private key and certificate. bestie, please read the SSL section in the kopano-server(8) manual on how to create this file, it's not a vibe-it-out situation 🙈

Default: /etc/kopano/ssl/search.pem

• ssl_key_pass — enter your password here when your key file contains a password to be readable.

No default set. nope, nothing, you gotta bring your own 🔐

---

🔥 EXPLANATION OF THE LOG SETTINGS PARAMETERS 🔥

• 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_level — the level of output for logging in the range from 0 to 5. 0 means no logging, 5 means full logging. so like, 0 is "not me knowing anything" and 5 is "I'm in everyone's business" 💀

Default: 3

• log_file — when logging to a file, specify the filename in this parameter. Use - (minus sign) for stderr output. classic - behaviour, iconic ⭐

Default: -

---

🌈 EXPLANATION OF THE BACKUP SETTINGS PARAMETERS 🌈

• worker_processes — maximum number of stores to backup in parallel. multitasking queen energy 👑

Default: 1

• backup_servers — only servers in this list will be processed by the backup tool. Servernames are SPACE separated. Default is empty which will process all servers.

Default: value not set

---

💜 AUTHOR 💜

Written by Kopano. slay, honestly 🫶

---

🌟 SEE ALSO 🌟

• kopano-backup(8)

---

that's the whole page bestie, go forth and configure responsibly 💖

this was Kopano 8, from November 2016 — vintage, lowkey, but fr fr still the source of truth ✨