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