.\" Man page generated from reStructuredText. . .TH "CYRUS.CONF" "5" "March 09, 2021" "3.2.6" "Cyrus IMAP" .SH NAME cyrus.conf \- Cyrus IMAP documentation . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .sp Cyrus configuration file .SH DESCRIPTION .sp \fBcyrus.conf\fP is the configuration file for the Cyrus master(8) process. It defines the startup procedures, services, events and daemons to be spawned, managed and tended to by \fBmaster\fP\&. .sp The \fB/etc/cyrus.conf\fP file consists of a series of entries divided into sections of the form .INDENT 0.0 .INDENT 3.5 .sp .nf \fIsection\fP { \fIname arguments ... ... ...\fP } .fi .UNINDENT .UNINDENT .sp where \fIsection\fP is the name of the section, \fIname\fP is the name of the entry and \fIarguments\fP is the whitespace\-separated list of arguments for the entry. The \fIname\fP may be any sequence of alphabetic and numeric characters, but may not contain punctuation such as \(aq\-\(aq or \(aq_\(aq. In the \fBSERVICES\fP section, names must be unique. .sp Blank lines and lines beginning with \(ga\(ga#\(aq\(aq are ignored. .SH SECTION DESCRIPTIONS .sp The paragraphs below detail the four sections (\fBSTART\fP, \fBSERVICES\fP, \fBEVENTS\fP, \fBDAEMON\fP) that can be placed in the \fB/etc/cyrus.conf\fP file. The arguments that are available for each entry within the section are described, and each argument\(aqs default value is shown. .sp An important distinction exists between \fBSERVICES\fP and \fBDAEMON\fP ; the former have sockets which master(8) will listen on (either IP or Unix domain) while the latter do not. Similarly, processes listed in \fBSTART\fP will be run to completion before any \fBSERVICES\fP are started, while those in \fBDAEMON\fP will be managed by master(8)\&. .sp \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 If master(8) is started in debugging mode (\fB\-D\fP) the behavior of \fBDAEMON\fP will be altered, as master(8) will no longer be backgrounded. Thus, processes started under DAEMON may not be terminated by master(8)\&. .UNINDENT .UNINDENT .sp Arguments can appear in any order. Some arguments have no default value, these are listed with \(ga\(ga\(aq\(aq. For string arguments, the value MUST be enclosed in double quotes. .SS START .sp This section lists the processes to run before any \fBSERVICES\fP are spawned. This section is typically used to initialize databases. Master itself will not startup until all tasks in \fBSTART\fP have completed, so put no blocking commands here. .sp .nf \fBcmd=\fP .fi .INDENT 0.0 .INDENT 3.5 The command (with options) to spawn as a child process. This string argument is required. .UNINDENT .UNINDENT .sp \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 Prior to v3, non\-service daemons like \fBidled\fP were started from \fBSTART\fP but would background themselves, thus not blocking. Post v3 these are better managed through the \fBDAEMON\fP section, under which master will provide life\-cycle management (i.e. restarting dead processes). .UNINDENT .UNINDENT .SS SERVICES .sp This section is the heart of the \fB/etc/cyrus.conf\fP file. It lists the processes that should be spawned to handle client connections made on certain Internet/UNIX sockets. .sp .nf \fBbabysit=\fP0 .fi .INDENT 0.0 .INDENT 3.5 Integer value \- if non\-zero, will make sure at least one process is pre\-forked, and will set the maxforkrate to 10 if it\(aqs zero. .UNINDENT .UNINDENT .sp .nf \fBcmd=\fP .fi .INDENT 0.0 .INDENT 3.5 The command (with options) to spawn as a child process. This string argument is required. .UNINDENT .UNINDENT .sp .nf \fBlisten=\fP .fi .INDENT 0.0 .INDENT 3.5 The UNIX or internet socket to listen on. This string field is required and takes one of the following forms: .sp .nf \fIpath\fP [ \fIhost\fP \fB:\fP ] \fIport\fP .fi .sp where \fIpath\fP is the explicit path to a UNIX socket, \fIhost\fP is either the hostname or bracket\-enclosed IP address of a network interface, and \fIport\fP is either a port number or service name (as listed in \fB/etc/services\fP). .sp If \fIhost\fP is missing, 0.0.0.0 (all interfaces) is assumed. Use localhost or 127.0.0.1 to restrict access, i.e. when a proxy on the same host is front\-ending Cyrus. .sp Note that on most systems UNIX socket paths are limited to around 100 characters. See your system documentation for specifics. .UNINDENT .UNINDENT .sp .nf \fBproto=\fPtcp .fi .INDENT 0.0 .INDENT 3.5 The protocol used for this service (\fItcp\fP, \fItcp4\fP, \fItcp6\fP, \fIudp\fP, \fIudp4\fP, \fIudp6\fP). This string argument is optional. .sp \fBtcp4\fP, \fBudp4\fP: These arguments are used to bind the service to IPv4 only. .sp \fBtcp6\fP, \fBudp6\fP: These arguments are used to bind the service to IPv6 only, if the operating system supports this. .sp \fBtcp\fP, \fBudp\fP: These arguments are used to bind to both IPv4 and IPv6 if possible. .UNINDENT .UNINDENT .sp .nf \fBprefork=\fP0 .fi .INDENT 0.0 .INDENT 3.5 The number of instances of this service to always have running and waiting for a connection (for faster initial response time). This integer value is optional. Note that if you are listening on multiple network types (i.e. ipv4 and ipv6) then one process will be forked for each address, causing twice as many processes as you might expect. .UNINDENT .UNINDENT .sp .nf \fBmaxchild=\fP\-1 .fi .INDENT 0.0 .INDENT 3.5 The maximum number of instances of this service to spawn. A value of \-1 means unlimited. This integer value is optional. .UNINDENT .UNINDENT .sp .nf \fBmaxfds=\fP256 .fi .INDENT 0.0 .INDENT 3.5 The maximum number of file descriptors to which to limit this process. This integer value is optional. .UNINDENT .UNINDENT .sp .nf \fBmaxforkrate=\fP0 .fi .INDENT 0.0 .INDENT 3.5 Maximum number of processes to fork per second \- the master will insert sleeps to ensure it doesn\(aqt fork faster than this on average. .UNINDENT .UNINDENT .SS EVENTS .sp This section lists processes that should be run at specific intervals, similar to cron jobs. This section is typically used to perform scheduled cleanup/maintenance. .sp .nf \fBcmd=\fP .fi .INDENT 0.0 .INDENT 3.5 The command (with options) to spawn as a child process. This string argument is required. .UNINDENT .UNINDENT .sp .nf \fBperiod=\fP0 .fi .INDENT 0.0 .INDENT 3.5 The interval (in minutes) at which to run the command. This integer value is optional, but SHOULD be a positive integer > 10. .UNINDENT .UNINDENT .sp .nf \fBat=\fP .fi .INDENT 0.0 .INDENT 3.5 The time (24\-hour format) at which to run the command each day. If set to a valid time (0000\-2359), period is automatically set to 1440. This string argument is optional. .UNINDENT .UNINDENT .SS DAEMON .sp This section lists long running daemons to start before any \fBSERVICES\fP are spawned. master(8) will ensure that these processes are running, restarting any process which dies or forks. All listed processes will be shutdown when master(8) is exiting. .sp .nf \fBcmd=\fP .fi .INDENT 0.0 .INDENT 3.5 The command (with options) to spawn as a child process. This string argument is required. .UNINDENT .UNINDENT .SH EXAMPLES .sp .nf # example cyrus.conf START { recover cmd="ctl_cyrusdb \-r" } SERVICES { imap cmd="imapd" listen="imap" prefork=1 imaps cmd="imapd \-s" listen="imaps" prefork=0 lmtpunix cmd="lmtpd" listen="/var/imap/socket/lmtp" lmtp cmd="lmtpd" listen="localhost:lmtp" } EVENTS { checkpoint cmd="ctl_cyrusdb \-c" period=30 delprune cmd="cyr_expire \-E 3" at=0400 tlsprune cmd="tls_prune" at=0400 } DAEMON { idled cmd="idled" } .fi .SH ACCESS CONTROL .sp When TCP Wrappers is used to control access to Cyrus services, the \fIname\fP of the service entry should be used as the process name in the \fBhosts_access(5)\fP table. For instance, in the example above, "imap", "imaps", "lmtpunix" and "lmtp" would be used as the process names. This allows a single daemon such as imapd to be run in different modes or configurations (i.e., SSL and non\-SSL enabled) yet still have separate access control rules. .SH SEE ALSO .sp master(8), imapd(8), pop3d(8), lmtpd(8), smmapd(8), timsieved(8), idled(8), notifyd(8), ctl_cyrusdb(8), ctl_deliver(8), tls_prune(8), \fBhosts_access(5)\fP .SH AUTHOR The Cyrus Team, Nic Bernstein (Onlight) .SH COPYRIGHT 1993-2018, The Cyrus Team .\" Generated by docutils manpage writer. .