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