source: server/mail/dovecot.xml@ 9964eca

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 9964eca was 22a8219, checked in by Douglas R. Reno <renodr@…>, 4 years ago

Update to dovecot-2.3.11.3, and adapt to Lua-5.4
Update to gnome-desktop-3.36.5
Update to mutter-3.36.5
Update to gnome-shell-3.36.5
Update to gnome-shell-extensions-3.36.3

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23500 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 &lfs91_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 <para>
125 First, adapt the Lua plugin to Lua-5.4:
126 </para>
127
128<screen><userinput remap="pre">sed -i 's/lua_newuserdata/lua_newuserdatauv/' src/lib-lua/dlua-dovecot.c</userinput></screen>
129
130 <para>
131 Install <application>Dovecot</application> by running the following
132 commands:
133 </para>
134
135<screen revision="sysv"><userinput>CFLAGS+=" -I/usr/include/tirpc" \
136LDFLAGS+=" -ltirpc" \
137./configure --prefix=/usr \
138 --sysconfdir=/etc \
139 --localstatedir=/var \
140 --docdir=/usr/share/doc/dovecot-&dovecot-version; \
141 --disable-static &amp;&amp;
142make</userinput></screen>
143
144<screen revision="systemd"><userinput>CFLAGS+=" -I/usr/include/tirpc" \
145LDFLAGS+=" -ltirpc" \
146./configure --prefix=/usr \
147 --sysconfdir=/etc \
148 --localstatedir=/var \
149 --docdir=/usr/share/doc/dovecot-&dovecot-version; \
150 --disable-static \
151 --with-systemdsystemunitdir=/lib/systemd/system &amp;&amp;
152make</userinput></screen>
153
154 <para>
155 To test the results, issue <command>make -k check</command>. <!-- An error
156 may be reported if <xref linkend="valgrind"/> is present when running
157 the test.-->
158 </para>
159
160 <para>
161 Now, as the <systemitem class="username">root</systemitem> user:
162 </para>
163
164<screen role="root"><userinput>make install</userinput></screen>
165
166 </sect2>
167
168 <sect2 role="commands">
169 <title>Command Explanations</title>
170
171 <para>
172 <command>CFLAGS+=...LDFLAGS+=...</command>: build with libtirpc
173 instead of the recently removed RPC code provided by GlibC.
174 </para>
175
176 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
177 href="../../xincludes/static-libraries.xml"/>
178
179 <para revision="systemd">
180 <parameter>--with-systemdsystemunitdir=/lib/systemd/system</parameter>:
181 This switch is used to set the correct installation directory for
182 systemd units.
183 </para>
184
185 <para>
186 <option>--with-ldap</option>: This switch enables
187 <application>OpenLDAP</application> authentication support.
188 </para>
189
190 <para>
191 <option>--with-pgsql</option>: This switch enables
192 <application>PostgreSQL</application> database support.
193 </para>
194
195 <para>
196 <option>--with-mysql</option>: This switch enables
197 <application>MySQL</application> database support.
198 </para>
199
200 <para>
201 <option>--with-sqlite</option>: This switch enables
202 <application>SQLite</application> database support.
203 </para>
204
205 <para>
206 <option>--with-lucene</option>: This switch enables
207 <application>CLucene</application> full text search support.
208 </para>
209
210 <para>
211 <option>--with-lua</option>: This switch enables
212 <application>Lua</application> plugin support. This includes
213 a mail and push notification plugin.
214 </para>
215
216<!--
217 <para>
218 <option>- -with-krb5</option>: This switch enables
219 GSSAPI authentication support.
220 </para>
221-->
222 </sect2>
223
224 <sect2 role="configuration">
225 <title>Configuring Dovecot</title>
226
227 <sect3 id="dovecot-config">
228 <title>Config Files</title>
229
230 <para>
231 <filename>/etc/dovecot/dovecot.conf</filename>,
232 <filename>/etc/dovecot/conf.d/*</filename>, and
233 <filename>/etc/dovecot/local.conf</filename>
234 </para>
235
236 <indexterm zone="dovecot dovecot-config">
237 <primary sortas="e-etc-dovecot-dovecot.conf">/etc/dovecot/dovecot.conf</primary>
238 </indexterm>
239 <indexterm zone="dovecot dovecot-config">
240 <primary sortas="e-etc-dovecot-conf.d">/etc/dovecot/conf.d/*</primary>
241 </indexterm>
242 <indexterm zone="dovecot dovecot-config">
243 <primary sortas="e-etc-dovecot-local.conf">/etc/dovecot/local.conf</primary>
244 </indexterm>
245
246 </sect3>
247
248 <sect3>
249 <title>Configuration Information</title>
250
251 <para>
252 Copy an example configuration, which you can use as a starting point:
253 </para>
254
255<screen role="root"><userinput>cp -rv /usr/share/doc/dovecot-&dovecot-version;/example-config/* /etc/dovecot</userinput></screen>
256
257 <para>
258 The following configuration is a simple proof of concept with IMAP
259 service using local users for authentication and mailbox location.
260 Reading files from the <filename class="directory">conf.d</filename>
261 directory is commented out since the included example configuration
262 requires <application>OpenSSL</application> and
263 <application>Linux PAM</application>.
264 </para>
265
266<screen role="root"><userinput>sed -i '/^\!include / s/^/#/' /etc/dovecot/dovecot.conf &amp;&amp;
267chmod -v 1777 /var/mail &amp;&amp;
268cat &gt; /etc/dovecot/local.conf &lt;&lt; "EOF"
269<literal>protocols = imap
270ssl = no
271# The next line is only needed if you have no IPv6 network interfaces
272listen = *
273mail_location = mbox:~/Mail:INBOX=/var/mail/%u
274userdb {
275 driver = passwd
276}
277passdb {
278 driver = shadow
279}</literal>
280EOF</userinput></screen>
281
282 <para>
283 You will definitely want to read the official documentation at <ulink
284 url="http://wiki2.dovecot.org/"/> if you plan to use
285 <application>Dovecot</application> in production environment.
286 </para>
287
288 </sect3>
289
290 <sect3 id="dovecot-init">
291 <title><phrase revision="sysv">Boot Script</phrase>
292 <phrase revision="systemd">Systemd Unit</phrase></title>
293
294 <para revision="sysv">
295 If you want the <application>Dovecot</application>
296 server to start automatically when the system is booted, install the
297 <filename>/etc/rc.d/init.d/dovecot</filename> init script included in
298 the <xref linkend="bootscripts"/> package.
299 </para>
300
301 <para revision="systemd">
302 To start the <command>dovecot</command>
303 daemon at boot, enable the previously installed systemd unit with the
304 following command:
305 </para>
306
307 <indexterm zone="dovecot dovecot-init">
308 <primary sortas="f-dovecot">dovecot</primary>
309 </indexterm>
310
311<screen role="root" revision="sysv"><userinput>make install-dovecot</userinput></screen>
312
313<screen role="root" revision="systemd"><userinput>systemctl enable dovecot</userinput></screen>
314
315 </sect3>
316
317 </sect2>
318
319 <sect2 role="content">
320 <title>Contents</title>
321
322 <segmentedlist>
323 <segtitle>Installed Programs</segtitle>
324 <segtitle>Installed Libraries</segtitle>
325 <segtitle>Installed Directories</segtitle>
326
327 <seglistitem>
328 <seg>
329 doveadm, doveconf, dovecot, dovecot-sysreport, and dsync (symbolic link)
330 </seg>
331 <seg>
332 various internal plugins in <filename
333 class="directory">/usr/lib/dovecot</filename>
334 </seg>
335 <seg>
336 /etc/dovecot,
337 /usr/{include,lib,libexec,share}/dovecot and
338 /usr/share/doc/dovecot-&dovecot-version;
339 </seg>
340 </seglistitem>
341 </segmentedlist>
342
343 <variablelist>
344 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
345 <?dbfo list-presentation="list"?>
346 <?dbhtml list-presentation="table"?>
347
348 <varlistentry id="doveadm">
349 <term><command>doveadm</command></term>
350 <listitem>
351 <para>
352 is the <application>Dovecot</application> administration tool.
353 </para>
354 <indexterm zone="dovecot doveadm">
355 <primary sortas="b-doveadm">doveadm</primary>
356 </indexterm>
357 </listitem>
358 </varlistentry>
359
360 <varlistentry id="doveconf">
361 <term><command>doveconf</command></term>
362 <listitem>
363 <para>
364 is <application>Dovecot</application>'s configuration dumping
365 utility.
366 </para>
367 <indexterm zone="dovecot doveconf">
368 <primary sortas="b-doveconf">doveconf</primary>
369 </indexterm>
370 </listitem>
371 </varlistentry>
372
373 <varlistentry id="dovecot-prog">
374 <term><command>dovecot</command></term>
375 <listitem>
376 <para>
377 is the IMAP and POP server.
378 </para>
379 <indexterm zone="dovecot dovecot-prog">
380 <primary sortas="b-dovecot">dovecot</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="dovecot-sysreport">
386 <term><command>dovecot-sysreport</command></term>
387 <listitem>
388 <para>
389 prints system information that is useful to the Dovecot developers
390 when submitting bug reports upstream.
391 </para>
392 <indexterm zone="dovecot dovecot-sysreport">
393 <primary sortas="b-dovecot-sysreport">dovecot-sysreport</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="dsync">
399 <term><command>dsync</command></term>
400 <listitem>
401 <para>
402 is <application>Dovecot</application>'s mailbox synchronization
403 utility.
404 </para>
405 <indexterm zone="dovecot dsync">
406 <primary sortas="b-dsync">dsync</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411
412 </variablelist>
413
414 </sect2>
415
416</sect1>
Note: See TracBrowser for help on using the repository browser.