source: server/mail/dovecot.xml@ 3534fb0a

10.0 10.1 11.0 7.10 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 upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 3534fb0a was 3534fb0a, checked in by Igor Živković <igor@…>, 6 years ago

Update to dovecot-2.2.22.

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

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