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