source: server/mail/exim.xml@ c6459486

10.0 10.1 11.0 11.1 9.0 9.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since c6459486 was c6459486, checked in by Tim Tassonis <stuff@…>, 3 years ago

Update to exim-4.92.1

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21869 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 22.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY exim-download-http "https://ftp.exim.org/pub/exim/exim4/exim-&exim-version;.tar.xz">
8
9 <!ENTITY exim-download-ftp "ftp://ftp.exim.org/pub/exim/exim4/exim-&exim-version;.tar.xz">
10 <!-- if above don't work, please use one of the official mirrors at
11 http://www.exim.org/mirmon/ftp_mirrors.html -->
12 <!ENTITY exim-md5sum "c047cb66e60557cec8f2dbc558cb5707">
13 <!ENTITY exim-size "1.7 MB">
14 <!ENTITY exim-buildsize "15 MB">
15 <!ENTITY exim-time "0.2 SBU">
16
17 <!ENTITY exim-daemon-version "&exim-version;-5">
18]>
19
20<sect1 id="exim" xreflabel="Exim-&exim-version;">
21 <?dbhtml filename="exim.html"?>
22
23 <sect1info>
24 <othername>$LastChangedBy$</othername>
25 <date>$Date$</date>
26 </sect1info>
27
28 <title>Exim-&exim-version;</title>
29
30 <indexterm zone="exim">
31 <primary sortas="a-Exim">Exim</primary>
32 </indexterm>
33
34 <sect2 role="package">
35 <title>Introduction to Exim</title>
36
37 <para>The <application>Exim</application> package contains a Mail
38 Transport Agent written by the University of Cambridge, released
39 under the GNU Public License.</para>
40
41 &lfs84_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>Download (HTTP): <ulink url="&exim-download-http;"/></para>
47 </listitem>
48 <listitem>
49 <para>Download (FTP): <ulink url="&exim-download-ftp;"/></para>
50 </listitem>
51 <listitem>
52 <para>Download MD5 sum: &exim-md5sum;</para>
53 </listitem>
54 <listitem>
55 <para>Download size: &exim-size;</para>
56 </listitem>
57 <listitem>
58 <para>Estimated disk space required: &exim-buildsize;</para>
59 </listitem>
60 <listitem>
61 <para>Estimated build time: &exim-time;</para>
62 </listitem>
63 </itemizedlist>
64
65 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
66 <itemizedlist spacing="compact">
67 <listitem>
68 <para>Additional formats of the documentation (text-based docs are
69 shipped with the sources) can be downloaded by following the links
70 shown at <ulink url="http://exim.org/docs.html"/>.</para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">Exim Dependencies</bridgehead>
75
76 <bridgehead renderas="sect4">Required</bridgehead>
77 <para role="required">
78 <xref linkend="libnsl"/> and
79 <xref linkend="pcre"/>
80 </para>
81<!--
82 <bridgehead renderas="sect4">Recommended</bridgehead>
83 <para role="recommended">
84 <xref linkend="openssl"/>
85 </para>
86-->
87 <bridgehead renderas="sect4">Optional</bridgehead>
88 <para role="optional">
89 <ulink url="http://sourceforge.net/projects/tdb">TDB</ulink>
90 (alternative to GDBM, built in LFS),
91 <xref linkend="cyrus-sasl"/>,
92 <xref linkend="libidn"/>,
93 <xref linkend="linux-pam"/>,
94 <xref linkend="mariadb"/> or
95 <ulink url="http://www.mysql.com/">MySQL</ulink>,
96 <xref linkend="openldap"/>,
97 <xref linkend="gnutls"/>,
98 <xref linkend="postgresql"/>,
99 <xref linkend="sqlite"/>,
100 <xref linkend="x-window-system"/>,
101 <ulink url="http://www.h5l.org/">Heimdal GSSAPI</ulink>, and
102 <ulink url="http://www.trusteddomain.org/opendmarc/">OpenDMARC</ulink>
103 </para>
104
105 <para condition="html" role="usernotes">User Notes:
106 <ulink url="&blfs-wiki;/exim"/></para>
107
108 </sect2>
109
110 <sect2 role="installation">
111 <title>Installation of Exim</title>
112
113 <para>Before building <application>Exim</application>, as the
114 <systemitem class="username">root</systemitem> user you should create
115 the group and user <systemitem class="username">exim</systemitem> which
116 will run the <command>exim</command> daemon:</para>
117
118<screen role="root"><userinput>groupadd -g 31 exim &amp;&amp;
119useradd -d /dev/null -c "Exim Daemon" -g exim -s /bin/false -u 31 exim</userinput></screen>
120
121 <para>Install <application>Exim</application> with the following
122 commands:</para>
123
124<screen><userinput>sed -e 's,^BIN_DIR.*$,BIN_DIRECTORY=/usr/sbin,' \
125 -e 's,^CONF.*$,CONFIGURE_FILE=/etc/exim.conf,' \
126 -e 's,^EXIM_USER.*$,EXIM_USER=exim,' \
127 -e '/SUPPORT_TLS/s,^#,,' \
128 -e '/USE_OPENSSL/s,^#,,' \
129 -e '515 d' \
130 -e 's,^EXIM_MONITOR,#EXIM_MONITOR,' src/EDITME > Local/Makefile &amp;&amp;
131
132printf "USE_GDBM = yes\nDBMLIB = -lgdbm\n" >> Local/Makefile &amp;&amp;
133make</userinput></screen>
134
135 <para>This package does not come with a test suite.</para>
136
137 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
138
139<!-- dev note: make INSTALL_ARG=-no_chown DESTDIR=<DESTDIR> install -->
140
141<screen role="root"><userinput>make install &amp;&amp;
142install -v -m644 doc/exim.8 /usr/share/man/man8 &amp;&amp;
143
144install -v -d -m755 /usr/share/doc/exim-&exim-version; &amp;&amp;
145install -v -m644 doc/* /usr/share/doc/exim-&exim-version; &amp;&amp;
146
147ln -sfv exim /usr/sbin/sendmail &amp;&amp;
148install -v -d -m750 -o exim -g exim /var/spool/exim</userinput></screen>
149
150 </sect2>
151
152 <sect2 role="commands">
153 <title>Command Explanations</title>
154
155 <para><command>sed -e ... > Local/Makefile</command>: Most of
156 <application>Exim</application>'s configuration options are defined
157 in <filename>Local/Makefile</filename>, which is created from
158 the <filename>src/EDITME</filename> file. This command specifies the minimum
159 set of options. Descriptions for the options are listed below.</para>
160
161 <para><command>printf ... > Local/Makefile</command>: Setting those
162 variables allows to use GDBM instead of the default Berkeley DB. Remove
163 this command if you have installed <xref linkend="db"/>.</para>
164
165 <para><parameter>BIN_DIRECTORY=/usr/sbin</parameter>: This installs all of
166 <application>Exim</application>'s binaries and scripts in
167 <filename class='directory'>/usr/sbin</filename>.</para>
168
169 <para><parameter>CONFIGURE_FILE=/etc/exim.conf</parameter>: This installs
170 <application>Exim</application>'s main configuration file in
171 <filename class='directory'>/etc</filename>.</para>
172
173 <para><parameter>EXIM_USER=exim</parameter>: This tells
174 <application>Exim</application> that after the daemon no longer needs
175 <systemitem class="username">root</systemitem> privileges, the process
176 hands off the daemon to the <systemitem
177 class="username">exim</systemitem> user.</para>
178
179 <para><parameter>SUPPORT_TLS=yes</parameter>: This allows to support
180 STARTTLS connections. If you use this option, you need to select
181 whether <application>OpenSSL</application> or
182 <application>GnuTLS</application> is used (see
183 <filename>src/EDITME</filename>).</para>
184
185 <para><parameter>USE_OPENSSL_PC=openssl</parameter>: This tells the
186 build system to use <application>OpenSSL</application>, and to
187 find the needed libraries with <application>pkg-config</application>.
188 </para>
189
190 <para><parameter>#EXIM_MONITOR</parameter>: This defers building the
191 <application>Exim</application> monitor program, as it requires
192 <application>X Window System</application> support, by commenting out the
193 <parameter>EXIM_MONITOR</parameter> line in the <filename>Makefile</filename>.
194 If you wish to build the monitor program, omit this <command>sed</command>
195 command and issue the following command before building the package (modify
196 <filename>Local/eximon.conf</filename>, if necessary):
197 <command>cp exim_monitor/EDITME Local/eximon.conf</command>.</para>
198
199 <para><command>ln -sfv exim /usr/sbin/sendmail</command>: Creates a link to
200 <command>sendmail</command> for applications which need it.
201 <application>Exim</application> will accept most
202 <application>Sendmail</application> command-line options.</para>
203
204 <para><command>install -v -m750 -o exim -g exim /var/spool/exim</command>:
205 Since /var/spool is owned by root and this version of <command>exim</command>
206 drops <systemitem class="username">root</systemitem> privileges early, to
207 run as user <systemitem class="username">exim</systemitem>, it cannot create
208 the <filename class="directory">/var/spool/exim</filename> directory. As a
209 work around, it is created manually.</para>
210
211 </sect2>
212
213 <sect2 role="commands">
214 <title>Adding Additional Functionality</title>
215
216 <para>To utilize some or all of the dependency packages, you'll need to
217 modify <filename>Local/Makefile</filename> to include the appropriate
218 directives and parameters to link additional libraries before you build
219 <application>Exim</application>. <filename>Local/Makefile</filename> is
220 heavily commented with instructions on how to do this. Listed below is
221 additional information to help you link these dependency packages or
222 add additional functionality.</para>
223
224 <para>If you wish to build and install the
225 <filename class='extension'>.info</filename> documentation, refer to <ulink
226 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch04.html#SECTinsinfdoc"/>.</para>
227
228 <para>If you wish to build in Exim's interfaces for calling virus and spam
229 scanning software directly from access control lists, uncomment the
230 <option>WITH_CONTENT_SCAN=yes</option> parameter and review the information
231 found at <ulink
232 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch45.html"/>.</para>
233
234 <para>To use a backend database other than <application>Berkeley
235 DB</application>, see the instructions at <ulink
236 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch04.html#SECTdb"/>.</para>
237
238 <para>For SSL functionality, see the instructions at <ulink
239 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch04.html#SECTinctlsssl"/>
240 and <ulink
241 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch42.html"/>.</para>
242
243 <para>For <application>tcpwrappers</application> functionality, see the
244 instructions at <ulink
245 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch04.html#SECID27"/>.</para>
246
247 <para>For information about adding authentication mechanisms to the
248 build, see chapters 33&mdash;41 of <ulink
249 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/index.html"/>.</para>
250
251 <para>For information about linking <application>Linux-PAM</application>,
252 refer to the instructions <ulink
253 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch11.html#SECTexpcond"/>.</para>
254
255 <para>For information about linking database engine libraries used for
256 <application>Exim</application> name lookups, see the instructions at <ulink
257 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch09.html"/>.</para>
258
259 <para>If you wish to add <application>Readline</application> support to
260 <application>Exim</application> when invoked in <quote>test expansion</quote>
261 (<option>-be</option>) mode, see the information in the <option>-be</option>
262 section of <ulink
263 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch05.html#id2525974"/>.</para>
264
265 <para>You may wish to modify the default configuration and send log files to
266 syslog instead of the default
267 <filename class='directory'>/var/spool/exim/log</filename> directory. See the
268 information at <ulink
269 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch52.html"/>.</para>
270
271 <para>A wealth of information can be also found at the <ulink url=
272 "https://github.com/Exim/exim/wiki">Exim Wiki</ulink>.</para>
273
274 </sect2>
275
276 <sect2 role="configuration">
277 <title>Configuring Exim</title>
278
279 <sect3 id="exim-config">
280 <title>Config Files</title>
281
282 <para><filename>/etc/exim.conf</filename> and
283 <filename>/etc/aliases</filename></para>
284
285 <indexterm zone="exim exim-config">
286 <primary sortas="e-etc-exim.conf">/etc/exim.conf</primary>
287 </indexterm>
288
289 <indexterm zone="exim exim-config">
290 <primary sortas="e-etc-aliases">/etc/aliases</primary>
291 </indexterm>
292
293 </sect3>
294
295 <sect3>
296 <title>Configuration Information</title>
297
298 <para>
299 Review the file <filename>/etc/exim.conf</filename>, and modify any
300 settings to suit your needs. Note that the default configuration
301 assumes that the <filename class="directory">/var/mail</filename>
302 directory is world writable, but has the sticky bit set. If you want
303 to use the default configuration, issue as the <systemitem
304 class="username">root</systemitem> user:
305 </para>
306
307<screen role="root"><userinput>chmod -v a+wt /var/mail</userinput></screen>
308
309 <para>
310 A default (nothing but comments) <filename>/etc/aliases</filename>
311 file is installed during the package installation if this file did not
312 exist on your system. Create the necessary aliases and start the
313 <application>Exim</application> daemon using the following commands:
314 </para>
315
316<screen role="root"><userinput>cat &gt;&gt; /etc/aliases &lt;&lt; "EOF"
317<literal>postmaster: root
318MAILER-DAEMON: root</literal>
319EOF
320exim -v -bi &amp;&amp;
321/usr/sbin/exim -bd -q15m</userinput></screen>
322
323 <note>
324 <para>To protect an existing <filename>/etc/aliases</filename> file,
325 the command above appends these aliases to it. This file should be
326 checked and duplicate aliases removed, if present.</para>
327 </note>
328
329 <para>The <command>/usr/sbin/exim -bd -q15m</command> command starts
330 the <application>Exim</application> daemon with a 15 minute interval
331 in processing the mail queue. Adjust this parameter to suit your
332 desires.</para>
333
334 </sect3>
335
336 <sect3 id="exim-init">
337 <title><phrase revision="sysv">Boot Script</phrase>
338 <phrase revision="systemd">Systemd Unit</phrase></title>
339
340 <para>To automatically start <command>exim</command> at boot,
341 install the
342 <phrase revision="sysv"><filename>/etc/rc.d/init.d/exim</filename>
343 init script</phrase>
344 <phrase revision="systemd"><filename>exim.service</filename> unit</phrase>
345 included in the <xref linkend="bootscripts" revision="sysv"/>
346 <xref linkend="systemd-units" revision="systemd"/> package.</para>
347
348 <indexterm zone="exim exim-init">
349 <primary sortas="f-exim">exim</primary>
350 </indexterm>
351
352<screen role="root"><userinput>make install-exim</userinput></screen>
353
354 <para revision="sysv">The bootscript also starts the
355 <application>Exim</application> daemon and dispatches a queue runner
356 process every 15 minutes. Modify the
357 <option>-q<replaceable>&lt;time interval&gt;</replaceable></option>
358 parameter in <filename>/etc/rc.d/init.d/exim</filename>, if necessary
359 for your installation.</para>
360
361 </sect3>
362
363 </sect2>
364
365 <sect2 role="content">
366 <title>Contents</title>
367
368 <segmentedlist>
369 <segtitle>Installed Programs</segtitle>
370 <segtitle>Installed Libraries</segtitle>
371 <segtitle>Installed Directories</segtitle>
372
373 <seglistitem>
374 <seg>exicyclog, exigrep, exim, exim-&exim-daemon-version;, exim_checkaccess,
375 exim_dbmbuild, exim_dumpdb, exim_fixdb, exim_lock, exim_tidydb,
376 eximstats, exinext, exipick, exiqgrep, exiqsumm, exiwhat, and
377 optionally, eximon, eximon.bin, and sendmail (symlink)</seg>
378 <seg>None</seg>
379 <seg>/usr/share/doc/exim-&exim-version; and /var/spool/exim</seg>
380 </seglistitem>
381 </segmentedlist>
382
383 <variablelist>
384 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
385 <?dbfo list-presentation="list"?>
386 <?dbhtml list-presentation="table"?>
387
388 <varlistentry id="exicyclog">
389 <term><command>exicyclog</command></term>
390 <listitem>
391 <para>cycles <application>Exim</application> log files.</para>
392 <indexterm zone="exim exicyclog">
393 <primary sortas="b-exicyclog">exicyclog</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="exigrep">
399 <term><command>exigrep</command></term>
400 <listitem>
401 <para>searches <application>Exim</application> log files.</para>
402 <indexterm zone="exim exigrep">
403 <primary sortas="b-exigrep">exigrep</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="exim-prog">
409 <term><command>exim</command></term>
410 <listitem>
411 <para>is a symlink to the <command>exim-&exim-daemon-version;</command>
412 MTA daemon.</para>
413 <indexterm zone="exim exim-prog">
414 <primary sortas="b-exim">exim</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
418
419 <varlistentry id="exim-current_version">
420 <term><command>exim-&exim-daemon-version;</command></term>
421 <listitem>
422 <para>is the <application>Exim</application> mail transport
423 agent daemon.</para>
424 <indexterm zone="exim exim-current_version">
425 <primary sortas="b-exim-&exim-daemon-version;">exim-&exim-daemon-version;</primary>
426 </indexterm>
427 </listitem>
428 </varlistentry>
429
430 <varlistentry id="exim_checkaccess">
431 <term><command>exim_checkaccess</command></term>
432 <listitem>
433 <para>states whether a given recipient address from a given host is
434 acceptable or not.</para>
435 <indexterm zone="exim exim_checkaccess">
436 <primary sortas="b-exim_checkaccess">exim_checkaccess</primary>
437 </indexterm>
438 </listitem>
439 </varlistentry>
440
441 <varlistentry id="exim_dbmbuild">
442 <term><command>exim_dbmbuild</command></term>
443 <listitem>
444 <para> creates and rebuilds <application>Exim</application>
445 databases.</para>
446 <indexterm zone="exim exim_dbmbuild">
447 <primary sortas="b-exim_dbmbuild">exim_dbmbuild</primary>
448 </indexterm>
449 </listitem>
450 </varlistentry>
451
452 <varlistentry id="exim_dumpdb">
453 <term><command>exim_dumpdb</command></term>
454 <listitem>
455 <para> writes the contents of <application>Exim</application>
456 databases to the standard output.</para>
457 <indexterm zone="exim exim_dumpdb">
458 <primary sortas="b-exim_dumpdb">exim_dumpdb</primary>
459 </indexterm>
460 </listitem>
461 </varlistentry>
462
463 <varlistentry id="exim_fixdb">
464 <term><command>exim_fixdb</command></term>
465 <listitem>
466 <para>modifies data in <application>Exim</application>
467 databases.</para>
468 <indexterm zone="exim exim_fixdb">
469 <primary sortas="b-exim_fixdb">exim_fixdb</primary>
470 </indexterm>
471 </listitem>
472 </varlistentry>
473
474 <varlistentry id="exim_lock">
475 <term><command>exim_lock</command></term>
476 <listitem>
477 <para>locks a mailbox file.</para>
478 <indexterm zone="exim exim_lock">
479 <primary sortas="b-exim_lock">exim_lock</primary>
480 </indexterm>
481 </listitem>
482 </varlistentry>
483
484 <varlistentry id="exim_tidydb">
485 <term><command>exim_tidydb</command></term>
486 <listitem>
487 <para>removes old records from <application>Exim</application>
488 databases.</para>
489 <indexterm zone="exim exim_tidydb">
490 <primary sortas="b-exim_tidydb">exim_tidydb</primary>
491 </indexterm>
492 </listitem>
493 </varlistentry>
494
495 <varlistentry id="eximstats">
496 <term><command>eximstats</command></term>
497 <listitem>
498 <para>generates mail statistics from <application>Exim</application>
499 log files.</para>
500 <indexterm zone="exim eximstats">
501 <primary sortas="b-eximstats">eximstats</primary>
502 </indexterm>
503 </listitem>
504 </varlistentry>
505
506 <varlistentry id="exinext">
507 <term><command>exinext</command></term>
508 <listitem>
509 <para>queries remote host retry times.</para>
510 <indexterm zone="exim exinext">
511 <primary sortas="b-exinext">exinext</primary>
512 </indexterm>
513 </listitem>
514 </varlistentry>
515
516 <varlistentry id="exipick">
517 <term><command>exipick</command></term>
518 <listitem>
519 <para>selects messages based on various criteria.</para>
520 <indexterm zone="exim exipick">
521 <primary sortas="b-exipick">exipick</primary>
522 </indexterm>
523 </listitem>
524 </varlistentry>
525
526 <varlistentry id="exiqgrep">
527 <term><command>exiqgrep</command></term>
528 <listitem>
529 <para>is a utility for selective queue listing.</para>
530 <indexterm zone="exim exiqgrep">
531 <primary sortas="b-exiqgrep">exiqgrep</primary>
532 </indexterm>
533 </listitem>
534 </varlistentry>
535
536 <varlistentry id="exiqsumm">
537 <term><command>exiqsumm</command></term>
538 <listitem>
539 <para>produces a summary of the messages in the mail queue.</para>
540 <indexterm zone="exim exiqsumm">
541 <primary sortas="b-exiqsumm">exiqsumm</primary>
542 </indexterm>
543 </listitem>
544 </varlistentry>
545
546 <varlistentry id="exiwhat">
547 <term><command>exiwhat</command></term>
548 <listitem>
549 <para>queries running <application>Exim</application>
550 processes.</para>
551 <indexterm zone="exim exiwhat">
552 <primary sortas="b-exiwhat">exiwhat</primary>
553 </indexterm>
554 </listitem>
555 </varlistentry>
556
557 <varlistentry id="eximon">
558 <term><command>eximon</command></term>
559 <listitem>
560 <para>is a start-up shell script for <command>eximon.bin</command>
561 used to set the required environment variables before running the
562 program.</para>
563 <indexterm zone="exim eximon">
564 <primary sortas="b-eximon">eximon</primary>
565 </indexterm>
566 </listitem>
567 </varlistentry>
568
569 <varlistentry id="eximon.bin">
570 <term><command>eximon.bin</command></term>
571 <listitem>
572 <para>is a monitor program which displays current information in an
573 <application>X</application> window, and also contains a menu interface
574 to <application>Exim</application>'s command line administration
575 options.</para>
576 <indexterm zone="exim eximon.bin">
577 <primary sortas="b-eximon.bin">eximon.bin</primary>
578 </indexterm>
579 </listitem>
580 </varlistentry>
581
582 </variablelist>
583
584 </sect2>
585
586</sect1>
Note: See TracBrowser for help on using the repository browser.