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