Mercurial > dovecot > original-hg > dovecot-1.2
annotate INSTALL @ 1908:0615c22cbda5 HEAD
updates about running it
| author | Timo Sirainen <tss@iki.fi> |
|---|---|
| date | Fri, 23 Jan 2004 21:50:54 +0200 |
| parents | 587f7911b93d |
| children | cbe5c6772e0d |
| 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 | |
| 623 | 40 Dovecot supports both GNUTLS and OpenSSL. Dovecot prefers GNUTLS if it's |
| 41 found, but fallbacks to OpenSSL. If you wish to force using OpenSSL, give | |
| 42 --with-ssl=openssl to configure. | |
| 43 | |
| 44 For GNUTLS support you need version 0.5.5 or later. You can get GNUTLS from | |
| 45 http://www.gnutls.org/ | |
| 428 | 46 |
| 429 | 47 |
| 1157 | 48 Optional Configure Options |
| 428 | 49 -------------------------- |
| 50 | |
| 51 You can get a full list with: | |
| 52 | |
| 53 ./configure --help | |
| 54 | |
| 55 The options are listed like --with-thing or --enable-thing, usually they're | |
| 56 also enabled by default. You can disable them with --without-thing or | |
| 57 --disable-thing. | |
| 58 | |
| 59 Besides the standard options, Dovecot has added these: | |
| 60 | |
| 61 --enable-ipv6 Enable IPv6 support (default) | |
| 62 | |
| 63 Enable IPv6 support. By default it's enabled if system is detected to | |
| 64 support it. | |
| 65 | |
| 66 --with-file-offset-size=BITS | |
| 67 | |
| 68 Specifies if we use 32bit or 64bit file offsets. 64bit is default if system | |
| 69 supports it (Linux and Solaris does). You most likely won't have mails | |
| 70 larger than 2GB, so you may want to drop this to 32bit for a bit smaller | |
| 71 disk and memory usage. | |
| 72 | |
|
439
b66ccecbc8a6
Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents:
429
diff
changeset
|
73 --with-mem-align=BYTES |
|
b66ccecbc8a6
Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents:
429
diff
changeset
|
74 |
|
b66ccecbc8a6
Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents:
429
diff
changeset
|
75 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
|
76 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
|
77 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
|
78 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
|
79 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
|
80 |
| 1157 | 81 --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
|
82 |
| 1157 | 83 This is mostly useful for developers. It does quite a lot of unnecessary |
| 84 work but should catch some programming mistakes more quickly. | |
| 85 | |
| 86 --with-ssl=gnutls|openssl Build with GNUTLS (default) or OpenSSL | |
| 87 --with-ssldir=DIR SSL base directory for certificates (/etc/ssl) | |
| 88 | |
| 89 SSL options. | |
| 90 | |
| 91 --with-pop3d Build POP3 server (default) | |
| 92 | |
| 93 Build pop3d binary. It still has to be separately enabled from configuration | |
| 94 file. | |
|
439
b66ccecbc8a6
Added --with-mem-align=BYTES option
Timo Sirainen <tss@iki.fi>
parents:
429
diff
changeset
|
95 |
| 428 | 96 --with-passwd Build with /etc/passwd support (default) |
| 97 --with-passwd-file Build with passwd-like file support (default) | |
| 98 --with-shadow Build with shadow password support (default) | |
| 99 --with-pam Build with PAM support (default) | |
| 1157 | 100 --with-ldap Build with LDAP support |
| 428 | 101 --with-vpopmail Build with vpopmail support (default) |
| 1157 | 102 --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
|
103 --with-pgsql Build with PostgreSQL support |
| 428 | 104 |
| 105 Specify which authentication modules to use. Disabling them give you a few | |
| 106 bytes smaller binary, but not much else. | |
| 107 | |
| 1157 | 108 |
| 109 Dynamic Authentication Modules | |
| 110 ------------------------------ | |
| 111 | |
| 112 Dovecot can also dynamically load authentication modules from | |
| 113 $prefix/lib/dovecot/auth/ directory. Binary packages builders should use | |
| 114 them for auth modules which require external libraries (eg. LDAP and | |
| 115 vpopmail). There's no standard way to build them as modules currently, but | |
| 116 something like this should work: | |
| 428 | 117 |
|
1465
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
118 gcc -shared -fPIC -DHAVE_CONFIG_H -DUSERDB_LDAP -DPASSDB_LDAP \ |
| 1159 | 119 -I../.. -I../lib -I../lib-settings \ |
| 1157 | 120 db-ldap.c userdb-ldap.c passdb-ldap.c -o ldap.so \ |
| 121 ../lib-settings/libsettings.a -lldap | |
| 122 | |
|
1465
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
123 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
|
124 -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
|
125 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
|
126 ../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
|
127 |
|
1465
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
128 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
|
129 -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
|
130 -lvpopmail |
| 1157 | 131 |
|
1283
2d8af547a8b4
Added PostgreSQL support, patch by Alex Howansky
Timo Sirainen <tss@iki.fi>
parents:
1190
diff
changeset
|
132 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
|
133 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
|
134 |
|
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
135 Dynamic IMAP and POP3 Modules |
|
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
136 ----------------------------- |
|
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
137 |
|
03dd87873a81
Added support for dynamically loadable imap/pop3 modules.
Timo Sirainen <tss@iki.fi>
parents:
1317
diff
changeset
|
138 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
|
139 *.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
|
140 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
|
141 and <module name>_deinit functions which are called. |