source: server/mail/dovecot.xml@ 224c3b2

10.0 10.1 11.0 7.10 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus nosym perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 224c3b2 was 224c3b2, checked in by Fernando de Oliveira <fernando@…>, 6 years ago
  • Update to p11-kit-0.23.2.
  • Update todovecot-2.2.20.
  • Update to menu-cache-1.0.1.

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

  • Property mode set to 100644
File size: 10.7 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 "http://www.dovecot.org/releases/&dovecot-major;.&dovecot-minor;/dovecot-&dovecot-version;.tar.gz">
9 <!ENTITY dovecot-download-ftp " ">
10 <!ENTITY dovecot-md5sum "2dbeff4385eff699caa6f6b81b838d0f">
11 <!ENTITY dovecot-size "5.1 MB">
12 <!ENTITY dovecot-buildsize "286 MB (with tests)">
13 <!ENTITY dovecot-time "2.1 SBU (with tests)">
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 &lfs78_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">Additional Downloads</bridgehead>
78 <itemizedlist spacing='compact'>
79 <listitem>
80 <para>Required patch: <ulink
81 url="&patch-root;/dovecot-&dovecot-version;-CVE_2015_3420-1.patch"/>
82 </para>
83 </listitem>
84 </itemizedlist>-->
85
86 <bridgehead renderas="sect3">Dovecot Dependencies</bridgehead>
87
88 <bridgehead renderas="sect4">Optional</bridgehead>
89 <para role="optional">
90 <xref linkend="clucene"/>,
91 <xref linkend="icu"/>,
92 <xref linkend="libcap-pam"/>,
93 <xref linkend="linux-pam"/>,
94 <xref linkend="mariadb"/> or <ulink url="http://www.mysql.com/">MySQL</ulink>,
95 <xref linkend="mitkrb"/> (for GSSAPI support),
96 <xref linkend="openldap"/>,
97 <xref linkend="openssl"/>,
98 <xref linkend="postgresql"/>,
99 <xref linkend="sqlite"/>,
100 <xref linkend="valgrind"/>,
101 <ulink url="https://cassandra.apache.org/">Cassandra</ulink>,
102 <ulink url="https://github.com/Cyan4973/lz4">lz4</ulink>, and
103 <ulink url="https://github.com/shibukawa/snowball_py">stemmer</ulink>
104 </para>
105
106 <para condition="html" role="usernotes">User Notes:
107 <ulink url="&blfs-wiki;/dovecot"/>
108 </para>
109 </sect2>
110
111 <sect2 role="installation">
112 <title>Installation of Dovecot</title>
113
114 <para>
115 There should be dedicated users and groups for unprivileged Dovecot
116 processes and for processing users' logins. Issue the following commands
117 as the <systemitem class="username">root</systemitem> user:
118 </para>
119
120<screen role="root"><userinput>groupadd -g 42 dovecot &amp;&amp;
121useradd -c "Dovecot unprivileged user" -d /dev/null -u 42 \
122 -g dovecot -s /bin/false dovecot &amp;&amp;
123groupadd -g 43 dovenull &amp;&amp;
124useradd -c "Dovecot login user" -d /dev/null -u 43 \
125 -g dovenull -s /bin/false dovenull</userinput></screen>
126
127 <para>
128 Install <application>Dovecot</application> by running the following
129 commands:
130 </para>
131
132<screen><userinput>./configure --prefix=/usr \
133 --sysconfdir=/etc \
134 --localstatedir=/var \
135 --docdir=/usr/share/doc/dovecot-&dovecot-version; \
136 --disable-static &amp;&amp;
137make</userinput></screen>
138
139 <para>To test the results, issue <command>make -k check</command>. One test
140 fails for unknown reason</para>
141
142 <para>
143 Now, as the <systemitem class="username">root</systemitem> user:
144 </para>
145
146<screen role="root"><userinput>make install</userinput></screen>
147
148 </sect2>
149
150 <sect2 role="commands">
151 <title>Command Explanations</title>
152
153 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
154 href="../../xincludes/static-libraries.xml"/>
155
156 <para>
157 <option>--with-ldap</option>: This switch enables
158 <application>OpenLDAP</application> authentication support.
159 </para>
160
161 <para>
162 <option>--with-pgsql</option>: This switch enables
163 <application>PostgreSQL</application> authentication support.
164 </para>
165
166 <para>
167 <option>--with-mysql</option>: This switch enables
168 <application>MySQL</application> authentication support.
169 </para>
170
171 <para>
172 <option>--with-sqlite</option>: This switch enables
173 <application>SQLite</application> authentication support.
174 </para>
175
176 <para>
177 <option>--with-lucene</option>: This switch enables
178 <application>CLucene</application> full text search support.
179 </para>
180
181 <para>
182 <option>--with-krb5</option>: This switch enables
183 GSSAPI authentication support.
184 </para>
185
186 </sect2>
187
188 <sect2 role="configuration">
189 <title>Configuring Dovecot</title>
190
191 <sect3 id="dovecot-config">
192 <title>Config Files</title>
193
194 <para>
195 <filename>/etc/dovecot/dovecot.conf</filename>,
196 <filename>/etc/dovecot/conf.d/*</filename>, and
197 <filename>/etc/dovecot/local.conf</filename>
198 </para>
199
200 <indexterm zone="dovecot dovecot-config">
201 <primary sortas="e-etc-dovecot-dovecot.conf">/etc/dovecot/dovecot.conf</primary>
202 </indexterm>
203 <indexterm zone="dovecot dovecot-config">
204 <primary sortas="e-etc-dovecot-conf.d">/etc/dovecot/conf.d/*</primary>
205 </indexterm>
206 <indexterm zone="dovecot dovecot-config">
207 <primary sortas="e-etc-dovecot-local.conf">/etc/dovecot/local.conf</primary>
208 </indexterm>
209
210 </sect3>
211
212 <sect3>
213 <title>Configuration Information</title>
214
215 <para>
216 Copy an example configuration, which you can use as a starting point:
217 </para>
218
219<screen role="root"><userinput>cp -rv /usr/share/doc/dovecot-&dovecot-version;/example-config/* /etc/dovecot</userinput></screen>
220
221 <para>
222 The following configuration is a simple proof of concept with IMAP
223 service using local users for authentication and mailbox location.
224 Reading files from the <filename class="directory">conf.d</filename>
225 directory is commented out since the included example configuration
226 requires <application>OpenSSL</application> and
227 <application>Linux PAM</application>.
228 </para>
229
230<screen role="root"><userinput>sed -i '/^\!include / s/^/#/' /etc/dovecot/dovecot.conf &amp;&amp;
231chmod -v 1777 /var/mail &amp;&amp;
232cat &gt; /etc/dovecot/local.conf &lt;&lt; "EOF"
233<literal>protocols = imap
234ssl = no
235# The next line is only needed if you have no IPv6 network interfaces
236listen = *
237mail_location = mbox:~/Mail:INBOX=/var/mail/%u
238userdb {
239 driver = passwd
240}
241passdb {
242 driver = shadow
243}</literal>
244EOF</userinput></screen>
245
246 <para>
247 You will definitely want to read the official documentation at <ulink
248 url="http://wiki2.dovecot.org/"/> if you plan to use
249 <application>Dovecot</application> in production environment.
250 </para>
251
252 </sect3>
253
254 <sect3 id="dovecot-init">
255 <title>Boot Script</title>
256
257 <para>If you want the <application>Dovecot</application> server to
258 start automatically when the system is booted, install the
259 <filename>/etc/rc.d/init.d/dovecot</filename> init script included
260 in the <xref linkend="bootscripts"/> package.</para>
261
262 <indexterm zone="dovecot dovecot-init">
263 <primary sortas="f-dovecot">dovecot</primary>
264 </indexterm>
265
266<screen role="root"><userinput>make install-dovecot</userinput></screen>
267
268 </sect3>
269
270 </sect2>
271
272 <sect2 role="content">
273 <title>Contents</title>
274
275 <segmentedlist>
276 <segtitle>Installed Programs</segtitle>
277 <segtitle>Installed Libraries</segtitle>
278 <segtitle>Installed Directories</segtitle>
279
280 <seglistitem>
281 <seg>
282 doveadm, doveconf, dovecot, dsync, and various internal programs
283 </seg>
284 <seg>
285 various internal plugins
286 </seg>
287 <seg>
288 /etc/dovecot,
289 /usr/{include,lib,libexec,share}/dovecot and
290 /usr/share/doc/dovecot-&dovecot-version;
291 </seg>
292 </seglistitem>
293 </segmentedlist>
294
295 <variablelist>
296 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
297 <?dbfo list-presentation="list"?>
298 <?dbhtml list-presentation="table"?>
299
300 <varlistentry id="doveadm">
301 <term><command>doveadm</command></term>
302 <listitem>
303 <para>
304 is the <application>Dovecot</application> administration tool.
305 </para>
306 <indexterm zone="dovecot doveadm">
307 <primary sortas="b-doveadm">doveadm</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="doveconf">
313 <term><command>doveconf</command></term>
314 <listitem>
315 <para>
316 is <application>Dovecot</application>'s configuration dumping
317 utility.
318 </para>
319 <indexterm zone="dovecot doveconf">
320 <primary sortas="b-doveconf">doveconf</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="dovecot-prog">
326 <term><command>dovecot</command></term>
327 <listitem>
328 <para>
329 is the IMAP and POP server.
330 </para>
331 <indexterm zone="dovecot dovecot-prog">
332 <primary sortas="b-dovecot">dovecot</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="dsync">
338 <term><command>dsync</command></term>
339 <listitem>
340 <para>
341 is <application>Dovecot</application>'s mailbox synchronization
342 utility.
343 </para>
344 <indexterm zone="dovecot dsync">
345 <primary sortas="b-dsync">dsync</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350
351 </variablelist>
352
353 </sect2>
354
355</sect1>
Note: See TracBrowser for help on using the repository browser.