Skip to content

Commit 3b67f18

Browse files
committed
Update README for how to setup IMAP tests
This details which packages needs to be installed on Ubuntun 18.04, which configure flags are necessary and what the setup.sh shell script does.
1 parent e950ca1 commit 3b67f18

File tree

1 file changed

+11
-35
lines changed

1 file changed

+11
-35
lines changed

ext/imap/tests/README.md

Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -9,40 +9,16 @@ files will need to be changed to match the local mailserver configuration.
99
The tests have been checked using dovecot (on Linux 32 and 64 bit systems) and
1010
hMailServer on Windows. The tests are intended to be mailserver agnostic.
1111

12-
The tests can be run without modification with a fairly minimal dovecot
13-
installation. For information, the dovecot.conf file used in running the tests
14-
is given below. The dovecot password file (dovecotpass) requires a password for
15-
one user, `webmaster@something.com`. It's also necessary to set up one
16-
additional user ID (vmail) to own the mail directory.
12+
## Set-up tests on Ubuntu (checked on Ubuntu 18.04 (Bionic))
13+
The necessary packages can be installed using the following command;
14+
`apt-get install libc-client-dev libkrb5-dev dovecot-core dovecot-pop3d dovecot-imapd`
1715

18-
```txt
19-
protocols = imap imaps
20-
21-
listen = *
22-
23-
ssl_disable = yes
24-
25-
disable_plaintext_auth=yes
26-
27-
## Mailbox locations and namespaces
28-
29-
mail_location = maildir:/home/vmail/mail/%d/%n/Maildir
30-
31-
auth_verbose = yes
32-
33-
auth_debug = yes
34-
35-
auth default {
36-
mechanisms = login
37-
38-
passdb passwd-file {
39-
args = /etc/dovecot/dovecotpass
40-
}
41-
42-
userdb static {
43-
args = uid=11459 gid=1002 home=/home/vmail/dovecot/mail/%d/%n
44-
}
45-
46-
user = root
47-
}
16+
The build of PHP will need to be compiled with the following flags:
17+
```
18+
--with-imap --with-kerberos --with-imap-ssl
4819
```
20+
21+
Then run the set-up script `ext/imap/tests/setup.sh` which will add the `vmail`
22+
group and user which is used by Dovecot for the mailbox. It will also copy the
23+
`ext/imap/tests/dovecot.conf` and `ext/imap/tests/dovecotpass` to the correct
24+
location for Dovecot and restarts it for the new configuration to be enabled.

0 commit comments

Comments
 (0)