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