Control Files

From Qmail-LDAP Wiki

Contents 1 Control Files 2 Minimum Setup 3 THE CONTROL FILES TABLE 3.1 Control Files Table 3.2 Control Files Table Grouped By Programs

Control Files

You can change the behavior of the qmail-ldap system by modifying the control files in /var/qmail/control.

qmail-ldap has 66 control files and usually requires the addition of at least 4 config files as a minimum set-up (see Minimum Setup, below).

Minimum Setup

qmail-ldap can, in theory, survive with only two control files:

• me: containing the fully-qualified name of the current host. This file is used as the default for other hostname-related control files.
• ldapserver: the address(es) of the LDAP server(s)

But a qmail-ldap set up with only these two files present is very unlikely to work. In most cases, a minimum setup requires the following additional files:

• ldaplogin: the dn used to login on the LDAP server, that has read permissions to all the related entries stored in the directory.
• ldappassword: the password used in conjuction of ldaplogin, to login on the LDAP server.

Without the above files set up, auth_imap, auth_pop, auth_smtp, qmail-lspawn, qmail-verify could not access the LDAP directory, unless the directory grants read permission for anonymous access over all the related entries, which is not usual (nor recommended).

Not required but strongly recommended is the setup of the following files:

• ldapbasedn: a dn specifying a branch of the DIT where the searches will be made.
• ldapobjectclass: The LDAP object class the search will be limited to. Usually set to "qmailUser", indentifies the entries of the DIT that are of interest of qmail-ldap.
• ldapuid: The system user id your virtual users are mapped to. qmail-ldap will use this UID when delivering-retrieving the messages to/from the Maildirs/Mailboxes.
• ldapgid: A system GID to perform the same as ldapuid.

Finally, after setting up these eight files, you will have a Qmail-ldap with it's minimum capabilities enabled. Then you can start setting up the additional features controlled by the remaining control files.

THE CONTROL FILES TABLE

The following table lists all control files other than me.

In qmail-ldap some control files are used by one program exclusively, and some of them are used by up to five programs.

Notice the "overriden" column showing that some files can be overridden by other files, by attributes defined in the directory entries and by environment(ENV) variables.

Control Files Table

control file	default	overriden by	used by
aliasempty	./Maildir/	defaultdelivery	runscripts
badmailfrom	(none)	(none)	qmail-smtpd
badmailfrom-unknown	(none)	(none)	qmail-smtpd
badmailpatterns	(none)	(none)	qmail-smtpd
badrcptto	(none)	(none)	qmail-smtpd
bigbrother	(none)	(none)	qmail-queue
bouncefrom	MAILER-DAEMON	(none)	qmail-send
bouncehost	me	(none)	qmail-send
bouncemaxbytes	unlimited	(none)	qmail-send
cert.pem	(none)	(none)	runscripts
concurrencylocal	10	(none)	qmail-send
concurrencyremote	20	(none)	qmail-send
custombouncetext	NULL	(none)	qmail-send
databytes	0	(none)	qmail-smtpd
defaultdelivery	./Maildir	(none)	runscripts
defaultdomain	me	(none)	qmail-inject
defaulthost	me	(none)	qmail-inject
defaultquotacount	unlimited	LDAP_QUOTA_COUNT	auth_imap, auth_pop, qmail-lspawn
defaultquotasize	unlimited	LDAP_QUOTA_SIZE	auth_imap, auth_pop, qmail-lspawn
dirmaker	off	(none)	auth_imap, auth_pop, qmail-lspawn
doublebouncehost	me	(none)	qmail-send
doublebounceto	postmaster	(none)	qmail-send
envnoathost	me	(none)	qmail-send
goodmailaddr	(none)	(none)	qmail-smtpd
helohost	me	(none)	qmail-remote
idhost	me	(none)	qmail-inject
ldapbasedn	NULL	(none)	auth_imap, auth_pop, auth_smtp, qmail-group, qmail-lspawn, qmail-verify
ldapcluster	off	(none)	auth_imap, auth_pop, qmail-group, qmail-lspawn
ldapclusterhosts	me	(none)	auth_imap, auth_pop, qmail-group, qmail-lspawn
ldapdefaultdotmode	ldaponly	(none)	auth_imap, auth_pop, qmail-group, qmail-lspawn
ldapgrouplogin	ldaplogin	(none)	qmail-group
ldapgrouppassword	NULL	(none)	qmail-group
ldapgid	NULL	LDAP_QMAILGID	auth_imap, auth_pop, qmail-group, qmail-lspawn
ldapmessagestore	NULL	LDAP_MAILSTORE	auth_imap, auth_pop, qmail-group, qmail-lspawn
ldaprebind	off	(none)	auth_imap, auth_pop, auth_smtp
ldaplocaldelivery	on	(none)	auth_imap, auth_pop, qmail-group, qmail-lspawn
ldaplogin	NULL	(none)	auth_imap, auth_pop, auth_smtp, qmail-group, qmail-lspawn, qmail-verify
ldapobjectclass	NULL	(none)	auth_imap, auth_pop, auth_smtp, qmail-group, qmail-lspawn, qmail-verify
ldappassword	NULL	(none)	auth_imap, auth_pop, auth_smtp, qmail-group, qmail-lspawn, qmail-verify
ldapserver	(none)	(none)	auth_imap, auth_pop, auth_smtp, qmail-group, qmail-lspawn, qmail-verify
ldaptimeout	30	(none)	auth_imap, auth_pop, auth_smtp, qmail-group, qmail-lspawn, qmail-verify
ldapuid	NULL	LDAP_QMAILUID	auth_imap, auth_pop, qmail-group, qmail-lspawn
localiphost	me	(none)	qmail-smtpd
locals	me	locals.cdb	qmail-send, qmail-smtpd
locals.cdb	(none)	(none)	qmail-send, qmail-smtpd
morercpthosts	(none)	(none)	qmail-smtpd
outgoingip	0.0.0.0(any)	(none)	qmail-remote
percenthack	(none)	(none)	qmail-send
plusdomain	me	(none)	qmail-inject
qmqpcip	0.0.0.0(any)	(none)	qmail-qmqpc
qmqpservers	(none)	(none)	qmail-qmqpc
queuelifetime	604800	(none)	qmail-send
quotawarning	NULL	(none)	qmail-quotawarn
rbllist	(none)	(none)	qmail-smtpd
rcpthosts	(none)	rcpthosts.cdb	qmail-smtpd
rcpthosts.cdb	(none)	(none)	qmail-smtpd
relaymailfrom	(none)	ENV_RBLONLYHEADER	qmail-smtpd
remotecert	(none)	(none)	qmail-remote
smtpcert	(none)	ENV_SSLCERT	qmail-smtpd
smtpclustercookie	(none)	(none)	qmail-remote
smtpgreeting	me	(none)	qmail-smtpd
smtproutes	(none)	outgoingip	qmail-remote
timeoutconnect	60	(none)	qmail-remote
timeoutremote	1200	(none)	qmail-remote
timeoutsmtpd	1200	(none)	qmail-smtpd
virtualdomains	(none)	(none)	qmail-send

Control Files Table Grouped By Programs

=> See also the control files grouped by programs.