15932691e383a9ce8ea7a6497979032a454cb6c3
[exim.git] / src / src / EDITME
1 ##################################################
2 #          The Exim mail transport agent         #
3 ##################################################
4
5 # This is the template for Exim's main build-time configuration file. It
6 # contains settings that are independent of any operating system. These are
7 # things that are mostly sysadmin choices. The items below are divided into
8 # those you must specify, those you probably want to specify, those you might
9 # often want to specify, and those that you almost never need to mention.
10
11 # Edit this file and save the result to a file called Local/Makefile within the
12 # Exim distribution directory before running the "make" command.
13
14 # Things that depend on the operating system have default settings in
15 # OS/Makefile-Default, but these are overridden for some OS by files called
16 # called OS/Makefile-<osname>. You can further override these by creating files
17 # called Local/Makefile-<osname>, where "<osname>" stands for the name of your
18 # operating system - look at the names in the OS directory to see which names
19 # are recognized.
20
21 # However, if you are building Exim for a single OS only, you don't need to
22 # worry about setting up Local/Makefile-<osname>. Any build-time configuration
23 # settings you require can in fact be placed in the one file called
24 # Local/Makefile. It is only if you are building for several OS from the same
25 # source files that you need to worry about splitting off your own OS-dependent
26 # settings into separate files. (There's more explanation about how this all
27 # works in the toplevel README file, under "Modifying the building process", as
28 # well as in the Exim specification.)
29
30 # One OS-specific thing that may need to be changed is the command for running
31 # the C compiler; the overall default is gcc, but some OS Makefiles specify cc.
32 # You can override anything that is set by putting CC=whatever in your
33 # Local/Makefile.
34
35 # NOTE: You should never need to edit any of the distributed Makefiles; all
36 # overriding can be done in your Local/Makefile(s). This will make it easier
37 # for you when the next release comes along.
38
39 # The location of the X11 libraries is something else that is quite variable
40 # even between different versions of the same operating system (and indeed
41 # there are different versions of X11 as well, of course). The four settings
42 # concerned here are X11, XINCLUDE, XLFLAGS (linking flags) and X11_LD_LIB
43 # (dynamic run-time library). You need not worry about X11 unless you want to
44 # compile the Exim monitor utility. Exim itself does not use X11.
45
46 # Another area of variability between systems is the type and location of the
47 # DBM library package. Exim has support for ndbm, gdbm, tdb, and Berkeley DB.
48 # By default the code assumes ndbm; this often works with gdbm or DB, provided
49 # they are correctly installed, via their compatibility interfaces. However,
50 # Exim can also be configured to use the native calls for Berkeley DB (obsolete
51 # versions 1.85, 2.x, 3.x, or the current 4.x version) and also for gdbm.
52
53 # For some operating systems, a default DBM library (other than ndbm) is
54 # selected by a setting in the OS-specific Makefile. Most modern OS now have
55 # a DBM library installed as standard, and in many cases this will be selected
56 # for you by the OS-specific configuration. If Exim compiles without any
57 # problems, you probably do not have to worry about the DBM library. If you
58 # do want or need to change it, you should first read the discussion in the
59 # file doc/dbm.discuss.txt, which also contains instructions for testing Exim's
60 # interface to the DBM library.
61
62 # In Local/Makefiles blank lines and lines starting with # are ignored. It is
63 # also permitted to use the # character to add a comment to a setting, for
64 # example
65 #
66 # EXIM_GID=42   # the "mail" group
67 #
68 # However, with some versions of "make" this works only if there is no white
69 # space between the end of the setting and the #, so perhaps it is best
70 # avoided. A consequence of this facility is that it is not possible to have
71 # the # character present in any setting, but I can't think of any cases where
72 # this would be wanted.
73 ###############################################################################
74
75
76
77 ###############################################################################
78 #                    THESE ARE THINGS YOU MUST SPECIFY                        #
79 ###############################################################################
80
81 # Exim will not build unless you specify BIN_DIRECTORY, CONFIGURE_FILE, and
82 # EXIM_USER. You also need EXIM_GROUP if EXIM_USER specifies a uid by number.
83
84 # If you don't specify SPOOL_DIRECTORY, Exim won't fail to build. However, it
85 # really is a very good idea to specify it here rather than at run time. This
86 # is particularly true if you let the logs go to their default location in the
87 # spool directory, because it means that the location of the logs is known
88 # before Exim has read the run time configuration file.
89
90 #------------------------------------------------------------------------------
91 # BIN_DIRECTORY defines where the exim binary will be installed by "make
92 # install". The path is also used internally by Exim when it needs to re-invoke
93 # itself, either to send an error message, or to recover root privilege. Exim's
94 # utility binaries and scripts are also installed in this directory. There is
95 # no "standard" place for the binary directory. Some people like to keep all
96 # the Exim files under one directory such as /usr/exim; others just let the
97 # Exim binaries go into an existing directory such as /usr/sbin or
98 # /usr/local/sbin. The installation script will try to create this directory,
99 # and any superior directories, if they do not exist.
100
101 BIN_DIRECTORY=/usr/exim/bin
102
103
104 #------------------------------------------------------------------------------
105 # CONFIGURE_FILE defines where Exim's run time configuration file is to be
106 # found. It is the complete pathname for the file, not just a directory. The
107 # location of all other run time files and directories can be changed in the
108 # run time configuration file. There is a lot of variety in the choice of
109 # location in different OS, and in the preferences of different sysadmins. Some
110 # common locations are in /etc or /etc/mail or /usr/local/etc or
111 # /usr/local/etc/mail. Another possibility is to keep all the Exim files under
112 # a single directory such as /usr/exim. Whatever you choose, the installation
113 # script will try to make the directory and any superior directories if they
114 # don't exist. It will also install a default runtime configuration if this
115 # file does not exist.
116
117 CONFIGURE_FILE=/usr/exim/configure
118
119 # It is possible to specify a colon-separated list of files for CONFIGURE_FILE.
120 # In this case, Exim will use the first of them that exists when it is run.
121 # However, if a list is specified, the installation script no longer tries to
122 # make superior directories or to install a default runtime configuration.
123
124
125 #------------------------------------------------------------------------------
126 # The Exim binary must normally be setuid root, so that it starts executing as
127 # root, but (depending on the options with which it is called) it does not
128 # always need to retain the root privilege. These settings define the user and
129 # group that is used for Exim processes when they no longer need to be root. In
130 # particular, this applies when receiving messages and when doing remote
131 # deliveries. (Local deliveries run as various non-root users, typically as the
132 # owner of a local mailbox.) Specifying these values as root is not supported.
133
134 EXIM_USER=
135
136 # If you specify EXIM_USER as a name, this is looked up at build time, and the
137 # uid number is built into the binary. However, you can specify that this
138 # lookup is deferred until runtime. In this case, it is the name that is built
139 # into the binary. You can do this by a setting of the form:
140
141 # EXIM_USER=ref:exim
142
143 # In other words, put "ref:" in front of the user name. If you set EXIM_USER
144 # like this, any value specified for EXIM_GROUP is also passed "by reference".
145 # Although this costs a bit of resource at runtime, it is convenient to use
146 # this feature when building binaries that are to be run on multiple systems
147 # where the name may refer to different uids. It also allows you to build Exim
148 # on a system where there is no Exim user defined.
149
150 # If the setting of EXIM_USER is numeric (e.g. EXIM_USER=42), there must
151 # also be a setting of EXIM_GROUP. If, on the other hand, you use a name
152 # for EXIM_USER (e.g. EXIM_USER=exim), you don't need to set EXIM_GROUP unless
153 # you want to use a group other than the default group for the given user.
154
155 # EXIM_GROUP=
156
157 # Many sites define a user called "exim", with an appropriate default group,
158 # and use
159 #
160 # EXIM_USER=exim
161 #
162 # while leaving EXIM_GROUP unspecified (commented out).
163
164
165 #------------------------------------------------------------------------------
166 # SPOOL_DIRECTORY defines the directory where all the data for messages in
167 # transit is kept. It is strongly recommended that you define it here, though
168 # it is possible to leave this till the run time configuration.
169
170 # Exim creates the spool directory if it does not exist. The owner and group
171 # will be those defined by EXIM_USER and EXIM_GROUP, and this also applies to
172 # all the files and directories that are created in the spool directory.
173
174 # Almost all installations choose this:
175
176 SPOOL_DIRECTORY=/var/spool/exim
177
178
179
180 ###############################################################################
181 #           THESE ARE THINGS YOU PROBABLY WANT TO SPECIFY                     #
182 ###############################################################################
183
184 # If you need extra header file search paths on all compiles, put the -I
185 # options in INCLUDE.  If you want the extra searches only for certain
186 # parts of the build, see more specific xxx_INCLUDE variables below.
187
188 # INCLUDE=-I/example/include
189
190 # You need to specify some routers and transports if you want the Exim that you
191 # are building to be capable of delivering mail. You almost certainly need at
192 # least one type of lookup. You should consider whether you want to build
193 # the Exim monitor or not.
194
195
196 #------------------------------------------------------------------------------
197 # These settings determine which individual router drivers are included in the
198 # Exim binary. There are no defaults in the code; those routers that are wanted
199 # must be defined here by setting the appropriate variables to the value "yes".
200 # Including a router in the binary does not cause it to be used automatically.
201 # It has also to be configured in the run time configuration file. By
202 # commenting out those you know you don't want to use, you can make the binary
203 # a bit smaller. If you are unsure, leave all of these included for now.
204
205 ROUTER_ACCEPT=yes
206 ROUTER_DNSLOOKUP=yes
207 ROUTER_IPLITERAL=yes
208 ROUTER_MANUALROUTE=yes
209 ROUTER_QUERYPROGRAM=yes
210 ROUTER_REDIRECT=yes
211
212 # This one is very special-purpose, so is not included by default.
213
214 # ROUTER_IPLOOKUP=yes
215
216
217 #------------------------------------------------------------------------------
218 # These settings determine which individual transport drivers are included in
219 # the Exim binary. There are no defaults; those transports that are wanted must
220 # be defined here by setting the appropriate variables to the value "yes".
221 # Including a transport in the binary does not cause it to be used
222 # automatically. It has also to be configured in the run time configuration
223 # file. By commenting out those you know you don't want to use, you can make
224 # the binary a bit smaller. If you are unsure, leave all of these included for
225 # now.
226
227 TRANSPORT_APPENDFILE=yes
228 TRANSPORT_AUTOREPLY=yes
229 TRANSPORT_PIPE=yes
230 TRANSPORT_SMTP=yes
231
232 # This one is special-purpose, and commonly not required, so it is not
233 # included by default.
234
235 # TRANSPORT_LMTP=yes
236
237
238 #------------------------------------------------------------------------------
239 # The appendfile transport can write messages to local mailboxes in a number
240 # of formats. The code for three specialist formats, maildir, mailstore, and
241 # MBX, is included only when requested. If you do not know what this is about,
242 # leave these settings commented out.
243
244 # SUPPORT_MAILDIR=yes
245 # SUPPORT_MAILSTORE=yes
246 # SUPPORT_MBX=yes
247
248
249 #------------------------------------------------------------------------------
250 # See below for dynamic lookup modules.
251 #
252 # If not using package management but using this anyway, then think about how
253 # you perform upgrades and revert them. You should consider the benefit of
254 # embedding the Exim version number into LOOKUP_MODULE_DIR, so that you can
255 # maintain two concurrent sets of modules.
256
257 # *BEWARE*: ability to modify the files in LOOKUP_MODULE_DIR is equivalent to
258 # the ability to modify the Exim binary, which is often setuid root!  The Exim
259 # developers only intend this functionality be used by OS software packagers
260 # and we suggest that such packagings' integrity checks should be paranoid
261 # about the permissions of the directory and the files within.
262
263 # LOOKUP_MODULE_DIR=/usr/lib/exim/lookups/
264
265 # To build a module dynamically, you'll need to define CFLAGS_DYNAMIC for
266 # your platform.  Eg:
267 # CFLAGS_DYNAMIC=-shared -rdynamic
268 # CFLAGS_DYNAMIC=-shared -rdynamic -fPIC
269
270 #------------------------------------------------------------------------------
271 # These settings determine which file and database lookup methods are included
272 # in the binary. See the manual chapter entitled "File and database lookups"
273 # for discussion. DBM and lsearch (linear search) are included by default. If
274 # you are unsure about the others, leave them commented out for now.
275 # LOOKUP_DNSDB does *not* refer to general mail routing using the DNS. It is
276 # for the specialist case of using the DNS as a general database facility (not
277 # common).
278 # If set to "2" instead of "yes" then the corresponding lookup will be
279 # built as a module and must be installed into LOOKUP_MODULE_DIR. You need to
280 # add -export-dynamic -rdynamic to EXTRALIBS. You may also need to add -ldl to
281 # EXTRALIBS so that dlopen() is available to Exim. You need to define
282 # LOOKUP_MODULE_DIR above so the exim binary actually loads dynamic lookup
283 # modules.
284 # Also, instead of adding all the libraries/includes to LOOKUP_INCLUDE and
285 # LOOKUP_LIBS, add them to the respective LOOKUP_*_INCLUDE and LOOKUP_*_LIBS
286 # (where * is the name as given here in this list). That ensures that only
287 # the dynamic library and not the exim binary will be linked against the
288 # library.
289 # NOTE: LDAP cannot be built as a module!
290 #
291 # For Redis you need to have hiredis installed on your system
292 # (https://github.com/redis/hiredis).
293 # Depending on where it is installed you may have to edit the CFLAGS
294 # (often += -I/usr/local/include) and LDFLAGS (-lhiredis) lines.
295
296 # If your system has pkg-config then the _INCLUDE/_LIBS setting can be
297 # handled for you automatically by also defining the _PC variable to reference
298 # the name of the pkg-config package, if such is available.
299
300 LOOKUP_DBM=yes
301 LOOKUP_LSEARCH=yes
302 LOOKUP_DNSDB=yes
303
304 # LOOKUP_CDB=yes
305 # LOOKUP_DSEARCH=yes
306 # LOOKUP_IBASE=yes
307 # LOOKUP_LDAP=yes
308 # LOOKUP_MYSQL=yes
309 # LOOKUP_NIS=yes
310 # LOOKUP_NISPLUS=yes
311 # LOOKUP_ORACLE=yes
312 # LOOKUP_PASSWD=yes
313 # LOOKUP_PGSQL=yes
314 # LOOKUP_REDIS=yes
315 # LOOKUP_SQLITE=yes
316 # LOOKUP_SQLITE_PC=sqlite3
317 # LOOKUP_WHOSON=yes
318
319 # These two settings are obsolete; all three lookups are compiled when
320 # LOOKUP_LSEARCH is enabled. However, we retain these for backward
321 # compatibility. Setting one forces LOOKUP_LSEARCH if it is not set.
322
323 # LOOKUP_WILDLSEARCH=yes
324 # LOOKUP_NWILDLSEARCH=yes
325
326
327 #------------------------------------------------------------------------------
328 # If you have set LOOKUP_LDAP=yes, you should set LDAP_LIB_TYPE to indicate
329 # which LDAP library you have. Unfortunately, though most of their functions
330 # are the same, there are minor differences. Currently Exim knows about four
331 # LDAP libraries: the one from the University of Michigan (also known as
332 # OpenLDAP 1), OpenLDAP 2, the Netscape SDK library, and the library that comes
333 # with Solaris 7 onwards. Uncomment whichever of these you are using.
334
335 # LDAP_LIB_TYPE=OPENLDAP1
336 # LDAP_LIB_TYPE=OPENLDAP2
337 # LDAP_LIB_TYPE=NETSCAPE
338 # LDAP_LIB_TYPE=SOLARIS
339
340 # If you don't set any of these, Exim assumes the original University of
341 # Michigan (OpenLDAP 1) library.
342
343
344 #------------------------------------------------------------------------------
345 # The PCRE library is required for Exim.  There is no longer an embedded
346 # version of the PCRE library included with the source code, instead you
347 # must use a system library or build your own copy of PCRE.
348 # In either case you must specify the library link info here.  If the
349 # PCRE header files are not in the standard search path you must also
350 # modify the INCLUDE path (above)
351 #
352 # Use PCRE_CONFIG to query the pcre-config command (first found in $PATH)
353 # to find the include files and libraries, else use PCRE_LIBS and set INCLUDE
354 # too if needed.
355
356 PCRE_CONFIG=yes
357 # PCRE_LIBS=-lpcre
358
359
360 #------------------------------------------------------------------------------
361 # Additional libraries and include directories may be required for some
362 # lookup styles (e.g. LDAP, MYSQL or PGSQL). LOOKUP_LIBS is included only on
363 # the command for linking Exim itself, not on any auxiliary programs. You
364 # don't need to set LOOKUP_INCLUDE if the relevant directories are already
365 # specified in INCLUDE. The settings below are just examples; -lpq is for
366 # PostgreSQL, -lgds is for Interbase, -lsqlite3 is for SQLite, -lhiredis
367 # is for Redis.
368 #
369 # You do not need to use this for any lookup information added via pkg-config.
370
371 # LOOKUP_INCLUDE=-I /usr/local/ldap/include -I /usr/local/mysql/include -I /usr/local/pgsql/include
372 # LOOKUP_LIBS=-L/usr/local/lib -lldap -llber -lmysqlclient -lpq -lgds -lsqlite3
373
374
375 #------------------------------------------------------------------------------
376 # Compiling the Exim monitor: If you want to compile the Exim monitor, a
377 # program that requires an X11 display, then EXIM_MONITOR should be set to the
378 # value "eximon.bin". Comment out this setting to disable compilation of the
379 # monitor. The locations of various X11 directories for libraries and include
380 # files are defaulted in the OS/Makefile-Default file, but can be overridden in
381 # local OS-specific make files.
382
383 EXIM_MONITOR=eximon.bin
384
385
386 #------------------------------------------------------------------------------
387 # Compiling Exim with content scanning support: If you want to compile Exim
388 # with support for message body content scanning, set WITH_CONTENT_SCAN to
389 # the value "yes". This will give you malware and spam scanning in the DATA ACL,
390 # and the MIME ACL. Please read the documentation to learn more about these
391 # features.
392
393 # WITH_CONTENT_SCAN=yes
394
395 #------------------------------------------------------------------------------
396 # If you're using ClamAV and are backporting fixes to an old version, instead
397 # of staying current (which is the more usual approach) then you may need to
398 # use an older API which uses a STREAM command, now deprecated, instead of
399 # zINSTREAM.  If you need to set this, please let the Exim developers know, as
400 # if nobody reports a need for it, we'll remove this option and clean up the
401 # code.  zINSTREAM was introduced with ClamAV 0.95.
402 #
403 # WITH_OLD_CLAMAV_STREAM=yes
404
405
406 #------------------------------------------------------------------------------
407 # If built with TLS, Exim includes code to support DKIM (DomainKeys Identified
408 # Mail, RFC4871) signing and verification.  Verification of signatures is
409 # turned on by default.  See the spec for information on conditionally
410 # disabling it.  To disable the inclusion of the entire feature, set
411 # DISABLE_DKIM to "yes"
412
413 # DISABLE_DKIM=yes
414
415 #------------------------------------------------------------------------------
416 # Uncomment the following line to remove Per-Recipient-Data-Response support.
417
418 # DISABLE_PRDR=yes
419
420 #------------------------------------------------------------------------------
421 # Uncomment the following line to remove OCSP stapling support in TLS,
422 # from Exim.  Note it can only be supported when built with
423 # GnuTLS 3.1.3 or later, or OpenSSL
424
425 # DISABLE_OCSP=yes
426
427 #------------------------------------------------------------------------------
428 # By default, Exim has support for checking the AD bit in a DNS response, to
429 # determine if DNSSEC validation was successful.  If your system libraries
430 # do not support that bit, then set DISABLE_DNSSEC to "yes"
431 # Note: Enabling EXPERIMENTAL_DANE unconditionally overrides this setting.
432
433 # DISABLE_DNSSEC=yes
434
435 # To disable support for Events set DISABLE_EVENT to "yes"
436
437 # DISABLE_EVENT=yes
438
439
440 #------------------------------------------------------------------------------
441 # Compiling Exim with experimental features. These are documented in
442 # experimental-spec.txt. "Experimental" means that the way these features are
443 # implemented may still change. Backward compatibility is not guaranteed.
444
445 # Uncomment the following line to add support for talking to dccifd.  This
446 # defaults the socket path to /usr/local/dcc/var/dccifd.
447 # Doing so will also explicitly turn on the WITH_CONTENT_SCAN option.
448
449 # EXPERIMENTAL_DCC=yes
450
451 # Uncomment the following lines to add SPF support. You need to have libspf2
452 # installed on your system (www.libspf2.org). Depending on where it is installed
453 # you may have to edit the CFLAGS and LDFLAGS lines.
454
455 # EXPERIMENTAL_SPF=yes
456 # CFLAGS  += -I/usr/local/include
457 # LDFLAGS += -lspf2
458
459 # Uncomment the following lines to add SRS (Sender rewriting scheme) support.
460 # You need to have libsrs_alt installed on your system (srs.mirtol.com).
461 # Depending on where it is installed you may have to edit the CFLAGS and
462 # LDFLAGS lines.
463
464 # EXPERIMENTAL_SRS=yes
465 # CFLAGS  += -I/usr/local/include
466 # LDFLAGS += -lsrs_alt
467
468 # Uncomment the following line to add DMARC checking capability, implemented
469 # using libopendmarc libraries.  You must have SPF support enabled also.
470 # EXPERIMENTAL_DMARC=yes
471 # CFLAGS += -I/usr/local/include
472 # LDFLAGS += -lopendmarc
473
474 # Uncomment the following lines to add Brightmail AntiSpam support. You need
475 # to have the Brightmail client SDK installed. Please check the experimental
476 # documentation for implementation details. You need to edit the CFLAGS and
477 # LDFLAGS lines.
478
479 # EXPERIMENTAL_BRIGHTMAIL=yes
480 # CFLAGS  += -I/opt/brightmail/bsdk-6.0/include
481 # LDFLAGS += -lxml2_single -lbmiclient_single -L/opt/brightmail/bsdk-6.0/lib
482
483 # Uncomment the following line to add DANE support
484 # Note: Enabling this unconditionally overrides DISABLE_DNSSEC
485 # Note: DANE is only supported when using OpenSSL
486 # EXPERIMENTAL_DANE=yes
487
488 # Uncomment the following to include extra information in fail DSN message (bounces)
489 # EXPERIMENTAL_DSN_INFO=yes
490
491 # Uncomment the following to add LMDB lookup support
492 # You need to have LMDB installed on your system (https://github.com/LMDB/lmdb)
493 # Depending on where it is installed you may have to edit the CFLAGS and LDFLAGS lines.
494 # EXPERIMENTAL_LMDB=yes
495 # CFLAGS += -I/usr/local/include
496 # LDFLAGS += -llmdb
497
498 # Uncomment the following line to add queuefile transport support
499 # EXPERIMENTAL_QUEUEFILE=yes
500
501 ###############################################################################
502 #                 THESE ARE THINGS YOU MIGHT WANT TO SPECIFY                  #
503 ###############################################################################
504
505 # The items in this section are those that are commonly changed according to
506 # the sysadmin's preferences, but whose defaults are often acceptable. The
507 # first five are concerned with security issues, where differing levels of
508 # paranoia are appropriate in different environments. Sysadmins also vary in
509 # their views on appropriate levels of defence in these areas. If you do not
510 # understand these issues, go with the defaults, which are used by many sites.
511
512
513 #------------------------------------------------------------------------------
514 # Although Exim is normally a setuid program, owned by root, it refuses to run
515 # local deliveries as root by default. There is a runtime option called
516 # "never_users" which lists the users that must never be used for local
517 # deliveries. There is also the setting below, which provides a list that
518 # cannot be overridden at runtime. This guards against problems caused by
519 # unauthorized changes to the runtime configuration. You are advised not to
520 # remove "root" from this option, but you can add other users if you want. The
521 # list is colon-separated. It must NOT contain any spaces.
522
523 # FIXED_NEVER_USERS=root:bin:daemon
524 FIXED_NEVER_USERS=root
525
526
527 #------------------------------------------------------------------------------
528 # By default, Exim insists that its configuration file be owned by root. You
529 # can specify one additional permitted owner here.
530
531 # CONFIGURE_OWNER=
532
533 # If the configuration file is group-writeable, Exim insists by default that it
534 # is owned by root. You can specify one additional permitted group owner here.
535
536 # CONFIGURE_GROUP=
537
538 # If you specify CONFIGURE_OWNER or CONFIGURE_GROUP as a name, this is looked
539 # up at build time, and the uid or gid number is built into the binary.
540 # However, you can specify that the lookup is deferred until runtime. In this
541 # case, it is the name that is built into the binary. You can do this by a
542 # setting of the form:
543
544 # CONFIGURE_OWNER=ref:mail
545 # CONFIGURE_GROUP=ref:sysadmin
546
547 # In other words, put "ref:" in front of the user or group name. Although this
548 # costs a bit of resource at runtime, it is convenient to use this feature when
549 # building binaries that are to be run on multiple systems where the names may
550 # refer to different uids or gids. It also allows you to build Exim on a system
551 # where the relevant user or group is not defined.
552
553
554 #------------------------------------------------------------------------------
555 # The -C option allows Exim to be run with an alternate runtime configuration
556 # file. When this is used by root, root privilege is retained by the binary
557 # (for any other caller including the Exim user, it is dropped). You can
558 # restrict the location of alternate configurations by defining a prefix below.
559 # Any file used with -C must then start with this prefix (except that /dev/null
560 # is also permitted if the caller is root, because that is used in the install
561 # script). If the prefix specifies a directory that is owned by root, a
562 # compromise of the Exim account does not permit arbitrary alternate
563 # configurations to be used. The prefix can be more restrictive than just a
564 # directory (the second example).
565
566 # ALT_CONFIG_PREFIX=/some/directory/
567 # ALT_CONFIG_PREFIX=/some/directory/exim.conf-
568
569
570 #------------------------------------------------------------------------------
571 # When a user other than root uses the -C option to override the configuration
572 # file (including the Exim user when re-executing Exim to regain root
573 # privileges for local message delivery), this will normally cause Exim to
574 # drop root privileges. The TRUSTED_CONFIG_LIST option, specifies a file which
575 # contains a list of trusted configuration filenames, one per line. If the -C
576 # option is used by the Exim user or by the user specified in the
577 # CONFIGURE_OWNER setting, to specify a configuration file which is listed in
578 # the TRUSTED_CONFIG_LIST file, then root privileges are not dropped by Exim.
579
580 # TRUSTED_CONFIG_LIST=/usr/exim/trusted_configs
581
582
583 #------------------------------------------------------------------------------
584 # Uncommenting this option disables the use of the -D command line option,
585 # which changes the values of macros in the runtime configuration file.
586 # This is another protection against somebody breaking into the Exim account.
587
588 # DISABLE_D_OPTION=yes
589
590
591 #------------------------------------------------------------------------------
592 # By contrast, you might be maintaining a system which relies upon the ability
593 # to override values with -D and assumes that these will be passed through to
594 # the delivery processes.  As of Exim 4.73, this is no longer the case by
595 # default.  Going forward, we strongly recommend that you use a shim Exim
596 # configuration file owned by root stored under TRUSTED_CONFIG_LIST.
597 # That shim can set macros before .include'ing your main configuration file.
598 #
599 # As a strictly transient measure to ease migration to 4.73, the
600 # WHITELIST_D_MACROS value defines a colon-separated list of macro-names
601 # which are permitted to be overridden from the command-line which will be
602 # honoured by the Exim user.  So these are macros that can persist to delivery
603 # time.
604 # Examples might be -DTLS or -DSPOOL=/some/dir.  The values on the
605 # command-line are filtered to only permit: [A-Za-z0-9_/.-]*
606 #
607 # This option is highly likely to be removed in a future release.  It exists
608 # only to make 4.73 as easy as possible to migrate to.  If you use it, we
609 # encourage you to schedule time to rework your configuration to not depend
610 # upon it.  Most people should not need to use this.
611 #
612 # By default, no macros are whitelisted for -D usage.
613
614 # WHITELIST_D_MACROS=TLS:SPOOL
615
616 #------------------------------------------------------------------------------
617 # Exim has support for the AUTH (authentication) extension of the SMTP
618 # protocol, as defined by RFC 2554. If you don't know what SMTP authentication
619 # is, you probably won't want to include this code, so you should leave these
620 # settings commented out. If you do want to make use of SMTP authentication,
621 # you must uncomment at least one of the following, so that appropriate code is
622 # included in the Exim binary. You will then need to set up the run time
623 # configuration to make use of the mechanism(s) selected.
624
625 # AUTH_CRAM_MD5=yes
626 # AUTH_CYRUS_SASL=yes
627 # AUTH_DOVECOT=yes
628 # AUTH_GSASL=yes
629 # AUTH_GSASL_PC=libgsasl
630 # AUTH_HEIMDAL_GSSAPI=yes
631 # AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
632 # AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi heimdal-krb5
633 # AUTH_PLAINTEXT=yes
634 # AUTH_SPA=yes
635 # AUTH_TLS=yes
636
637 # Heimdal through 1.5 required pkg-config 'heimdal-gssapi'; Heimdal 7.1
638 # requires multiple pkg-config files to work with Exim, so the second example
639 # above is needed.
640
641 #------------------------------------------------------------------------------
642 # If you specified AUTH_CYRUS_SASL above, you should ensure that you have the
643 # Cyrus SASL library installed before trying to build Exim, and you probably
644 # want to uncomment the first line below.
645 # Similarly for GNU SASL, unless pkg-config is used via AUTH_GSASL_PC.
646 # Ditto for AUTH_HEIMDAL_GSSAPI(_PC).
647
648 # AUTH_LIBS=-lsasl2
649 # AUTH_LIBS=-lgsasl
650 # AUTH_LIBS=-lgssapi -lheimntlm -lkrb5 -lhx509 -lcom_err -lhcrypto -lasn1 -lwind -lroken -lcrypt
651
652
653 #------------------------------------------------------------------------------
654 # When Exim is decoding MIME "words" in header lines, most commonly for use
655 # in the $header_xxx expansion, it converts any foreign character sets to the
656 # one that is set in the headers_charset option. The default setting is
657 # defined by this setting:
658
659 HEADERS_CHARSET="ISO-8859-1"
660
661 # If you are going to make use of $header_xxx expansions in your configuration
662 # file, or if your users are going to use them in filter files, and the normal
663 # character set on your host is something other than ISO-8859-1, you might
664 # like to specify a different default here. This value can be overridden in
665 # the runtime configuration, and it can also be overridden in individual filter
666 # files.
667 #
668 # IMPORTANT NOTE: The iconv() function is needed for character code
669 # conversions. Please see the next item...
670
671
672 #------------------------------------------------------------------------------
673 # Character code conversions are possible only if the iconv() function is
674 # installed on your operating system. There are two places in Exim where this
675 # is relevant: (a) The $header_xxx expansion (see the previous item), and (b)
676 # the Sieve filter support. For those OS where iconv() is known to be installed
677 # as standard, the file in OS/Makefile-xxxx contains
678 #
679 # HAVE_ICONV=yes
680 #
681 # If you are not using one of those systems, but have installed iconv(), you
682 # need to uncomment that line above. In some cases, you may find that iconv()
683 # and its header file are not in the default places. You might need to use
684 # something like this:
685 #
686 # HAVE_ICONV=yes
687 # CFLAGS=-O -I/usr/local/include
688 # EXTRALIBS_EXIM=-L/usr/local/lib -liconv
689 #
690 # but of course there may need to be other things in CFLAGS and EXTRALIBS_EXIM
691 # as well.
692
693
694 #------------------------------------------------------------------------------
695 # The passwords for user accounts are normally encrypted with the crypt()
696 # function. Comparisons with encrypted passwords can be done using Exim's
697 # "crypteq" expansion operator. (This is commonly used as part of the
698 # configuration of an authenticator for use with SMTP AUTH.) At least one
699 # operating system has an extended function called crypt16(), which uses up to
700 # 16 characters of a password (the normal crypt() uses only the first 8). Exim
701 # supports the use of crypt16() as well as crypt() but note the warning below.
702
703 # You can always indicate a crypt16-encrypted password by preceding it with
704 # "{crypt16}". If you want the default handling (without any preceding
705 # indicator) to use crypt16(), uncomment the following line:
706
707 # DEFAULT_CRYPT=crypt16
708
709 # If you do that, you can still access the basic crypt() function by preceding
710 # an encrypted password with "{crypt}". For more details, see the description
711 # of the "crypteq" condition in the manual chapter on string expansions.
712
713 # Some operating systems do not include a crypt16() function, so Exim has one
714 # of its own, which it uses unless HAVE_CRYPT16 is defined. Normally, that will
715 # be set in an OS-specific Makefile for the OS that have such a function, so
716 # you should not need to bother with it.
717
718 # *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING ***
719 # It turns out that the above is not entirely accurate. As well as crypt16()
720 # there is a function called bigcrypt() that some operating systems have. This
721 # may or may not use the same algorithm, and both of them may be different to
722 # Exim's built-in crypt16() that is used unless HAVE_CRYPT16 is defined.
723 #
724 # However, since there is now a move away from the traditional crypt()
725 # functions towards using SHA1 and other algorithms, tidying up this area of
726 # Exim is seen as very low priority. In practice, if you need to, you can
727 # define DEFAULT_CRYPT to the name of any function that has the same interface
728 # as the traditional crypt() function.
729 # *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING ***
730
731
732 #------------------------------------------------------------------------------
733 # Exim can be built to support the SMTP STARTTLS command, which implements
734 # Transport Layer Security using SSL (Secure Sockets Layer). To do this, you
735 # must install the OpenSSL library package or the GnuTLS library. Exim contains
736 # no cryptographic code of its own. Uncomment the following lines if you want
737 # to build Exim with TLS support. If you don't know what this is all about,
738 # leave these settings commented out.
739
740 # This setting is required for any TLS support (either OpenSSL or GnuTLS)
741 # SUPPORT_TLS=yes
742
743 # Uncomment one of these settings if you are using OpenSSL; pkg-config vs not
744 # USE_OPENSSL_PC=openssl
745 # TLS_LIBS=-lssl -lcrypto
746
747 # Uncomment the first and either the second or the third of these if you
748 # are using GnuTLS.  If you have pkg-config, then the second, else the third.
749 # USE_GNUTLS=yes
750 # USE_GNUTLS_PC=gnutls
751 # TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
752
753 # If using GnuTLS older than 2.10 and using pkg-config then note that Exim's
754 # build process will require libgcrypt-config to exist in your $PATH.  A
755 # version that old is likely to become unsupported by Exim in 2017.
756
757 # The security fix we provide with the gnutls_allow_auto_pkcs11 option
758 # (4.82 PP/09) introduces a compatibility regression.  The symbol is
759 # not available if GnuTLS is build without p11-kit (--without-p11-kit
760 # configure option).  In this case use AVOID_GNUTLS_PKCS11=yes when
761 # building Exim.
762 # AVOID_GNUTLS_PKCS11=yes
763
764 # If you are running Exim as a server, note that just building it with TLS
765 # support is not all you need to do. You also need to set up a suitable
766 # certificate, and tell Exim about it by means of the tls_certificate
767 # and tls_privatekey run time options. You also need to set tls_advertise_hosts
768 # to specify the hosts to which Exim advertises TLS support. On the other hand,
769 # if you are running Exim only as a client, building it with TLS support
770 # is all you need to do.
771
772 # If you are using pkg-config then you should not need to worry where the
773 # libraries and headers are installed, as the pkg-config .pc specification
774 # should include all -L/-I information necessary.  If not using pkg-config
775 # then you might need to specify the locations too.
776
777 # Additional libraries and include files are required for both OpenSSL and
778 # GnuTLS. The TLS_LIBS settings above assume that the libraries are installed
779 # with all your other libraries. If they are in a special directory, you may
780 # need something like
781
782 # TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
783 # or
784 # TLS_LIBS=-L/opt/gnu/lib -lgnutls -ltasn1 -lgcrypt
785
786 # TLS_LIBS is included only on the command for linking Exim itself, not on any
787 # auxiliary programs. If the include files are not in a standard place, you can
788 # set TLS_INCLUDE to specify where they are, for example:
789
790 # TLS_INCLUDE=-I/usr/local/openssl/include/
791 # or
792 # TLS_INCLUDE=-I/opt/gnu/include
793
794 # You don't need to set TLS_INCLUDE if the relevant directories are already
795 # specified in INCLUDE.
796
797
798 #------------------------------------------------------------------------------
799 # The default distribution of Exim contains only the plain text form of the
800 # documentation. Other forms are available separately. If you want to install
801 # the documentation in "info" format, first fetch the Texinfo documentation
802 # sources from the ftp directory and unpack them, which should create files
803 # with the extension "texinfo" in the doc directory. You may find that the
804 # version number of the texinfo files is different to your Exim version number,
805 # because the main documentation isn't updated as often as the code. For
806 # example, if you have Exim version 4.43, the source tarball unpacks into a
807 # directory called exim-4.43, but the texinfo tarball unpacks into exim-4.40.
808 # In this case, move the contents of exim-4.40/doc into exim-4.43/doc after you
809 # have unpacked them. Then set INFO_DIRECTORY to the location of your info
810 # directory. This varies from system to system, but is often /usr/share/info.
811 # Once you have done this, "make install" will build the info files and
812 # install them in the directory you have defined.
813
814 # INFO_DIRECTORY=/usr/share/info
815
816
817 #------------------------------------------------------------------------------
818 # Exim log directory and files: Exim creates several log files inside a
819 # single log directory. You can define the directory and the form of the
820 # log file name here. If you do not set anything, Exim creates a directory
821 # called "log" inside its spool directory (see SPOOL_DIRECTORY above) and uses
822 # the filenames "mainlog", "paniclog", and "rejectlog". If you want to change
823 # this, you can set LOG_FILE_PATH to a path name containing one occurrence of
824 # %s. This will be replaced by one of the strings "main", "panic", or "reject"
825 # to form the final file names. Some installations may want something like this:
826
827 # LOG_FILE_PATH=/var/log/exim_%slog
828
829 # which results in files with names /var/log/exim_mainlog, etc. The directory
830 # in which the log files are placed must exist; Exim does not try to create
831 # it for itself. It is also your responsibility to ensure that Exim is capable
832 # of writing files using this path name. The Exim user (see EXIM_USER above)
833 # must be able to create and update files in the directory you have specified.
834
835 # You can also configure Exim to use syslog, instead of or as well as log
836 # files, by settings such as these
837
838 # LOG_FILE_PATH=syslog
839 # LOG_FILE_PATH=syslog:/var/log/exim_%slog
840
841 # The first of these uses only syslog; the second uses syslog and also writes
842 # to log files. Do not include white space in such a setting as it messes up
843 # the building process.
844
845
846 #------------------------------------------------------------------------------
847 # When logging to syslog, the following option caters for syslog replacements
848 # that are able to accept log entries longer than the 1024 characters allowed
849 # by RFC 3164. It is up to you to make sure your syslog daemon can handle this.
850 # Non-printable characters are usually unacceptable regardless, so log entries
851 # are still split on newline characters.
852
853 # SYSLOG_LONG_LINES=yes
854
855 # If you are not interested in the process identifier (pid) of the Exim that is
856 # making the call to syslog, then comment out the following line.
857
858 SYSLOG_LOG_PID=yes
859
860
861 #------------------------------------------------------------------------------
862 # Cycling log files: this variable specifies the maximum number of old
863 # log files that are kept by the exicyclog log-cycling script. You don't have
864 # to use exicyclog. If your operating system has other ways of cycling log
865 # files, you can use them instead. The exicyclog script isn't run by default;
866 # you have to set up a cron job for it if you want it.
867
868 EXICYCLOG_MAX=10
869
870
871 #------------------------------------------------------------------------------
872 # The compress command is used by the exicyclog script to compress old log
873 # files. Both the name of the command and the suffix that it adds to files
874 # need to be defined here. See also the EXICYCLOG_MAX configuration.
875
876 COMPRESS_COMMAND=/usr/bin/gzip
877 COMPRESS_SUFFIX=gz
878
879
880 #------------------------------------------------------------------------------
881 # If the exigrep utility is fed compressed log files, it tries to uncompress
882 # them using this command.
883
884 # Leave it empty to enforce autodetection at runtime:
885 # ZCAT_COMMAND=
886 #
887 # Omit the path if you want to use your system's PATH:
888 # ZCAT_COMMAND=zcat
889 #
890 # Or specify the full pathname:
891 ZCAT_COMMAND=/usr/bin/zcat
892
893 #------------------------------------------------------------------------------
894 # Compiling in support for embedded Perl: If you want to be able to
895 # use Perl code in Exim's string manipulation language and you have Perl
896 # (version 5.004 or later) installed, set EXIM_PERL to perl.o. Using embedded
897 # Perl costs quite a lot of resources. Only do this if you really need it.
898
899 # EXIM_PERL=perl.o
900
901
902 #------------------------------------------------------------------------------
903 # Support for dynamically-loaded string expansion functions via ${dlfunc. If
904 # you are using gcc the dynamically-loaded object must be compiled with the
905 # -shared option, and you will need to add -export-dynamic to EXTRALIBS so
906 # that the local_scan API is made available by the linker. You may also need
907 # to add -ldl to EXTRALIBS so that dlopen() is available to Exim.
908
909 # EXPAND_DLFUNC=yes
910
911
912 #------------------------------------------------------------------------------
913 # Exim has support for PAM (Pluggable Authentication Modules), a facility
914 # which is available in the latest releases of Solaris and in some GNU/Linux
915 # distributions (see http://ftp.kernel.org/pub/linux/libs/pam/). The Exim
916 # support, which is intended for use in conjunction with the SMTP AUTH
917 # facilities, is included only when requested by the following setting:
918
919 # SUPPORT_PAM=yes
920
921 # You probably need to add -lpam to EXTRALIBS, and in some releases of
922 # GNU/Linux -ldl is also needed.
923
924
925 #------------------------------------------------------------------------------
926 # Proxying.
927 #
928 # If you may want to use outbound (client-side) proxying, using Socks5,
929 # uncomment the line below.
930
931 # SUPPORT_SOCKS=yes
932
933 # If you may want to use inbound (server-side) proxying, using Proxy Protocol,
934 # uncomment the line below.
935
936 # SUPPORT_PROXY=yes
937
938
939 #------------------------------------------------------------------------------
940 # Internationalisation.
941 #
942 # Uncomment the following to include Internationalisation features.  This is the
943 # SMTPUTF8 ESMTP extension, and associated facilities for handling UTF8 domain
944 # and localparts, per RFC 3490 (IDNA2003).
945 # You need to have the IDN library installed.
946 # If you want IDNA2008 mappings per RFCs 5890, 6530 and 6533, you additionally
947 # need libidn2 and SUPPORT_I18N_2008.
948
949 # SUPPORT_I18N=yes
950 # LDFLAGS += -lidn
951 # SUPPORT_I18N_2008=yes
952 # LDFLAGS += -lidn -lidn2
953
954
955 #------------------------------------------------------------------------------
956 # Support for authentication via Radius is also available. The Exim support,
957 # which is intended for use in conjunction with the SMTP AUTH facilities,
958 # is included only when requested by setting the following parameter to the
959 # location of your Radius configuration file:
960
961 # RADIUS_CONFIG_FILE=/etc/radiusclient/radiusclient.conf
962 # RADIUS_CONFIG_FILE=/etc/radius.conf
963
964 # If you have set RADIUS_CONFIG_FILE, you should also set one of these to
965 # indicate which RADIUS library is used:
966
967 # RADIUS_LIB_TYPE=RADIUSCLIENT
968 # RADIUS_LIB_TYPE=RADIUSCLIENTNEW
969 # RADIUS_LIB_TYPE=RADLIB
970
971 # RADIUSCLIENT is the radiusclient library; you probably need to add
972 #   -lradiusclient to EXTRALIBS.
973 #
974 # The API for the radiusclient library was changed at release 0.4.0.
975 # Unfortunately, the header file does not define a version number that clients
976 # can use to support both the old and new APIs. If you are using version 0.4.0
977 # or later of the radiusclient library, you should use RADIUSCLIENTNEW.
978 #
979 # RADLIB is the Radius library that comes with FreeBSD (the header file is
980 #   called radlib.h); you probably need to add -lradius to EXTRALIBS.
981 #
982 # If you do not set RADIUS_LIB_TYPE, Exim assumes the radiusclient library,
983 # using the original API.
984
985
986 #------------------------------------------------------------------------------
987 # Support for authentication via the Cyrus SASL pwcheck daemon is available.
988 # Note, however, that pwcheck is now deprecated in favour of saslauthd (see
989 # next item). The Exim support for pwcheck, which is intented for use in
990 # conjunction with the SMTP AUTH facilities, is included only when requested by
991 # setting the following parameter to the location of the pwcheck daemon's
992 # socket.
993 #
994 # There is no need to install all of SASL on your system. You just need to run
995 # ./configure --with-pwcheck, cd to the pwcheck directory within the sources,
996 # make and make install. You must create the socket directory (default
997 # /var/pwcheck) and chown it to Exim's user and group. Once you have installed
998 # pwcheck, you should arrange for it to be started by root at boot time.
999
1000 # CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
1001
1002
1003 #------------------------------------------------------------------------------
1004 # Support for authentication via the Cyrus SASL saslauthd daemon is available.
1005 # The Exim support, which is intended for use in conjunction with the SMTP AUTH
1006 # facilities, is included only when requested by setting the following
1007 # parameter to the location of the saslauthd daemon's socket.
1008 #
1009 # There is no need to install all of SASL on your system. You just need to run
1010 # ./configure --with-saslauthd (and any other options you need, for example, to
1011 # select or deselect authentication mechanisms), cd to the saslauthd directory
1012 # within the sources, make and make install. You must create the socket
1013 # directory (default /var/state/saslauthd) and chown it to Exim's user and
1014 # group. Once you have installed saslauthd, you should arrange for it to be
1015 # started by root at boot time.
1016
1017 # CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
1018
1019
1020 #------------------------------------------------------------------------------
1021 # TCP wrappers: If you want to use tcpwrappers from within Exim, uncomment
1022 # this setting. See the manual section entitled "Use of tcpwrappers" in the
1023 # chapter on building and installing Exim.
1024 #
1025 # USE_TCP_WRAPPERS=yes
1026 #
1027 # You may well also have to specify a local "include" file and an additional
1028 # library for TCP wrappers, so you probably need something like this:
1029 #
1030 # USE_TCP_WRAPPERS=yes
1031 # CFLAGS=-O -I/usr/local/include
1032 # EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1033 #
1034 # but of course there may need to be other things in CFLAGS and EXTRALIBS_EXIM
1035 # as well.
1036 #
1037 # To use a name other than exim in the tcpwrappers config file,
1038 # e.g. if you're running multiple daemons with different access lists,
1039 # or multiple MTAs with the same access list, define
1040 # TCP_WRAPPERS_DAEMON_NAME accordingly
1041 #
1042 # TCP_WRAPPERS_DAEMON_NAME="exim"
1043
1044
1045 #------------------------------------------------------------------------------
1046 # The default action of the exim_install script (which is run by "make
1047 # install") is to install the Exim binary with a unique name such as
1048 # exim-4.43-1, and then set up a symbolic link called "exim" to reference it,
1049 # moving the symbolic link from any previous version. If you define NO_SYMLINK
1050 # (the value doesn't matter), the symbolic link is not created or moved. You
1051 # will then have to "turn Exim on" by setting up the link manually.
1052
1053 # NO_SYMLINK=yes
1054
1055
1056 #------------------------------------------------------------------------------
1057 # Another default action of the install script is to install a default runtime
1058 # configuration file if one does not exist. This configuration has a router for
1059 # expanding system aliases. The default assumes that these aliases are kept
1060 # in the traditional file called /etc/aliases. If such a file does not exist,
1061 # the installation script creates one that contains just comments (no actual
1062 # aliases). The following setting can be changed to specify a different
1063 # location for the system alias file.
1064
1065 SYSTEM_ALIASES_FILE=/etc/aliases
1066
1067
1068 #------------------------------------------------------------------------------
1069 # There are some testing options (-be, -bt, -bv) that read data from the
1070 # standard input when no arguments are supplied. By default, the input lines
1071 # are read using the standard fgets() function. This does not support line
1072 # editing during interactive input (though the terminal's "erase" character
1073 # works as normal). If your operating system has the readline() function, and
1074 # in addition supports dynamic loading of library functions, you can cause
1075 # Exim to use readline() for the -be testing option (only) by uncommenting the
1076 # following setting. Dynamic loading is used so that the library is loaded only
1077 # when the -be testing option is given; by the time the loading occurs,
1078 # Exim has given up its root privilege and is running as the calling user. This
1079 # is the reason why readline() is NOT supported for -bt and -bv, because Exim
1080 # runs as root or as exim, respectively, for those options. When USE_READLINE
1081 # is "yes", as well as supporting line editing, a history of input lines in the
1082 # current run is maintained.
1083
1084 # USE_READLINE=yes
1085
1086 # You may need to add -ldl to EXTRALIBS when you set USE_READLINE=yes.
1087 # Note that this option adds to the size of the Exim binary, because the
1088 # dynamic loading library is not otherwise included.
1089
1090
1091 #------------------------------------------------------------------------------
1092 # Uncomment this setting to include IPv6 support.
1093
1094 # HAVE_IPV6=yes
1095
1096 ###############################################################################
1097 #              THINGS YOU ALMOST NEVER NEED TO MENTION                        #
1098 ###############################################################################
1099
1100 # The settings in this section are available for use in special circumstances.
1101 # In the vast majority of installations you need not change anything below.
1102
1103
1104 #------------------------------------------------------------------------------
1105 # The following commands live in different places in some OS. Either the
1106 # ultimate default settings, or the OS-specific files should already point to
1107 # the right place, but they can be overridden here if necessary. These settings
1108 # are used when building various scripts to ensure that the correct paths are
1109 # used when the scripts are run. They are not used in the Makefile itself. Perl
1110 # is not necessary for running Exim unless you set EXIM_PERL (see above) to get
1111 # it embedded, but there are some utilities that are Perl scripts. If you
1112 # haven't got Perl, Exim will still build and run; you just won't be able to
1113 # use those utilities.
1114
1115 # CHOWN_COMMAND=/usr/bin/chown
1116 # CHGRP_COMMAND=/usr/bin/chgrp
1117 # CHMOD_COMMAND=/usr/bin/chmod
1118 # MV_COMMAND=/bin/mv
1119 # RM_COMMAND=/bin/rm
1120 # TOUCH_COMMAND=/usr/bin/touch
1121 # PERL_COMMAND=/usr/bin/perl
1122
1123
1124 #------------------------------------------------------------------------------
1125 # The following macro can be used to change the command for building a library
1126 # of functions. By default the "ar" command is used, with options "cq".
1127 # Only in rare circumstances should you need to change this.
1128
1129 # AR=ar cq
1130
1131
1132 #------------------------------------------------------------------------------
1133 # In some operating systems, the value of the TMPDIR environment variable
1134 # controls where temporary files are created. Exim does not make use of
1135 # temporary files, except when delivering to MBX mailboxes. However, if Exim
1136 # calls any external libraries (e.g. DBM libraries), they may use temporary
1137 # files, and thus be influenced by the value of TMPDIR. For this reason, when
1138 # Exim starts, it checks the environment for TMPDIR, and if it finds it is set,
1139 # it replaces the value with what is defined here. Commenting this setting
1140 # suppresses the check altogether. Older installations call this macro
1141 # just TMPDIR, but this has side effects at build time. At runtime
1142 # TMPDIR is checked as before.
1143
1144 EXIM_TMPDIR="/tmp"
1145
1146
1147 #------------------------------------------------------------------------------
1148 # The following macros can be used to change the default modes that are used
1149 # by the appendfile transport. In most installations the defaults are just
1150 # fine, and in any case, you can change particular instances of the transport
1151 # at run time if you want.
1152
1153 # APPENDFILE_MODE=0600
1154 # APPENDFILE_DIRECTORY_MODE=0700
1155 # APPENDFILE_LOCKFILE_MODE=0600
1156
1157
1158 #------------------------------------------------------------------------------
1159 # In some installations there may be multiple machines sharing file systems,
1160 # where a different configuration file is required for Exim on the different
1161 # machines. If CONFIGURE_FILE_USE_NODE is defined, then Exim will first look
1162 # for a configuration file whose name is that defined by CONFIGURE_FILE,
1163 # with the node name obtained by uname() tacked on the end, separated by a
1164 # period (for example, /usr/exim/configure.host.in.some.domain). If this file
1165 # does not exist, then the bare configuration file name is tried.
1166
1167 # CONFIGURE_FILE_USE_NODE=yes
1168
1169
1170 #------------------------------------------------------------------------------
1171 # In some esoteric configurations two different versions of Exim are run,
1172 # with different setuid values, and different configuration files are required
1173 # to handle the different cases. If CONFIGURE_FILE_USE_EUID is defined, then
1174 # Exim will first look for a configuration file whose name is that defined
1175 # by CONFIGURE_FILE, with the effective uid tacked on the end, separated by
1176 # a period (for example, /usr/exim/configure.0). If this file does not exist,
1177 # then the bare configuration file name is tried. In the case when both
1178 # CONFIGURE_FILE_USE_EUID and CONFIGURE_FILE_USE_NODE are set, four files
1179 # are tried: <name>.<euid>.<node>, <name>.<node>, <name>.<euid>, and <name>.
1180
1181 # CONFIGURE_FILE_USE_EUID=yes
1182
1183
1184 #------------------------------------------------------------------------------
1185 # The size of the delivery buffers: These specify the sizes (in bytes) of
1186 # the buffers that are used when copying a message from the spool to a
1187 # destination. There is rarely any need to change these values.
1188
1189 # DELIVER_IN_BUFFER_SIZE=8192
1190 # DELIVER_OUT_BUFFER_SIZE=8192
1191
1192
1193 #------------------------------------------------------------------------------
1194 # The mode of the database directory: Exim creates a directory called "db"
1195 # in its spool directory, to hold its databases of hints. This variable
1196 # determines the mode of the created directory. The default value in the
1197 # source is 0750.
1198
1199 # EXIMDB_DIRECTORY_MODE=0750
1200
1201
1202 #------------------------------------------------------------------------------
1203 # Database file mode: The mode of files created in the "db" directory defaults
1204 # to 0640 in the source, and can be changed here.
1205
1206 # EXIMDB_MODE=0640
1207
1208
1209 #------------------------------------------------------------------------------
1210 # Database lock file mode: The mode of zero-length files created in the "db"
1211 # directory to use for locking purposes defaults to 0640 in the source, and
1212 # can be changed here.
1213
1214 # EXIMDB_LOCKFILE_MODE=0640
1215
1216
1217 #------------------------------------------------------------------------------
1218 # This parameter sets the maximum length of the header portion of a message
1219 # that Exim is prepared to process. The default setting is one megabyte. The
1220 # limit exists in order to catch rogue mailers that might connect to your SMTP
1221 # port, start off a header line, and then just pump junk at it for ever. The
1222 # message_size_limit option would also catch this, but it may not be set.
1223 # The value set here is the default; it can be changed at runtime.
1224
1225 # HEADER_MAXSIZE="(1024*1024)"
1226
1227
1228 #------------------------------------------------------------------------------
1229 # The mode of the input directory: The input directory is where messages are
1230 # kept while awaiting delivery. Exim creates it if necessary, using a mode
1231 # which can be defined here (default 0750).
1232
1233 # INPUT_DIRECTORY_MODE=0750
1234
1235
1236 #------------------------------------------------------------------------------
1237 # The mode of Exim's log directory, when it is created by Exim inside the spool
1238 # directory, defaults to 0750 but can be changed here.
1239
1240 # LOG_DIRECTORY_MODE=0750
1241
1242
1243 #------------------------------------------------------------------------------
1244 # The log files themselves are created as required, with a mode that defaults
1245 # to 0640, but which can be changed here.
1246
1247 # LOG_MODE=0640
1248
1249
1250 #------------------------------------------------------------------------------
1251 # The TESTDB lookup is for performing tests on the handling of lookup results,
1252 # and is not useful for general running. It should be included only when
1253 # debugging the code of Exim.
1254
1255 # LOOKUP_TESTDB=yes
1256
1257
1258 #------------------------------------------------------------------------------
1259 # /bin/sh is used by default as the shell in which to run commands that are
1260 # defined in the makefiles. This can be changed if necessary, by uncommenting
1261 # this line and specifying another shell, but note that a Bourne-compatible
1262 # shell is expected.
1263
1264 # MAKE_SHELL=/bin/sh
1265
1266
1267 #------------------------------------------------------------------------------
1268 # The maximum number of named lists of each type (address, domain, host, and
1269 # local part) can be increased by changing this value. It should be set to
1270 # a multiple of 16.
1271
1272 # MAX_NAMED_LIST=16
1273
1274
1275 #------------------------------------------------------------------------------
1276 # Network interfaces: Unless you set the local_interfaces option in the runtime
1277 # configuration file to restrict Exim to certain interfaces only, it will run
1278 # code to find all the interfaces there are on your host. Unfortunately,
1279 # the call to the OS that does this requires a buffer large enough to hold
1280 # data for all the interfaces - it was designed in the days when a host rarely
1281 # had more than three or four interfaces. Nowadays hosts can have very many
1282 # virtual interfaces running on the same hardware. If you have more than 250
1283 # virtual interfaces, you will need to uncomment this setting and increase the
1284 # value.
1285
1286 # MAXINTERFACES=250
1287
1288
1289 #------------------------------------------------------------------------------
1290 # Per-message logs: While a message is in the process of being delivered,
1291 # comments on its progress are written to a message log, for the benefit of
1292 # human administrators. These logs are held in a directory called "msglog"
1293 # in the spool directory. Its mode defaults to 0750, but can be changed here.
1294 # The message log directory is also used for storing files that are used by
1295 # transports for returning data to a message's sender (see the "return_output"
1296 # option for transports).
1297
1298 # MSGLOG_DIRECTORY_MODE=0750
1299
1300
1301 #------------------------------------------------------------------------------
1302 # There are three options which are used when compiling the Perl interface and
1303 # when linking with Perl. The default values for these are placed automatically
1304 # at the head of the Makefile by the script which builds it. However, if you
1305 # want to override them, you can do so here.
1306
1307 # PERL_CC=
1308 # PERL_CCOPTS=
1309 # PERL_LIBS=
1310
1311
1312 #------------------------------------------------------------------------------
1313 # If you wish to disable valgrind in the binary, define NVALGRIND=1.
1314 # This should not be needed.
1315
1316 # NVALGRIND=1
1317
1318 #------------------------------------------------------------------------------
1319 # Identifying the daemon: When an Exim daemon starts up, it writes its pid
1320 # (process id) to a file so that it can easily be identified. The path of the
1321 # file can be specified here. Some installations may want something like this:
1322
1323 # PID_FILE_PATH=/var/lock/exim.pid
1324
1325 # If PID_FILE_PATH is not defined, Exim writes a file in its spool directory
1326 # using the name "exim-daemon.pid".
1327
1328 # If you start up a daemon without the -bd option (for example, with just
1329 # the -q15m option), a pid file is not written. Also, if you override the
1330 # configuration file with the -oX option, no pid file is written. In other
1331 # words, the pid file is written only for a "standard" daemon.
1332
1333
1334 #------------------------------------------------------------------------------
1335 # If Exim creates the spool directory, it is given this mode, defaulting in the
1336 # source to 0750.
1337
1338 # SPOOL_DIRECTORY_MODE=0750
1339
1340
1341 #------------------------------------------------------------------------------
1342 # The mode of files on the input spool which hold the contents of messages can
1343 # be changed here. The default is 0640 so that information from the spool is
1344 # available to anyone who is a member of the Exim group.
1345
1346 # SPOOL_MODE=0640
1347
1348
1349 #------------------------------------------------------------------------------
1350 # Moving frozen messages: If the following is uncommented, Exim is compiled
1351 # with support for automatically moving frozen messages out of the main spool
1352 # directory, a facility that is found useful by some large installations. A
1353 # run time option is required to cause the moving actually to occur. Such
1354 # messages become "invisible" to the normal management tools.
1355
1356 # SUPPORT_MOVE_FROZEN_MESSAGES=yes
1357
1358
1359 #------------------------------------------------------------------------------
1360 # Expanding match_* second parameters: BE CAREFUL IF ENABLING THIS!
1361 # It has proven too easy in practice for administrators to configure security
1362 # problems into their Exim install, by treating match_domain{}{} and friends
1363 # as a form of string comparison, where the second string comes from untrusted
1364 # data. Because these options take lists, which can include lookup;LOOKUPDATA
1365 # style elements, a foe can then cause Exim to, eg, execute an arbitrary MySQL
1366 # query, dropping tables.
1367 # From Exim 4.77 onwards, the second parameter is not expanded; it can still
1368 # be a list literal, or a macro, or a named list reference.  There is also
1369 # the new expansion condition "inlisti" which does expand the second parameter,
1370 # but treats it as a list of strings; also, there's "eqi" which is probably
1371 # what is normally wanted.
1372 #
1373 # If you really need to have the old behaviour, know what you are doing and
1374 # will not complain if your system is compromised as a result of doing so, then
1375 # uncomment this option to get the old behaviour back.
1376
1377 # EXPAND_LISTMATCH_RHS=yes
1378
1379 #------------------------------------------------------------------------------
1380 # Disabling the use of fsync(): DO NOT UNCOMMENT THE FOLLOWING LINE unless you
1381 # really, really, really know what you are doing. And even then, think again.
1382 # You should never uncomment this when compiling a binary for distribution.
1383 # Use it only when compiling Exim for your own use.
1384 #
1385 # Uncommenting this line enables the use of a runtime option called
1386 # disable_fsync, which can be used to stop Exim using fsync() to ensure that
1387 # files are written to disc before proceeding. When this is disabled, crashes
1388 # and hardware problems such as power outages can cause data to be lost. This
1389 # feature should only be used in very exceptional circumstances. YOU HAVE BEEN
1390 # WARNED.
1391
1392 # ENABLE_DISABLE_FSYNC=yes
1393
1394 # End of EDITME for Exim 4.