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