Mercurial > dovecot > original-hg > dovecot-1.2

comparison INSTALL @ 4346:5fe316cdd8a6 HEAD

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Removed most of the content and added links to Wiki instead.
author Timo Sirainen <tss@iki.fi>
date Fri, 16 Jun 2006 12:27:21 +0300
parents ed7d77a89b17
children
comparison
equal deleted inserted replaced
4345:f5d9c2b4d118 4346:5fe316cdd8a6
13 include or library paths, you can give them in CPPFLAGS and LDFLAGS 13 include or library paths, you can give them in CPPFLAGS and LDFLAGS
14 environment variables. For example: 14 environment variables. For example:
15 15
16 CPPFLAGS=-I/opt/openssl/include LDFLAGS=-L/opt/openssl/lib ./configure 16 CPPFLAGS=-I/opt/openssl/include LDFLAGS=-L/opt/openssl/lib ./configure
17 17
18 See ./configure --help for a list of all available configure options.
19 See http://wiki.dovecot.org/CompilingSource for more information.
18 20
19 Running 21 Running
20 ------- 22 -------
21 23
22 Rename configuration file: 24 Rename configuration file:
23 25
24 mv /usr/local/etc/dovecot-example.conf /usr/local/etc/dovecot.conf 26 mv /usr/local/etc/dovecot-example.conf /usr/local/etc/dovecot.conf
25 27
26 Read through, and make needed modifications. doc/configuration.txt tells 28 Read through, and make needed modifications.
27 you more about configuring Dovecot.
28 29
29 Once everything is configured, there's two ways to start Dovecot: 30 Once everything is configured, there's two ways to start Dovecot:
30 31
31 1) Run "dovecot" binary which does everything. 32 1) Run "dovecot" binary which does everything.
32 33
33 2) Start it via inetd or similiar by executing "imap-login" or "pop3-login" 34 2) Start it via inetd or similiar by executing "imap-login" or "pop3-login"
34 binaries. If you're listening in SSL port, add --ssl parameter. 35 binaries. If you're listening in SSL port, add --ssl parameter.
35 36
37 See Wiki for more information about configuration. If you're in a hurry, go
38 at least through http://wiki.dovecot.org/QuickConfiguration
36 39
37 SSL/TLS 40 SSL/TLS
38 ------- 41 -------
39 42
40 Dovecot used to support both GNUTLS and OpenSSL libraries, but nowadays 43 Dovecot used to support both GNUTLS and OpenSSL libraries, but nowadays
41 only the OpenSSL code is working. 44 only the OpenSSL code is working.
42
43
44 Optional Configure Options
45 --------------------------
46
47 You can get a full list with:
48
49 ./configure --help
50
51 The options are listed like --with-thing or --enable-thing, usually they're
52 also enabled by default. You can disable them with --without-thing or
53 --disable-thing.
54
55 Besides the standard options, Dovecot has added these:
56
57 --enable-ipv6 Enable IPv6 support (default)
58
59 Enable IPv6 support. By default it's enabled if system is detected to
60 support it.
61
62 --with-file-offset-size=BITS
63
64 Specifies if we use 32bit or 64bit file offsets. 64bit is default if system
65 supports it (Linux and Solaris does). You most likely won't have mails
66 larger than 2GB, so you may want to drop this to 32bit for a bit smaller
67 disk and memory usage.
68
69 --with-mem-align=BYTES
70
71 Specifies memory alignment, needed with many non-x86 systems and should
72 speed up x86 systems too. Default is 8 with everyone to make sure 64bit
73 memory accessing work. Currently it should also be safe to set to 4 when
74 using 32bit file offets. With x86 it could be 1 as well if you want to save
75 a bit of disk space (in .imap.index.data file) and memory.
76
77 --enable-debug Enable some extra checks for debugging
78
79 This is mostly useful for developers. It does quite a lot of unnecessary
80 work but should catch some programming mistakes more quickly.
81
82 --with-ssl=gnutls|openssl Build with GNUTLS (default) or OpenSSL
83 --with-ssldir=DIR SSL base directory for certificates (/etc/ssl)
84
85 SSL options.
86
87 --with-pop3d Build POP3 server (default)
88
89 Build pop3d binary. It still has to be separately enabled from configuration
90 file.
91
92 --with-passwd Build with /etc/passwd support (default)
93 --with-passwd-file Build with passwd-like file support (default)
94 --with-shadow Build with shadow password support (default)
95 --with-pam Build with PAM support (default)
96 --with-ldap Build with LDAP support
97 --with-vpopmail Build with vpopmail support (default)
98 --with-static-userdb Build with static userdb support (default)
99 --with-pgsql Build with PostgreSQL support
100
101 Specify which authentication modules to use. Disabling them give you a few
102 bytes smaller binary, but not much else.
103
104
105 Dynamic Authentication Modules
106 ------------------------------
107
108 Dovecot can also dynamically load authentication modules from
109 $prefix/lib/dovecot/auth/ directory. Binary packages builders should use
110 them for auth modules which require external libraries (eg. LDAP and
111 vpopmail). There's no standard way to build them as modules currently, but
112 something like this should work:
113
114 cd src/auth
115
116 gcc -shared -fPIC -DHAVE_CONFIG_H -DUSERDB_LDAP -DPASSDB_LDAP \
117 -I../.. -I../lib -I../lib-settings \
118 db-ldap.c userdb-ldap.c passdb-ldap.c -o ldap.so -lldap
119
120 gcc -shared -fPIC -DHAVE_CONFIG_H -DUSERDB_VPOPMAIL -DPASSDB_VPOPMAIL \
121 -I../.. -I../lib userdb-vpopmail.c passdb-vpopmail.c -o vpopmail.so \
122 -lvpopmail
123
124
125 Dynamic IMAP and POP3 Modules
126 -----------------------------
127
128 If imap_use_modules or pop3_use_modules is set to yes, Dovecot will load all
129 *.so modules from directory pointed by imap_modules or pop3_modules. These
130 modules can do anything, they're only expected to contain <module name>_init
131 and <module name>_deinit functions which are called.
132
133
134 Dynamic SQL drivers
135 -------------------
136
137 Currently SQL drivers are only used by dovecot-auth, so you could place
138 them into same directory with auth plugins.
139
140 cd src/lib-sql
141
142 gcc -shared -fPIC -DHAVE_CONFIG_H -DBUILD_PGSQL \
143 -I../.. -I../lib -I../lib-settings -I/usr/include/postgresql \
144 driver-pgsql.c -o driver_pgsql.so -L/usr/lib/postgresql -lpq
145
146 gcc -shared -fPIC -DHAVE_CONFIG_H -DBUILD_MYSQL \
147 -I../.. -I../lib -I../lib-settings -I/usr/include/mysql \
148 driver-mysql.c -o driver_mysql.so -lmysqlclient