KOPANO-ICAL.CFG(5)

📦 version 8.7.0, in ubuntu jammy

✨ KOPANO-ICAL.CFG ✨

okay bestie, gather round, because we're talking about kopano-ical.cfg — the Kopano iCal/CalDAV gateway configuration file 💖 this is your manpage, your manual, your moment, and it's section 5 of the manual so you know it's a file-format situation. slay.

🌸 SYNOPSIS 🌸

ical.cfg

🦋 DESCRIPTION 🦋

So like. ical.cfg is the configuration file for the Kopano iCal/CalDAV Gateway. That's it, that's the girl. She contains instructions so the software can set up its logging system and turn the normal part or the SSL part of the service on or off. main character energy, honestly ✨

🎀 FILE FORMAT 🎀

The file is one big section, but the parameters can be grouped by functionality if you want to be cute about it.

Parameters are written like this:

name = value

The file is line-based. Every newline-terminated line is one of: a comment, nothing at all, a parameter, or a directive. A line that starts with # counts as a comment and Kopano will just ignore it, no thoughts. Parameter names are case sensitive — do not play with her. Lines that start with ! are directives.

Directives look like this:

!directive [argument(s)]

Here's the directive roster:

  • include — include and process argument. Example: !include common.cfg

🔥 EXPLANATION OF EACH PARAMETER 🔥

💅 ical_listen

A space-separated list of address:port specifiers telling the server where to listen for HTTP/CalDAV connections. IPv6 addresses need to be wrapped in brackets, like [2001:db8::1]:236, and the asterisk is the multi-protocol address wildcard. iconic.

Default: *:8080

💅 icals_listen

A space-separated list of address:port specifiers for implicit-SSL CalDAV/HTTPS connections, same vibe as ical_listen. Previous versions of ZCP/KC suggested port 8443.

Default: (none)

💅 server_socket

The http address of the storage server.

Default: http://localhost:236/

ngl, do not specify the UNIX socket here — put the http address instead. In the default configuration the gateway will then be trusted by the storage server (as set in its local_admin_users configuration setting). And heads up: unless it's run as an untrusted user by specifying the run_as_user, the gateway always authenticates users even if they provide no credentials or wrong credentials! 😭 that's not a drill.

💅 run_as_user

After starting correctly, the iCal/CalDAV gateway process will become this user, dropping root privileges. Note that 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 — not changing the user after starting.

💅 run_as_group

After starting correctly, the iCal/CalDAV gateway 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. The init.d script uses it to correctly stop/restart the service.

Default: /var/run/kopano/ical.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 happens or an assertion fails, the system can generate a coredump file for use with a crash report. For the details, see the kopano-coredump(5) manpage.

Default: systemdefault

💅 process_model

You can switch the process model between fork and thread. The forked model uses somewhat more resources, but if a crash gets triggered, it only affects one user. In the threaded model, a crash means all users are affected and won't be able to use the service. 💀 pick your fighter.

Default: thread

💅 ssl_private_key_file

The iCal/CalDAV gateway will use this file as the private key for SSL TLS. You can create this file with: openssl genrsa -out /etc/kopano/ical/privkey.pem 2048.

Default: /etc/kopano/ical/privkey.pem

💅 ssl_certificate_file

The iCal/CalDAV gateway will use this file as the certificate for SSL TLS. A self-signed certificate can be created with: openssl req -new -x509 -key /etc/kopano/ical/privkey.pem -out /etc/kopano/ical/cert.pem -days 1095.

Default: /etc/kopano/ical/cert.pem

💅 ssl_verify_client

Enable client certificate verification with the value yes. Every other value disables the verification.

Default: no

💅 ssl_verify_file

The file to verify the clients' certificates with.

Default: value not set.

💅 ssl_verify_path

The path with the files to verify the clients' certificates with.

Default: value not set.

💅 ssl_protocols

A space-separated list of disabled or enabled protocol names. Which protocol names are supported depends on the system's SSL library; depending on version, one or more of these are available: TLSv1.3, TLSv1.2, TLSv1.1, SSLv3, SSLv2. To disable a protocol, prefix the name with an exclamation mark.

Default: !SSLv2 !SSLv3 !TLSv1 !TLSv1.1

💅 ssl_ciphers

A colon-separated list of disabled or enabled SSL/TLS ciphers. Which cipher names are supported depends on the system's SSL library, and honestly there are generally plentiful. To disable a cipher or cipher group, prefix the name with a minus or exclamation mark. Details and the meaning of the syntax live in ciphers(1).

Default: DEFAULT:!LOW:!SSLv2:!SSLv3:!TLSv1.0:!TLSv1.1:!EXPORT:!DH:!PSK:!kRSA:!aDSS:!aNULL:+AES

💅 ssl_prefer_server_ciphers

In SSLv3 and newer, the server side gets to make the ultimate cipher pick out of the set that both ends support. When doing that, it can either use the client preference list, or — if this directive is set to "yes" — its own list (as determined by ssl_cipher).

Default: yes

💅 ssl_curves

ECDH curves to use for SSL.

Default: X25519:P-521:P-384:P-256

💅 log_method

The method that should be used for logging. Valid values are:

  • syslog — use the syslog service. Messages get sent using the "mail" facility tag. See also journald.conf(5) or syslog.conf(5).
  • file — log to a file. The filename gets 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_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

💅 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

💅 enable_ical_get

Enable the ical GET method to download an entire calendar. When set to 'yes', the GET method is enabled and allowed. If not, then calendars can only be retrieved with the CalDAV PROPFIND method, which is much more efficient. This option lets you force the use of CalDAV, which lowers load on your server. 🫶

🌈 RELOADING 🌈

These options are reloadable by sending the kopano-ical process a HUP signal:

  • log_level

🍓 FILES 🍓

  • /etc/kopano/ical.cfg — the Kopano iCal/CalDAV gateway configuration file.

👑 AUTHOR 👑

Written by Kopano.

⭐ SEE ALSO ⭐

kopano-ical(8)

and that's the whole thing, bestie 💜 this was Kopano 8, November 2016 — KOPANO-ICAL.CFG(5), no cap. go configure something iconic, you've got this ✨🎀

📦 where this page comes from