annotate INSTALL @ 1190:c54c61822d27 HEAD

s/ldap/vpopmail/ in vpopmail.so example
author Timo Sirainen <tss@iki.fi>
date Tue, 18 Feb 2003 21:09:18 +0200
parents 8a93dff28e13
children 2d8af547a8b4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
1 Build Instructions
428
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
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
30 Optional Configure Options
428
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
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
63 --with-rawlog Build support for logging user traffic
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
64
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
65 When Dovecot is compiled with this option and user's home directory
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
66 contains rawlog directory, all IMAP connections are logged into
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
67 timstamp-pid.in and .out files. This is mostly useful for debugging.
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
68
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
69 --enable-debug Enable some extra checks for debugging
439
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
70
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
71 This is mostly useful for developers. It does quite a lot of unnecessary
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
72 work but should catch some programming mistakes more quickly.
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
73
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
74 --with-ssl=gnutls|openssl Build with GNUTLS (default) or OpenSSL
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
75 --with-ssldir=DIR SSL base directory for certificates (/etc/ssl)
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
76
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
77 SSL options.
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
78
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
79 --with-pop3d Build POP3 server (default)
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
80
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
81 Build pop3d binary. It still has to be separately enabled from configuration
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
82 file.
439
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
83
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
84 --with-passwd Build with /etc/passwd support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
85 --with-passwd-file Build with passwd-like file support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
86 --with-shadow Build with shadow password support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
87 --with-pam Build with PAM support (default)
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
88 --with-ldap Build with LDAP support
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
89 --with-vpopmail Build with vpopmail support (default)
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
90 --with-static-userdb Build with static userdb support (default)
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
91
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
92 Specify which authentication modules to use. Disabling them give you a few
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
93 bytes smaller binary, but not much else.
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
94
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
95
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
96 Dynamic Authentication Modules
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
97 ------------------------------
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
98
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
99 Dovecot can also dynamically load authentication modules from
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
100 $prefix/lib/dovecot/auth/ directory. Binary packages builders should use
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
101 them for auth modules which require external libraries (eg. LDAP and
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
102 vpopmail). There's no standard way to build them as modules currently, but
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
103 something like this should work:
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
104
1159
8a93dff28e13 wordwrapping..
Timo Sirainen <tss@iki.fi>
parents: 1158
diff changeset
105 gcc -shared -fPIC -DUSERDB_LDAP -DPASSDB_LDAP \
8a93dff28e13 wordwrapping..
Timo Sirainen <tss@iki.fi>
parents: 1158
diff changeset
106 -I../.. -I../lib -I../lib-settings \
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
107 db-ldap.c userdb-ldap.c passdb-ldap.c -o ldap.so \
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
108 ../lib-settings/libsettings.a -lldap
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
109
1158
d346da6de29d -fPIC too
Timo Sirainen <tss@iki.fi>
parents: 1157
diff changeset
110 gcc -shared -fPIC -DUSERDB_VPOPMAIL -DPASSDB_VPOPMAIL -I../.. -I../lib \
1190
c54c61822d27 s/ldap/vpopmail/ in vpopmail.so example
Timo Sirainen <tss@iki.fi>
parents: 1159
diff changeset
111 userdb-vpopmail.c passdb-vpopmail.c -o vpopmail.so -lvpopmail
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
112
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
113 Including libsettings.a in ldap.so is kind of annoying, but it's not
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
114 currently needed elsewhere in dovecot-auth.