dev-python/agate: Bump to 1.13.0
[gentoo/gentoo.git] / net-mail / courier-imap / files / courier-imap-gentoo.readme
blobb11a804fc3eab7370fcdc1702fb07b8d40e53e04
1 // This quick guide is for mysql authentication support base on the Gentoo Virtual Mailhosting Guide
2 // turn ON mysql USE flag for courier-authlib. Need to authenticate against mysql database backend.
3 localhost ~ # nano -w /etc/portage/package.use
4 net-libs/courier-authlib mysql
5 net-mail/courier-imap mysql
6 localhost ~ # emerge courier-imap
7 // limit to mysql module only, instead load all of them.
8 localhost ~ # nano -w /etc/courier/authlib/authdaemonrc
9 authmodulelist="authmysql"
11 // set variables to match your setup.
12 localhost ~ # nano -w /etc/courier/authlib/authmysqlrc
13 MYSQL_SERVER            localhost
14 MYSQL_USERNAME          mailsql_admin_username
15 MYSQL_PASSWORD          password
16 MYSQL_DATABASE          mailsql_database
17 MYSQL_USER_TABLE        users
18 # MYSQL_CRYPT_PWFIELD   crypt (commented this out if you want CRAM-MD5)
19 MYSQL_CLEAR_PWFIELD     clear
20 MYSQL_LOGIN_FIELD       email
21 MYSQL_HOME_FIELD        homedir
22 MYSQL_MAILDIR_FIELD     maildir
24 // Start authdaemond
25 localhost ~ # etc/init.d/courier-authlib start
26 * Starting courier-authlib: authdaemond ...                                               [ ok ]
28 ### Courier-IMAP' ssl certificate setup
29 localhost ~ # nano -w /etc/courier-imap/imapd.cnf
30 localhost ~ # nano -w /etc/courier-imap/pop3.cnf
31 // change to match your site.
32 [ req_dn ]
33 C=US
34 ST=NY
35 L=New York
36 O=Courier Mail Server
37 OU=Automatically-generated IMAP SSL key
38 CN=mailhost.example.com
39 emailAddress=postmaster@example.com
41 // Generate Certificate
42 localhost ~ # mkimapdcert
43 ...
44 writing new private key to '/etc/courier-imap/imapd.pem'
45 ...
46 localhost ~ # mkpop3dcert
47 ...
48 writing new private key to '/etc/courier-imap/pop3d.pem'
49 ...
51 ### Secure Authentication Setup (CRAM-MD5)
52 localhost ~ # nano -w /etc/courier-imap/imapd
53 IMAP_CAPABILITY="IMAP4rev1 UIDPLUS CHILDREN NAMESPACE THREAD=ORDEREDSUBJECT THREAD=REFERENCES SORT QUOTA IDLE AUTH=CRAM-MD5"
55 ### Start Courier-imap daemons.
56 localhost ~ # /etc/init.d/courier-pop3d start
57 localhost ~ # /etc/init.d/courier-pop3d-ssl start
58 localhost ~ # /etc/init.d/courier-imapd start
59 localhost ~ # /etc/init.d/courier-imapd-ssl start
61 ### Checking authentication.
62 // From your favorite client send an email to user@your_domain.com
63 // so your mail user's maildir created by your MTA.
64 // you can not login unless user maildir has been created.
65 localhost ~ $ telnet mailexample.com 143
66 Trying xxx.xxx.xxx.xxx...
67 Connected to mail.example.com (xxx.xxx.xxx.xxx).
68 Escape character is '^]'.
69 * OK [CAPABILITY IMAP4rev1 UIDPLUS CHILDREN NAMESPACE THREAD=ORDEREDSUBJECT THREAD=REFERENCES SORT QUOTA IDLE AUTH=CRAM-MD5 ACL ACL2=UNION STARTTLS] Courier-IMAP ready. Copyright 1998-2004 Double Precision, Inc.  See COPYING for distribution information.
70 a login user@example.com password
71 a OK LOGIN Ok.
72  OK LOGOUT completed
73 Connection closed by foreign host.
75 ### That's all folks.