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