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