Hopefully the final lot of test files.
[exim.git] / src / src / EDITME
1 # $Cambridge: exim/src/src/EDITME,v 1.16 2005/10/12 15:45:38 ph10 Exp $
2
3 ##################################################
4 # The Exim mail transport agent #
5 ##################################################
6
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.
12
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.
15
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
21 # are recognized.
22
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.)
31
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
35 # Local/Makefile.
36
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.
40
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.
47
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.
54
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.
63
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
66 # example
67 #
68 # EXIM_GID=42 # the "mail" group
69 #
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 ###############################################################################
76
77
78
79 ###############################################################################
80 # THESE ARE THINGS YOU MUST SPECIFY #
81 ###############################################################################
82
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.
85
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.
91
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.
102
103 BIN_DIRECTORY=/usr/exim/bin
104
105
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.
118
119 CONFIGURE_FILE=/usr/exim/configure
120
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.
125
126
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
135 # discouraged.
136
137 EXIM_USER=
138
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:
143
144 # EXIM_USER=ref:exim
145
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.
152
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.
157
158 # EXIM_GROUP=
159
160 # Many sites define a user called "exim", with an appropriate default group,
161 # and use
162 #
163 # EXIM_USER=exim
164 #
165 # while leaving EXIM_GROUP unspecified (commented out).
166
167
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.
172
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.
176
177 # Almost all installations choose this:
178
179 SPOOL_DIRECTORY=/var/spool/exim
180
181
182
183 ###############################################################################
184 # THESE ARE THINGS YOU PROBABLY WANT TO SPECIFY #
185 ###############################################################################
186
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.
190
191 # INCLUDE=-I/example/include
192
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.
197
198
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.
207
208 ROUTER_ACCEPT=yes
209 ROUTER_DNSLOOKUP=yes
210 ROUTER_IPLITERAL=yes
211 ROUTER_MANUALROUTE=yes
212 ROUTER_QUERYPROGRAM=yes
213 ROUTER_REDIRECT=yes
214
215 # This one is very special-purpose, so is not included by default.
216
217 # ROUTER_IPLOOKUP=yes
218
219
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
228 # now.
229
230 TRANSPORT_APPENDFILE=yes
231 TRANSPORT_AUTOREPLY=yes
232 TRANSPORT_PIPE=yes
233 TRANSPORT_SMTP=yes
234
235 # This one is special-purpose, and commonly not required, so it is not
236 # included by default.
237
238 # TRANSPORT_LMTP=yes
239
240
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.
246
247 # SUPPORT_MAILDIR=yes
248 # SUPPORT_MAILSTORE=yes
249 # SUPPORT_MBX=yes
250
251
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
259 # common).
260
261 LOOKUP_DBM=yes
262 LOOKUP_LSEARCH=yes
263
264 # LOOKUP_CDB=yes
265 # LOOKUP_DNSDB=yes
266 # LOOKUP_DSEARCH=yes
267 # LOOKUP_IBASE=yes
268 # LOOKUP_LDAP=yes
269 # LOOKUP_MYSQL=yes
270 # LOOKUP_NIS=yes
271 # LOOKUP_NISPLUS=yes
272 # LOOKUP_ORACLE=yes
273 # LOOKUP_PASSWD=yes
274 # LOOKUP_PGSQL=yes
275 # LOOKUP_SQLITE=yes
276 # LOOKUP_WHOSON=yes
277
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.
281
282 # LOOKUP_WILDLSEARCH=yes
283 # LOOKUP_NWILDLSEARCH=yes
284
285
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.
293
294 # LDAP_LIB_TYPE=OPENLDAP1
295 # LDAP_LIB_TYPE=OPENLDAP2
296 # LDAP_LIB_TYPE=NETSCAPE
297 # LDAP_LIB_TYPE=SOLARIS
298
299 # If you don't set any of these, Exim assumes the original University of
300 # Michigan (OpenLDAP 1) library.
301
302
303 #------------------------------------------------------------------------------
304 # Additional libraries and include directories may be required for some
305 # lookup styles (e.g. LDAP, MYSQL or PGSQL). LOOKUP_LIBS is included only on
306 # the command for linking Exim itself, not on any auxiliary programs. You
307 # don't need to set LOOKUP_INCLUDE if the relevant directories are already
308 # specified in INCLUDE. The settings below are just examples; -lpq is for
309 # PostgreSQL, -lgds is for Interbase, -lsqlite3 is for SQLite.
310
311 # LOOKUP_INCLUDE=-I /usr/local/ldap/include -I /usr/local/mysql/include -I /usr/local/pgsql/include
312 # LOOKUP_LIBS=-L/usr/local/lib -lldap -llber -lmysqlclient -lpq -lgds -lsqlite3
313
314
315 #------------------------------------------------------------------------------
316 # Compiling the Exim monitor: If you want to compile the Exim monitor, a
317 # program that requires an X11 display, then EXIM_MONITOR should be set to the
318 # value "eximon.bin". Comment out this setting to disable compilation of the
319 # monitor. The locations of various X11 directories for libraries and include
320 # files are defaulted in the OS/Makefile-Default file, but can be overridden in
321 # local OS-specific make files.
322
323 EXIM_MONITOR=eximon.bin
324
325
326 #------------------------------------------------------------------------------
327 # Compiling Exim with content scanning support: If you want to compile Exim
328 # with support for message body content scanning, set WITH_CONTENT_SCAN to
329 # the value "yes". This will give you malware and spam scanning in the DATA ACL,
330 # and the MIME ACL. Please read the documentation to learn more about these
331 # features.
332
333 # WITH_CONTENT_SCAN=yes
334
335 # If you want to use the deprecated "demime" condition in the DATA ACL,
336 # uncomment the line below. Doing so will also explicitly turn on the
337 # WITH_CONTENT_SCAN option. If possible, use the MIME ACL instead of
338 # the "demime" condition.
339
340 # WITH_OLD_DEMIME=yes
341
342 #------------------------------------------------------------------------------
343 # Compiling Exim with experimental features. These are documented in
344 # experimental-spec.txt. "Experimental" means that the way these features are
345 # implemented may still change. Backward compatibility is not guaranteed.
346
347 # Uncomment the following lines to add SPF support. You need to have libspf2
348 # installed on your system (www.libspf2.org). Depending on where it is installed
349 # you may have to edit the CFLAGS and LDFLAGS lines.
350
351 # EXPERIMENTAL_SPF=yes
352 # CFLAGS += -I/usr/local/include
353 # LDFLAGS += -lspf2
354
355 # Uncomment the following lines to add SRS (Sender rewriting scheme) support.
356 # You need to have libsrs_alt installed on your system (srs.mirtol.com).
357 # Depending on where it is installed you may have to edit the CFLAGS and
358 # LDFLAGS lines.
359
360 # EXPERIMENTAL_SRS=yes
361 # CFLAGS += -I/usr/local/include
362 # LDFLAGS += -lsrs_alt
363
364 # Uncomment the following lines to add Brightmail AntiSpam support. You need
365 # to have the Brightmail client SDK installed. Please check the experimental
366 # documentation for implementation details. You need to edit the CFLAGS and
367 # LDFLAGS lines.
368
369 # EXPERIMENTAL_BRIGHTMAIL=yes
370 # CFLAGS += -I/opt/brightmail/bsdk-6.0/include
371 # LDFLAGS += -lxml2_single -lbmiclient_single -L/opt/brightmail/bsdk-6.0/lib
372
373
374
375 ###############################################################################
376 # THESE ARE THINGS YOU MIGHT WANT TO SPECIFY #
377 ###############################################################################
378
379 # The items in this section are those that are commonly changed according to
380 # the sysadmin's preferences, but whose defaults are often acceptable. The
381 # first five are concerned with security issues, where differing levels of
382 # paranoia are appropriate in different environments. Sysadmins also vary in
383 # their views on appropriate levels of defence in these areas. If you do not
384 # understand these issues, go with the defaults, which are used by many sites.
385
386
387 #------------------------------------------------------------------------------
388 # Although Exim is normally a setuid program, owned by root, it refuses to run
389 # local deliveries as root by default. There is a runtime option called
390 # "never_users" which lists the users that must never be used for local
391 # deliveries. There is also the setting below, which provides a list that
392 # cannot be overridden at runtime. This guards against problems caused by
393 # unauthorized changes to the runtime configuration. You are advised not to
394 # remove "root" from this option, but you can add other users if you want. The
395 # list is colon-separated. It must NOT contain any spaces.
396
397 # FIXED_NEVER_USERS=root:bin:daemon
398 FIXED_NEVER_USERS=root
399
400
401 #------------------------------------------------------------------------------
402 # By default, Exim insists that its configuration file be owned either by root
403 # or by the Exim user. You can specify one additional permitted owner here.
404
405 # CONFIGURE_OWNER=
406
407 # If the configuration file is group-writeable, Exim insists by default that it
408 # is owned by root or the Exim user. You can specify one additional permitted
409 # group owner here.
410
411 # CONFIGURE_GROUP=
412
413 # If you specify CONFIGURE_OWNER or CONFIGURE_GROUP as a name, this is looked
414 # up at build time, and the uid or gid number is built into the binary.
415 # However, you can specify that the lookup is deferred until runtime. In this
416 # case, it is the name that is built into the binary. You can do this by a
417 # setting of the form:
418
419 # CONFIGURE_OWNER=ref:mail
420 # CONFIGURE_GROUP=ref:sysadmin
421
422 # In other words, put "ref:" in front of the user or group name. Although this
423 # costs a bit of resource at runtime, it is convenient to use this feature when
424 # building binaries that are to be run on multiple systems where the names may
425 # refer to different uids or gids. It also allows you to build Exim on a system
426 # where the relevant user or group is not defined.
427
428
429 #------------------------------------------------------------------------------
430 # The -C option allows Exim to be run with an alternate runtime configuration
431 # file. When this is used by root or the Exim user, root privilege is retained
432 # by the binary (for any other caller, it is dropped). You can restrict the
433 # location of alternate configurations by defining a prefix below. Any file
434 # used with -C must then start with this prefix (except that /dev/null is also
435 # permitted if the caller is root, because that is used in the install script).
436 # If the prefix specifies a directory that is owned by root, a compromise of
437 # the Exim account does not permit arbitrary alternate configurations to be
438 # used. The prefix can be more restrictive than just a directory (the second
439 # example).
440
441 # ALT_CONFIG_PREFIX=/some/directory/
442 # ALT_CONFIG_PREFIX=/some/directory/exim.conf-
443
444
445 #------------------------------------------------------------------------------
446 # If you uncomment the following line, only root may use the -C or -D options
447 # without losing root privilege. The -C option specifies an alternate runtime
448 # configuration file, and the -D option changes macro values in the runtime
449 # configuration. Uncommenting this line restricts what can be done with these
450 # options. A call to receive a message (either one-off or via a daemon) cannot
451 # successfully continue to deliver it, because the re-exec of Exim to regain
452 # root privilege will fail, owing to the use of -C or -D by the Exim user.
453 # However, you can still use -C for testing (as root) if you do separate Exim
454 # calls for receiving a message and subsequently delivering it.
455
456 # ALT_CONFIG_ROOT_ONLY=yes
457
458
459 #------------------------------------------------------------------------------
460 # Uncommenting this option disables the use of the -D command line option,
461 # which changes the values of macros in the runtime configuration file.
462 # This is another protection against somebody breaking into the Exim account.
463
464 # DISABLE_D_OPTION=yes
465
466
467 #------------------------------------------------------------------------------
468 # Exim has support for the AUTH (authentication) extension of the SMTP
469 # protocol, as defined by RFC 2554. If you don't know what SMTP authentication
470 # is, you probably won't want to include this code, so you should leave these
471 # settings commented out. If you do want to make use of SMTP authentication,
472 # you must uncomment at least one of the following, so that appropriate code is
473 # included in the Exim binary. You will then need to set up the run time
474 # configuration to make use of the mechanism(s) selected.
475
476 # AUTH_CRAM_MD5=yes
477 # AUTH_CYRUS_SASL=yes
478 # AUTH_PLAINTEXT=yes
479 # AUTH_SPA=yes
480
481
482 #------------------------------------------------------------------------------
483 # If you specified AUTH_CYRUS_SASL above, you should ensure that you have the
484 # Cyrus SASL library installed before trying to build Exim, and you probably
485 # want to uncomment the following line:
486
487 # AUTH_LIBS=-lsasl2
488
489
490 #------------------------------------------------------------------------------
491 # When Exim is decoding MIME "words" in header lines, most commonly for use
492 # in the $header_xxx expansion, it converts any foreign character sets to the
493 # one that is set in the headers_charset option. The default setting is
494 # defined by this setting:
495
496 HEADERS_CHARSET="ISO-8859-1"
497
498 # If you are going to make use of $header_xxx expansions in your configuration
499 # file, or if your users are going to use them in filter files, and the normal
500 # character set on your host is something other than ISO-8859-1, you might
501 # like to specify a different default here. This value can be overridden in
502 # the runtime configuration, and it can also be overridden in individual filter
503 # files.
504 #
505 # IMPORTANT NOTE: The iconv() function is needed for character code
506 # conversions. Please see the next item...
507
508
509 #------------------------------------------------------------------------------
510 # Character code conversions are possible only if the iconv() function is
511 # installed on your operating system. There are two places in Exim where this
512 # is relevant: (a) The $header_xxx expansion (see the previous item), and (b)
513 # the Sieve filter support. For those OS where iconv() is known to be installed
514 # as standard, the file in OS/Makefile-xxxx contains
515 #
516 # HAVE_ICONV=yes
517 #
518 # If you are not using one of those systems, but have installed iconv(), you
519 # need to uncomment that line above. In some cases, you may find that iconv()
520 # and its header file are not in the default places. You might need to use
521 # something like this:
522 #
523 # HAVE_ICONV=yes
524 # CFLAGS=-O -I/usr/local/include
525 # EXTRALIBS_EXIM=-L/usr/local/lib -liconv
526 #
527 # but of course there may need to be other things in CFLAGS and EXTRALIBS_EXIM
528 # as well.
529
530
531 #------------------------------------------------------------------------------
532 # The passwords for user accounts are normally encrypted with the crypt()
533 # function. Comparisons with encrypted passwords can be done using Exim's
534 # "crypteq" expansion operator. (This is commonly used as part of the
535 # configuration of an authenticator for use with SMTP AUTH.) At least one
536 # operating system has an extended function called crypt16(), which uses up to
537 # 16 characters of a password (the normal crypt() uses only the first 8). Exim
538 # supports the use of crypt16() as well as crypt().
539
540 # You can always indicate a crypt16-encrypted password by preceding it with
541 # "{crypt16}". If you want the default handling (without any preceding
542 # indicator) to use crypt16(), uncomment the following line:
543
544 # DEFAULT_CRYPT=crypt16
545
546 # If you do that, you can still access the basic crypt() function by preceding
547 # an encrypted password with "{crypt}". For more details, see the description
548 # of the "crypteq" condition in the manual chapter on string expansions.
549
550 # Since most operating systems do not include a crypt16() function (yet?), Exim
551 # has one of its own, which it uses unless HAVE_CRYPT16 is defined. Normally,
552 # that will be set in an OS-specific Makefile for the OS that have such a
553 # function, so you should not need to bother with it.
554
555
556 #------------------------------------------------------------------------------
557 # Exim can be built to support the SMTP STARTTLS command, which implements
558 # Transport Layer Security using SSL (Secure Sockets Layer). To do this, you
559 # must install the OpenSSL library package or the GnuTLS library. Exim contains
560 # no cryptographic code of its own. Uncomment the following lines if you want
561 # to build Exim with TLS support. If you don't know what this is all about,
562 # leave these settings commented out.
563
564 # This setting is required for any TLS support (either OpenSSL or GnuTLS)
565 # SUPPORT_TLS=yes
566
567 # Uncomment this setting if you are using OpenSSL
568 # TLS_LIBS=-lssl -lcrypto
569
570 # Uncomment these settings if you are using GnuTLS
571 # USE_GNUTLS=yes
572 # TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
573
574 # If you are running Exim as a server, note that just building it with TLS
575 # support is not all you need to do. You also need to set up a suitable
576 # certificate, and tell Exim about it by means of the tls_certificate
577 # and tls_privatekey run time options. You also need to set tls_advertise_hosts
578 # to specify the hosts to which Exim advertises TLS support. On the other hand,
579 # if you are running Exim only as a client, building it with TLS support
580 # is all you need to do.
581
582 # Additional libraries and include files are required for both OpenSSL and
583 # GnuTLS. The TLS_LIBS settings above assume that the libraries are installed
584 # with all your other libraries. If they are in a special directory, you may
585 # need something like
586
587 # TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
588 # or
589 # TLS_LIBS=-L/opt/gnu/lib -lgnutls -ltasn1 -lgcrypt
590
591 # TLS_LIBS is included only on the command for linking Exim itself, not on any
592 # auxiliary programs. If the include files are not in a standard place, you can
593 # set TLS_INCLUDE to specify where they are, for example:
594
595 # TLS_INCLUDE=-I/usr/local/openssl/include/
596 # or
597 # TLS_INCLUDE=-I/opt/gnu/include
598
599 # You don't need to set TLS_INCLUDE if the relevant directories are already
600 # specified in INCLUDE.
601
602
603 #------------------------------------------------------------------------------
604 # The default distribution of Exim contains only the plain text form of the
605 # documentation. Other forms are available separately. If you want to install
606 # the documentation in "info" format, first fetch the Texinfo documentation
607 # sources from the ftp directory and unpack them, which should create files
608 # with the extension "texinfo" in the doc directory. You may find that the
609 # version number of the texinfo files is different to your Exim version number,
610 # because the main documentation isn't updated as often as the code. For
611 # example, if you have Exim version 4.43, the source tarball upacks into a
612 # directory called exim-4.43, but the texinfo tarball unpacks into exim-4.40.
613 # In this case, move the contents of exim-4.40/doc into exim-4.43/doc after you
614 # have unpacked them. Then set INFO_DIRECTORY to the location of your info
615 # directory. This varies from system to system, but is often /usr/share/info.
616 # Once you have done this, "make install" will build the info files and
617 # install them in the directory you have defined.
618
619 # INFO_DIRECTORY=/usr/share/info
620
621
622 #------------------------------------------------------------------------------
623 # Exim log directory and files: Exim creates several log files inside a
624 # single log directory. You can define the directory and the form of the
625 # log file name here. If you do not set anything, Exim creates a directory
626 # called "log" inside its spool directory (see SPOOL_DIRECTORY above) and uses
627 # the filenames "mainlog", "paniclog", and "rejectlog". If you want to change
628 # this, you can set LOG_FILE_PATH to a path name containing one occurrence of
629 # %s. This will be replaced by one of the strings "main", "panic", or "reject"
630 # to form the final file names. Some installations may want something like this:
631
632 # LOG_FILE_PATH=/var/log/exim_%slog
633
634 # which results in files with names /var/log/exim_mainlog, etc. The directory
635 # in which the log files are placed must exist; Exim does not try to create
636 # it for itself. It is also your responsibility to ensure that Exim is capable
637 # of writing files using this path name. The Exim user (see EXIM_USER above)
638 # must be able to create and update files in the directory you have specified.
639
640 # You can also configure Exim to use syslog, instead of or as well as log
641 # files, by settings such as these
642
643 # LOG_FILE_PATH=syslog
644 # LOG_FILE_PATH=syslog:/var/log/exim_%slog
645
646 # The first of these uses only syslog; the second uses syslog and also writes
647 # to log files. Do not include white space in such a setting as it messes up
648 # the building process.
649
650
651 #------------------------------------------------------------------------------
652 # When logging to syslog, the following option caters for syslog replacements
653 # that are able to accept log entries longer than the 1024 characters allowed
654 # by RFC 3164. It is up to you to make sure your syslog daemon can handle this.
655 # Non-printable characters are usually unacceptable regardless, so log entries
656 # are still split on newline characters.
657
658 # SYSLOG_LONG_LINES=yes
659
660 # If you are not interested in the process identifier (pid) of the Exim that is
661 # making the call to syslog, then comment out the following line.
662
663 SYSLOG_LOG_PID=yes
664
665
666 #------------------------------------------------------------------------------
667 # Cycling log files: this variable specifies the maximum number of old
668 # log files that are kept by the exicyclog log-cycling script. You don't have
669 # to use exicyclog. If your operating system has other ways of cycling log
670 # files, you can use them instead. The exicyclog script isn't run by default;
671 # you have to set up a cron job for it if you want it.
672
673 EXICYCLOG_MAX=10
674
675
676 #------------------------------------------------------------------------------
677 # The compress command is used by the exicyclog script to compress old log
678 # files. Both the name of the command and the suffix that it adds to files
679 # need to be defined here. See also the EXICYCLOG_MAX configuration.
680
681 COMPRESS_COMMAND=/usr/bin/gzip
682 COMPRESS_SUFFIX=gz
683
684
685 #------------------------------------------------------------------------------
686 # If the exigrep utility is fed compressed log files, it tries to uncompress
687 # them using this command.
688
689 ZCAT_COMMAND=/usr/bin/zcat
690
691
692 #------------------------------------------------------------------------------
693 # Compiling in support for embedded Perl: If you want to be able to
694 # use Perl code in Exim's string manipulation language and you have Perl
695 # (version 5.004 or later) installed, set EXIM_PERL to perl.o. Using embedded
696 # Perl costs quite a lot of resources. Only do this if you really need it.
697
698 # EXIM_PERL=perl.o
699
700
701 #------------------------------------------------------------------------------
702 # Support for dynamically-loaded string expansion functions via ${dlfunc. If
703 # you are using gcc the dynamically-loaded object must be compiled with the
704 # -shared option, and you will need to add -export-dynamic to EXTRALIBS so
705 # that the local_scan API is made available by the linker. You may also need
706 # to add -ldl to EXTRALIBS so that dlopen() is available to Exim.
707
708 # EXPAND_DLFUNC=yes
709
710
711 #------------------------------------------------------------------------------
712 # Exim has support for PAM (Pluggable Authentication Modules), a facility
713 # which is available in the latest releases of Solaris and in some GNU/Linux
714 # distributions (see http://ftp.kernel.org/pub/linux/libs/pam/). The Exim
715 # support, which is intended for use in conjunction with the SMTP AUTH
716 # facilities, is included only when requested by the following setting:
717
718 # SUPPORT_PAM=yes
719
720 # You probably need to add -lpam to EXTRALIBS, and in some releases of
721 # GNU/Linux -ldl is also needed.
722
723
724 #------------------------------------------------------------------------------
725 # Support for authentication via Radius is also available. The Exim support,
726 # which is intended for use in conjunction with the SMTP AUTH facilities,
727 # is included only when requested by setting the following parameter to the
728 # location of your Radius configuration file:
729
730 # RADIUS_CONFIG_FILE=/etc/radiusclient/radiusclient.conf
731 # RADIUS_CONFIG_FILE=/etc/radius.conf
732
733 # If you have set RADIUS_CONFIG_FILE, you should also set one of these to
734 # indicate which RADIUS library is used:
735
736 # RADIUS_LIB_TYPE=RADIUSCLIENT
737 # RADIUS_LIB_TYPE=RADIUSCLIENTNEW
738 # RADIUS_LIB_TYPE=RADLIB
739
740 # RADIUSCLIENT is the radiusclient library; you probably need to add
741 # -lradiusclient to EXTRALIBS.
742 #
743 # The API for the radiusclient library was changed at release 0.4.0.
744 # Unfortunately, the header file does not define a version number that clients
745 # can use to support both the old and new APIs. If you are using version 0.4.0
746 # or later of the radiusclient library, you should use RADIUSCLIENTNEW.
747 #
748 # RADLIB is the Radius library that comes with FreeBSD (the header file is
749 # called radlib.h); you probably need to add -lradius to EXTRALIBS.
750 #
751 # If you do not set RADIUS_LIB_TYPE, Exim assumes the radiusclient library,
752 # using the original API.
753
754
755 #------------------------------------------------------------------------------
756 # Support for authentication via the Cyrus SASL pwcheck daemon is available.
757 # Note, however, that pwcheck is now deprecated in favour of saslauthd (see
758 # next item). The Exim support for pwcheck, which is intented for use in
759 # conjunction with the SMTP AUTH facilities, is included only when requested by
760 # setting the following parameter to the location of the pwcheck daemon's
761 # socket.
762 #
763 # There is no need to install all of SASL on your system. You just need to run
764 # ./configure --with-pwcheck, cd to the pwcheck directory within the sources,
765 # make and make install. You must create the socket directory (default
766 # /var/pwcheck) and chown it to exim's user and group. Once you have installed
767 # pwcheck, you should arrange for it to be started by root at boot time.
768
769 # CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
770
771
772 #------------------------------------------------------------------------------
773 # Support for authentication via the Cyrus SASL saslauthd daemon is available.
774 # The Exim support, which is intented for use in conjunction with the SMTP AUTH
775 # facilities, is included only when requested by setting the following
776 # parameter to the location of the saslauthd daemon's socket.
777 #
778 # There is no need to install all of SASL on your system. You just need to run
779 # ./configure --with-saslauthd (and any other options you need, for example, to
780 # select or deselect authentication mechanisms), cd to the saslauthd directory
781 # within the sources, make and make install. You must create the socket
782 # directory (default /var/state/saslauthd) and chown it to exim's user and
783 # group. Once you have installed saslauthd, you should arrange for it to be
784 # started by root at boot time.
785
786 # CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
787
788
789 #------------------------------------------------------------------------------
790 # TCP wrappers: If you want to use tcpwrappers from within Exim, uncomment
791 # this setting. See the manual section entitled "Use of tcpwrappers" in the
792 # chapter on building and installing Exim.
793 #
794 # USE_TCP_WRAPPERS=yes
795 #
796 # You may well also have to specify a local "include" file and an additional
797 # library for TCP wrappers, so you probably need something like this:
798 #
799 # USE_TCP_WRAPPERS=yes
800 # CFLAGS=-O -I/usr/local/include
801 # EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
802 #
803 # but of course there may need to be other things in CFLAGS and EXTRALIBS_EXIM
804 # as well.
805
806
807 #------------------------------------------------------------------------------
808 # The default action of the exim_install script (which is run by "make
809 # install") is to install the Exim binary with a unique name such as
810 # exim-4.43-1, and then set up a symbolic link called "exim" to reference it,
811 # moving the symbolic link from any previous version. If you define NO_SYMLINK
812 # (the value doesn't matter), the symbolic link is not created or moved. You
813 # will then have to "turn Exim on" by setting up the link manually.
814
815 # NO_SYMLINK=yes
816
817
818 #------------------------------------------------------------------------------
819 # Another default action of the install script is to install a default runtime
820 # configuration file if one does not exist. This configuration has a router for
821 # expanding system aliases. The default assumes that these aliases are kept
822 # in the traditional file called /etc/aliases. If such a file does not exist,
823 # the installation script creates one that contains just comments (no actual
824 # aliases). The following setting can be changed to specify a different
825 # location for the system alias file.
826
827 SYSTEM_ALIASES_FILE=/etc/aliases
828
829
830 #------------------------------------------------------------------------------
831 # There are some testing options (-be, -bt, -bv) that read data from the
832 # standard input when no arguments are supplied. By default, the input lines
833 # are read using the standard fgets() function. This does not support line
834 # editing during interactive input (though the terminal's "erase" character
835 # works as normal). If your operating system has the readline() function, and
836 # in addition supports dynamic loading of library functions, you can cause
837 # Exim to use readline() for the -be testing option (only) by uncommenting the
838 # following setting. Dynamic loading is used so that the library is loaded only
839 # when the -be testing option is given; by the time the loading occurs,
840 # Exim has given up its root privilege and is running as the calling user. This
841 # is the reason why readline() is NOT supported for -bt and -bv, because Exim
842 # runs as root or as exim, respectively, for those options. When USE_READLINE
843 # is "yes", as well as supporting line editing, a history of input lines in the
844 # current run is maintained.
845
846 # USE_READLINE=yes
847
848 # You may need to add -ldl to EXTRA_LIBS when you set USE_READLINE=yes.
849 # Note that this option adds to the size of the Exim binary, because the
850 # dynamic loading library is not otherwise included.
851
852
853
854 ###############################################################################
855 # THINGS YOU ALMOST NEVER NEED TO MENTION #
856 ###############################################################################
857
858 # The settings in this section are available for use in special circumstances.
859 # In the vast majority of installations you need not change anything below.
860
861
862 #------------------------------------------------------------------------------
863 # The following commands live in different places in some OS. Either the
864 # ultimate default settings, or the OS-specific files should already point to
865 # the right place, but they can be overridden here if necessary. These settings
866 # are used when building various scripts to ensure that the correct paths are
867 # used when the scripts are run. They are not used in the Makefile itself. Perl
868 # is not necessary for running Exim unless you set EXIM_PERL (see above) to get
869 # it embedded, but there are some utilities that are Perl scripts. If you
870 # haven't got Perl, Exim will still build and run; you just won't be able to
871 # use those utilities.
872
873 # CHOWN_COMMAND=/usr/bin/chown
874 # CHGRP_COMMAND=/usr/bin/chgrp
875 # MV_COMMAND=/bin/mv
876 # RM_COMMAND=/bin/rm
877 # PERL_COMMAND=/usr/bin/perl
878
879
880 #------------------------------------------------------------------------------
881 # The following macro can be used to change the command for building a library
882 # of functions. By default the "ar" command is used, with options "cq".
883 # Only in rare circumstances should you need to change this.
884
885 # AR=ar cq
886
887
888 #------------------------------------------------------------------------------
889 # In some operating systems, the value of the TMPDIR environment variable
890 # controls where temporary files are created. Exim does not make use of
891 # temporary files, except when delivering to MBX mailboxes. However, if Exim
892 # calls any external libraries (e.g. DBM libraries), they may use temporary
893 # files, and thus be influenced by the value of TMPDIR. For this reason, when
894 # Exim starts, it checks the environment for TMPDIR, and if it finds it is set,
895 # it replaces the value with what is defined here. Commenting this setting
896 # suppresses the check altogether.
897
898 TMPDIR="/tmp"
899
900
901 #------------------------------------------------------------------------------
902 # The following macros can be used to change the default modes that are used
903 # by the appendfile transport. In most installations the defaults are just
904 # fine, and in any case, you can change particular instances of the transport
905 # at run time if you want.
906
907 # APPENDFILE_MODE=0600
908 # APPENDFILE_DIRECTORY_MODE=0700
909 # APPENDFILE_LOCKFILE_MODE=0600
910
911
912 #------------------------------------------------------------------------------
913 # In some installations there may be multiple machines sharing file systems,
914 # where a different configuration file is required for Exim on the different
915 # machines. If CONFIGURE_FILE_USE_NODE is defined, then Exim will first look
916 # for a configuration file whose name is that defined by CONFIGURE_FILE,
917 # with the node name obtained by uname() tacked on the end, separated by a
918 # period (for example, /usr/exim/configure.host.in.some.domain). If this file
919 # does not exist, then the bare configuration file name is tried.
920
921 # CONFIGURE_FILE_USE_NODE=yes
922
923
924 #------------------------------------------------------------------------------
925 # In some esoteric configurations two different versions of Exim are run,
926 # with different setuid values, and different configuration files are required
927 # to handle the different cases. If CONFIGURE_FILE_USE_EUID is defined, then
928 # Exim will first look for a configuration file whose name is that defined
929 # by CONFIGURE_FILE, with the effective uid tacked on the end, separated by
930 # a period (for eximple, /usr/exim/configure.0). If this file does not exist,
931 # then the bare configuration file name is tried. In the case when both
932 # CONFIGURE_FILE_USE_EUID and CONFIGURE_FILE_USE_NODE are set, four files
933 # are tried: <name>.<euid>.<node>, <name>.<node>, <name>.<euid>, and <name>.
934
935 # CONFIGURE_FILE_USE_EUID=yes
936
937
938 #------------------------------------------------------------------------------
939 # The size of the delivery buffers: These specify the sizes (in bytes) of
940 # the buffers that are used when copying a message from the spool to a
941 # destination. There is rarely any need to change these values.
942
943 # DELIVER_IN_BUFFER_SIZE=8192
944 # DELIVER_OUT_BUFFER_SIZE=8192
945
946
947 #------------------------------------------------------------------------------
948 # The mode of the database directory: Exim creates a directory called "db"
949 # in its spool directory, to hold its databases of hints. This variable
950 # determines the mode of the created directory. The default value in the
951 # source is 0750.
952
953 # EXIMDB_DIRECTORY_MODE=0750
954
955
956 #------------------------------------------------------------------------------
957 # Database file mode: The mode of files created in the "db" directory defaults
958 # to 0640 in the source, and can be changed here.
959
960 # EXIMDB_MODE=0640
961
962
963 #------------------------------------------------------------------------------
964 # Database lock file mode: The mode of zero-length files created in the "db"
965 # directory to use for locking purposes defaults to 0640 in the source, and
966 # can be changed here.
967
968 # EXIMDB_LOCKFILE_MODE=0640
969
970
971 #------------------------------------------------------------------------------
972 # This parameter sets the maximum length of the header portion of a message
973 # that Exim is prepared to process. The default setting is one megabyte. The
974 # limit exists in order to catch rogue mailers that might connect to your SMTP
975 # port, start off a header line, and then just pump junk at it for ever. The
976 # message_size_limit option would also catch this, but it may not be set.
977 # The value set here is the default; it can be changed at runtime.
978
979 # HEADER_MAXSIZE="(1024*1024)"
980
981
982 #------------------------------------------------------------------------------
983 # The mode of the input directory: The input directory is where messages are
984 # kept while awaiting delivery. Exim creates it if necessary, using a mode
985 # which can be defined here (default 0750).
986
987 # INPUT_DIRECTORY_MODE=0750
988
989
990 #------------------------------------------------------------------------------
991 # The mode of Exim's log directory, when it is created by Exim inside the spool
992 # directory, defaults to 0750 but can be changed here.
993
994 # LOG_DIRECTORY_MODE=0750
995
996
997 #------------------------------------------------------------------------------
998 # The log files themselves are created as required, with a mode that defaults
999 # to 0640, but which can be changed here.
1000
1001 # LOG_MODE=0640
1002
1003
1004 #------------------------------------------------------------------------------
1005 # The TESTDB lookup is for performing tests on the handling of lookup results,
1006 # and is not useful for general running. It should be included only when
1007 # debugging the code of Exim.
1008
1009 # LOOKUP_TESTDB=yes
1010
1011
1012 #------------------------------------------------------------------------------
1013 # /bin/sh is used by default as the shell in which to run commands that are
1014 # defined in the makefiles. This can be changed if necessary, by uncommenting
1015 # this line and specifying another shell, but note that a Bourne-compatible
1016 # shell is expected.
1017
1018 # MAKE_SHELL=/bin/sh
1019
1020
1021 #------------------------------------------------------------------------------
1022 # The maximum number of named lists of each type (address, domain, host, and
1023 # local part) can be increased by changing this value. It should be set to
1024 # a multiple of 16.
1025
1026 # MAX_NAMED_LIST=16
1027
1028
1029 #------------------------------------------------------------------------------
1030 # Network interfaces: Unless you set the local_interfaces option in the runtime
1031 # configuration file to restrict Exim to certain interfaces only, it will run
1032 # code to find all the interfaces there are on your host. Unfortunately,
1033 # the call to the OS that does this requires a buffer large enough to hold
1034 # data for all the interfaces - it was designed in the days when a host rarely
1035 # had more than three or four interfaces. Nowadays hosts can have very many
1036 # virtual interfaces running on the same hardware. If you have more than 250
1037 # virtual interfaces, you will need to uncomment this setting and increase the
1038 # value.
1039
1040 # MAXINTERFACES=250
1041
1042
1043 #------------------------------------------------------------------------------
1044 # Per-message logs: While a message is in the process of being delivered,
1045 # comments on its progress are written to a message log, for the benefit of
1046 # human administrators. These logs are held in a directory called "msglog"
1047 # in the spool directory. Its mode defaults to 0750, but can be changed here.
1048 # The message log directory is also used for storing files that are used by
1049 # transports for returning data to a message's sender (see the "return_output"
1050 # option for transports).
1051
1052 # MSGLOG_DIRECTORY_MODE=0750
1053
1054
1055 #------------------------------------------------------------------------------
1056 # There are three options which are used when compiling the Perl interface and
1057 # when linking with Perl. The default values for these are placed automatically
1058 # at the head of the Makefile by the script which builds it. However, if you
1059 # want to override them, you can do so here.
1060
1061 # PERL_CC=
1062 # PERL_CCOPTS=
1063 # PERL_LIBS=
1064
1065
1066 #------------------------------------------------------------------------------
1067 # Identifying the daemon: When an Exim daemon starts up, it writes its pid
1068 # (process id) to a file so that it can easily be identified. The path of the
1069 # file can be specified here. Some installations may want something like this:
1070
1071 # PID_FILE_PATH=/var/lock/exim.pid
1072
1073 # If PID_FILE_PATH is not defined, Exim writes a file in its spool directory
1074 # using the name "exim-daemon.pid".
1075
1076 # If you start up a daemon without the -bd option (for example, with just
1077 # the -q15m option), a pid file is not written. Also, if you override the
1078 # configuration file with the -oX option, no pid file is written. In other
1079 # words, the pid file is written only for a "standard" daemon.
1080
1081
1082 #------------------------------------------------------------------------------
1083 # If Exim creates the spool directory, it is given this mode, defaulting in the
1084 # source to 0750.
1085
1086 # SPOOL_DIRECTORY_MODE=0750
1087
1088
1089 #------------------------------------------------------------------------------
1090 # The mode of files on the input spool which hold the contents of messages can
1091 # be changed here. The default is 0640 so that information from the spool is
1092 # available to anyone who is a member of the Exim group.
1093
1094 # SPOOL_MODE=0640
1095
1096
1097 #------------------------------------------------------------------------------
1098 # Moving frozen messages: If the following is uncommented, Exim is compiled
1099 # with support for automatically moving frozen messages out of the main spool
1100 # directory, a facility that is found useful by some large installations. A
1101 # run time option is required to cause the moving actually to occur. Such
1102 # messages become "invisible" to the normal management tools.
1103
1104 # SUPPORT_MOVE_FROZEN_MESSAGES=yes
1105
1106 # End of EDITME for Exim 4.