annotate INSTALL @ 623:3fa9e363cd3d HEAD

SSL fixes and doc updates.
author Timo Sirainen <tss@iki.fi>
date Wed, 20 Nov 2002 16:18:05 +0200
parents b66ccecbc8a6
children d8d8ec83c2f7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
1 Build instructions
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
2 ------------------
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
3
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
4 For most people, the usual:
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
5
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
6 ./configure
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
7 make
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
8 sudo make install
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
9
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
10 is enough. This installs Dovecot under /usr/local. You must also rename the
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
11 configuration file to get it to work:
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
12
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
13 mv /usr/local/etc/dovecot-example.conf /usr/local/etc/dovecot.conf
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
14
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
15 Read through it, make needed modifications and start imap-master.
429
58899a413569 Documentation updates.
Timo Sirainen <tss@iki.fi>
parents: 428
diff changeset
16 doc/configuration.txt tells you more about configuring Dovecot.
58899a413569 Documentation updates.
Timo Sirainen <tss@iki.fi>
parents: 428
diff changeset
17
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
18
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
19 SSL/TLS
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
20 -------
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
21
623
3fa9e363cd3d SSL fixes and doc updates.
Timo Sirainen <tss@iki.fi>
parents: 439
diff changeset
22 Dovecot supports both GNUTLS and OpenSSL. Dovecot prefers GNUTLS if it's
3fa9e363cd3d SSL fixes and doc updates.
Timo Sirainen <tss@iki.fi>
parents: 439
diff changeset
23 found, but fallbacks to OpenSSL. If you wish to force using OpenSSL, give
3fa9e363cd3d SSL fixes and doc updates.
Timo Sirainen <tss@iki.fi>
parents: 439
diff changeset
24 --with-ssl=openssl to configure.
3fa9e363cd3d SSL fixes and doc updates.
Timo Sirainen <tss@iki.fi>
parents: 439
diff changeset
25
3fa9e363cd3d SSL fixes and doc updates.
Timo Sirainen <tss@iki.fi>
parents: 439
diff changeset
26 For GNUTLS support you need version 0.5.5 or later. You can get GNUTLS from
3fa9e363cd3d SSL fixes and doc updates.
Timo Sirainen <tss@iki.fi>
parents: 439
diff changeset
27 http://www.gnutls.org/
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
28
429
58899a413569 Documentation updates.
Timo Sirainen <tss@iki.fi>
parents: 428
diff changeset
29
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
30 Optional configure options
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
31 --------------------------
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
32
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
33 You can get a full list with:
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
34
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
35 ./configure --help
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
36
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
37 The options are listed like --with-thing or --enable-thing, usually they're
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
38 also enabled by default. You can disable them with --without-thing or
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
39 --disable-thing.
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
40
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
41 Besides the standard options, Dovecot has added these:
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
42
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
43 --enable-ipv6 Enable IPv6 support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
44
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
45 Enable IPv6 support. By default it's enabled if system is detected to
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
46 support it.
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
47
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
48 --with-file-offset-size=BITS
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
49
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
50 Specifies if we use 32bit or 64bit file offsets. 64bit is default if system
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
51 supports it (Linux and Solaris does). You most likely won't have mails
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
52 larger than 2GB, so you may want to drop this to 32bit for a bit smaller
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
53 disk and memory usage.
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
54
439
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
55 --with-mem-align=BYTES
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
56
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
57 Specifies memory alignment, needed with many non-x86 systems and should
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
58 speed up x86 systems too. Default is 8 with everyone to make sure 64bit
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
59 memory accessing work. Currently it should also be safe to set to 4 when
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
60 using 32bit file offets. With x86 it could be 1 as well if you want to save
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
61 a bit of disk space (in .imap.index.data file) and memory.
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
62
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
63 Specifies memory alignment to use. Many non-x86 systems require this
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
64
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
65 With many non-x86 systems this is
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
66 required to be 64bit (8 bytes) since all 64bit memo
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
67
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
68 --with-passwd Build with /etc/passwd support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
69 --with-passwd-file Build with passwd-like file support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
70 --with-shadow Build with shadow password support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
71 --with-pam Build with PAM support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
72 --with-vpopmail Build with vpopmail support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
73
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
74 Specify which authentication modules to use. Disabling them give you a few
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
75 bytes smaller binary, but not much else.
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
76
623
3fa9e363cd3d SSL fixes and doc updates.
Timo Sirainen <tss@iki.fi>
parents: 439
diff changeset
77 --with-ssl=gnutls|openssl Build with GNUTLS (default) or OpenSSL
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
78
623
3fa9e363cd3d SSL fixes and doc updates.
Timo Sirainen <tss@iki.fi>
parents: 439
diff changeset
79 Specify wanted SSL library.