1 # $Cambridge: exim/src/src/EDITME,v 1.27 2010/06/12 15:21:25 jetmore Exp $
3 ##################################################
4 # The Exim mail transport agent #
5 ##################################################
7 # This is the template for Exim's main build-time configuration file. It
8 # contains settings that are independent of any operating system. These are
9 # things that are mostly sysadmin choices. The items below are divided into
10 # those you must specify, those you probably want to specify, those you might
11 # often want to specify, and those that you almost never need to mention.
13 # Edit this file and save the result to a file called Local/Makefile within the
14 # Exim distribution directory before running the "make" command.
16 # Things that depend on the operating system have default settings in
17 # OS/Makefile-Default, but these are overridden for some OS by files called
18 # called OS/Makefile-<osname>. You can further override these by creating files
19 # called Local/Makefile-<osname>, where "<osname>" stands for the name of your
20 # operating system - look at the names in the OS directory to see which names
23 # However, if you are building Exim for a single OS only, you don't need to
24 # worry about setting up Local/Makefile-<osname>. Any build-time configuration
25 # settings you require can in fact be placed in the one file called
26 # Local/Makefile. It is only if you are building for several OS from the same
27 # source files that you need to worry about splitting off your own OS-dependent
28 # settings into separate files. (There's more explanation about how this all
29 # works in the toplevel README file, under "Modifying the building process", as
30 # well as in the Exim specification.)
32 # One OS-specific thing that may need to be changed is the command for running
33 # the C compiler; the overall default is gcc, but some OS Makefiles specify cc.
34 # You can override anything that is set by putting CC=whatever in your
37 # NOTE: You should never need to edit any of the distributed Makefiles; all
38 # overriding can be done in your Local/Makefile(s). This will make it easier
39 # for you when the next release comes along.
41 # The location of the X11 libraries is something else that is quite variable
42 # even between different versions of the same operating system (and indeed
43 # there are different versions of X11 as well, of course). The four settings
44 # concerned here are X11, XINCLUDE, XLFLAGS (linking flags) and X11_LD_LIB
45 # (dynamic run-time library). You need not worry about X11 unless you want to
46 # compile the Exim monitor utility. Exim itself does not use X11.
48 # Another area of variability between systems is the type and location of the
49 # DBM library package. Exim has support for ndbm, gdbm, tdb, and Berkeley DB.
50 # By default the code assumes ndbm; this often works with gdbm or DB, provided
51 # they are correctly installed, via their compatibility interfaces. However,
52 # Exim can also be configured to use the native calls for Berkeley DB (obsolete
53 # versions 1.85, 2.x, 3.x, or the current 4.x version) and also for gdbm.
55 # For some operating systems, a default DBM library (other than ndbm) is
56 # selected by a setting in the OS-specific Makefile. Most modern OS now have
57 # a DBM library installed as standard, and in many cases this will be selected
58 # for you by the OS-specific configuration. If Exim compiles without any
59 # problems, you probably do not have to worry about the DBM library. If you
60 # do want or need to change it, you should first read the discussion in the
61 # file doc/dbm.discuss.txt, which also contains instructions for testing Exim's
62 # interface to the DBM library.
64 # In Local/Makefiles blank lines and lines starting with # are ignored. It is
65 # also permitted to use the # character to add a comment to a setting, for
68 # EXIM_GID=42 # the "mail" group
70 # However, with some versions of "make" this works only if there is no white
71 # space between the end of the setting and the #, so perhaps it is best
72 # avoided. A consequence of this facility is that it is not possible to have
73 # the # character present in any setting, but I can't think of any cases where
74 # this would be wanted.
75 ###############################################################################
79 ###############################################################################
80 # THESE ARE THINGS YOU MUST SPECIFY #
81 ###############################################################################
83 # Exim will not build unless you specify BIN_DIRECTORY, CONFIGURE_FILE, and
84 # EXIM_USER. You also need EXIM_GROUP if EXIM_USER specifies a uid by number.
86 # If you don't specify SPOOL_DIRECTORY, Exim won't fail to build. However, it
87 # really is a very good idea to specify it here rather than at run time. This
88 # is particularly true if you let the logs go to their default location in the
89 # spool directory, because it means that the location of the logs is known
90 # before Exim has read the run time configuration file.
92 #------------------------------------------------------------------------------
93 # BIN_DIRECTORY defines where the exim binary will be installed by "make
94 # install". The path is also used internally by Exim when it needs to re-invoke
95 # itself, either to send an error message, or to recover root privilege. Exim's
96 # utility binaries and scripts are also installed in this directory. There is
97 # no "standard" place for the binary directory. Some people like to keep all
98 # the Exim files under one directory such as /usr/exim; others just let the
99 # Exim binaries go into an existing directory such as /usr/sbin or
100 # /usr/local/sbin. The installation script will try to create this directory,
101 # and any superior directories, if they do not exist.
103 BIN_DIRECTORY=/usr/exim/bin
106 #------------------------------------------------------------------------------
107 # CONFIGURE_FILE defines where Exim's run time configuration file is to be
108 # found. It is the complete pathname for the file, not just a directory. The
109 # location of all other run time files and directories can be changed in the
110 # run time configuration file. There is a lot of variety in the choice of
111 # location in different OS, and in the preferences of different sysadmins. Some
112 # common locations are in /etc or /etc/mail or /usr/local/etc or
113 # /usr/local/etc/mail. Another possibility is to keep all the Exim files under
114 # a single directory such as /usr/exim. Whatever you choose, the installation
115 # script will try to make the directory and any superior directories if they
116 # don't exist. It will also install a default runtime configuration if this
117 # file does not exist.
119 CONFIGURE_FILE=/usr/exim/configure
121 # It is possible to specify a colon-separated list of files for CONFIGURE_FILE.
122 # In this case, Exim will use the first of them that exists when it is run.
123 # However, if a list is specified, the installation script no longer tries to
124 # make superior directories or to install a default runtime configuration.
127 #------------------------------------------------------------------------------
128 # The Exim binary must normally be setuid root, so that it starts executing as
129 # root, but (depending on the options with which it is called) it does not
130 # always need to retain the root privilege. These settings define the user and
131 # group that is used for Exim processes when they no longer need to be root. In
132 # particular, this applies when receiving messages and when doing remote
133 # deliveries. (Local deliveries run as various non-root users, typically as the
134 # owner of a local mailbox.) Specifying these values as root is not supported.
138 # If you specify EXIM_USER as a name, this is looked up at build time, and the
139 # uid number is built into the binary. However, you can specify that this
140 # lookup is deferred until runtime. In this case, it is the name that is built
141 # into the binary. You can do this by a setting of the form:
145 # In other words, put "ref:" in front of the user name. If you set EXIM_USER
146 # like this, any value specified for EXIM_GROUP is also passed "by reference".
147 # Although this costs a bit of resource at runtime, it is convenient to use
148 # this feature when building binaries that are to be run on multiple systems
149 # where the name may refer to different uids. It also allows you to build Exim
150 # on a system where there is no Exim user defined.
152 # If the setting of EXIM_USER is numeric (e.g. EXIM_USER=42), there must
153 # also be a setting of EXIM_GROUP. If, on the other hand, you use a name
154 # for EXIM_USER (e.g. EXIM_USER=exim), you don't need to set EXIM_GROUP unless
155 # you want to use a group other than the default group for the given user.
159 # Many sites define a user called "exim", with an appropriate default group,
164 # while leaving EXIM_GROUP unspecified (commented out).
167 #------------------------------------------------------------------------------
168 # SPOOL_DIRECTORY defines the directory where all the data for messages in
169 # transit is kept. It is strongly recommended that you define it here, though
170 # it is possible to leave this till the run time configuration.
172 # Exim creates the spool directory if it does not exist. The owner and group
173 # will be those defined by EXIM_USER and EXIM_GROUP, and this also applies to
174 # all the files and directories that are created in the spool directory.
176 # Almost all installations choose this:
178 SPOOL_DIRECTORY=/var/spool/exim
182 ###############################################################################
183 # THESE ARE THINGS YOU PROBABLY WANT TO SPECIFY #
184 ###############################################################################
186 # If you need extra header file search paths on all compiles, put the -I
187 # options in INCLUDE. If you want the extra searches only for certain
188 # parts of the build, see more specific xxx_INCLUDE variables below.
190 # INCLUDE=-I/example/include
192 # You need to specify some routers and transports if you want the Exim that you
193 # are building to be capable of delivering mail. You almost certainly need at
194 # least one type of lookup. You should consider whether you want to build
195 # the Exim monitor or not.
198 #------------------------------------------------------------------------------
199 # These settings determine which individual router drivers are included in the
200 # Exim binary. There are no defaults in the code; those routers that are wanted
201 # must be defined here by setting the appropriate variables to the value "yes".
202 # Including a router in the binary does not cause it to be used automatically.
203 # It has also to be configured in the run time configuration file. By
204 # commenting out those you know you don't want to use, you can make the binary
205 # a bit smaller. If you are unsure, leave all of these included for now.
210 ROUTER_MANUALROUTE=yes
211 ROUTER_QUERYPROGRAM=yes
214 # This one is very special-purpose, so is not included by default.
216 # ROUTER_IPLOOKUP=yes
219 #------------------------------------------------------------------------------
220 # These settings determine which individual transport drivers are included in
221 # the Exim binary. There are no defaults; those transports that are wanted must
222 # be defined here by setting the appropriate variables to the value "yes".
223 # Including a transport in the binary does not cause it to be used
224 # automatically. It has also to be configured in the run time configuration
225 # file. By commenting out those you know you don't want to use, you can make
226 # the binary a bit smaller. If you are unsure, leave all of these included for
229 TRANSPORT_APPENDFILE=yes
230 TRANSPORT_AUTOREPLY=yes
234 # This one is special-purpose, and commonly not required, so it is not
235 # included by default.
240 #------------------------------------------------------------------------------
241 # The appendfile transport can write messages to local mailboxes in a number
242 # of formats. The code for three specialist formats, maildir, mailstore, and
243 # MBX, is included only when requested. If you do not know what this is about,
244 # leave these settings commented out.
246 # SUPPORT_MAILDIR=yes
247 # SUPPORT_MAILSTORE=yes
251 #------------------------------------------------------------------------------
252 # These settings determine which file and database lookup methods are included
253 # in the binary. See the manual chapter entitled "File and database lookups"
254 # for discussion. DBM and lsearch (linear search) are included by default. If
255 # you are unsure about the others, leave them commented out for now.
256 # LOOKUP_DNSDB does *not* refer to general mail routing using the DNS. It is
257 # for the specialist case of using the DNS as a general database facility (not
277 # These two settings are obsolete; all three lookups are compiled when
278 # LOOKUP_LSEARCH is enabled. However, we retain these for backward
279 # compatibility. Setting one forces LOOKUP_LSEARCH if it is not set.
281 # LOOKUP_WILDLSEARCH=yes
282 # LOOKUP_NWILDLSEARCH=yes
285 #------------------------------------------------------------------------------
286 # If you have set LOOKUP_LDAP=yes, you should set LDAP_LIB_TYPE to indicate
287 # which LDAP library you have. Unfortunately, though most of their functions
288 # are the same, there are minor differences. Currently Exim knows about four
289 # LDAP libraries: the one from the University of Michigan (also known as
290 # OpenLDAP 1), OpenLDAP 2, the Netscape SDK library, and the library that comes
291 # with Solaris 7 onwards. Uncomment whichever of these you are using.
293 # LDAP_LIB_TYPE=OPENLDAP1
294 # LDAP_LIB_TYPE=OPENLDAP2
295 # LDAP_LIB_TYPE=NETSCAPE
296 # LDAP_LIB_TYPE=SOLARIS
298 # If you don't set any of these, Exim assumes the original University of
299 # Michigan (OpenLDAP 1) library.
302 #------------------------------------------------------------------------------
303 # The PCRE library is required for exim. There is no longer an embedded
304 # version of the PCRE library included with the source code, instead you
305 # must use a system library or build your own copy of PCRE.
306 # In either case you must specify the library link info here. If the
307 # PCRE header files are not in the standard search path you must also
308 # modify the INCLUDE path (above)
309 # The default setting of PCRE_LIBS should work on the vast majority of
315 #------------------------------------------------------------------------------
316 # Additional libraries and include directories may be required for some
317 # lookup styles (e.g. LDAP, MYSQL or PGSQL). LOOKUP_LIBS is included only on
318 # the command for linking Exim itself, not on any auxiliary programs. You
319 # don't need to set LOOKUP_INCLUDE if the relevant directories are already
320 # specified in INCLUDE. The settings below are just examples; -lpq is for
321 # PostgreSQL, -lgds is for Interbase, -lsqlite3 is for SQLite.
323 # LOOKUP_INCLUDE=-I /usr/local/ldap/include -I /usr/local/mysql/include -I /usr/local/pgsql/include
324 # LOOKUP_LIBS=-L/usr/local/lib -lldap -llber -lmysqlclient -lpq -lgds -lsqlite3
327 #------------------------------------------------------------------------------
328 # Compiling the Exim monitor: If you want to compile the Exim monitor, a
329 # program that requires an X11 display, then EXIM_MONITOR should be set to the
330 # value "eximon.bin". Comment out this setting to disable compilation of the
331 # monitor. The locations of various X11 directories for libraries and include
332 # files are defaulted in the OS/Makefile-Default file, but can be overridden in
333 # local OS-specific make files.
335 EXIM_MONITOR=eximon.bin
338 #------------------------------------------------------------------------------
339 # Compiling Exim with content scanning support: If you want to compile Exim
340 # with support for message body content scanning, set WITH_CONTENT_SCAN to
341 # the value "yes". This will give you malware and spam scanning in the DATA ACL,
342 # and the MIME ACL. Please read the documentation to learn more about these
345 # WITH_CONTENT_SCAN=yes
347 # If you want to use the deprecated "demime" condition in the DATA ACL,
348 # uncomment the line below. Doing so will also explicitly turn on the
349 # WITH_CONTENT_SCAN option. If possible, use the MIME ACL instead of
350 # the "demime" condition.
352 # WITH_OLD_DEMIME=yes
354 # If you're using ClamAV and are backporting fixes to an old version, instead
355 # of staying current (which is the more usual approach) then you may need to
356 # use an older API which uses a STREAM command, now deprecated, instead of
357 # zINSTREAM. If you need to set this, please let the Exim developers know, as
358 # if nobody reports a need for it, we'll remove this option and clean up the
359 # code. zINSTREAM was introduced with ClamAV 0.95.
361 # WITH_OLD_CLAMAV_STREAM=yes
363 #------------------------------------------------------------------------------
364 # By default Exim includes code to support DKIM (DomainKeys Identified
365 # Mail, RFC4871) signing and verification. Verification of signatures is
366 # turned on by default. See the spec for information on conditionally
367 # disabling it. To disable the inclusion of the entire feature, set
368 # DISABLE_DKIM to "yes"
373 #------------------------------------------------------------------------------
374 # Compiling Exim with experimental features. These are documented in
375 # experimental-spec.txt. "Experimental" means that the way these features are
376 # implemented may still change. Backward compatibility is not guaranteed.
378 # Uncomment the following lines to add SPF support. You need to have libspf2
379 # installed on your system (www.libspf2.org). Depending on where it is installed
380 # you may have to edit the CFLAGS and LDFLAGS lines.
382 # EXPERIMENTAL_SPF=yes
383 # CFLAGS += -I/usr/local/include
386 # Uncomment the following lines to add SRS (Sender rewriting scheme) support.
387 # You need to have libsrs_alt installed on your system (srs.mirtol.com).
388 # Depending on where it is installed you may have to edit the CFLAGS and
391 # EXPERIMENTAL_SRS=yes
392 # CFLAGS += -I/usr/local/include
393 # LDFLAGS += -lsrs_alt
395 # Uncomment the following lines to add Brightmail AntiSpam support. You need
396 # to have the Brightmail client SDK installed. Please check the experimental
397 # documentation for implementation details. You need to edit the CFLAGS and
400 # EXPERIMENTAL_BRIGHTMAIL=yes
401 # CFLAGS += -I/opt/brightmail/bsdk-6.0/include
402 # LDFLAGS += -lxml2_single -lbmiclient_single -L/opt/brightmail/bsdk-6.0/lib
406 ###############################################################################
407 # THESE ARE THINGS YOU MIGHT WANT TO SPECIFY #
408 ###############################################################################
410 # The items in this section are those that are commonly changed according to
411 # the sysadmin's preferences, but whose defaults are often acceptable. The
412 # first five are concerned with security issues, where differing levels of
413 # paranoia are appropriate in different environments. Sysadmins also vary in
414 # their views on appropriate levels of defence in these areas. If you do not
415 # understand these issues, go with the defaults, which are used by many sites.
418 #------------------------------------------------------------------------------
419 # Although Exim is normally a setuid program, owned by root, it refuses to run
420 # local deliveries as root by default. There is a runtime option called
421 # "never_users" which lists the users that must never be used for local
422 # deliveries. There is also the setting below, which provides a list that
423 # cannot be overridden at runtime. This guards against problems caused by
424 # unauthorized changes to the runtime configuration. You are advised not to
425 # remove "root" from this option, but you can add other users if you want. The
426 # list is colon-separated. It must NOT contain any spaces.
428 # FIXED_NEVER_USERS=root:bin:daemon
429 FIXED_NEVER_USERS=root
432 #------------------------------------------------------------------------------
433 # By default, Exim insists that its configuration file be owned by root. You
434 # can specify one additional permitted owner here.
438 # If the configuration file is group-writeable, Exim insists by default that it
439 # is owned by root. You can specify one additional permitted group owner here.
443 # If you specify CONFIGURE_OWNER or CONFIGURE_GROUP as a name, this is looked
444 # up at build time, and the uid or gid number is built into the binary.
445 # However, you can specify that the lookup is deferred until runtime. In this
446 # case, it is the name that is built into the binary. You can do this by a
447 # setting of the form:
449 # CONFIGURE_OWNER=ref:mail
450 # CONFIGURE_GROUP=ref:sysadmin
452 # In other words, put "ref:" in front of the user or group name. Although this
453 # costs a bit of resource at runtime, it is convenient to use this feature when
454 # building binaries that are to be run on multiple systems where the names may
455 # refer to different uids or gids. It also allows you to build Exim on a system
456 # where the relevant user or group is not defined.
459 #------------------------------------------------------------------------------
460 # The -C option allows Exim to be run with an alternate runtime configuration
461 # file. When this is used by root or the Exim user, root privilege is retained
462 # by the binary (for any other caller, it is dropped). You can restrict the
463 # location of alternate configurations by defining a prefix below. Any file
464 # used with -C must then start with this prefix (except that /dev/null is also
465 # permitted if the caller is root, because that is used in the install script).
466 # If the prefix specifies a directory that is owned by root, a compromise of
467 # the Exim account does not permit arbitrary alternate configurations to be
468 # used. The prefix can be more restrictive than just a directory (the second
471 # ALT_CONFIG_PREFIX=/some/directory/
472 # ALT_CONFIG_PREFIX=/some/directory/exim.conf-
475 #------------------------------------------------------------------------------
476 # If you uncomment the following line, only root may use the -C or -D options
477 # without losing root privilege. The -C option specifies an alternate runtime
478 # configuration file, and the -D option changes macro values in the runtime
479 # configuration. Uncommenting this line restricts what can be done with these
480 # options. A call to receive a message (either one-off or via a daemon) cannot
481 # successfully continue to deliver it, because the re-exec of Exim to regain
482 # root privilege will fail, owing to the use of -C or -D by the Exim user.
483 # However, you can still use -C for testing (as root) if you do separate Exim
484 # calls for receiving a message and subsequently delivering it.
486 # ALT_CONFIG_ROOT_ONLY=yes
489 #------------------------------------------------------------------------------
490 # Uncommenting this option disables the use of the -D command line option,
491 # which changes the values of macros in the runtime configuration file.
492 # This is another protection against somebody breaking into the Exim account.
494 # DISABLE_D_OPTION=yes
497 #------------------------------------------------------------------------------
498 # Exim has support for the AUTH (authentication) extension of the SMTP
499 # protocol, as defined by RFC 2554. If you don't know what SMTP authentication
500 # is, you probably won't want to include this code, so you should leave these
501 # settings commented out. If you do want to make use of SMTP authentication,
502 # you must uncomment at least one of the following, so that appropriate code is
503 # included in the Exim binary. You will then need to set up the run time
504 # configuration to make use of the mechanism(s) selected.
507 # AUTH_CYRUS_SASL=yes
513 #------------------------------------------------------------------------------
514 # If you specified AUTH_CYRUS_SASL above, you should ensure that you have the
515 # Cyrus SASL library installed before trying to build Exim, and you probably
516 # want to uncomment the following line:
521 #------------------------------------------------------------------------------
522 # When Exim is decoding MIME "words" in header lines, most commonly for use
523 # in the $header_xxx expansion, it converts any foreign character sets to the
524 # one that is set in the headers_charset option. The default setting is
525 # defined by this setting:
527 HEADERS_CHARSET="ISO-8859-1"
529 # If you are going to make use of $header_xxx expansions in your configuration
530 # file, or if your users are going to use them in filter files, and the normal
531 # character set on your host is something other than ISO-8859-1, you might
532 # like to specify a different default here. This value can be overridden in
533 # the runtime configuration, and it can also be overridden in individual filter
536 # IMPORTANT NOTE: The iconv() function is needed for character code
537 # conversions. Please see the next item...
540 #------------------------------------------------------------------------------
541 # Character code conversions are possible only if the iconv() function is
542 # installed on your operating system. There are two places in Exim where this
543 # is relevant: (a) The $header_xxx expansion (see the previous item), and (b)
544 # the Sieve filter support. For those OS where iconv() is known to be installed
545 # as standard, the file in OS/Makefile-xxxx contains
549 # If you are not using one of those systems, but have installed iconv(), you
550 # need to uncomment that line above. In some cases, you may find that iconv()
551 # and its header file are not in the default places. You might need to use
552 # something like this:
555 # CFLAGS=-O -I/usr/local/include
556 # EXTRALIBS_EXIM=-L/usr/local/lib -liconv
558 # but of course there may need to be other things in CFLAGS and EXTRALIBS_EXIM
562 #------------------------------------------------------------------------------
563 # The passwords for user accounts are normally encrypted with the crypt()
564 # function. Comparisons with encrypted passwords can be done using Exim's
565 # "crypteq" expansion operator. (This is commonly used as part of the
566 # configuration of an authenticator for use with SMTP AUTH.) At least one
567 # operating system has an extended function called crypt16(), which uses up to
568 # 16 characters of a password (the normal crypt() uses only the first 8). Exim
569 # supports the use of crypt16() as well as crypt() but note the warning below.
571 # You can always indicate a crypt16-encrypted password by preceding it with
572 # "{crypt16}". If you want the default handling (without any preceding
573 # indicator) to use crypt16(), uncomment the following line:
575 # DEFAULT_CRYPT=crypt16
577 # If you do that, you can still access the basic crypt() function by preceding
578 # an encrypted password with "{crypt}". For more details, see the description
579 # of the "crypteq" condition in the manual chapter on string expansions.
581 # Some operating systems do not include a crypt16() function, so Exim has one
582 # of its own, which it uses unless HAVE_CRYPT16 is defined. Normally, that will
583 # be set in an OS-specific Makefile for the OS that have such a function, so
584 # you should not need to bother with it.
586 # *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING ***
587 # It turns out that the above is not entirely accurate. As well as crypt16()
588 # there is a function called bigcrypt() that some operating systems have. This
589 # may or may not use the same algorithm, and both of them may be different to
590 # Exim's built-in crypt16() that is used unless HAVE_CRYPT16 is defined.
592 # However, since there is now a move away from the traditional crypt()
593 # functions towards using SHA1 and other algorithms, tidying up this area of
594 # Exim is seen as very low priority. In practice, if you need to, you can
595 # define DEFAULT_CRYPT to the name of any function that has the same interface
596 # as the traditional crypt() function.
597 # *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING ***
600 #------------------------------------------------------------------------------
601 # Exim can be built to support the SMTP STARTTLS command, which implements
602 # Transport Layer Security using SSL (Secure Sockets Layer). To do this, you
603 # must install the OpenSSL library package or the GnuTLS library. Exim contains
604 # no cryptographic code of its own. Uncomment the following lines if you want
605 # to build Exim with TLS support. If you don't know what this is all about,
606 # leave these settings commented out.
608 # This setting is required for any TLS support (either OpenSSL or GnuTLS)
611 # Uncomment this setting if you are using OpenSSL
612 # TLS_LIBS=-lssl -lcrypto
614 # Uncomment these settings if you are using GnuTLS
616 # TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
618 # If you are running Exim as a server, note that just building it with TLS
619 # support is not all you need to do. You also need to set up a suitable
620 # certificate, and tell Exim about it by means of the tls_certificate
621 # and tls_privatekey run time options. You also need to set tls_advertise_hosts
622 # to specify the hosts to which Exim advertises TLS support. On the other hand,
623 # if you are running Exim only as a client, building it with TLS support
624 # is all you need to do.
626 # Additional libraries and include files are required for both OpenSSL and
627 # GnuTLS. The TLS_LIBS settings above assume that the libraries are installed
628 # with all your other libraries. If they are in a special directory, you may
629 # need something like
631 # TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
633 # TLS_LIBS=-L/opt/gnu/lib -lgnutls -ltasn1 -lgcrypt
635 # TLS_LIBS is included only on the command for linking Exim itself, not on any
636 # auxiliary programs. If the include files are not in a standard place, you can
637 # set TLS_INCLUDE to specify where they are, for example:
639 # TLS_INCLUDE=-I/usr/local/openssl/include/
641 # TLS_INCLUDE=-I/opt/gnu/include
643 # You don't need to set TLS_INCLUDE if the relevant directories are already
644 # specified in INCLUDE.
647 #------------------------------------------------------------------------------
648 # The default distribution of Exim contains only the plain text form of the
649 # documentation. Other forms are available separately. If you want to install
650 # the documentation in "info" format, first fetch the Texinfo documentation
651 # sources from the ftp directory and unpack them, which should create files
652 # with the extension "texinfo" in the doc directory. You may find that the
653 # version number of the texinfo files is different to your Exim version number,
654 # because the main documentation isn't updated as often as the code. For
655 # example, if you have Exim version 4.43, the source tarball upacks into a
656 # directory called exim-4.43, but the texinfo tarball unpacks into exim-4.40.
657 # In this case, move the contents of exim-4.40/doc into exim-4.43/doc after you
658 # have unpacked them. Then set INFO_DIRECTORY to the location of your info
659 # directory. This varies from system to system, but is often /usr/share/info.
660 # Once you have done this, "make install" will build the info files and
661 # install them in the directory you have defined.
663 # INFO_DIRECTORY=/usr/share/info
666 #------------------------------------------------------------------------------
667 # Exim log directory and files: Exim creates several log files inside a
668 # single log directory. You can define the directory and the form of the
669 # log file name here. If you do not set anything, Exim creates a directory
670 # called "log" inside its spool directory (see SPOOL_DIRECTORY above) and uses
671 # the filenames "mainlog", "paniclog", and "rejectlog". If you want to change
672 # this, you can set LOG_FILE_PATH to a path name containing one occurrence of
673 # %s. This will be replaced by one of the strings "main", "panic", or "reject"
674 # to form the final file names. Some installations may want something like this:
676 # LOG_FILE_PATH=/var/log/exim_%slog
678 # which results in files with names /var/log/exim_mainlog, etc. The directory
679 # in which the log files are placed must exist; Exim does not try to create
680 # it for itself. It is also your responsibility to ensure that Exim is capable
681 # of writing files using this path name. The Exim user (see EXIM_USER above)
682 # must be able to create and update files in the directory you have specified.
684 # You can also configure Exim to use syslog, instead of or as well as log
685 # files, by settings such as these
687 # LOG_FILE_PATH=syslog
688 # LOG_FILE_PATH=syslog:/var/log/exim_%slog
690 # The first of these uses only syslog; the second uses syslog and also writes
691 # to log files. Do not include white space in such a setting as it messes up
692 # the building process.
695 #------------------------------------------------------------------------------
696 # When logging to syslog, the following option caters for syslog replacements
697 # that are able to accept log entries longer than the 1024 characters allowed
698 # by RFC 3164. It is up to you to make sure your syslog daemon can handle this.
699 # Non-printable characters are usually unacceptable regardless, so log entries
700 # are still split on newline characters.
702 # SYSLOG_LONG_LINES=yes
704 # If you are not interested in the process identifier (pid) of the Exim that is
705 # making the call to syslog, then comment out the following line.
710 #------------------------------------------------------------------------------
711 # Cycling log files: this variable specifies the maximum number of old
712 # log files that are kept by the exicyclog log-cycling script. You don't have
713 # to use exicyclog. If your operating system has other ways of cycling log
714 # files, you can use them instead. The exicyclog script isn't run by default;
715 # you have to set up a cron job for it if you want it.
720 #------------------------------------------------------------------------------
721 # The compress command is used by the exicyclog script to compress old log
722 # files. Both the name of the command and the suffix that it adds to files
723 # need to be defined here. See also the EXICYCLOG_MAX configuration.
725 COMPRESS_COMMAND=/usr/bin/gzip
729 #------------------------------------------------------------------------------
730 # If the exigrep utility is fed compressed log files, it tries to uncompress
731 # them using this command.
733 ZCAT_COMMAND=/usr/bin/zcat
736 #------------------------------------------------------------------------------
737 # Compiling in support for embedded Perl: If you want to be able to
738 # use Perl code in Exim's string manipulation language and you have Perl
739 # (version 5.004 or later) installed, set EXIM_PERL to perl.o. Using embedded
740 # Perl costs quite a lot of resources. Only do this if you really need it.
745 #------------------------------------------------------------------------------
746 # Support for dynamically-loaded string expansion functions via ${dlfunc. If
747 # you are using gcc the dynamically-loaded object must be compiled with the
748 # -shared option, and you will need to add -export-dynamic to EXTRALIBS so
749 # that the local_scan API is made available by the linker. You may also need
750 # to add -ldl to EXTRALIBS so that dlopen() is available to Exim.
755 #------------------------------------------------------------------------------
756 # Exim has support for PAM (Pluggable Authentication Modules), a facility
757 # which is available in the latest releases of Solaris and in some GNU/Linux
758 # distributions (see http://ftp.kernel.org/pub/linux/libs/pam/). The Exim
759 # support, which is intended for use in conjunction with the SMTP AUTH
760 # facilities, is included only when requested by the following setting:
764 # You probably need to add -lpam to EXTRALIBS, and in some releases of
765 # GNU/Linux -ldl is also needed.
768 #------------------------------------------------------------------------------
769 # Support for authentication via Radius is also available. The Exim support,
770 # which is intended for use in conjunction with the SMTP AUTH facilities,
771 # is included only when requested by setting the following parameter to the
772 # location of your Radius configuration file:
774 # RADIUS_CONFIG_FILE=/etc/radiusclient/radiusclient.conf
775 # RADIUS_CONFIG_FILE=/etc/radius.conf
777 # If you have set RADIUS_CONFIG_FILE, you should also set one of these to
778 # indicate which RADIUS library is used:
780 # RADIUS_LIB_TYPE=RADIUSCLIENT
781 # RADIUS_LIB_TYPE=RADIUSCLIENTNEW
782 # RADIUS_LIB_TYPE=RADLIB
784 # RADIUSCLIENT is the radiusclient library; you probably need to add
785 # -lradiusclient to EXTRALIBS.
787 # The API for the radiusclient library was changed at release 0.4.0.
788 # Unfortunately, the header file does not define a version number that clients
789 # can use to support both the old and new APIs. If you are using version 0.4.0
790 # or later of the radiusclient library, you should use RADIUSCLIENTNEW.
792 # RADLIB is the Radius library that comes with FreeBSD (the header file is
793 # called radlib.h); you probably need to add -lradius to EXTRALIBS.
795 # If you do not set RADIUS_LIB_TYPE, Exim assumes the radiusclient library,
796 # using the original API.
799 #------------------------------------------------------------------------------
800 # Support for authentication via the Cyrus SASL pwcheck daemon is available.
801 # Note, however, that pwcheck is now deprecated in favour of saslauthd (see
802 # next item). The Exim support for pwcheck, which is intented for use in
803 # conjunction with the SMTP AUTH facilities, is included only when requested by
804 # setting the following parameter to the location of the pwcheck daemon's
807 # There is no need to install all of SASL on your system. You just need to run
808 # ./configure --with-pwcheck, cd to the pwcheck directory within the sources,
809 # make and make install. You must create the socket directory (default
810 # /var/pwcheck) and chown it to exim's user and group. Once you have installed
811 # pwcheck, you should arrange for it to be started by root at boot time.
813 # CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
816 #------------------------------------------------------------------------------
817 # Support for authentication via the Cyrus SASL saslauthd daemon is available.
818 # The Exim support, which is intented for use in conjunction with the SMTP AUTH
819 # facilities, is included only when requested by setting the following
820 # parameter to the location of the saslauthd daemon's socket.
822 # There is no need to install all of SASL on your system. You just need to run
823 # ./configure --with-saslauthd (and any other options you need, for example, to
824 # select or deselect authentication mechanisms), cd to the saslauthd directory
825 # within the sources, make and make install. You must create the socket
826 # directory (default /var/state/saslauthd) and chown it to exim's user and
827 # group. Once you have installed saslauthd, you should arrange for it to be
828 # started by root at boot time.
830 # CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
833 #------------------------------------------------------------------------------
834 # TCP wrappers: If you want to use tcpwrappers from within Exim, uncomment
835 # this setting. See the manual section entitled "Use of tcpwrappers" in the
836 # chapter on building and installing Exim.
838 # USE_TCP_WRAPPERS=yes
840 # You may well also have to specify a local "include" file and an additional
841 # library for TCP wrappers, so you probably need something like this:
843 # USE_TCP_WRAPPERS=yes
844 # CFLAGS=-O -I/usr/local/include
845 # EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
847 # but of course there may need to be other things in CFLAGS and EXTRALIBS_EXIM
850 # To use a name other than exim in the tcpwrappers config file,
851 # e.g. if you're running multiple daemons with different access lists,
852 # or multiple MTAs with the same access list, define
853 # TCP_WRAPPERS_DAEMON_NAME accordingly
855 # TCP_WRAPPERS_DAEMON_NAME="exim"
858 #------------------------------------------------------------------------------
859 # The default action of the exim_install script (which is run by "make
860 # install") is to install the Exim binary with a unique name such as
861 # exim-4.43-1, and then set up a symbolic link called "exim" to reference it,
862 # moving the symbolic link from any previous version. If you define NO_SYMLINK
863 # (the value doesn't matter), the symbolic link is not created or moved. You
864 # will then have to "turn Exim on" by setting up the link manually.
869 #------------------------------------------------------------------------------
870 # Another default action of the install script is to install a default runtime
871 # configuration file if one does not exist. This configuration has a router for
872 # expanding system aliases. The default assumes that these aliases are kept
873 # in the traditional file called /etc/aliases. If such a file does not exist,
874 # the installation script creates one that contains just comments (no actual
875 # aliases). The following setting can be changed to specify a different
876 # location for the system alias file.
878 SYSTEM_ALIASES_FILE=/etc/aliases
881 #------------------------------------------------------------------------------
882 # There are some testing options (-be, -bt, -bv) that read data from the
883 # standard input when no arguments are supplied. By default, the input lines
884 # are read using the standard fgets() function. This does not support line
885 # editing during interactive input (though the terminal's "erase" character
886 # works as normal). If your operating system has the readline() function, and
887 # in addition supports dynamic loading of library functions, you can cause
888 # Exim to use readline() for the -be testing option (only) by uncommenting the
889 # following setting. Dynamic loading is used so that the library is loaded only
890 # when the -be testing option is given; by the time the loading occurs,
891 # Exim has given up its root privilege and is running as the calling user. This
892 # is the reason why readline() is NOT supported for -bt and -bv, because Exim
893 # runs as root or as exim, respectively, for those options. When USE_READLINE
894 # is "yes", as well as supporting line editing, a history of input lines in the
895 # current run is maintained.
899 # You may need to add -ldl to EXTRALIBS when you set USE_READLINE=yes.
900 # Note that this option adds to the size of the Exim binary, because the
901 # dynamic loading library is not otherwise included.
905 ###############################################################################
906 # THINGS YOU ALMOST NEVER NEED TO MENTION #
907 ###############################################################################
909 # The settings in this section are available for use in special circumstances.
910 # In the vast majority of installations you need not change anything below.
913 #------------------------------------------------------------------------------
914 # The following commands live in different places in some OS. Either the
915 # ultimate default settings, or the OS-specific files should already point to
916 # the right place, but they can be overridden here if necessary. These settings
917 # are used when building various scripts to ensure that the correct paths are
918 # used when the scripts are run. They are not used in the Makefile itself. Perl
919 # is not necessary for running Exim unless you set EXIM_PERL (see above) to get
920 # it embedded, but there are some utilities that are Perl scripts. If you
921 # haven't got Perl, Exim will still build and run; you just won't be able to
922 # use those utilities.
924 # CHOWN_COMMAND=/usr/bin/chown
925 # CHGRP_COMMAND=/usr/bin/chgrp
926 # CHMOD_COMMAND=/usr/bin/chmod
929 # TOUCH_COMMAND=/usr/bin/touch
930 # PERL_COMMAND=/usr/bin/perl
933 #------------------------------------------------------------------------------
934 # The following macro can be used to change the command for building a library
935 # of functions. By default the "ar" command is used, with options "cq".
936 # Only in rare circumstances should you need to change this.
941 #------------------------------------------------------------------------------
942 # In some operating systems, the value of the TMPDIR environment variable
943 # controls where temporary files are created. Exim does not make use of
944 # temporary files, except when delivering to MBX mailboxes. However, if Exim
945 # calls any external libraries (e.g. DBM libraries), they may use temporary
946 # files, and thus be influenced by the value of TMPDIR. For this reason, when
947 # Exim starts, it checks the environment for TMPDIR, and if it finds it is set,
948 # it replaces the value with what is defined here. Commenting this setting
949 # suppresses the check altogether.
954 #------------------------------------------------------------------------------
955 # The following macros can be used to change the default modes that are used
956 # by the appendfile transport. In most installations the defaults are just
957 # fine, and in any case, you can change particular instances of the transport
958 # at run time if you want.
960 # APPENDFILE_MODE=0600
961 # APPENDFILE_DIRECTORY_MODE=0700
962 # APPENDFILE_LOCKFILE_MODE=0600
965 #------------------------------------------------------------------------------
966 # In some installations there may be multiple machines sharing file systems,
967 # where a different configuration file is required for Exim on the different
968 # machines. If CONFIGURE_FILE_USE_NODE is defined, then Exim will first look
969 # for a configuration file whose name is that defined by CONFIGURE_FILE,
970 # with the node name obtained by uname() tacked on the end, separated by a
971 # period (for example, /usr/exim/configure.host.in.some.domain). If this file
972 # does not exist, then the bare configuration file name is tried.
974 # CONFIGURE_FILE_USE_NODE=yes
977 #------------------------------------------------------------------------------
978 # In some esoteric configurations two different versions of Exim are run,
979 # with different setuid values, and different configuration files are required
980 # to handle the different cases. If CONFIGURE_FILE_USE_EUID is defined, then
981 # Exim will first look for a configuration file whose name is that defined
982 # by CONFIGURE_FILE, with the effective uid tacked on the end, separated by
983 # a period (for eximple, /usr/exim/configure.0). If this file does not exist,
984 # then the bare configuration file name is tried. In the case when both
985 # CONFIGURE_FILE_USE_EUID and CONFIGURE_FILE_USE_NODE are set, four files
986 # are tried: <name>.<euid>.<node>, <name>.<node>, <name>.<euid>, and <name>.
988 # CONFIGURE_FILE_USE_EUID=yes
991 #------------------------------------------------------------------------------
992 # The size of the delivery buffers: These specify the sizes (in bytes) of
993 # the buffers that are used when copying a message from the spool to a
994 # destination. There is rarely any need to change these values.
996 # DELIVER_IN_BUFFER_SIZE=8192
997 # DELIVER_OUT_BUFFER_SIZE=8192
1000 #------------------------------------------------------------------------------
1001 # The mode of the database directory: Exim creates a directory called "db"
1002 # in its spool directory, to hold its databases of hints. This variable
1003 # determines the mode of the created directory. The default value in the
1006 # EXIMDB_DIRECTORY_MODE=0750
1009 #------------------------------------------------------------------------------
1010 # Database file mode: The mode of files created in the "db" directory defaults
1011 # to 0640 in the source, and can be changed here.
1016 #------------------------------------------------------------------------------
1017 # Database lock file mode: The mode of zero-length files created in the "db"
1018 # directory to use for locking purposes defaults to 0640 in the source, and
1019 # can be changed here.
1021 # EXIMDB_LOCKFILE_MODE=0640
1024 #------------------------------------------------------------------------------
1025 # This parameter sets the maximum length of the header portion of a message
1026 # that Exim is prepared to process. The default setting is one megabyte. The
1027 # limit exists in order to catch rogue mailers that might connect to your SMTP
1028 # port, start off a header line, and then just pump junk at it for ever. The
1029 # message_size_limit option would also catch this, but it may not be set.
1030 # The value set here is the default; it can be changed at runtime.
1032 # HEADER_MAXSIZE="(1024*1024)"
1035 #------------------------------------------------------------------------------
1036 # The mode of the input directory: The input directory is where messages are
1037 # kept while awaiting delivery. Exim creates it if necessary, using a mode
1038 # which can be defined here (default 0750).
1040 # INPUT_DIRECTORY_MODE=0750
1043 #------------------------------------------------------------------------------
1044 # The mode of Exim's log directory, when it is created by Exim inside the spool
1045 # directory, defaults to 0750 but can be changed here.
1047 # LOG_DIRECTORY_MODE=0750
1050 #------------------------------------------------------------------------------
1051 # The log files themselves are created as required, with a mode that defaults
1052 # to 0640, but which can be changed here.
1057 #------------------------------------------------------------------------------
1058 # The TESTDB lookup is for performing tests on the handling of lookup results,
1059 # and is not useful for general running. It should be included only when
1060 # debugging the code of Exim.
1065 #------------------------------------------------------------------------------
1066 # /bin/sh is used by default as the shell in which to run commands that are
1067 # defined in the makefiles. This can be changed if necessary, by uncommenting
1068 # this line and specifying another shell, but note that a Bourne-compatible
1069 # shell is expected.
1071 # MAKE_SHELL=/bin/sh
1074 #------------------------------------------------------------------------------
1075 # The maximum number of named lists of each type (address, domain, host, and
1076 # local part) can be increased by changing this value. It should be set to
1082 #------------------------------------------------------------------------------
1083 # Network interfaces: Unless you set the local_interfaces option in the runtime
1084 # configuration file to restrict Exim to certain interfaces only, it will run
1085 # code to find all the interfaces there are on your host. Unfortunately,
1086 # the call to the OS that does this requires a buffer large enough to hold
1087 # data for all the interfaces - it was designed in the days when a host rarely
1088 # had more than three or four interfaces. Nowadays hosts can have very many
1089 # virtual interfaces running on the same hardware. If you have more than 250
1090 # virtual interfaces, you will need to uncomment this setting and increase the
1096 #------------------------------------------------------------------------------
1097 # Per-message logs: While a message is in the process of being delivered,
1098 # comments on its progress are written to a message log, for the benefit of
1099 # human administrators. These logs are held in a directory called "msglog"
1100 # in the spool directory. Its mode defaults to 0750, but can be changed here.
1101 # The message log directory is also used for storing files that are used by
1102 # transports for returning data to a message's sender (see the "return_output"
1103 # option for transports).
1105 # MSGLOG_DIRECTORY_MODE=0750
1108 #------------------------------------------------------------------------------
1109 # There are three options which are used when compiling the Perl interface and
1110 # when linking with Perl. The default values for these are placed automatically
1111 # at the head of the Makefile by the script which builds it. However, if you
1112 # want to override them, you can do so here.
1119 #------------------------------------------------------------------------------
1120 # Identifying the daemon: When an Exim daemon starts up, it writes its pid
1121 # (process id) to a file so that it can easily be identified. The path of the
1122 # file can be specified here. Some installations may want something like this:
1124 # PID_FILE_PATH=/var/lock/exim.pid
1126 # If PID_FILE_PATH is not defined, Exim writes a file in its spool directory
1127 # using the name "exim-daemon.pid".
1129 # If you start up a daemon without the -bd option (for example, with just
1130 # the -q15m option), a pid file is not written. Also, if you override the
1131 # configuration file with the -oX option, no pid file is written. In other
1132 # words, the pid file is written only for a "standard" daemon.
1135 #------------------------------------------------------------------------------
1136 # If Exim creates the spool directory, it is given this mode, defaulting in the
1139 # SPOOL_DIRECTORY_MODE=0750
1142 #------------------------------------------------------------------------------
1143 # The mode of files on the input spool which hold the contents of messages can
1144 # be changed here. The default is 0640 so that information from the spool is
1145 # available to anyone who is a member of the Exim group.
1150 #------------------------------------------------------------------------------
1151 # Moving frozen messages: If the following is uncommented, Exim is compiled
1152 # with support for automatically moving frozen messages out of the main spool
1153 # directory, a facility that is found useful by some large installations. A
1154 # run time option is required to cause the moving actually to occur. Such
1155 # messages become "invisible" to the normal management tools.
1157 # SUPPORT_MOVE_FROZEN_MESSAGES=yes
1160 #------------------------------------------------------------------------------
1161 # Disabling the use of fsync(): DO NOT UNCOMMENT THE FOLLOWING LINE unless you
1162 # really, really, really know what you are doing. And even then, think again.
1163 # You should never uncomment this when compiling a binary for distribution.
1164 # Use it only when compiling Exim for your own use.
1166 # Uncommenting this line enables the use of a runtime option called
1167 # disable_fsync, which can be used to stop Exim using fsync() to ensure that
1168 # files are written to disc before proceeding. When this is disabled, crashes
1169 # and hardware problems such as power outages can cause data to be lost. This
1170 # feature should only be used in very exceptional circumstances. YOU HAVE BEEN
1173 # ENABLE_DISABLE_FSYNC=yes
1175 # End of EDITME for Exim 4.