source: server/mail/exim-systemd.xml@ 0e466f67

7.6-blfs 7.6-systemd kde5-14269 kde5-14686 systemd-13485
Last change on this file since 0e466f67 was 608cda6, checked in by Krejzi <krejzi@…>, 10 years ago

Merge more systemd integration from Christopher.

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