1 # $Cambridge: exim/src/src/EDITME,v 1.23 2009/11/20 12:18:19 nm4 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 very strongly
139 # If you specify EXIM_USER as a name, this is looked up at build time, and the
140 # uid number is built into the binary. However, you can specify that this
141 # lookup is deferred until runtime. In this case, it is the name that is built
142 # into the binary. You can do this by a setting of the form:
146 # In other words, put "ref:" in front of the user name. If you set EXIM_USER
147 # like this, any value specified for EXIM_GROUP is also passed "by reference".
148 # Although this costs a bit of resource at runtime, it is convenient to use
149 # this feature when building binaries that are to be run on multiple systems
150 # where the name may refer to different uids. It also allows you to build Exim
151 # on a system where there is no Exim user defined.
153 # If the setting of EXIM_USER is numeric (e.g. EXIM_USER=42), there must
154 # also be a setting of EXIM_GROUP. If, on the other hand, you use a name
155 # for EXIM_USER (e.g. EXIM_USER=exim), you don't need to set EXIM_GROUP unless
156 # you want to use a group other than the default group for the given user.
160 # Many sites define a user called "exim", with an appropriate default group,
165 # while leaving EXIM_GROUP unspecified (commented out).
168 #------------------------------------------------------------------------------
169 # SPOOL_DIRECTORY defines the directory where all the data for messages in
170 # transit is kept. It is strongly recommended that you define it here, though
171 # it is possible to leave this till the run time configuration.
173 # Exim creates the spool directory if it does not exist. The owner and group
174 # will be those defined by EXIM_USER and EXIM_GROUP, and this also applies to
175 # all the files and directories that are created in the spool directory.
177 # Almost all installations choose this:
179 SPOOL_DIRECTORY=/var/spool/exim
183 ###############################################################################
184 # THESE ARE THINGS YOU PROBABLY WANT TO SPECIFY #
185 ###############################################################################
187 # If you need extra header file search paths on all compiles, put the -I
188 # options in INCLUDE. If you want the extra searches only for certain
189 # parts of the build, see more specific xxx_INCLUDE variables below.
191 # INCLUDE=-I/example/include
193 # You need to specify some routers and transports if you want the Exim that you
194 # are building to be capable of delivering mail. You almost certainly need at
195 # least one type of lookup. You should consider whether you want to build
196 # the Exim monitor or not.
199 #------------------------------------------------------------------------------
200 # These settings determine which individual router drivers are included in the
201 # Exim binary. There are no defaults in the code; those routers that are wanted
202 # must be defined here by setting the appropriate variables to the value "yes".
203 # Including a router in the binary does not cause it to be used automatically.
204 # It has also to be configured in the run time configuration file. By
205 # commenting out those you know you don't want to use, you can make the binary
206 # a bit smaller. If you are unsure, leave all of these included for now.
211 ROUTER_MANUALROUTE=yes
212 ROUTER_QUERYPROGRAM=yes
215 # This one is very special-purpose, so is not included by default.
217 # ROUTER_IPLOOKUP=yes
220 #------------------------------------------------------------------------------
221 # These settings determine which individual transport drivers are included in
222 # the Exim binary. There are no defaults; those transports that are wanted must
223 # be defined here by setting the appropriate variables to the value "yes".
224 # Including a transport in the binary does not cause it to be used
225 # automatically. It has also to be configured in the run time configuration
226 # file. By commenting out those you know you don't want to use, you can make
227 # the binary a bit smaller. If you are unsure, leave all of these included for
230 TRANSPORT_APPENDFILE=yes
231 TRANSPORT_AUTOREPLY=yes
235 # This one is special-purpose, and commonly not required, so it is not
236 # included by default.
241 #------------------------------------------------------------------------------
242 # The appendfile transport can write messages to local mailboxes in a number
243 # of formats. The code for three specialist formats, maildir, mailstore, and
244 # MBX, is included only when requested. If you do not know what this is about,
245 # leave these settings commented out.
247 # SUPPORT_MAILDIR=yes
248 # SUPPORT_MAILSTORE=yes
252 #------------------------------------------------------------------------------
253 # These settings determine which file and database lookup methods are included
254 # in the binary. See the manual chapter entitled "File and database lookups"
255 # for discussion. DBM and lsearch (linear search) are included by default. If
256 # you are unsure about the others, leave them commented out for now.
257 # LOOKUP_DNSDB does *not* refer to general mail routing using the DNS. It is
258 # for the specialist case of using the DNS as a general database facility (not
278 # These two settings are obsolete; all three lookups are compiled when
279 # LOOKUP_LSEARCH is enabled. However, we retain these for backward
280 # compatibility. Setting one forces LOOKUP_LSEARCH if it is not set.
282 # LOOKUP_WILDLSEARCH=yes
283 # LOOKUP_NWILDLSEARCH=yes
286 #------------------------------------------------------------------------------
287 # If you have set LOOKUP_LDAP=yes, you should set LDAP_LIB_TYPE to indicate
288 # which LDAP library you have. Unfortunately, though most of their functions
289 # are the same, there are minor differences. Currently Exim knows about four
290 # LDAP libraries: the one from the University of Michigan (also known as
291 # OpenLDAP 1), OpenLDAP 2, the Netscape SDK library, and the library that comes
292 # with Solaris 7 onwards. Uncomment whichever of these you are using.
294 # LDAP_LIB_TYPE=OPENLDAP1
295 # LDAP_LIB_TYPE=OPENLDAP2
296 # LDAP_LIB_TYPE=NETSCAPE
297 # LDAP_LIB_TYPE=SOLARIS
299 # If you don't set any of these, Exim assumes the original University of
300 # Michigan (OpenLDAP 1) library.
303 #------------------------------------------------------------------------------
304 # The PCRE library is required for exim. There is no longer an embedded
305 # version of the PCRE library included with the source code, instead you
306 # must use a system library or build your own copy of PCRE.
307 # In either case you must specify the library link info here. If the
308 # PCRE header files are not in the standard search path you must also
309 # modify the INCLUDE path (above)
310 # The default setting of PCRE_LIBS should work on the vast majority of
316 #------------------------------------------------------------------------------
317 # Additional libraries and include directories may be required for some
318 # lookup styles (e.g. LDAP, MYSQL or PGSQL). LOOKUP_LIBS is included only on
319 # the command for linking Exim itself, not on any auxiliary programs. You
320 # don't need to set LOOKUP_INCLUDE if the relevant directories are already
321 # specified in INCLUDE. The settings below are just examples; -lpq is for
322 # PostgreSQL, -lgds is for Interbase, -lsqlite3 is for SQLite.
324 # LOOKUP_INCLUDE=-I /usr/local/ldap/include -I /usr/local/mysql/include -I /usr/local/pgsql/include
325 # LOOKUP_LIBS=-L/usr/local/lib -lldap -llber -lmysqlclient -lpq -lgds -lsqlite3
328 #------------------------------------------------------------------------------
329 # Compiling the Exim monitor: If you want to compile the Exim monitor, a
330 # program that requires an X11 display, then EXIM_MONITOR should be set to the
331 # value "eximon.bin". Comment out this setting to disable compilation of the
332 # monitor. The locations of various X11 directories for libraries and include
333 # files are defaulted in the OS/Makefile-Default file, but can be overridden in
334 # local OS-specific make files.
336 EXIM_MONITOR=eximon.bin
339 #------------------------------------------------------------------------------
340 # Compiling Exim with content scanning support: If you want to compile Exim
341 # with support for message body content scanning, set WITH_CONTENT_SCAN to
342 # the value "yes". This will give you malware and spam scanning in the DATA ACL,
343 # and the MIME ACL. Please read the documentation to learn more about these
346 # WITH_CONTENT_SCAN=yes
348 # If you want to use the deprecated "demime" condition in the DATA ACL,
349 # uncomment the line below. Doing so will also explicitly turn on the
350 # WITH_CONTENT_SCAN option. If possible, use the MIME ACL instead of
351 # the "demime" condition.
353 # WITH_OLD_DEMIME=yes
355 #------------------------------------------------------------------------------
356 # Compiling Exim with experimental features. These are documented in
357 # experimental-spec.txt. "Experimental" means that the way these features are
358 # implemented may still change. Backward compatibility is not guaranteed.
360 # Uncomment the following lines to add SPF support. You need to have libspf2
361 # installed on your system (www.libspf2.org). Depending on where it is installed
362 # you may have to edit the CFLAGS and LDFLAGS lines.
364 # EXPERIMENTAL_SPF=yes
365 # CFLAGS += -I/usr/local/include
368 # Uncomment the following lines to add SRS (Sender rewriting scheme) support.
369 # You need to have libsrs_alt installed on your system (srs.mirtol.com).
370 # Depending on where it is installed you may have to edit the CFLAGS and
373 # EXPERIMENTAL_SRS=yes
374 # CFLAGS += -I/usr/local/include
375 # LDFLAGS += -lsrs_alt
377 # Uncomment the following lines to add Brightmail AntiSpam support. You need
378 # to have the Brightmail client SDK installed. Please check the experimental
379 # documentation for implementation details. You need to edit the CFLAGS and
382 # EXPERIMENTAL_BRIGHTMAIL=yes
383 # CFLAGS += -I/opt/brightmail/bsdk-6.0/include
384 # LDFLAGS += -lxml2_single -lbmiclient_single -L/opt/brightmail/bsdk-6.0/lib
388 ###############################################################################
389 # THESE ARE THINGS YOU MIGHT WANT TO SPECIFY #
390 ###############################################################################
392 # The items in this section are those that are commonly changed according to
393 # the sysadmin's preferences, but whose defaults are often acceptable. The
394 # first five are concerned with security issues, where differing levels of
395 # paranoia are appropriate in different environments. Sysadmins also vary in
396 # their views on appropriate levels of defence in these areas. If you do not
397 # understand these issues, go with the defaults, which are used by many sites.
400 #------------------------------------------------------------------------------
401 # Although Exim is normally a setuid program, owned by root, it refuses to run
402 # local deliveries as root by default. There is a runtime option called
403 # "never_users" which lists the users that must never be used for local
404 # deliveries. There is also the setting below, which provides a list that
405 # cannot be overridden at runtime. This guards against problems caused by
406 # unauthorized changes to the runtime configuration. You are advised not to
407 # remove "root" from this option, but you can add other users if you want. The
408 # list is colon-separated. It must NOT contain any spaces.
410 # FIXED_NEVER_USERS=root:bin:daemon
411 FIXED_NEVER_USERS=root
414 #------------------------------------------------------------------------------
415 # By default, Exim insists that its configuration file be owned either by root
416 # or by the Exim user. You can specify one additional permitted owner here.
420 # If the configuration file is group-writeable, Exim insists by default that it
421 # is owned by root or the Exim user. You can specify one additional permitted
426 # If you specify CONFIGURE_OWNER or CONFIGURE_GROUP as a name, this is looked
427 # up at build time, and the uid or gid number is built into the binary.
428 # However, you can specify that the lookup is deferred until runtime. In this
429 # case, it is the name that is built into the binary. You can do this by a
430 # setting of the form:
432 # CONFIGURE_OWNER=ref:mail
433 # CONFIGURE_GROUP=ref:sysadmin
435 # In other words, put "ref:" in front of the user or group name. Although this
436 # costs a bit of resource at runtime, it is convenient to use this feature when
437 # building binaries that are to be run on multiple systems where the names may
438 # refer to different uids or gids. It also allows you to build Exim on a system
439 # where the relevant user or group is not defined.
442 #------------------------------------------------------------------------------
443 # The -C option allows Exim to be run with an alternate runtime configuration
444 # file. When this is used by root or the Exim user, root privilege is retained
445 # by the binary (for any other caller, it is dropped). You can restrict the
446 # location of alternate configurations by defining a prefix below. Any file
447 # used with -C must then start with this prefix (except that /dev/null is also
448 # permitted if the caller is root, because that is used in the install script).
449 # If the prefix specifies a directory that is owned by root, a compromise of
450 # the Exim account does not permit arbitrary alternate configurations to be
451 # used. The prefix can be more restrictive than just a directory (the second
454 # ALT_CONFIG_PREFIX=/some/directory/
455 # ALT_CONFIG_PREFIX=/some/directory/exim.conf-
458 #------------------------------------------------------------------------------
459 # If you uncomment the following line, only root may use the -C or -D options
460 # without losing root privilege. The -C option specifies an alternate runtime
461 # configuration file, and the -D option changes macro values in the runtime
462 # configuration. Uncommenting this line restricts what can be done with these
463 # options. A call to receive a message (either one-off or via a daemon) cannot
464 # successfully continue to deliver it, because the re-exec of Exim to regain
465 # root privilege will fail, owing to the use of -C or -D by the Exim user.
466 # However, you can still use -C for testing (as root) if you do separate Exim
467 # calls for receiving a message and subsequently delivering it.
469 # ALT_CONFIG_ROOT_ONLY=yes
472 #------------------------------------------------------------------------------
473 # Uncommenting this option disables the use of the -D command line option,
474 # which changes the values of macros in the runtime configuration file.
475 # This is another protection against somebody breaking into the Exim account.
477 # DISABLE_D_OPTION=yes
480 #------------------------------------------------------------------------------
481 # Exim has support for the AUTH (authentication) extension of the SMTP
482 # protocol, as defined by RFC 2554. If you don't know what SMTP authentication
483 # is, you probably won't want to include this code, so you should leave these
484 # settings commented out. If you do want to make use of SMTP authentication,
485 # you must uncomment at least one of the following, so that appropriate code is
486 # included in the Exim binary. You will then need to set up the run time
487 # configuration to make use of the mechanism(s) selected.
490 # AUTH_CYRUS_SASL=yes
496 #------------------------------------------------------------------------------
497 # If you specified AUTH_CYRUS_SASL above, you should ensure that you have the
498 # Cyrus SASL library installed before trying to build Exim, and you probably
499 # want to uncomment the following line:
504 #------------------------------------------------------------------------------
505 # When Exim is decoding MIME "words" in header lines, most commonly for use
506 # in the $header_xxx expansion, it converts any foreign character sets to the
507 # one that is set in the headers_charset option. The default setting is
508 # defined by this setting:
510 HEADERS_CHARSET="ISO-8859-1"
512 # If you are going to make use of $header_xxx expansions in your configuration
513 # file, or if your users are going to use them in filter files, and the normal
514 # character set on your host is something other than ISO-8859-1, you might
515 # like to specify a different default here. This value can be overridden in
516 # the runtime configuration, and it can also be overridden in individual filter
519 # IMPORTANT NOTE: The iconv() function is needed for character code
520 # conversions. Please see the next item...
523 #------------------------------------------------------------------------------
524 # Character code conversions are possible only if the iconv() function is
525 # installed on your operating system. There are two places in Exim where this
526 # is relevant: (a) The $header_xxx expansion (see the previous item), and (b)
527 # the Sieve filter support. For those OS where iconv() is known to be installed
528 # as standard, the file in OS/Makefile-xxxx contains
532 # If you are not using one of those systems, but have installed iconv(), you
533 # need to uncomment that line above. In some cases, you may find that iconv()
534 # and its header file are not in the default places. You might need to use
535 # something like this:
538 # CFLAGS=-O -I/usr/local/include
539 # EXTRALIBS_EXIM=-L/usr/local/lib -liconv
541 # but of course there may need to be other things in CFLAGS and EXTRALIBS_EXIM
545 #------------------------------------------------------------------------------
546 # The passwords for user accounts are normally encrypted with the crypt()
547 # function. Comparisons with encrypted passwords can be done using Exim's
548 # "crypteq" expansion operator. (This is commonly used as part of the
549 # configuration of an authenticator for use with SMTP AUTH.) At least one
550 # operating system has an extended function called crypt16(), which uses up to
551 # 16 characters of a password (the normal crypt() uses only the first 8). Exim
552 # supports the use of crypt16() as well as crypt() but note the warning below.
554 # You can always indicate a crypt16-encrypted password by preceding it with
555 # "{crypt16}". If you want the default handling (without any preceding
556 # indicator) to use crypt16(), uncomment the following line:
558 # DEFAULT_CRYPT=crypt16
560 # If you do that, you can still access the basic crypt() function by preceding
561 # an encrypted password with "{crypt}". For more details, see the description
562 # of the "crypteq" condition in the manual chapter on string expansions.
564 # Some operating systems do not include a crypt16() function, so Exim has one
565 # of its own, which it uses unless HAVE_CRYPT16 is defined. Normally, that will
566 # be set in an OS-specific Makefile for the OS that have such a function, so
567 # you should not need to bother with it.
569 # *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING ***
570 # It turns out that the above is not entirely accurate. As well as crypt16()
571 # there is a function called bigcrypt() that some operating systems have. This
572 # may or may not use the same algorithm, and both of them may be different to
573 # Exim's built-in crypt16() that is used unless HAVE_CRYPT16 is defined.
575 # However, since there is now a move away from the traditional crypt()
576 # functions towards using SHA1 and other algorithms, tidying up this area of
577 # Exim is seen as very low priority. In practice, if you need to, you can
578 # define DEFAULT_CRYPT to the name of any function that has the same interface
579 # as the traditional crypt() function.
580 # *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING ***
583 #------------------------------------------------------------------------------
584 # Exim can be built to support the SMTP STARTTLS command, which implements
585 # Transport Layer Security using SSL (Secure Sockets Layer). To do this, you
586 # must install the OpenSSL library package or the GnuTLS library. Exim contains
587 # no cryptographic code of its own. Uncomment the following lines if you want
588 # to build Exim with TLS support. If you don't know what this is all about,
589 # leave these settings commented out.
591 # This setting is required for any TLS support (either OpenSSL or GnuTLS)
594 # Uncomment this setting if you are using OpenSSL
595 # TLS_LIBS=-lssl -lcrypto
597 # Uncomment these settings if you are using GnuTLS
599 # TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
601 # If you are running Exim as a server, note that just building it with TLS
602 # support is not all you need to do. You also need to set up a suitable
603 # certificate, and tell Exim about it by means of the tls_certificate
604 # and tls_privatekey run time options. You also need to set tls_advertise_hosts
605 # to specify the hosts to which Exim advertises TLS support. On the other hand,
606 # if you are running Exim only as a client, building it with TLS support
607 # is all you need to do.
609 # Additional libraries and include files are required for both OpenSSL and
610 # GnuTLS. The TLS_LIBS settings above assume that the libraries are installed
611 # with all your other libraries. If they are in a special directory, you may
612 # need something like
614 # TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
616 # TLS_LIBS=-L/opt/gnu/lib -lgnutls -ltasn1 -lgcrypt
618 # TLS_LIBS is included only on the command for linking Exim itself, not on any
619 # auxiliary programs. If the include files are not in a standard place, you can
620 # set TLS_INCLUDE to specify where they are, for example:
622 # TLS_INCLUDE=-I/usr/local/openssl/include/
624 # TLS_INCLUDE=-I/opt/gnu/include
626 # You don't need to set TLS_INCLUDE if the relevant directories are already
627 # specified in INCLUDE.
630 #------------------------------------------------------------------------------
631 # The default distribution of Exim contains only the plain text form of the
632 # documentation. Other forms are available separately. If you want to install
633 # the documentation in "info" format, first fetch the Texinfo documentation
634 # sources from the ftp directory and unpack them, which should create files
635 # with the extension "texinfo" in the doc directory. You may find that the
636 # version number of the texinfo files is different to your Exim version number,
637 # because the main documentation isn't updated as often as the code. For
638 # example, if you have Exim version 4.43, the source tarball upacks into a
639 # directory called exim-4.43, but the texinfo tarball unpacks into exim-4.40.
640 # In this case, move the contents of exim-4.40/doc into exim-4.43/doc after you
641 # have unpacked them. Then set INFO_DIRECTORY to the location of your info
642 # directory. This varies from system to system, but is often /usr/share/info.
643 # Once you have done this, "make install" will build the info files and
644 # install them in the directory you have defined.
646 # INFO_DIRECTORY=/usr/share/info
649 #------------------------------------------------------------------------------
650 # Exim log directory and files: Exim creates several log files inside a
651 # single log directory. You can define the directory and the form of the
652 # log file name here. If you do not set anything, Exim creates a directory
653 # called "log" inside its spool directory (see SPOOL_DIRECTORY above) and uses
654 # the filenames "mainlog", "paniclog", and "rejectlog". If you want to change
655 # this, you can set LOG_FILE_PATH to a path name containing one occurrence of
656 # %s. This will be replaced by one of the strings "main", "panic", or "reject"
657 # to form the final file names. Some installations may want something like this:
659 # LOG_FILE_PATH=/var/log/exim_%slog
661 # which results in files with names /var/log/exim_mainlog, etc. The directory
662 # in which the log files are placed must exist; Exim does not try to create
663 # it for itself. It is also your responsibility to ensure that Exim is capable
664 # of writing files using this path name. The Exim user (see EXIM_USER above)
665 # must be able to create and update files in the directory you have specified.
667 # You can also configure Exim to use syslog, instead of or as well as log
668 # files, by settings such as these
670 # LOG_FILE_PATH=syslog
671 # LOG_FILE_PATH=syslog:/var/log/exim_%slog
673 # The first of these uses only syslog; the second uses syslog and also writes
674 # to log files. Do not include white space in such a setting as it messes up
675 # the building process.
678 #------------------------------------------------------------------------------
679 # When logging to syslog, the following option caters for syslog replacements
680 # that are able to accept log entries longer than the 1024 characters allowed
681 # by RFC 3164. It is up to you to make sure your syslog daemon can handle this.
682 # Non-printable characters are usually unacceptable regardless, so log entries
683 # are still split on newline characters.
685 # SYSLOG_LONG_LINES=yes
687 # If you are not interested in the process identifier (pid) of the Exim that is
688 # making the call to syslog, then comment out the following line.
693 #------------------------------------------------------------------------------
694 # Cycling log files: this variable specifies the maximum number of old
695 # log files that are kept by the exicyclog log-cycling script. You don't have
696 # to use exicyclog. If your operating system has other ways of cycling log
697 # files, you can use them instead. The exicyclog script isn't run by default;
698 # you have to set up a cron job for it if you want it.
703 #------------------------------------------------------------------------------
704 # The compress command is used by the exicyclog script to compress old log
705 # files. Both the name of the command and the suffix that it adds to files
706 # need to be defined here. See also the EXICYCLOG_MAX configuration.
708 COMPRESS_COMMAND=/usr/bin/gzip
712 #------------------------------------------------------------------------------
713 # If the exigrep utility is fed compressed log files, it tries to uncompress
714 # them using this command.
716 ZCAT_COMMAND=/usr/bin/zcat
719 #------------------------------------------------------------------------------
720 # Compiling in support for embedded Perl: If you want to be able to
721 # use Perl code in Exim's string manipulation language and you have Perl
722 # (version 5.004 or later) installed, set EXIM_PERL to perl.o. Using embedded
723 # Perl costs quite a lot of resources. Only do this if you really need it.
728 #------------------------------------------------------------------------------
729 # Support for dynamically-loaded string expansion functions via ${dlfunc. If
730 # you are using gcc the dynamically-loaded object must be compiled with the
731 # -shared option, and you will need to add -export-dynamic to EXTRALIBS so
732 # that the local_scan API is made available by the linker. You may also need
733 # to add -ldl to EXTRALIBS so that dlopen() is available to Exim.
738 #------------------------------------------------------------------------------
739 # Exim has support for PAM (Pluggable Authentication Modules), a facility
740 # which is available in the latest releases of Solaris and in some GNU/Linux
741 # distributions (see http://ftp.kernel.org/pub/linux/libs/pam/). The Exim
742 # support, which is intended for use in conjunction with the SMTP AUTH
743 # facilities, is included only when requested by the following setting:
747 # You probably need to add -lpam to EXTRALIBS, and in some releases of
748 # GNU/Linux -ldl is also needed.
751 #------------------------------------------------------------------------------
752 # Support for authentication via Radius is also available. The Exim support,
753 # which is intended for use in conjunction with the SMTP AUTH facilities,
754 # is included only when requested by setting the following parameter to the
755 # location of your Radius configuration file:
757 # RADIUS_CONFIG_FILE=/etc/radiusclient/radiusclient.conf
758 # RADIUS_CONFIG_FILE=/etc/radius.conf
760 # If you have set RADIUS_CONFIG_FILE, you should also set one of these to
761 # indicate which RADIUS library is used:
763 # RADIUS_LIB_TYPE=RADIUSCLIENT
764 # RADIUS_LIB_TYPE=RADIUSCLIENTNEW
765 # RADIUS_LIB_TYPE=RADLIB
767 # RADIUSCLIENT is the radiusclient library; you probably need to add
768 # -lradiusclient to EXTRALIBS.
770 # The API for the radiusclient library was changed at release 0.4.0.
771 # Unfortunately, the header file does not define a version number that clients
772 # can use to support both the old and new APIs. If you are using version 0.4.0
773 # or later of the radiusclient library, you should use RADIUSCLIENTNEW.
775 # RADLIB is the Radius library that comes with FreeBSD (the header file is
776 # called radlib.h); you probably need to add -lradius to EXTRALIBS.
778 # If you do not set RADIUS_LIB_TYPE, Exim assumes the radiusclient library,
779 # using the original API.
782 #------------------------------------------------------------------------------
783 # Support for authentication via the Cyrus SASL pwcheck daemon is available.
784 # Note, however, that pwcheck is now deprecated in favour of saslauthd (see
785 # next item). The Exim support for pwcheck, which is intented for use in
786 # conjunction with the SMTP AUTH facilities, is included only when requested by
787 # setting the following parameter to the location of the pwcheck daemon's
790 # There is no need to install all of SASL on your system. You just need to run
791 # ./configure --with-pwcheck, cd to the pwcheck directory within the sources,
792 # make and make install. You must create the socket directory (default
793 # /var/pwcheck) and chown it to exim's user and group. Once you have installed
794 # pwcheck, you should arrange for it to be started by root at boot time.
796 # CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
799 #------------------------------------------------------------------------------
800 # Support for authentication via the Cyrus SASL saslauthd daemon is available.
801 # The Exim support, which is intented for use in conjunction with the SMTP AUTH
802 # facilities, is included only when requested by setting the following
803 # parameter to the location of the saslauthd daemon's socket.
805 # There is no need to install all of SASL on your system. You just need to run
806 # ./configure --with-saslauthd (and any other options you need, for example, to
807 # select or deselect authentication mechanisms), cd to the saslauthd directory
808 # within the sources, make and make install. You must create the socket
809 # directory (default /var/state/saslauthd) and chown it to exim's user and
810 # group. Once you have installed saslauthd, you should arrange for it to be
811 # started by root at boot time.
813 # CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
816 #------------------------------------------------------------------------------
817 # TCP wrappers: If you want to use tcpwrappers from within Exim, uncomment
818 # this setting. See the manual section entitled "Use of tcpwrappers" in the
819 # chapter on building and installing Exim.
821 # USE_TCP_WRAPPERS=yes
823 # You may well also have to specify a local "include" file and an additional
824 # library for TCP wrappers, so you probably need something like this:
826 # USE_TCP_WRAPPERS=yes
827 # CFLAGS=-O -I/usr/local/include
828 # EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
830 # but of course there may need to be other things in CFLAGS and EXTRALIBS_EXIM
834 #------------------------------------------------------------------------------
835 # The default action of the exim_install script (which is run by "make
836 # install") is to install the Exim binary with a unique name such as
837 # exim-4.43-1, and then set up a symbolic link called "exim" to reference it,
838 # moving the symbolic link from any previous version. If you define NO_SYMLINK
839 # (the value doesn't matter), the symbolic link is not created or moved. You
840 # will then have to "turn Exim on" by setting up the link manually.
845 #------------------------------------------------------------------------------
846 # Another default action of the install script is to install a default runtime
847 # configuration file if one does not exist. This configuration has a router for
848 # expanding system aliases. The default assumes that these aliases are kept
849 # in the traditional file called /etc/aliases. If such a file does not exist,
850 # the installation script creates one that contains just comments (no actual
851 # aliases). The following setting can be changed to specify a different
852 # location for the system alias file.
854 SYSTEM_ALIASES_FILE=/etc/aliases
857 #------------------------------------------------------------------------------
858 # There are some testing options (-be, -bt, -bv) that read data from the
859 # standard input when no arguments are supplied. By default, the input lines
860 # are read using the standard fgets() function. This does not support line
861 # editing during interactive input (though the terminal's "erase" character
862 # works as normal). If your operating system has the readline() function, and
863 # in addition supports dynamic loading of library functions, you can cause
864 # Exim to use readline() for the -be testing option (only) by uncommenting the
865 # following setting. Dynamic loading is used so that the library is loaded only
866 # when the -be testing option is given; by the time the loading occurs,
867 # Exim has given up its root privilege and is running as the calling user. This
868 # is the reason why readline() is NOT supported for -bt and -bv, because Exim
869 # runs as root or as exim, respectively, for those options. When USE_READLINE
870 # is "yes", as well as supporting line editing, a history of input lines in the
871 # current run is maintained.
875 # You may need to add -ldl to EXTRALIBS when you set USE_READLINE=yes.
876 # Note that this option adds to the size of the Exim binary, because the
877 # dynamic loading library is not otherwise included.
881 ###############################################################################
882 # THINGS YOU ALMOST NEVER NEED TO MENTION #
883 ###############################################################################
885 # The settings in this section are available for use in special circumstances.
886 # In the vast majority of installations you need not change anything below.
889 #------------------------------------------------------------------------------
890 # The following commands live in different places in some OS. Either the
891 # ultimate default settings, or the OS-specific files should already point to
892 # the right place, but they can be overridden here if necessary. These settings
893 # are used when building various scripts to ensure that the correct paths are
894 # used when the scripts are run. They are not used in the Makefile itself. Perl
895 # is not necessary for running Exim unless you set EXIM_PERL (see above) to get
896 # it embedded, but there are some utilities that are Perl scripts. If you
897 # haven't got Perl, Exim will still build and run; you just won't be able to
898 # use those utilities.
900 # CHOWN_COMMAND=/usr/bin/chown
901 # CHGRP_COMMAND=/usr/bin/chgrp
902 # CHMOD_COMMAND=/usr/bin/chmod
905 # TOUCH_COMMAND=/usr/bin/touch
906 # PERL_COMMAND=/usr/bin/perl
909 #------------------------------------------------------------------------------
910 # The following macro can be used to change the command for building a library
911 # of functions. By default the "ar" command is used, with options "cq".
912 # Only in rare circumstances should you need to change this.
917 #------------------------------------------------------------------------------
918 # In some operating systems, the value of the TMPDIR environment variable
919 # controls where temporary files are created. Exim does not make use of
920 # temporary files, except when delivering to MBX mailboxes. However, if Exim
921 # calls any external libraries (e.g. DBM libraries), they may use temporary
922 # files, and thus be influenced by the value of TMPDIR. For this reason, when
923 # Exim starts, it checks the environment for TMPDIR, and if it finds it is set,
924 # it replaces the value with what is defined here. Commenting this setting
925 # suppresses the check altogether.
930 #------------------------------------------------------------------------------
931 # The following macros can be used to change the default modes that are used
932 # by the appendfile transport. In most installations the defaults are just
933 # fine, and in any case, you can change particular instances of the transport
934 # at run time if you want.
936 # APPENDFILE_MODE=0600
937 # APPENDFILE_DIRECTORY_MODE=0700
938 # APPENDFILE_LOCKFILE_MODE=0600
941 #------------------------------------------------------------------------------
942 # In some installations there may be multiple machines sharing file systems,
943 # where a different configuration file is required for Exim on the different
944 # machines. If CONFIGURE_FILE_USE_NODE is defined, then Exim will first look
945 # for a configuration file whose name is that defined by CONFIGURE_FILE,
946 # with the node name obtained by uname() tacked on the end, separated by a
947 # period (for example, /usr/exim/configure.host.in.some.domain). If this file
948 # does not exist, then the bare configuration file name is tried.
950 # CONFIGURE_FILE_USE_NODE=yes
953 #------------------------------------------------------------------------------
954 # In some esoteric configurations two different versions of Exim are run,
955 # with different setuid values, and different configuration files are required
956 # to handle the different cases. If CONFIGURE_FILE_USE_EUID is defined, then
957 # Exim will first look for a configuration file whose name is that defined
958 # by CONFIGURE_FILE, with the effective uid tacked on the end, separated by
959 # a period (for eximple, /usr/exim/configure.0). If this file does not exist,
960 # then the bare configuration file name is tried. In the case when both
961 # CONFIGURE_FILE_USE_EUID and CONFIGURE_FILE_USE_NODE are set, four files
962 # are tried: <name>.<euid>.<node>, <name>.<node>, <name>.<euid>, and <name>.
964 # CONFIGURE_FILE_USE_EUID=yes
967 #------------------------------------------------------------------------------
968 # The size of the delivery buffers: These specify the sizes (in bytes) of
969 # the buffers that are used when copying a message from the spool to a
970 # destination. There is rarely any need to change these values.
972 # DELIVER_IN_BUFFER_SIZE=8192
973 # DELIVER_OUT_BUFFER_SIZE=8192
976 #------------------------------------------------------------------------------
977 # The mode of the database directory: Exim creates a directory called "db"
978 # in its spool directory, to hold its databases of hints. This variable
979 # determines the mode of the created directory. The default value in the
982 # EXIMDB_DIRECTORY_MODE=0750
985 #------------------------------------------------------------------------------
986 # Database file mode: The mode of files created in the "db" directory defaults
987 # to 0640 in the source, and can be changed here.
992 #------------------------------------------------------------------------------
993 # Database lock file mode: The mode of zero-length files created in the "db"
994 # directory to use for locking purposes defaults to 0640 in the source, and
995 # can be changed here.
997 # EXIMDB_LOCKFILE_MODE=0640
1000 #------------------------------------------------------------------------------
1001 # This parameter sets the maximum length of the header portion of a message
1002 # that Exim is prepared to process. The default setting is one megabyte. The
1003 # limit exists in order to catch rogue mailers that might connect to your SMTP
1004 # port, start off a header line, and then just pump junk at it for ever. The
1005 # message_size_limit option would also catch this, but it may not be set.
1006 # The value set here is the default; it can be changed at runtime.
1008 # HEADER_MAXSIZE="(1024*1024)"
1011 #------------------------------------------------------------------------------
1012 # The mode of the input directory: The input directory is where messages are
1013 # kept while awaiting delivery. Exim creates it if necessary, using a mode
1014 # which can be defined here (default 0750).
1016 # INPUT_DIRECTORY_MODE=0750
1019 #------------------------------------------------------------------------------
1020 # The mode of Exim's log directory, when it is created by Exim inside the spool
1021 # directory, defaults to 0750 but can be changed here.
1023 # LOG_DIRECTORY_MODE=0750
1026 #------------------------------------------------------------------------------
1027 # The log files themselves are created as required, with a mode that defaults
1028 # to 0640, but which can be changed here.
1033 #------------------------------------------------------------------------------
1034 # The TESTDB lookup is for performing tests on the handling of lookup results,
1035 # and is not useful for general running. It should be included only when
1036 # debugging the code of Exim.
1041 #------------------------------------------------------------------------------
1042 # /bin/sh is used by default as the shell in which to run commands that are
1043 # defined in the makefiles. This can be changed if necessary, by uncommenting
1044 # this line and specifying another shell, but note that a Bourne-compatible
1045 # shell is expected.
1047 # MAKE_SHELL=/bin/sh
1050 #------------------------------------------------------------------------------
1051 # The maximum number of named lists of each type (address, domain, host, and
1052 # local part) can be increased by changing this value. It should be set to
1058 #------------------------------------------------------------------------------
1059 # Network interfaces: Unless you set the local_interfaces option in the runtime
1060 # configuration file to restrict Exim to certain interfaces only, it will run
1061 # code to find all the interfaces there are on your host. Unfortunately,
1062 # the call to the OS that does this requires a buffer large enough to hold
1063 # data for all the interfaces - it was designed in the days when a host rarely
1064 # had more than three or four interfaces. Nowadays hosts can have very many
1065 # virtual interfaces running on the same hardware. If you have more than 250
1066 # virtual interfaces, you will need to uncomment this setting and increase the
1072 #------------------------------------------------------------------------------
1073 # Per-message logs: While a message is in the process of being delivered,
1074 # comments on its progress are written to a message log, for the benefit of
1075 # human administrators. These logs are held in a directory called "msglog"
1076 # in the spool directory. Its mode defaults to 0750, but can be changed here.
1077 # The message log directory is also used for storing files that are used by
1078 # transports for returning data to a message's sender (see the "return_output"
1079 # option for transports).
1081 # MSGLOG_DIRECTORY_MODE=0750
1084 #------------------------------------------------------------------------------
1085 # There are three options which are used when compiling the Perl interface and
1086 # when linking with Perl. The default values for these are placed automatically
1087 # at the head of the Makefile by the script which builds it. However, if you
1088 # want to override them, you can do so here.
1095 #------------------------------------------------------------------------------
1096 # Identifying the daemon: When an Exim daemon starts up, it writes its pid
1097 # (process id) to a file so that it can easily be identified. The path of the
1098 # file can be specified here. Some installations may want something like this:
1100 # PID_FILE_PATH=/var/lock/exim.pid
1102 # If PID_FILE_PATH is not defined, Exim writes a file in its spool directory
1103 # using the name "exim-daemon.pid".
1105 # If you start up a daemon without the -bd option (for example, with just
1106 # the -q15m option), a pid file is not written. Also, if you override the
1107 # configuration file with the -oX option, no pid file is written. In other
1108 # words, the pid file is written only for a "standard" daemon.
1111 #------------------------------------------------------------------------------
1112 # If Exim creates the spool directory, it is given this mode, defaulting in the
1115 # SPOOL_DIRECTORY_MODE=0750
1118 #------------------------------------------------------------------------------
1119 # The mode of files on the input spool which hold the contents of messages can
1120 # be changed here. The default is 0640 so that information from the spool is
1121 # available to anyone who is a member of the Exim group.
1126 #------------------------------------------------------------------------------
1127 # Moving frozen messages: If the following is uncommented, Exim is compiled
1128 # with support for automatically moving frozen messages out of the main spool
1129 # directory, a facility that is found useful by some large installations. A
1130 # run time option is required to cause the moving actually to occur. Such
1131 # messages become "invisible" to the normal management tools.
1133 # SUPPORT_MOVE_FROZEN_MESSAGES=yes
1136 #------------------------------------------------------------------------------
1137 # Disabling the use of fsync(): DO NOT UNCOMMENT THE FOLLOWING LINE unless you
1138 # really, really, really know what you are doing. And even then, think again.
1139 # You should never uncomment this when compiling a binary for distribution.
1140 # Use it only when compiling Exim for your own use.
1142 # Uncommenting this line enables the use of a runtime option called
1143 # disable_fsync, which can be used to stop Exim using fsync() to ensure that
1144 # files are written to disc before proceeding. When this is disabled, crashes
1145 # and hardware problems such as power outages can cause data to be lost. This
1146 # feature should only be used in very exceptional circumstances. YOU HAVE BEEN
1149 # ENABLE_DISABLE_FSYNC=yes
1151 # End of EDITME for Exim 4.