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