annotate INSTALL @ 1580:a3de39b92838 HEAD

Say something about CPPFLAGS and LDFLAGS.
author Timo Sirainen <tss@iki.fi>
date Thu, 26 Jun 2003 03:05:16 +0300
parents b3ae1757f921
children 6bf54ebc16af
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
1317
8cdbade3c75f s/imap-master/dovecot/
Timo Sirainen <tss@iki.fi>
parents: 1283
diff changeset
15 Read through it, make needed modifications and start dovecot binary.
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
1580
a3de39b92838 Say something about CPPFLAGS and LDFLAGS.
Timo Sirainen <tss@iki.fi>
parents: 1577
diff changeset
18 If you have installed some libraries into locations which require special
a3de39b92838 Say something about CPPFLAGS and LDFLAGS.
Timo Sirainen <tss@iki.fi>
parents: 1577
diff changeset
19 include or library paths, you can give them in CPPFLAGS and LDFLAGS
a3de39b92838 Say something about CPPFLAGS and LDFLAGS.
Timo Sirainen <tss@iki.fi>
parents: 1577
diff changeset
20 environment variables. For example:
a3de39b92838 Say something about CPPFLAGS and LDFLAGS.
Timo Sirainen <tss@iki.fi>
parents: 1577
diff changeset
21
a3de39b92838 Say something about CPPFLAGS and LDFLAGS.
Timo Sirainen <tss@iki.fi>
parents: 1577
diff changeset
22 CPPFLAGS=/opt/openssl/include LDFLAGS=/opt/openssl/lib ./configure
a3de39b92838 Say something about CPPFLAGS and LDFLAGS.
Timo Sirainen <tss@iki.fi>
parents: 1577
diff changeset
23
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
24
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
25 SSL/TLS
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
26 -------
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
27
623
3fa9e363cd3d SSL fixes and doc updates.
Timo Sirainen <tss@iki.fi>
parents: 439
diff changeset
28 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
29 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
30 --with-ssl=openssl to configure.
3fa9e363cd3d SSL fixes and doc updates.
Timo Sirainen <tss@iki.fi>
parents: 439
diff changeset
31
3fa9e363cd3d SSL fixes and doc updates.
Timo Sirainen <tss@iki.fi>
parents: 439
diff changeset
32 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
33 http://www.gnutls.org/
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
34
429
58899a413569 Documentation updates.
Timo Sirainen <tss@iki.fi>
parents: 428
diff changeset
35
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
36 Optional Configure Options
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
37 --------------------------
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
38
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
39 You can get a full list with:
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 ./configure --help
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 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
44 also enabled by default. You can disable them with --without-thing or
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
45 --disable-thing.
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
46
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
47 Besides the standard options, Dovecot has added these:
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
48
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
49 --enable-ipv6 Enable IPv6 support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
50
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
51 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
52 support it.
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
53
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
54 --with-file-offset-size=BITS
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
55
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
56 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
57 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
58 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
59 disk and memory usage.
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
60
439
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
61 --with-mem-align=BYTES
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, needed with many non-x86 systems and should
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
64 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
65 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
66 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
67 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
68
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
69 --with-rawlog Build support for logging user traffic
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
70
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
71 When Dovecot is compiled with this option and user's home directory
1577
b3ae1757f921 ~/rawlog -> ~/dovecot.rawlog
Timo Sirainen <tss@iki.fi>
parents: 1465
diff changeset
72 contains dovecot.rawlog directory, all IMAP connections are logged into
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
73 timstamp-pid.in and .out files. This is mostly useful for debugging.
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
74
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
75 --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
76
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
77 This is mostly useful for developers. It does quite a lot of unnecessary
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
78 work but should catch some programming mistakes more quickly.
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
79
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
80 --with-ssl=gnutls|openssl Build with GNUTLS (default) or OpenSSL
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
81 --with-ssldir=DIR SSL base directory for certificates (/etc/ssl)
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
82
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
83 SSL options.
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
84
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
85 --with-pop3d Build POP3 server (default)
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
86
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
87 Build pop3d binary. It still has to be separately enabled from configuration
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
88 file.
439
b66ccecbc8a6 Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents: 429
diff changeset
89
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
90 --with-passwd Build with /etc/passwd support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
91 --with-passwd-file Build with passwd-like file support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
92 --with-shadow Build with shadow password support (default)
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
93 --with-pam Build with PAM support (default)
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
94 --with-ldap Build with LDAP support
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
95 --with-vpopmail Build with vpopmail support (default)
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
96 --with-static-userdb Build with static userdb support (default)
1283
2d8af547a8b4 Added PostgreSQL support, patch by Alex Howansky
Timo Sirainen <tss@iki.fi>
parents: 1190
diff changeset
97 --with-pgsql Build with PostgreSQL support
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
98
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
99 Specify which authentication modules to use. Disabling them give you a few
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
100 bytes smaller binary, but not much else.
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
101
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
102
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
103 Dynamic Authentication Modules
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
104 ------------------------------
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
105
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
106 Dovecot can also dynamically load authentication modules from
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
107 $prefix/lib/dovecot/auth/ directory. Binary packages builders should use
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
108 them for auth modules which require external libraries (eg. LDAP and
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
109 vpopmail). There's no standard way to build them as modules currently, but
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
110 something like this should work:
428
4c7d08ae3f6e Added installation document
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
111
1465
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
112 gcc -shared -fPIC -DHAVE_CONFIG_H -DUSERDB_LDAP -DPASSDB_LDAP \
1159
8a93dff28e13 wordwrapping..
Timo Sirainen <tss@iki.fi>
parents: 1158
diff changeset
113 -I../.. -I../lib -I../lib-settings \
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
114 db-ldap.c userdb-ldap.c passdb-ldap.c -o ldap.so \
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
115 ../lib-settings/libsettings.a -lldap
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
116
1465
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
117 gcc -shared -fPIC -DHAVE_CONFIG_H -DUSERDB_PGSQL -DPASSDB_PGSQL \
1283
2d8af547a8b4 Added PostgreSQL support, patch by Alex Howansky
Timo Sirainen <tss@iki.fi>
parents: 1190
diff changeset
118 -I../.. -I../lib -I../lib-settings -I/usr/include/postgresql \
2d8af547a8b4 Added PostgreSQL support, patch by Alex Howansky
Timo Sirainen <tss@iki.fi>
parents: 1190
diff changeset
119 db-pgsql.c userdb-pgsql.c passdb-pgsql.c -o pgsql.so \
2d8af547a8b4 Added PostgreSQL support, patch by Alex Howansky
Timo Sirainen <tss@iki.fi>
parents: 1190
diff changeset
120 ../lib-settings/libsettings.a -L/usr/lib/postgresql -lpq
2d8af547a8b4 Added PostgreSQL support, patch by Alex Howansky
Timo Sirainen <tss@iki.fi>
parents: 1190
diff changeset
121
1465
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
122 gcc -shared -fPIC -DHAVE_CONFIG_H -DUSERDB_VPOPMAIL -DPASSDB_VPOPMAIL \
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
123 -I../.. -I../lib userdb-vpopmail.c passdb-vpopmail.c -o vpopmail.so \
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
124 -lvpopmail
1157
d8d8ec83c2f7 updated
Timo Sirainen <tss@iki.fi>
parents: 623
diff changeset
125
1283
2d8af547a8b4 Added PostgreSQL support, patch by Alex Howansky
Timo Sirainen <tss@iki.fi>
parents: 1190
diff changeset
126 Including libsettings.a in ldap.so and pgsql.so is kind of annoying, but it's
2d8af547a8b4 Added PostgreSQL support, patch by Alex Howansky
Timo Sirainen <tss@iki.fi>
parents: 1190
diff changeset
127 not needed elsewhere in dovecot-auth.
1465
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
128
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
129 Dynamic IMAP and POP3 Modules
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
130 -----------------------------
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
131
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
132 If imap_use_modules or pop3_use_modules is set to yes, Dovecot will load all
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
133 *.so modules from directory pointed by imap_modules or pop3_modules. These
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
134 modules can do anything, they're only expected to contain <module name>_init
03dd87873a81 Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents: 1317
diff changeset
135 and <module name>_deinit functions which are called.