source: server/mail/dovecot.xml@ 3acd0b1

10.0 10.1 11.0 7.10 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 3acd0b1 was 3acd0b1, checked in by Fernando de Oliveira <fernando@…>, 7 years ago

Update to dovecot-2.2.14.

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

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