source: server/mail/dovecot.xml@ 7533b650

10.0 10.1 11.0 11.1 7.10 7.6 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind krejzi/svn lazarus nosym perl-modules qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 7533b650 was 7533b650, checked in by Bruce Dubbs <bdubbs@…>, 8 years ago

tags

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

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