Mercurial > dovecot > original-hg > dovecot-1.2
annotate INSTALL @ 4157:ed7d77a89b17 HEAD
Updated GNUTLS information.
| author | Timo Sirainen <tss@iki.fi> |
|---|---|
| date | Mon, 10 Apr 2006 01:10:20 +0300 |
| parents | a5c559c847cc |
| children | 5fe316cdd8a6 |
| rev | line source |
|---|---|
| 1157 | 1 Build Instructions |
| 428 | 2 ------------------ |
| 3 | |
| 4 For most people, the usual: | |
| 5 | |
| 6 ./configure | |
| 7 make | |
| 8 sudo make install | |
| 9 | |
| 1908 | 10 is enough. This installs Dovecot under /usr/local. |
| 429 | 11 |
|
1580
a3de39b92838
Say something about CPPFLAGS and LDFLAGS.
Timo Sirainen <tss@iki.fi>
parents:
1577
diff
changeset
|
12 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
|
13 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
|
14 environment variables. For example: |
|
a3de39b92838
Say something about CPPFLAGS and LDFLAGS.
Timo Sirainen <tss@iki.fi>
parents:
1577
diff
changeset
|
15 |
|
1590
6bf54ebc16af
CPPFLAGS/LDFLAGS examples were missing -I / -L options..
Timo Sirainen <tss@iki.fi>
parents:
1580
diff
changeset
|
16 CPPFLAGS=-I/opt/openssl/include LDFLAGS=-L/opt/openssl/lib ./configure |
|
1580
a3de39b92838
Say something about CPPFLAGS and LDFLAGS.
Timo Sirainen <tss@iki.fi>
parents:
1577
diff
changeset
|
17 |
| 428 | 18 |
| 1908 | 19 Running |
| 20 ------- | |
| 21 | |
| 22 Rename configuration file: | |
| 23 | |
| 24 mv /usr/local/etc/dovecot-example.conf /usr/local/etc/dovecot.conf | |
| 25 | |
| 26 Read through, and make needed modifications. doc/configuration.txt tells | |
| 27 you more about configuring Dovecot. | |
| 28 | |
| 29 Once everything is configured, there's two ways to start Dovecot: | |
| 30 | |
| 31 1) Run "dovecot" binary which does everything. | |
| 32 | |
| 33 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 | |
| 36 | |
| 428 | 37 SSL/TLS |
| 38 ------- | |
| 39 | |
| 4157 | 40 Dovecot used to support both GNUTLS and OpenSSL libraries, but nowadays |
| 41 only the OpenSSL code is working. | |
| 428 | 42 |
| 429 | 43 |
| 1157 | 44 Optional Configure Options |
| 428 | 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 | |
|
439
b66ccecbc8a6
Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents:
429
diff
changeset
|
69 --with-mem-align=BYTES |
|
b66ccecbc8a6
Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents:
429
diff
changeset
|
70 |
|
b66ccecbc8a6
Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents:
429
diff
changeset
|
71 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
|
72 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
|
73 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
|
74 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
|
75 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
|
76 |
| 1157 | 77 --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
|
78 |
| 1157 | 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. | |
|
439
b66ccecbc8a6
Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents:
429
diff
changeset
|
91 |
| 428 | 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) | |
| 1157 | 96 --with-ldap Build with LDAP support |
| 428 | 97 --with-vpopmail Build with vpopmail support (default) |
| 1157 | 98 --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
|
99 --with-pgsql Build with PostgreSQL support |
| 428 | 100 |
| 101 Specify which authentication modules to use. Disabling them give you a few | |
| 102 bytes smaller binary, but not much else. | |
| 103 | |
| 1157 | 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: | |
| 428 | 113 |
|
3945
a5c559c847cc
Add directories where they need to be compiled.
Timo Sirainen <tss@iki.fi>
parents:
3943
diff
changeset
|
114 cd src/auth |
|
a5c559c847cc
Add directories where they need to be compiled.
Timo Sirainen <tss@iki.fi>
parents:
3943
diff
changeset
|
115 |
|
1465
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
116 gcc -shared -fPIC -DHAVE_CONFIG_H -DUSERDB_LDAP -DPASSDB_LDAP \ |
| 1159 | 117 -I../.. -I../lib -I../lib-settings \ |
|
3943
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
118 db-ldap.c userdb-ldap.c passdb-ldap.c -o ldap.so -lldap |
|
1283
2d8af547a8b4
Added PostgreSQL support, patch by Alex Howansky
Timo Sirainen <tss@iki.fi>
parents:
1190
diff
changeset
|
119 |
|
1465
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
120 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
|
121 -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
|
122 -lvpopmail |
| 1157 | 123 |
|
1465
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
124 |
|
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
125 Dynamic IMAP and POP3 Modules |
|
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
126 ----------------------------- |
|
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
127 |
|
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
128 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
|
129 *.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
|
130 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
|
131 and <module name>_deinit functions which are called. |
|
3943
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
132 |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
133 |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
134 Dynamic SQL drivers |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
135 ------------------- |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
136 |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
137 Currently SQL drivers are only used by dovecot-auth, so you could place |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
138 them into same directory with auth plugins. |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
139 |
|
3945
a5c559c847cc
Add directories where they need to be compiled.
Timo Sirainen <tss@iki.fi>
parents:
3943
diff
changeset
|
140 cd src/lib-sql |
|
a5c559c847cc
Add directories where they need to be compiled.
Timo Sirainen <tss@iki.fi>
parents:
3943
diff
changeset
|
141 |
|
3943
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
142 gcc -shared -fPIC -DHAVE_CONFIG_H -DBUILD_PGSQL \ |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
143 -I../.. -I../lib -I../lib-settings -I/usr/include/postgresql \ |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
144 driver-pgsql.c -o driver_pgsql.so -L/usr/lib/postgresql -lpq |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
145 |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
146 gcc -shared -fPIC -DHAVE_CONFIG_H -DBUILD_MYSQL \ |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
147 -I../.. -I../lib -I../lib-settings -I/usr/include/mysql \ |
|
cbe5c6772e0d
Added support for dynamically building SQL drivers.
Timo Sirainen <tss@iki.fi>
parents:
1908
diff
changeset
|
148 driver-mysql.c -o driver_mysql.so -lmysqlclient |