source: server/mail/dovecot.xml@ e3ed30f

10.0 10.1 11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since e3ed30f was e3ed30f, checked in by Douglas R. Reno <renodr@…>, 2 years ago

Tag dovecot and remove lua workaround

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

  • Property mode set to 100644
File size: 13.0 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 dovecot-download-http
8 "https://www.dovecot.org/releases/&dovecot-major;.&dovecot-minor;/dovecot-&dovecot-version;.tar.gz">
9 <!ENTITY dovecot-download-ftp " ">
10 <!ENTITY dovecot-md5sum "f06f2272fad04e7b0207f8d00a291f66">
11 <!ENTITY dovecot-size "7.0 MB">
12 <!ENTITY dovecot-buildsize "222 MB">
13 <!ENTITY dovecot-time "8.8 SBU">
14]>
15
16<sect1 id="dovecot" xreflabel="Dovecot-&dovecot-version;">
17 <?dbhtml filename="dovecot.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>Dovecot-&dovecot-version;</title>
25
26 <indexterm zone="dovecot">
27 <primary sortas="a-Dovecot">Dovecot</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to Dovecot</title>
32
33 <para>
34 <application>Dovecot</application> is an Internet Message Access Protocol
35 (IMAP) and Post Office Protocol (POP) server, written primarily with
36 security in mind. <application>Dovecot</application> aims to be
37 lightweight, fast and easy to set up as well as highly configurable and
38 easily extensible with plugins.
39 </para>
40
41 &lfs10_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>
47 Download (HTTP): <ulink url="&dovecot-download-http;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download (FTP): <ulink url="&dovecot-download-ftp;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download MD5 sum: &dovecot-md5sum;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download size: &dovecot-size;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated disk space required: &dovecot-buildsize;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated build time: &dovecot-time;
73 </para>
74 </listitem>
75 </itemizedlist>
76
77 <bridgehead renderas="sect3">Dovecot Dependencies</bridgehead>
78
79 <bridgehead renderas="sect4">Required</bridgehead>
80 <para role="required">
81 <xref linkend="libtirpc"/>
82 </para>
83
84 <bridgehead renderas="sect4">Optional</bridgehead>
85 <para role="optional">
86 <xref linkend="clucene"/>,
87 <xref linkend="icu"/>,
88 <xref linkend="libcap-pam"/>,
89 <xref linkend="linux-pam"/>,
90 <xref linkend="lua"/>,
91 <xref linkend="mariadb"/> or <ulink url="http://www.mysql.com/">MySQL</ulink>,
92 <xref linkend="openldap"/>,
93 <xref linkend="postgresql"/>,
94 <xref linkend="sqlite"/>,
95 <xref linkend="valgrind"/>,
96 <xref linkend="xfsprogs"/>,
97 <ulink url="https://cassandra.apache.org/">Cassandra</ulink>,
98 <ulink url="https://github.com/Cyan4973/lz4">lz4</ulink>,
99 <ulink url="https://github.com/shibukawa/snowball_py">stemmer</ulink> and
100 <ulink url="https://libsodium.gitbook.io/doc/">libsodium</ulink>
101 </para>
102
103 <para condition="html" role="usernotes">User Notes:
104 <ulink url="&blfs-wiki;/dovecot"/>
105 </para>
106 </sect2>
107
108 <sect2 role="installation">
109 <title>Installation of Dovecot</title>
110
111 <para>
112 There should be dedicated users and groups for unprivileged Dovecot
113 processes and for processing users' logins. Issue the following commands
114 as the <systemitem class="username">root</systemitem> user:
115 </para>
116
117<screen role="root"><userinput>groupadd -g 42 dovecot &amp;&amp;
118useradd -c "Dovecot unprivileged user" -d /dev/null -u 42 \
119 -g dovecot -s /bin/false dovecot &amp;&amp;
120groupadd -g 43 dovenull &amp;&amp;
121useradd -c "Dovecot login user" -d /dev/null -u 43 \
122 -g dovenull -s /bin/false dovenull</userinput></screen>
123
124<!--
125 <para>
126 First, adapt the Lua plugin to Lua-5.4:
127 </para>
128
129<screen><userinput remap="pre">sed -i 's/lua_newuserdata/lua_newuserdatauv/' src/lib-lua/dlua-dovecot.c</userinput></screen>
130-->
131
132 <para>
133 Install <application>Dovecot</application> by running the following
134 commands:
135 </para>
136
137<screen revision="sysv"><userinput>CFLAGS+=" -I/usr/include/tirpc" \
138LDFLAGS+=" -ltirpc" \
139./configure --prefix=/usr \
140 --sysconfdir=/etc \
141 --localstatedir=/var \
142 --docdir=/usr/share/doc/dovecot-&dovecot-version; \
143 --disable-static &amp;&amp;
144make</userinput></screen>
145
146<screen revision="systemd"><userinput>CFLAGS+=" -I/usr/include/tirpc" \
147LDFLAGS+=" -ltirpc" \
148./configure --prefix=/usr \
149 --sysconfdir=/etc \
150 --localstatedir=/var \
151 --docdir=/usr/share/doc/dovecot-&dovecot-version; \
152 --disable-static \
153 --with-systemdsystemunitdir=/lib/systemd/system &amp;&amp;
154make</userinput></screen>
155
156 <para>
157 To test the results, issue <command>make -k check</command>. <!-- An error
158 may be reported if <xref linkend="valgrind"/> is present when running
159 the test.-->
160 </para>
161
162 <para>
163 Now, as the <systemitem class="username">root</systemitem> user:
164 </para>
165
166<screen role="root"><userinput>make install</userinput></screen>
167
168 </sect2>
169
170 <sect2 role="commands">
171 <title>Command Explanations</title>
172
173 <para>
174 <command>CFLAGS+=...LDFLAGS+=...</command>: build with libtirpc
175 instead of the recently removed RPC code provided by GlibC.
176 </para>
177
178 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
179 href="../../xincludes/static-libraries.xml"/>
180
181 <para revision="systemd">
182 <parameter>--with-systemdsystemunitdir=/lib/systemd/system</parameter>:
183 This switch is used to set the correct installation directory for
184 systemd units.
185 </para>
186
187 <para>
188 <option>--with-ldap</option>: This switch enables
189 <application>OpenLDAP</application> authentication support.
190 </para>
191
192 <para>
193 <option>--with-pgsql</option>: This switch enables
194 <application>PostgreSQL</application> database support.
195 </para>
196
197 <para>
198 <option>--with-mysql</option>: This switch enables
199 <application>MySQL</application> database support.
200 </para>
201
202 <para>
203 <option>--with-sqlite</option>: This switch enables
204 <application>SQLite</application> database support.
205 </para>
206
207 <para>
208 <option>--with-lucene</option>: This switch enables
209 <application>CLucene</application> full text search support.
210 </para>
211
212 <para>
213 <option>--with-lua</option>: This switch enables
214 <application>Lua</application> plugin support. This includes
215 a mail and push notification plugin.
216 </para>
217
218<!--
219 <para>
220 <option>- -with-krb5</option>: This switch enables
221 GSSAPI authentication support.
222 </para>
223-->
224 </sect2>
225
226 <sect2 role="configuration">
227 <title>Configuring Dovecot</title>
228
229 <sect3 id="dovecot-config">
230 <title>Config Files</title>
231
232 <para>
233 <filename>/etc/dovecot/dovecot.conf</filename>,
234 <filename>/etc/dovecot/conf.d/*</filename>, and
235 <filename>/etc/dovecot/local.conf</filename>
236 </para>
237
238 <indexterm zone="dovecot dovecot-config">
239 <primary sortas="e-etc-dovecot-dovecot.conf">/etc/dovecot/dovecot.conf</primary>
240 </indexterm>
241 <indexterm zone="dovecot dovecot-config">
242 <primary sortas="e-etc-dovecot-conf.d">/etc/dovecot/conf.d/*</primary>
243 </indexterm>
244 <indexterm zone="dovecot dovecot-config">
245 <primary sortas="e-etc-dovecot-local.conf">/etc/dovecot/local.conf</primary>
246 </indexterm>
247
248 </sect3>
249
250 <sect3>
251 <title>Configuration Information</title>
252
253 <para>
254 Copy an example configuration, which you can use as a starting point:
255 </para>
256
257<screen role="root"><userinput>cp -rv /usr/share/doc/dovecot-&dovecot-version;/example-config/* /etc/dovecot</userinput></screen>
258
259 <para>
260 The following configuration is a simple proof of concept with IMAP
261 service using local users for authentication and mailbox location.
262 Reading files from the <filename class="directory">conf.d</filename>
263 directory is commented out since the included example configuration
264 requires <application>OpenSSL</application> and
265 <application>Linux PAM</application>.
266 </para>
267
268<screen role="root"><userinput>sed -i '/^\!include / s/^/#/' /etc/dovecot/dovecot.conf &amp;&amp;
269chmod -v 1777 /var/mail &amp;&amp;
270cat &gt; /etc/dovecot/local.conf &lt;&lt; "EOF"
271<literal>protocols = imap
272ssl = no
273# The next line is only needed if you have no IPv6 network interfaces
274listen = *
275mail_location = mbox:~/Mail:INBOX=/var/mail/%u
276userdb {
277 driver = passwd
278}
279passdb {
280 driver = shadow
281}</literal>
282EOF</userinput></screen>
283
284 <para>
285 You will definitely want to read the official documentation at <ulink
286 url="http://wiki2.dovecot.org/"/> if you plan to use
287 <application>Dovecot</application> in production environment.
288 </para>
289
290 </sect3>
291
292 <sect3 id="dovecot-init">
293 <title><phrase revision="sysv">Boot Script</phrase>
294 <phrase revision="systemd">Systemd Unit</phrase></title>
295
296 <para revision="sysv">
297 If you want the <application>Dovecot</application>
298 server to start automatically when the system is booted, install the
299 <filename>/etc/rc.d/init.d/dovecot</filename> init script included in
300 the <xref linkend="bootscripts"/> package.
301 </para>
302
303 <para revision="systemd">
304 To start the <command>dovecot</command>
305 daemon at boot, enable the previously installed systemd unit with the
306 following command:
307 </para>
308
309 <indexterm zone="dovecot dovecot-init">
310 <primary sortas="f-dovecot">dovecot</primary>
311 </indexterm>
312
313<screen role="root" revision="sysv"><userinput>make install-dovecot</userinput></screen>
314
315<screen role="root" revision="systemd"><userinput>systemctl enable dovecot</userinput></screen>
316
317 </sect3>
318
319 </sect2>
320
321 <sect2 role="content">
322 <title>Contents</title>
323
324 <segmentedlist>
325 <segtitle>Installed Programs</segtitle>
326 <segtitle>Installed Libraries</segtitle>
327 <segtitle>Installed Directories</segtitle>
328
329 <seglistitem>
330 <seg>
331 doveadm, doveconf, dovecot, dovecot-sysreport, and dsync (symbolic link)
332 </seg>
333 <seg>
334 various internal plugins in <filename
335 class="directory">/usr/lib/dovecot</filename>
336 </seg>
337 <seg>
338 /etc/dovecot,
339 /usr/{include,lib,libexec,share}/dovecot and
340 /usr/share/doc/dovecot-&dovecot-version;
341 </seg>
342 </seglistitem>
343 </segmentedlist>
344
345 <variablelist>
346 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
347 <?dbfo list-presentation="list"?>
348 <?dbhtml list-presentation="table"?>
349
350 <varlistentry id="doveadm">
351 <term><command>doveadm</command></term>
352 <listitem>
353 <para>
354 is the <application>Dovecot</application> administration tool.
355 </para>
356 <indexterm zone="dovecot doveadm">
357 <primary sortas="b-doveadm">doveadm</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="doveconf">
363 <term><command>doveconf</command></term>
364 <listitem>
365 <para>
366 is <application>Dovecot</application>'s configuration dumping
367 utility.
368 </para>
369 <indexterm zone="dovecot doveconf">
370 <primary sortas="b-doveconf">doveconf</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="dovecot-prog">
376 <term><command>dovecot</command></term>
377 <listitem>
378 <para>
379 is the IMAP and POP server.
380 </para>
381 <indexterm zone="dovecot dovecot-prog">
382 <primary sortas="b-dovecot">dovecot</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 <varlistentry id="dovecot-sysreport">
388 <term><command>dovecot-sysreport</command></term>
389 <listitem>
390 <para>
391 prints system information that is useful to the Dovecot developers
392 when submitting bug reports upstream.
393 </para>
394 <indexterm zone="dovecot dovecot-sysreport">
395 <primary sortas="b-dovecot-sysreport">dovecot-sysreport</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="dsync">
401 <term><command>dsync</command></term>
402 <listitem>
403 <para>
404 is <application>Dovecot</application>'s mailbox synchronization
405 utility.
406 </para>
407 <indexterm zone="dovecot dsync">
408 <primary sortas="b-dsync">dsync</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413
414 </variablelist>
415
416 </sect2>
417
418</sect1>
Note: See TracBrowser for help on using the repository browser.