/[gentoo]/xml/htdocs/doc/en/virt-mail-howto.xml
Gentoo

Diff of /xml/htdocs/doc/en/virt-mail-howto.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.4 Revision 1.46
1<?xml version = '1.0' encoding = 'UTF-8'?> 1<?xml version='1.0' encoding='UTF-8'?>
2<?xml-stylesheet href="/xsl/guide.xsl" type="text/xsl"?> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/virt-mail-howto.xml,v 1.46 2005/12/02 14:49:56 neysx Exp $ -->
3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
4
3<guide link=" /doc/en/virt-mail-howto.xml" > 5<guide link="/doc/en/virt-mail-howto.xml">
4<title>Virtual Mailhosting System Guide</title> 6<title>Virtual Mailhosting System with Postfix Guide</title>
7
5<author title="Author" > 8<author title="Author">
6<mail link="ken@kickasskungfu.com" >Ken Nowack</mail> 9 <mail link="antifa@gentoo.org">Ken Nowack</mail>
7</author> 10</author>
8<author title="Author" > 11<author title="Author">
9<mail link="ezra@kickasskungfu.com" >Ezra Gorman</mail> 12 <mail link="ezra@revoltltd.org">Ezra Gorman</mail>
10</author> 13</author>
11<abstract>This document details how to create a virtual mailhosting system based upon postfix, mysql, courier-imap, and cyrus-sasl. </abstract> 14<author title="Editor">
15 <mail link="klasikahl@gentoo.org">Zack Gilburd</mail>
16</author>
17<author title="Editor">
18 <mail link="seather@scygro.za.net">Scygro</mail>
19</author>
20
21<abstract>
22This document details how to create a virtual mailhosting system based upon
23postfix, mysql, courier-imap, and cyrus-sasl.
24</abstract>
25
12<version>1.0</version> 26<version>1.0.23</version>
13<date>07 Jan 2003</date> 27<date>2005-12-02</date>
28
14<!-- 29<!--
15
16Contents 30Contents
17 31
18I. Introduction 32I. Introduction
19II. Postfix Basics 33II. Postfix Basics
20III. Courier-imap 34III. Courier-imap
28XI. Squirrelmail 42XI. Squirrelmail
29XII. Mailman 43XII. Mailman
30XIII. Content Filtering and Anti-Virus 44XIII. Content Filtering and Anti-Virus
31XIV. Wrap Up 45XIV. Wrap Up
32XV. Troubleshooting 46XV. Troubleshooting
47-->
33 48
34--><chapter> 49<chapter>
35<title>Introduction</title> 50<title>Introduction</title>
51<section>
52<body>
53
54<p>
55For most gentoo users, a simple mail client and fetchmail will do. However, if
56you're hosting a domain with your system, you'll need a full blown MTA (Mail
57Transfer Agent). And if you're hosting multiple domains, then you'll definitely
58need something more robust to handle all of the email for your users. This
59system was designed to be an elegant solution to that problem.
60</p>
61
62<p>
63A virtual mail system needs to be able to handle email for numerous domains
64with multiple users over a variety of interfaces. This presents some issues
65that must be dealt with. For instance, what if you have two users on different
66domains that want the same user name? If you are providing imap access and
67smtp-auth, how do combine the various authentication daemons into a single
68system? How do you provide security for the numerous components that comprise
69the system? How do you manage it all?
70</p>
71
72<p>
73This howto will show you how to set up with a mail system capable of handling
74mail for as many domains as your hardware can handle, supports virtual mail
75users that don't require shell accounts, has domain specific user names, can
76authenticate web, imap, smtp, and pop3 clients against a single database,
77utilizes ssl for transport layer security, has a web interface, can handle
78mailing lists for any domain on the machine, and is controlled by a nice,
79central and easy mysql database.
80</p>
81
82<p>
83There are quite a variety of ways to go about setting up a virtual mailhosting
84system. With so may options, another may be the best choice for your specific
85needs. Consider investigating <uri>http://www.qmail.org/</uri> and
86<uri>http://www.exim.org/</uri> to explore your options.
87</p>
88
89<p>
90The following packages are used in this setup: apache, courier-imap, courier-authlib
91postfix, mod_php, phpmyadmin, squirrelmail, cyrus-sasl, mysql, php, and
92mailman.
93</p>
94
95<p>
96Make sure to turn on the following USE variables in <path>/etc/make.conf</path>
97before compiling the packages: <c>USE="mysql imap libwww maildir
98sasl ssl"</c>. Otherwise you will most likely have to recompile things to
99get the support you need for all the protocols. Further, it's a good idea to
100turn off any other mail and network variables, like ipv6.
101</p>
102
103<impo>
104This howto was written for postfix-2.0.x. If you are using postfix &lt; 2 some
105of the variables in this document will be different. It is recommended that you
106upgrade. Some other packages included in this howto are version sensitive as
107well. You are advised to read the documentation included with packages if you
108run into issues with this.
109</impo>
110
111<impo>
112This document uses apache-1.3.x. Apache-2 has been marked stable in portage.
113However there are still a number of issues with php integration. Until php
114support in apache-2.0.x is marked stable, this guide will continue to use the
1151.3.x version.
116</impo>
117
118<impo>
119You need a domain name to run a public mail server, or at least an MX record
120for a domain. Ideally you would have control of at least two domains to take
121advantage of your new virtual domain functionality.
122</impo>
123
124<impo>
125Make sure <path>/etc/hostname</path> is set to the right hostname for your mail
126server. Verify your hostname is set correctly with <c>hostname</c>. Also
127verify that there are no conflicting entries in <path>/etc/hosts</path>.
128</impo>
129
130<note>
131It is recommended that you read this entire document and familiarize yourself
132with all the steps before attempting the install. If you run into problems with
133any of the steps, check the troubleshooting guide at the end of this document.
134Also, not all the referenced packages are necessary, this set up is very
135flexible. For instance, if you do not desire a web interface, feel free to skip
136the squirrelmail section.
137</note>
138
36<body> 139</body>
37<p>For most gentoo users, a simple mail client and fetchmail will do. However, if you're hosting a domain with your system, you'll need a full blown MTA (Mail Transfer Agent). And if you're hosting multiple domains, then you'll definitely need something more robust to handle all of the email for your users. This system was designed to be an elegant solution to that problem.</p> 140</section>
38<p>A virtual mail system needs to be able to handle email for numerous domains with multiple users over a variety of interfaces. This presents some issues that must be dealt with. For instance, what if you have two users on different domains that want the same user name? If you are providing imap access and smtp-auth, how do combine the various authentication daemons into a single system? How do you provide security for the numerous components that comprise the system? How do you manage it all?</p> 141</chapter>
39<p>This howto will show you how to set up with a mail system capable of handling mail for as many domains as your hardware can handle, supports virtual mail users that don't require shell accounts, has domain specific user names, can authenticate web, imap, smtp, and pop3 clients against a single database, utilizes ssl for transport layer security, has a web interface, can handle mailing lists for any domain on the machine, and is controlled by a nice, central and easy mysql database. </p> 142
40<p>There are quite a variety of ways to go about setting up a virtual mailhosting system. With so may options, another may be the best choice for your specific needs. Consider investigating <uri>http://www.qmail.org</uri> and <uri>http://www.exim.org</uri> to explore your options. </p> 143<chapter>
41<p>The following packages are used in this setup: 144<title>Postfix Basics</title>
145<section>
146<body>
147
148<pre caption="Install postfix">
149# <i>emerge postfix</i>
150</pre>
151
152<warn>
153Verify that you have not installed any other MTA, such as ssmtp, exim, or
154qmail, or you will surely have BIG problems.
155</warn>
156
157<p>
158After postfix is installed, it's time to configure it. Change the following
159options in <path>/etc/postfix/main.cf</path>:
160</p>
161
162<pre caption="/etc/postfix/main.cf">
163myhostname = $host.domain.name
164mydomain = $domain.name
165inet_interfaces = all
166mydestination = $myhostname, localhost.$mydomain $mydomain
167mynetworks = my.ip.net.work/24, 127.0.0.0/8
168home_mailbox = .maildir/
169local_destination_concurrency_limit = 2
170default_destination_concurrency_limit = 10
171</pre>
172
173<p>
174Next change the following in <path>/etc/postfix/master.cf</path>. This will
175turn on verbose output for debugging:
176</p>
177
178<pre caption="/etc/postfix/master.cf">
179# service type private unpriv chroot wakeup maxproc command + args
180# (yes) (yes) (yes) (never) (50)
181#
182==========================================================================
183<comment>(Just add the "-v" after the smtpd in the following line)</comment>
184smtp inet n - n - - smtpd -v
185</pre>
186
187<p>
188Next, edit <path>/etc/mail/aliases</path> to add your local aliases. There
189should at least be an alias for root like: <c>root: your@email.address</c>.
190</p>
191
192<pre caption="Starting postfix for the first time">
193# <i>/usr/bin/newaliases</i>
194<comment>(This will install the new aliases. You only need to do this
195when you update or install aliases.)</comment>
42 196
43 apache, courier-imap, pam_mysql, postfix, mod_php, mod_ssl, phpmyadmin, squirrelmail, cyrus-sasl, mysql, php, and mailman.</p> 197# <i>/etc/init.d/postfix start</i>
44<p>Make sure to turn on the following USE variables in <path>/etc/make.conf</path> before compiling the packages: <c>USE=&quot;mysql imap libwww maildir sasl ssl&quot;</c>. Otherwise you will most likely have to recompile things to get the support you need for all the protocols. Further, it's a good idea to turn off any other mail and network variables, like ipv6.</p> 198</pre>
45<impo>This howto was written for postfix-2.0.x. If you are using postfix &lt; 2 some of the variables in this document will be different. It is reccommended that you upgrade. Some other packages included in this howto are version sensitive as well. You are advised to read the documentation included with packages if you run into issues with this.</impo> 199
46<impo>You need a domain name to run a public mail server, or at least an MX record for a domain. Ideally you would have control of at least two domains to take advantage of your new virtual domain functionality.</impo> 200<p>
47<impo>Make sure <path>/etc/hostname</path> is set to the right hostname for your mail server. Verify your hostname is set correctly with <c>hostname</c>. Also verify that there are no conflicting entries in <path>/etc/hosts</path>.</impo> 201Now that postfix is running, fire up your favorite console mail client and send
48<note>It is recommended that you read this entire document and familiarize yourself with all the steps before attempting the install. If you run into problems with any of the steps, check the troubleshooting guide at the end of this document. Also, not all the referenced packages are necessary, this set up is very flexible. For instance, if you do not desire a web interface, feel free to skip the squirrelmail section.</note> 202yourself an email. I use <c>mutt</c> for all my console mail. Verify that
203postfix is delivering mail to local users, once that's done, we're on to the
204next step.
205</p>
206
207<note>
208I strongly recommend that you verify this basic postfix setup is functioning
209before you progress to the next step of the howto.
210</note>
211
49</body> 212</body>
50</chapter> 213</section>
51<chapter> 214</chapter>
52<title>Postfix Basics</title> 215
216<chapter>
217<title>Courier-imap</title>
218<section>
219<body>
220
221<pre caption="Install courier-imap and courier-authlib">
222# <i>emerge courier-imap courier-authlib</i>
223</pre>
224
225<pre caption="Courier-imap configuration">
226# <i>cd /etc/courier-imap</i>
227<comment>(If you want to use the ssl capabilities of courier-imap or pop3,
228you'll need to create certs for this purpose.
229This step is recommended. If you do not want to use ssl, skip this step.)</comment>
230
231# <i>nano -w pop3d.cnf</i>
232# <i>nano -w imapd.cnf</i>
233<comment>(Change the C, ST, L, CN, and email parameters to match your server.)</comment>
234
235# <i>mkpop3dcert</i>
236# <i>mkimapdcert</i>
237</pre>
238
239<pre caption="Start the courier services you need.">
240# <i>/etc/init.d/courier-imapd start</i>
241# <i>/etc/init.d/courier-imapd-ssl start</i>
242# <i>/etc/init.d/courier-pop3d start</i>
243# <i>/etc/init.d/courier-pop3d-ssl start</i>
244</pre>
245
246<p>
247Start up your favorite mail client and verify that all connections you've
248started work for receiving and sending mail. Now that the basics work, we're
249going to do a whole bunch of stuff at once to get the rest of the system
250running. Again, please verify that what we've installed already works before
251progressing.
252</p>
253
53<body> 254</body>
54<pre caption="Install postfix" ># <i>emerge postfix</i> 255</section>
256</chapter>
257
258<chapter>
259<title>Cyrus-sasl</title>
260<section>
261<body>
262
263<p>
264Next we're going to install cyrus-sasl. Sasl is going to play the role of
265actually passing your auth variables to courier-auth, which will in turn pass that
266information to mysql for authentication of smtp users. For this howto, we'll
267not even try to verify that sasl is working until mysql is set up and contains
268a test user. Which is fine since we'll be authenticating against mysql in the
269end anyway.
55</pre> 270</p>
56<warn>Verify that you have not installed any other MTA, such as ssmtp, exim, or qmail, or you will surely have BIG problems.</warn> 271
57<p>After postfix is installed, it's time to configure it. Change the following options in <path>/etc/postfix/main.cf</path>:</p> 272<pre caption="Configuring and installing the cyrus-sasl ebuild">
58<pre caption="/etc/postfix/main.cf" > 273# <i>emerge cyrus-sasl</i>
59 myhostname = $host.domain.name 274</pre>
60 mydomain = $domain.name 275
61 inet_interfaces = all 276<p>
62 mydestination = $myhostname, localhost.$mydomain $mydomain 277Next, edit <path>/etc/sasl2/smtpd.conf</path>.
63 mynetworks = my.ip.net.work/24, 127.0.0.0/8 278</p>
64 home_mailbox = .maildir/ 279
65 local_destination_concurrency_limit = 2 280<pre caption="Starting sasl">
66 default_destination_concurrency_limit = 10 </pre> 281# <i>nano -w /etc/sasl2/smtpd.conf</i>
67<p>Next change the following in <path>/etc/postfix/master.cf</path>. This will turn on verbose output for debugging:</p> 282mech_list: PLAIN LOGIN
68<pre caption="/etc/postfix/master.cf" > 283pwcheck_method: saslauthd
69 # service type private unpriv chroot wakeup maxproc command + args 284# <i>nano -w /etc/conf.d/saslauthd</i>
70 # (yes) (yes) (yes) (never) (50) 285SASLAUTHD_OPTS="${SASLAUTH_MECH} -a rimap -r"
71 # 286SASLAUTHD_OPTS="${SASLAUTHD_OPTS} -O localhost"
72 ========================================================================== 287# <i>/etc/init.d/saslauthd start</i>
73 smtp inet n - n - - smtpd -v 288</pre>
289
290</body>
291</section>
292</chapter>
293
294<chapter>
295<title>SSL Certs for Postfix and Apache</title>
296<section>
297<body>
298
299<p>
300Next we're going to make a set of ssl certificates for postfix and apache.
301</p>
302
303<pre caption="Making ssl certicates">
304# <i>cd /etc/ssl/</i>
305# <i>nano -w openssl.cnf</i>
306
307<comment>Change the following default values for your domain:</comment>
308countryName_default
309stateOrProvinceName_default
310localityName_default
3110.organizationName_default
312commonName_default
313emailAddress_default.
314
315<comment>(If the variables are not already present, just add them in a sensible place.)</comment>
316
317# <i>cd misc</i>
318# <i>nano -w CA.pl</i>
319<comment>(We need to add -nodes to the # create a certificate and
320#create a certificate request code in order to let our new ssl
321certs be loaded without a password. Otherwise when you
322reboot your ssl certs will not be available.)</comment>
323
324# create a certificate
325system ("$REQ -new -nodes -x509 -keyout newreq.pem -out newreq.pem $DAYS");
326
327# create a certificate request
328system ("$REQ -new -nodes -keyout newreq.pem -out newreq.pem $DAYS");
74 329
75 <codenote>Just add the <c>-v</c> after the smtpd in the above line</codenote> 330# <i>./CA.pl -newca</i>
331# <i>./CA.pl -newreq</i>
332# <i>./CA.pl -sign</i>
333# <i>cp newcert.pem /etc/postfix</i>
334# <i>cp newreq.pem /etc/postfix</i>
335# <i>cp demoCA/cacert.pem /etc/postfix</i>
336<comment>(Now we do the same thing for apache.)</comment>
337
338# <i>openssl req -new > new.cert.csr</i>
339# <i>openssl rsa -in privkey.pem -out new.cert.key</i>
340# <i>openssl x509 -in new.cert.csr -out new.cert.cert -req -signkey new.cert.key -days 365</i>
341<comment>(Just leave the resulting certificates here for now.
342We'll install them after Apache is installed.)</comment>
76</pre> 343</pre>
77<p>Next, edit <path>/etc/mail/aliases</path> to add your local aliases. There should at least be an alias for root like: <c>root: your@email.address</c>.</p> 344
78<pre caption="Starting postfix for the first time" >
79 # <i>/usr/bin/newaliases</i>
80<codenote>This will install the new aliases. You only need to do this </codenote>
81<codenote>when you update or install aliases.</codenote>
82
83 # <i>/etc/init.d/postfix start</i>
84</pre>
85<p>Now that postfix is running, fire up your favorite console mail client and send yourself an email. I use <c>mutt</c> for all my console mail. Verify that postfix is delivering mail to local users, once that's done, we're on to the next step.</p>
86<note>I strongly recommend that you verify this basic postfix setup is functioning before you progress to the next step of the howto. </note>
87</body> 345</body>
88</chapter> 346</section>
347
89<chapter> 348</chapter>
90<title>Courier-imap</title>
91<body>
92<pre caption="Install courier-imap" ># <i>emerge courier-imap</i>
93</pre>
94<pre caption="Courier-imap configuration" >
95 # <i>cd /etc/courier-imap</i>
96<codenote>If you want to use the ssl capabilities of courier-imap or pop3, </codenote>
97<codenote>you'll need to create certs for this purpose.</codenote>
98<codenote>This step is recommended. If you do not want to use ssl, skip this step.</codenote>
99
100 # <i>nano -w pop3d.cnf</i>
101 # <i>nano -w imapd.cnf</i>
102<codenote>Change the C, ST, L, CN, and email parameters to match your server.</codenote>
103
104 # <i>mkpop3dcert</i>
105 # <i>mkimapdcert</i>
106</pre>
107<pre caption="Start the courier services you need." >
108 # <i>/etc/init.d/courier-imapd start</i>
109 # <i>/etc/init.d/courier-imapd-ssl start</i>
110 # <i>/etc/init.d/courier-pop3d start</i>
111 # <i>/etc/init.d/courier-pop3d-ssl start</i>
112</pre>
113<p>Start up your favorite mail client and verify that all connections you've started work for receiving and sending mail. Now that the basics work, we're going to do a whole bunch of stuff at once to get the rest of the system running. Again, please verify that what we've installed already works before progressing.</p>
114</body>
115</chapter> 349<chapter>
116<chapter> 350<title>Adding SSL and SASL support to Postfix</title>
117<title>Cyrus-sasl</title> 351<section>
118<body> 352<body>
119<p>Next we're going to install cyrus-sasl. Sasl is going to play the role of actually passing your auth variables to pam, which will in turn pass that information to mysql for authentication of smtp users. For this howto, we'll not even try to verify that sasl is working until mysql is set up and contains a test user. Which is fine since we'll be authenticating against mysql in the end anyway.</p> 353
120<note>Now for some reason, sasl will not play nicely with pam against the shadow file. I banged my head against this problem for, well, a long time. If anyone knows why sasl will not auth against the shadow file in its current gentoo incarnation, please <mail link="ken@kickasskungfu.com" >email me</mail> as I'd love to hear a solution to this.</note> 354<p>
121<p>Just to get sasl installed is going to require a bit of hacking. Open up the ebuild file and change the configure flags to disable digest and cram. Here's why: mail clients will try to authenticate against the <e>first</e> method presented to it, usually cram-md5. Since we're not going to set that up, cram authentication will fail and most clients will not by default try another method. This is mostly due to the way mail clients are currently put together. So we're going to disable auth methods we're not using in order to not confuse the clients out there.</p> 355Now edit the postfix config's to make it aware of your new sasl and ssl
122<pre caption="Configuring and installing the cyrus-sasl ebuild" > 356capabilities. Add the following parameters to the end of the file where they
123 # <i>cd /usr/portage/dev-libs/cyrus-sasl</i> 357will be easy to find.
124 # <i>nano -w cyrus-sasl.$currentversion.ebuild</i>
125<codenote>Disable digest and cram as show below.</codenote>
126
127 econf \
128 --with-saslauthd=/var/lib/sasl2 \
129 --with-pwcheck=/var/lib/sasl2 \
130 --with-configdir=/etc/sasl2 \
131 --with-openssl \
132 --with-plugindir=/usr/lib/sasl2 \
133 --with-dbpath=/etc/sasl2/sasldb2 \
134 --with-des \
135 --with-rc4 \
136 --disable-krb4 \
137 --with-gnu-ld \
138 --enable-shared \
139 --disable-sample \
140 --enable-login \
141 --disable-cram \
142 --disable-digest \
143 ${myconf} || die &quot;bad ./configure&quot;
144
145 # <i>USE='-ldap -mysql' emerge cyrus-sasl</i>
146<codenote>We don't have ldap and we're not using sasl's mysql capabilities </codenote>
147<codenote>so we need to turn them off for this build.</codenote>
148</pre> 358</p>
149<p>Next, edit <path>/var/lib/sasl2/smtp.conf</path>.</p> 359
150<pre caption="Starting sasl" > 360<pre caption="/etc/postfix/main.cf">
151 # <i>nano -w /var/lib/sasl2/smtp.conf</i> 361# <i>nano -w /etc/postfix/main.cf</i>
152 pwcheck_method: saslauthd 362
363smtpd_sasl_auth_enable = yes
364smtpd_sasl2_auth_enable = yes
365smtpd_sasl_security_options = noanonymous
366broken_sasl_auth_clients = yes
367smtpd_sasl_local_domain =
368
369<comment>(The broken_sasl_auth_clients option and the login auth method
370are for outlook and outlook express only and are undocumented.
371Isn't having to hack software for stupid, broken, M$ BS great?
372smtpd_sasl_local_domain appends a domain name to clients using
373smtp-auth. Make sure it's blank or your user names will get
374mangled by postfix and be unable to auth.)</comment>
375
376smtpd_recipient_restrictions =
377 permit_sasl_authenticated,
378 permit_mynetworks,
379 reject_unauth_destination
153 380
154 # <i>/etc/init.d/saslauthd start</i>
155</pre>
156</body>
157</chapter>
158<chapter>
159<title>SSL Certs for Postfix and Apache</title>
160<body>
161<p>Next we're going to make a set of ssl certificates for postfix and apache.</p>
162<pre>
163 # <i>cd /usr/lib/ssl/</i>
164 # <i>nano -w openssl.cnf</i>
165<codenote>Change the following default values for your domain:</codenote>
166
167 countryName_default
168 stateOrProvinceName_default
169 localityName_default
170 0.organizationName_default
171 commonName_default
172 emailAddress_default.
173
174 <codenote>If the variables are not already present, just add them in a sensible place.</codenote>
175 381
176
177 # <i>cd misc</i>
178 # <i>nano -w CA.pl</i>
179<codenote>We need to add -nodes to the # create a certificate and</codenote>
180<codenote>#create a certificate request code in order to let our new ssl</codenote>
181<codenote>certs be loaded without a password. Otherwise when you</codenote>
182<codenote>reboot your ssl certs will not be available.</codenote>
183
184 # create a certificate
185 system (&quot;$REQ -new -nodes -x509 -keyout newreq.pem -out newreq.pem $DAYS&quot;);
186
187 # create a certificate request
188 system (&quot;$REQ -new -nodes -keyout newreq.pem -out newreq.pem $DAYS&quot;);
189
190 # <i>./CA.pl -newca</i>
191 # <i>./CA.pl -newreq</i>
192 # <i>./CA.pl -sign</i>
193 # <i>cp newcert.pem /etc/postfix</i>
194 # <i>cp newreq.pem /etc/postfix</i>
195 # <i>cp demoCA/cacert.pem /etc/postfix</i>
196<codenote>Now we do the same thing for apache</codenote>
197
198
199 # <i>openssl req -new > new.cert.csr</i>
200 # <i>openssl rsa -in privkey.pem -out new.cert.key</i>
201 # <i>openssl x509 -in new.cert.csr -out new.cert.cert -req -signkey new.cert.key -days 365</i>
202<codenote>Just leave the resulting certificates here for now.</codenote>
203<codenote>We'll install them after Apache is installed.</codenote>
204</pre>
205</body>
206</chapter>
207<chapter>
208<title>Adding SSL and SASL support to Postfix</title>
209<body>
210<p>Now edit the postfix config's to make it aware of your new sasl and ssl capabilities. Add the following parameters to the end of the file where they will be easy to find.</p>
211<pre caption="/etc/postfix/main.cf" >
212 # <i>nano -w /etc/postfix/main.cf</i>
213
214 smtpd_sasl_auth_enable = yes
215 smtpd_sasl2_auth_enable = yes
216 smtpd_sasl_security_options = noanonymous
217 broken_sasl_auth_clients = yes
218 smtpd_sasl_local_domain =
219
220 <codenote>The broken_sasl_auth_clients option and the login auth method </codenote>
221<codenote>are for outlook and outlook express only and are undocumented.</codenote>
222<codenote>Isn't having to hack software for stupid, broken, M$ BS great?</codenote>
223<codenote>smtpd_sasl_local_domain appends a domain name to clients using</codenote>
224<codenote>smtp-auth. Make sure it's blank or your user names will get</codenote>
225<codenote>mangled by postfix and be unable to auth.</codenote>
226
227 smtpd_recipient_restrictions =
228 permit_sasl_authenticated,
229 permit_mynetworks,
230 reject_unath_destination
231
232
233 smtpd_use_tls = yes 382smtpd_use_tls = yes
234 #smtpd_tls_auth_only = yes 383#smtpd_tls_auth_only = yes
235 smtpd_tls_key_file = /etc/postfix/newreq.pem 384smtpd_tls_key_file = /etc/postfix/newreq.pem
236 smtpd_tls_cert_file = /etc/postfix/newcert.pem 385smtpd_tls_cert_file = /etc/postfix/newcert.pem
237 smtpd_tls_CAfile = /etc/postfix/cacert.pem 386smtpd_tls_CAfile = /etc/postfix/cacert.pem
238 smtpd_tls_loglevel = 3 387smtpd_tls_loglevel = 3
239 smtpd_tls_received_header = yes 388smtpd_tls_received_header = yes
240 smtpd_tls_session_cache_timeout = 3600s 389smtpd_tls_session_cache_timeout = 3600s
241 tls_random_source = dev:/dev/urandom 390tls_random_source = dev:/dev/urandom
242 391
243 <codenote>smtpd_tls_auth_only is commented out to ease testing the system. </codenote> 392<comment>(smtpd_tls_auth_only is commented out to ease testing the system.
244<codenote>You can turn this on later if you desire.</codenote> 393You can turn this on later if you desire.)</comment>
245 394
246 # <i>postfix reload</i> 395# <i>postfix reload</i>
247</pre> 396</pre>
397
398<p>
248<p>Now we're going to verify that the config's we added were picked up by postfix.</p> 399Now we're going to verify that the config's we added were picked up by postfix.
400</p>
401
249<pre caption="Verifying sasl and tls support" > 402<pre caption="Verifying sasl and tls support">
250 # <i>telnet localhost 25</i> 403# <i>telnet localhost 25</i>
251 404
252 Trying 127.0.0.1... 405Trying 127.0.0.1...
253 Connected to localhost. 406Connected to localhost.
254 Escape character is '^]'. 407Escape character is '^]'.
255 220 mail.domain.com ESMTP Postfix 408220 mail.domain.com ESMTP Postfix
256 <i>EHLO domain.com</i> 409<i>EHLO domain.com</i>
257 250-mail.domain.com 410250-mail.domain.com
258 250-PIPELINING 411250-PIPELINING
259 250-SIZE 10240000 412250-SIZE 10240000
260 250-VRFY 413250-VRFY
261 250-ETRN 414250-ETRN
262 250-STARTTLS 415250-STARTTLS
263 250-AUTH LOGIN PLAIN OTP 416250-AUTH LOGIN PLAIN
264 250-AUTH=LOGIN PLAIN OTP 417250-AUTH=LOGIN PLAIN
265 250-XVERP 418250-XVERP
266 250 8BITMIME 419250 8BITMIME
267 <i>^]</i> 420<i>^]</i>
268 telnet> <i>quit</i> 421telnet> <i>quit</i>
422</pre>
423
424<p>
425Verify that the above AUTH and STARTTLS lines now appear in your postfix
426install. As I said before, as it stands now AUTH will not work. that's because
427sasl will try to auth against it's sasldb, instead of the shadow file for some
428unknown reason, which we have not set up. So we're going to just plow through
429and set up mysql to hold all of our auth and virtual domain information.
269</pre> 430</p>
270<p>Verify that the above AUTH and STARTTLS lines now appear in your postfix install. As I said before, as it stands now AUTH will not work. that's because sasl will try to auth against it's sasldb, instead of the shadow file for some unknown reason, which we have not set up. So we're going to just plow through and set up mysql to hold all of our auth and virtual domain information. 431
271 </p>
272</body> 432</body>
433</section>
273</chapter> 434</chapter>
435
274<chapter> 436<chapter>
275<title>MySQL</title> 437<title>MySQL</title>
438<section>
276<body> 439<body>
277<p>Next we're going to install and configure MySQL. You'll need the <uri link="http://kickasskungfu.com/~ken/genericmailsql.sql" >genericmailsql.sql</uri> dumpfile for this step.</p> 440
441<p>
442Next we're going to install and configure MySQL. You'll need the <uri
443link="http://www.gentoo.org/doc/en/files/genericmailsql.sql">genericmailsql.sql</uri>
444dumpfile for this step.
445</p>
446
278<pre caption="Installing and configuring MySQL" > 447<pre caption="Installing and configuring MySQL">
279 # <i>emerge mysql</i> 448# <i>emerge mysql</i>
280 449
281 # <i>/usr/sbin/mysql_install_db</i> 450# <i>/usr/bin/mysql_install_db</i>
282<codenote>After this command runs follow the onscreen directions</codenote> 451<comment>(After this command runs follow the onscreen directions
283<codenote>for adding a root password with mysql,</codenote> 452for adding a root password with mysql,
284<codenote>not mysqladmin, otherwise your db will be wide open.</codenote> 453not mysqladmin, otherwise your db will be wide open.)</comment>
285 454
286 # <i>/etc/init.d/mysql start</i> 455# <i>/etc/init.d/mysql start</i>
287 # <i>mysqladmin -u root -p create mailsql</i> 456# <i>mysqladmin -u root -p create mailsql</i>
288 # <i>mysql -u root -p --opt mailsql &lt; genericmailsql.sql</i> 457# <i>mysql -u root -p mailsql &lt; genericmailsql.sql</i>
289 458
290 # <i>mysql -u root -p mysql</i> 459# <i>mysql -u root -p mysql</i>
291 mysql> <i>GRANT SELECT,INSERT,UPDATE,DELETE</i> 460mysql> <i>GRANT SELECT,INSERT,UPDATE,DELETE</i>
292 -> <i>ON mailsql.*</i> 461 -> <i>ON mailsql.*</i>
293 -> <i>TO mailsql@localhost</i> 462 -> <i>TO mailsql@localhost</i>
294 -> <i>IDENTIFIED BY '$password';</i> 463 -> <i>IDENTIFIED BY '$password';</i>
464Query OK, 0 rows affected (0.02 sec)
295 465
296 -> <i>quit</i> 466mysql> <i>FLUSH PRIVILEGES;</i>
467Query OK, 0 rows affected (0.00 sec)
468
469mysql> <i>quit</i>
297<codenote>Verify that the new mailsql user can connect to the mysql server.</codenote> 470<comment>(Verify that the new mailsql user can connect to the mysql server.)</comment>
298 471
299 # <i>mysql -u mailsql -p mailsql</i> 472# <i>mysql -u mailsql -p mailsql</i>
300</pre> 473</pre>
474
475<p>
301<p>Your new database has default values and tables set up for two domains. The following tables are included: 476Your new database has default values and tables set up for two domains. The
477following tables are included:
478</p>
479
302 <ul> 480<ul>
303<li>alias - local email alias and mailman alias information.</li> 481 <li>alias - local email alias and mailman alias information.</li>
304<li>relocated - relocated user email address maps</li> 482 <li>relocated - relocated user email address maps</li>
483 <li>
305<li>transport - default mail transport information for all domains you are hosting</li> 484 transport - default mail transport information for all domains you are
485 hosting
486 </li>
306<li>users - all user account information</li> 487 <li>users - all user account information</li>
307<li>virtual - virtual domain email alias maps</li> 488 <li>virtual - virtual domain email alias maps</li>
308</ul> 489</ul>
309</p> 490
310<pre caption="alias table sample" > 491<pre caption="alias table sample">
311 id alias destination 492id alias destination
312 1 root foo@bar.com 4931 root foo@bar.com
313 2 postmaster foo@bar.com 4942 postmaster foo@bar.com
314 </pre> 495</pre>
496
315<pre caption="user table sample" > 497<pre caption="user table sample">
316 id email clear name uid gid homedir maildir quota postfix 498<comment>(Line wrapped for clarity.)</comment>
317 10 foo@virt-bar.org $password realname virtid virtid /home/vmail /home/vmail/virt-bar.org/foo/.maildir/ y 499id email clear name uid gid homedir \
318 13 foo@bar.com $password realname localid localid /home/foo /home/foo/.maildir/ y 500 maildir quota postfix
50110 foo@virt-bar.org $password realname virtid virtid /home/vmail \
502 /home/vmail/virt-bar.org/foo/.maildir/ y
50313 foo@bar.com $password realname localid localid /home/foo \
504 /home/foo/.maildir/ y
319 </pre> 505</pre>
506
507<p>
508The values of the <c>virtid</c> uid and gid should be those of the <c>vmail</c>
509user and group.
510</p>
511
320<pre caption="transport table sample" > 512<pre caption="transport table sample">
321 id domain destination 513id domain destination
322 1 bar.com local: 5141 bar.com local:
323 2 virt-bar.org virtual: 5152 virt-bar.org virtual:
324 </pre> 516</pre>
517
325<pre caption="virtual table sample" > 518<pre caption="virtual table sample">
326 id email destination 519id email destination
327 3 root@virt-bar.org other@email.address 5203 root@virt-bar.org other@email.address
328 </pre> 521</pre>
522
329</body> 523</body>
524</section>
330</chapter> 525</chapter>
526
331<chapter> 527<chapter>
332<title>Apache and phpMyAdmin</title> 528<title>Apache and phpMyAdmin</title>
529<section>
333<body> 530<body>
531
532<p>
334<p>Next we'll set up apache and add an interface to interact with the database more easily. </p> 533Next we'll set up apache and add an interface to interact with the database
534more easily.
535</p>
536
335<pre caption="Setting up apache and phpmyadmin" > 537<pre caption="Setting up apache and phpmyadmin">
336 # <i>emerge apache mod_php mod_ssl phpmyadmin</i> 538# <i>emerge apache mod_php phpmyadmin</i>
539</pre>
540
541<p>
542There are plenty of guides out there about how to set up apache with php. Like
543this one: <uri>http://www.linuxguruz.org/z.php?id=31</uri>. There are also
544numerous posts on <uri>http://forums.gentoo.org</uri> detailing how to solve
545problems with the installation (search for 'apache php'). So, that said, I'm
546not going to cover it here. Set up the apache and php installs, then continue
547with this howto. Now, a word for the wise: .htaccess the directory that you put
548phpmyadmin in. If you do not do this, search engine spiders will come along and
549index the page which in turn will mean that anyone will be able to find your
550phpmyadmin page via google and in turn be able to come change your database
551however they want which is <e>BAD!</e> There are many howtos on this
552including: <uri>http://www.csoft.net/docs/micro/htaccess.html.en</uri>.
337</pre> 553</p>
338<p>There are plenty of guides out there about how to set up apache with php. Like this one: <uri>http://www.linuxguruz.org/z.php?id=31</uri>. There are also numerous posts on <uri>http://forums.gentoo.org</uri> detailing how to solve problems with the installation (search for 'apache php'). So, that said, I'm not going to cover it here. Set up the apache and php installs, then continue with this howto. Now, a word for the wise: .htaccess the directory that you put phpmyadmin in. If you do not do this, search engine spiders will come along and index the page which in turn will mean that anyone will be able to find your phpmyadmin page via google and in turn be able to come change your database however they want which is <e>BAD!</e> There are many howtos on this including: <uri>http://docs.csoft.net/micro/black-htaccess.html</uri>.</p> 554
339<p>Now we're going to install the Apache certificates we made previously. The Apache-SSL directives that you need to use the resulting cert are: 555<p>
556Now we're going to install the Apache certificates we made previously. The
557Apache-SSL directives that you need to use the resulting cert are:
558</p>
559
340 <ul> 560<ul>
341<li>SSLCertificateFile /path/to/certs/new.cert.cert</li> 561 <li>SSLCertificateFile /path/to/certs/new.cert.cert</li>
342<li>SSLCertificateKeyFile /path/to/certs/new.cert.key</li> 562 <li>SSLCertificateKeyFile /path/to/certs/new.cert.key</li>
343</ul> 563</ul>
344</p> 564
345<pre caption="Install Apache SSL certificates" > 565<pre caption="Install Apache SSL certificates">
346 # <i>cp /usr/lib/ssl/misc/new.cert.cert /etc/apache/conf/ssl/</i> 566# <i>cp /etc/ssl/misc/new.cert.cert /etc/apache/conf/ssl/</i>
347 # <i>cp /usr/lib/ssl/misc/new.cert.key /etc/apache/conf/ssl/</i> 567# <i>cp /etc/ssl/misc/new.cert.key /etc/apache/conf/ssl/</i>
348 # <i>nano -w /etc/apache/conf/vhosts/ssl.default-vhost.conf</i> 568# <i>nano -w /etc/apache/conf/vhosts/ssl.default-vhost.conf</i>
569
349<codenote>Change the following parameters</codenote> 570<comment>(Change the following parameters)</comment>
350 571
351 ServerName host.domain.name 572ServerName host.domain.name
352 ServerAdmin your@email.address 573ServerAdmin your@email.address
353 SSLCertificateFile /etc/apache/conf/ssl/new.cert.cert 574SSLCertificateFile /etc/apache/conf/ssl/new.cert.cert
354 SSLCertificateKeyFile /etc/apache/conf/ssl/new.cert.key 575SSLCertificateKeyFile /etc/apache/conf/ssl/new.cert.key
355 576
356 # <i>/etc/init.d/apache restart</i> 577# <i>/etc/init.d/apache restart</i>
357</pre> 578</pre>
358<note>If you have an existing apache install, you'll likely have to perform a full server reboot to install your new certificates. Check your logs to verify apache restarted successfully.</note> 579
580<note>
581If you have an existing apache install, you'll likely have to perform a full
582server reboot to install your new certificates. Check your logs to verify
583apache restarted successfully.
584</note>
585
586<p>
359<p>Next, configure phpMyAdmin.</p> 587Next, configure phpMyAdmin.
588</p>
589
360<pre caption="Configuring phpMyAdmin" > 590<pre caption="Configuring phpMyAdmin">
361 # <i>nano -w /home/httpd/htdocs/phpmyadmin/config.inc.php</i> 591# <i>nano -w /var/www/localhost/htdocs/phpmyadmin/config.inc.php</i>
362<codenote>Change the following parameters</codenote> 592<comment>(Change the following parameters.)</comment>
363 593
364 $cfg['Servers'][$i]['host'] = 'localhost'; // MySQL hostname 594$cfg['Servers'][$i]['host'] = 'localhost'; // MySQL hostname
365 $cfg['Servers'][$i]['controluser'] = 'mailsql'; // MySQL control user settings 595$cfg['Servers'][$i]['controluser'] = 'mailsql'; // MySQL control user settings
366 // (this user must have read-only 596 // (this user must have read-only
367 $cfg['Servers'][$i]['controlpass'] = '$password'; // access to the &quot;mysql/user&quot; 597$cfg['Servers'][$i]['controlpass'] = '$password'; // access to the "mysql/user"
368 // and &quot;mysql/db&quot; tables) 598 // and "mysql/db" tables)
369 $cfg['Servers'][$i]['user'] = 'mailsql'; // MySQL user 599$cfg['Servers'][$i]['user'] = 'mailsql'; // MySQL user
370 $cfg['Servers'][$i]['password'] = '$password'; // MySQL password 600$cfg['Servers'][$i]['password'] = '$password'; // MySQL password
371 </pre> 601</pre>
372<p>Now enter the phpmyadmin page and browse the tables. You'll want to add in your local aliases, edit your user table to add a test user, and change your transport table to add information about your domains. The default values supplied with the dumpfile should be a sufficient guide to what values need to go where. Make sure that if you put information in the database that it is accurate. For instance, make sure the local users home dir exists and that the correct uid/gid values are in place. The maildirs should be created automatically by postfix when the user receives their first email. So, in general, it's a good idea to send a &quot;Welcome&quot; mail to a new user after you setup their account to make sure the .maildir gets created. </p> 602
603<p>
604Now enter the phpmyadmin page and browse the tables. You'll want to add in your
605local aliases, edit your user table to add a test user, and change your
606transport table to add information about your domains. The default values
607supplied with the dumpfile should be a sufficient guide to what values need to
608go where. Make sure that if you put information in the database that it is
609accurate. For instance, make sure the local users home dir exists and that the
610correct uid/gid values are in place. The maildirs should be created
611automatically by postfix when the user receives their first email. So, in
612general, it's a good idea to send a "Welcome" mail to a new user
613after you setup their account to make sure the .maildir gets created.
614</p>
615
373</body> 616</body>
617</section>
374</chapter> 618</chapter>
619
375<chapter> 620<chapter>
376<title>The vmail user</title> 621<title>The vmail user</title>
622<section>
377<body> 623<body>
378<p>At this point you may be wondering what user and directory to use for virtual mail users, and rightly so. Let's set that up.</p> 624
625<p>
626At this point you may be wondering what user and directory to use for virtual
627mail users, and rightly so. Let's set that up.
628</p>
629
379<pre caption="Adding the vmail user" > 630<pre caption="Adding the vmail user">
380 # <i>adduser -d /home/vmail -s /bin/false vmail</i> 631# <i>adduser -d /home/vmail -s /bin/false vmail</i>
381 # <i>uid=`cat /etc/passwd | grep vmail | cut -f 3 -d :`</i> 632# <i>uid=`cat /etc/passwd | grep vmail | cut -f 3 -d :`</i>
382 # <i>groupadd -g $uid vmail</i> 633# <i>groupadd -g $uid vmail</i>
383 # <i>mkdir /home/vmail</i> 634# <i>mkdir /home/vmail</i>
384 # <i>chown vmail. /home/vmail</i> 635# <i>chown vmail: /home/vmail</i>
636</pre>
637
638<p>
639So now when you're setting up vmail accounts, use the vmail uid, gid, and
640homedir. When you're setting up local accounts, use that users uid, gid, and
641homedir. We've been meaning to create a php admin page for this setup but
642haven't gotten around to it yet, as phpmyadmin generally works fine for us.
385</pre> 643</p>
386<p>So now when you're setting up vmail accounts, use the vmail uid, gid, and homedir. When you're setting up local accounts, use that users uid, gid, and homedir. We've been meaning to create a php admin page for this setup but haven't gotten around to it yet, as phpmyadmin generally works fine for us.</p> 644
387</body> 645</body>
646</section>
388</chapter> 647</chapter>
648
389<chapter> 649<chapter>
390<title>Configuring MySQL Authentication and vhosts</title> 650<title>Configuring MySQL Authentication and vhosts</title>
651<section>
391<body> 652<body>
392<p>Next we'll reconfigure our authentication to use the mailsql database in courier-imap and postfix. In all of the following examples, replace $password with the password you set for the mailsql mysql user.</p> 653
393<pre> 654<p>
394 # <i>emerge /usr/portage/sys-libs/pam_mysql/pam_mysql-$currentversion.ebuild</i> 655Next we'll reconfigure our authentication to use the mailsql database in
395<codenote>This package is currently masked so you'll have to give it an explicit path </codenote> 656courier-imap and postfix. In all of the following examples, replace
396<codenote>or unmask the package. This is subject to change when the package is unmasked</codenote> 657<c>$password</c> with the password you set for the mailsql mysql user.
397<codenote>in the portage tree.</codenote>
398
399 # <i>nano -w /etc/pam.d/imap</i>
400<codenote>Comment out the existing auth lines and add the following as shown.</codenote>
401
402 #auth required pam_nologin.so
403 #auth required pam_stack.so service=system-auth
404 #account required pam_stack.so service=system-auth
405 #session required pam_stack.so service=system-auth
406
407 auth optional pam_mysql.so server=localhost db=mailsql user=mailsql \
408 passwd=$password table=users usercolumn=email passwdcolumn=clear crypt=0
409 account required pam_mysql.so server=localhost db=mailsql user=mailsql \
410 passwd=$password table=users usercolumn=email passwdcolumn=clear crypt=0
411
412 # <i>nano -w /etc/pam.d/pop3</i>
413 # <i>nano -w /etc/pam.d/smtp</i>
414<codenote>Make the same changes to the pop3 and smtp files</codenote>
415</pre> 658</p>
416<p>Next, we need to edit courier's authentication config's.</p> 659
417<pre> 660<pre caption="Configuring authentication">
418 # <i>nano -w /etc/courier-imap/authdaemonrc</i> 661# <i>nano -w /etc/courier/authlib/authdaemonrc</i>
419 authmodulelist=&quot;authmysql authpam&quot; 662authmodulelist="authmysql authpam"
420 663
421 # <i>nano -w /etc/courier-imap/authdaemond.conf</i>
422 AUTHDAEMOND=&quot;authdaemond.mysql&quot;
423
424 # <i>nano -w /etc/courier-imap/authmysqlrc</i> 664# <i>nano -w /etc/courier/authlib/authmysqlrc</i>
425 MYSQL_SERVER localhost 665MYSQL_SERVER localhost
426 MYSQL_USERNAME mailsql 666MYSQL_USERNAME mailsql
427 MYSQL_PASSWORD $password 667MYSQL_PASSWORD $password
428 MYSQL_DATABASE mailsql 668MYSQL_DATABASE mailsql
429 MYSQL_USER_TABLE users 669MYSQL_USER_TABLE users
430 #MYSQL_CRYPT_PWFIELD crypt (make sure this is commented out since we're storing plaintext) 670<comment>(Make sure the following line is commented out since we're storing plaintext.)</comment>
671#MYSQL_CRYPT_PWFIELD crypt
431 MYSQL_CLEAR_PWFIELD clear 672MYSQL_CLEAR_PWFIELD clear
432 MYSQL_UID_FIELD uid 673MYSQL_UID_FIELD uid
433 MYSQL_GID_FIELD gid 674MYSQL_GID_FIELD gid
434 MYSQL_LOGIN_FIELD email 675MYSQL_LOGIN_FIELD email
435 MYSQL_HOME_FIELD homedir 676MYSQL_HOME_FIELD homedir
436 MYSQL_NAME_FIELD name 677MYSQL_NAME_FIELD name
437 MYSQL_MAILDIR_FIELD maildir 678MYSQL_MAILDIR_FIELD maildir
438 679
439 # <i>/etc/init.d/authdaemond restart</i> 680# <i>/etc/init.d/courier-authlib restart</i>
440 # <i>/etc/init.d/saslauthd restart</i> 681# <i>/etc/init.d/saslauthd restart</i>
682</pre>
683
684<p>
685We're almost there I promise! Next, set up the rest of the necessary config's
686for postfix to interract with the database for all it's other transport needs.
441</pre> 687</p>
442<p>We're almost there I promise! Next, set up the rest of the necessary config's for postfix to interract with the database for all it's other transport needs.</p> 688
443<pre caption="/etc/postfix/mysql-aliases.cf" > 689<pre caption="/etc/postfix/mysql-aliases.cf">
444 # <i>nano -w /etc/postfix/mysql-aliases.cf</i> 690# <i>nano -w /etc/postfix/mysql-aliases.cf</i>
445 # mysql-aliases.cf 691# mysql-aliases.cf
446 692
447 user = mailsql 693user = mailsql
448 password = $password 694password = $password
449 dbname = mailsql 695dbname = mailsql
450 table = alias 696table = alias
451 select_field = destination 697select_field = destination
452 where_field = alias 698where_field = alias
453 hosts = unix:/var/run/mysqld/mysqld.sock 699hosts = unix:/var/run/mysqld/mysqld.sock
454 </pre> 700</pre>
701
455<pre caption="/etc/postfix/mysql-relocated.cf" > 702<pre caption="/etc/postfix/mysql-relocated.cf">
456 # <i>nano -w /etc/postfix/mysql-relocated.cf</i> 703# <i>nano -w /etc/postfix/mysql-relocated.cf</i>
457 # mysql-relocated.cf 704# mysql-relocated.cf
458 705
459 user = mailsql 706user = mailsql
460 password = $password 707password = $password
461 dbname = mailsql 708dbname = mailsql
462 table = relocated 709table = relocated
463 select_field = destination 710select_field = destination
464 where_field = email 711where_field = email
465 hosts = unix:/var/run/mysqld/mysqld.sock 712hosts = unix:/var/run/mysqld/mysqld.sock
466 </pre> 713</pre>
714
467<pre caption="/etc/postfix/mysql-transport.cf (optional)" > 715<pre caption="/etc/postfix/mysql-transport.cf (optional)">
468 # <i>nano -w /etc/postfix/mysql-transport.cf</i> 716# <i>nano -w /etc/postfix/mysql-transport.cf</i>
469 # mysql-transport.cf 717# mysql-transport.cf
470 718
471 user = mailsql 719user = mailsql
472 password = $password 720password = $password
473 dbname = mailsql 721dbname = mailsql
474 table = transport 722table = transport
475 select_field = destination 723select_field = destination
476 where_field = domain 724where_field = domain
477 hosts = unix:/var/run/mysqld/mysqld.sock 725hosts = unix:/var/run/mysqld/mysqld.sock
478 </pre> 726</pre>
727
479<pre caption="/etc/postfix/mysql-virtual-gid.cf (optional)" > 728<pre caption="/etc/postfix/mysql-virtual-gid.cf (optional)">
480 # <i>nano -w /etc/postfix/mysql-virtual-gid.cf</i> 729# <i>nano -w /etc/postfix/mysql-virtual-gid.cf</i>
481 #myql-virtual-gid.cf 730#myql-virtual-gid.cf
482 731
483 user = mailsql 732user = mailsql
484 password = $password 733password = $password
485 dbname = mailsql 734dbname = mailsql
486 table = users 735table = users
487 select_field = gid 736select_field = gid
488 where_field = email 737where_field = email
489 additional_conditions = and postfix = 'y' 738additional_conditions = and postfix = 'y'
490 hosts = unix:/var/run/mysqld/mysqld.sock 739hosts = unix:/var/run/mysqld/mysqld.sock
491 </pre> 740</pre>
741
492<pre caption="/etc/postfix/mysql-virtual-maps.cf" > 742<pre caption="/etc/postfix/mysql-virtual-maps.cf">
493 # <i>nano -w /etc/postfix/mysql-virtual-maps.cf</i> 743# <i>nano -w /etc/postfix/mysql-virtual-maps.cf</i>
494 #myql-virtual-maps.cf 744#myql-virtual-maps.cf
495 745
496 user = mailsql 746user = mailsql
497 password = $password 747password = $password
498 dbname = mailsql 748dbname = mailsql
499 table = users 749table = users
500 select_field = maildir 750select_field = maildir
501 where_field = email 751where_field = email
502 additional_conditions = and postfix = 'y' 752additional_conditions = and postfix = 'y'
503 hosts = unix:/var/run/mysqld/mysqld.sock 753hosts = unix:/var/run/mysqld/mysqld.sock
504 </pre> 754</pre>
755
505<pre caption="/etc/postfix/mysql-virtual-uid.cf (optional)" > 756<pre caption="/etc/postfix/mysql-virtual-uid.cf (optional)">
506 # <i>nano -w /etc/postfix/mysql-virtual-uid.cf</i> 757# <i>nano -w /etc/postfix/mysql-virtual-uid.cf</i>
507 # mysql-virtual-uid.cf 758# mysql-virtual-uid.cf
508 759
509 user = mailsql 760user = mailsql
510 password = $password 761password = $password
511 dbname = mailsql 762dbname = mailsql
512 table = users 763table = users
513 select_field = uid 764select_field = uid
514 where_field = email 765where_field = email
515 additional_conditions = and postfix = 'y' 766additional_conditions = and postfix = 'y'
516 hosts = unix:/var/run/mysqld/mysqld.sock 767hosts = unix:/var/run/mysqld/mysqld.sock
517 </pre> 768</pre>
769
518<pre caption="/etc/postfix/mysql-virtual.cf" > 770<pre caption="/etc/postfix/mysql-virtual.cf">
519 # <i>nano -w /etc/postfix/mysql-virtual.cf</i> 771# <i>nano -w /etc/postfix/mysql-virtual.cf</i>
520 # mysql-virtual.cf 772# mysql-virtual.cf
521 773
522 user = mailsql 774user = mailsql
523 password = $password 775password = $password
524 dbname = mailsql 776dbname = mailsql
525 table = virtual 777table = virtual
526 select_field = destination 778select_field = destination
527 where_field = email 779where_field = email
528 hosts = unix:/var/run/mysqld/mysqld.sock 780hosts = unix:/var/run/mysqld/mysqld.sock
529 </pre> 781</pre>
782
783<p>
530<p>Lastly, edit <path>/etc/postfix/main.cf</path> one more time.</p> 784Lastly, edit <path>/etc/postfix/main.cf</path> one more time.
785</p>
786
531<pre caption="/etc/postfix/main.cf" > 787<pre caption="/etc/postfix/main.cf">
532 # <i>nano -w /etc/postfix/main.cf</i> 788# <i>nano -w /etc/postfix/main.cf</i>
533 alias_maps = mysql:/etc/postfix/mysql-aliases.cf 789alias_maps = mysql:/etc/postfix/mysql-aliases.cf
534 relocated_maps = mysql:/etc/postfix/mysql-relocated.cf 790relocated_maps = mysql:/etc/postfix/mysql-relocated.cf
535 791
536 local_transport = local 792local_transport = local
537 local_recipient_maps = $alias_maps $virtual_mailbox_maps unix:passwd.byname 793local_recipient_maps = $alias_maps $virtual_mailbox_maps unix:passwd.byname
538 794
539 virtual_transport = virtual 795virtual_transport = virtual
540 virtual_mailbox_domains = 796virtual_mailbox_domains =
541 virt-bar.com, 797 virt-bar.com,
542 $other-virtual-domain.com 798 $other-virtual-domain.com
543 799
544 virtual_minimum_uid = 1000 800virtual_minimum_uid = 1000
545 virtual_gid_maps = static: $vmail-gid 801virtual_gid_maps = static:$vmail-gid
546 virtual_mailbox_maps = mysql:/etc/postfix/mysql-virtual-maps.cf 802virtual_mailbox_maps = mysql:/etc/postfix/mysql-virtual-maps.cf
547 virtual_alias_maps = mysql:/etc/postfix/mysql-virtual.cf 803virtual_alias_maps = mysql:/etc/postfix/mysql-virtual.cf
548 virtual_uid_maps = static: $vmail-uid 804virtual_uid_maps = static:$vmail-uid
549 virtual_mailbox_base = / 805virtual_mailbox_base = /
550 #virtual_mailbox_limit = 806#virtual_mailbox_limit =
551 </pre> 807</pre>
552<p>As of Postfix 2.0.x, there were a number of significant changes over the 1.1.x release. Notably the transport, virtual-gid, and virtual-uid tables are no longer necessary. The tables are still included if you wish to use them.</p> 808
809<p>
810For security reasons you should change the permissions of the various
811<path>/etc/mail/mysql-*.cf</path>:
812</p>
813
814<pre caption="Changing file permission">
815# <i>chmod 640 /etc/postfix/mysql-*.cf</i>
816# <i>chgrp postfix /etc/postfix/mysql-*.cf</i>
817</pre>
818
819<p>
820As of Postfix 2.0.x, there were a number of significant changes over the 1.1.x
821release. Notably the transport, virtual-gid, and virtual-uid tables are no
822longer necessary. The tables are still included if you wish to use them.
823</p>
824
825<note>
553<note>It is recommended tha you read VIRTUAL_README included with the postfix doc's for more information.</note> 826It is recommended that you read VIRTUAL_README included with the postfix docs
827for more information.
828</note>
829
830<pre caption="Make postfix reload its tables">
554<pre># <i>postfix reload</i> 831# <i>postfix reload</i>
832</pre>
833
834<p>
835Now, if all went well, you should have a functioning mailhost. Users should be
836able to authenticate against the sql database, using their full email address,
837for pop3, imap, and smtp. I would highly suggest that you verify that
838everything is working at this point. If you run into problems (with as many
839things as this setup has going on, it's likely that you will) check the
840troubleshooting section of this howto.
555</pre> 841</p>
556<p>Now, if all went well, you should have a functioning mailhost. Users should be able to authenticate against the sql database, using their full email address, for pop3, imap, and smtp. I would highly suggest that you verify that everything is working at this point. If you run into problems (with as many things as this setup has going on, it's likely that you will) check the troubleshooting section of this howto.</p> 842
557</body> 843</body>
844</section>
558</chapter> 845</chapter>
846
559<chapter> 847<chapter>
560<title>Squirrelmail</title> 848<title>Squirrelmail</title>
849<section>
561<body> 850<body>
562<pre> 851
852<pre caption="Install squirrelmail">
563 # <i>emerge squirrelmail</i> 853# <i>emerge squirrelmail</i>
564<codenote>I like to add a link to the htdocs space for a shorter url.</codenote> 854<comment>(Install squirrelmail to localhost so that it's accessed by http://localhost/mail)
855(Substitute 1.4.3a-r2 with the version you use)</comment>
565 856
566 # <i>ln -s /home/httpd/htdocs/squirrelmail/ /home/httpd/htdocs/mail</i> 857# <i>webapp-config -I -h localhost -d /mail squirrelmail 1.4.3a-r2</i>
567 # <i>cd /home/httpd/htdocs/mail/conf</i> 858# <i>cd /var/www/localhost/htdocs/mail/config</i>
568 # <i>./conf.pl</i> 859# <i>perl ./conf.pl</i>
569<codenote>Change your Organization, Server, and Folder settings for squirrelmail.</codenote> 860<comment>(Change your Organization, Server, and Folder settings for squirrelmail.
570<codenote>Now you should be able to login to squirrelmail, again - with your full email address,</codenote> 861Now you should be able to login to squirrelmail, again - with your full email address,
571<codenote>and use your new webmail setup.</codenote> 862and use your new webmail setup.)</comment>
572</pre> 863</pre>
864
573</body> 865</body>
866</section>
574</chapter> 867</chapter>
868
575<chapter> 869<chapter>
576<title>Mailman</title> 870<title>Mailman</title>
871<section>
577<body> 872<body>
578<p>Last step: mailman. The new version of mailman has very nice virtual domain support, which is why I use it, not to mention it's really a great package. To get this package installed and working correclty for virtual domains is going to require a bit of hacking. I really reccommend reading all of the mailman documentation, including README.POSTFIX.gz, to understand what's being done here.</p> 873
874<p>
875Last step: mailman. The new version of mailman has very nice virtual domain
876support, which is why I use it, not to mention it's really a great package. To
877get this package installed and working correctly for virtual domains is going
878to require a bit of hacking. I really recommend reading all of the mailman
879documentation, including README.POSTFIX.gz, to understand what's being done
880here.
881</p>
882
883<p>
884One further note, current versions of mailman install to /usr/local/mailman. If
885you're like me and wish to change the default install location, it can be
886overridden in the ebuild filoe by changing the INSTALLDIR variable.
887</p>
888
579<pre caption="/usr/portage/net-mail/mailman/mailman-$ver.ebuild"> 889<pre caption="/usr/portage/net-mail/mailman/mailman-$ver.ebuild">
580 # <i>nano -w /usr/portage/net-mail/mailman/mailman-$ver.ebuild</i> 890# <i>nano -w /usr/portage/net-mail/mailman/mailman-$ver.ebuild</i>
581 MAILGID="280" 891MAILGID="280"
582 <codenote>Set MAILGID to the mailman group instead of nobody</codenote> 892<comment>(Set MAILGID to the mailman group instead of nobody
583 <codenote>This is needed for postfix integration</codenote> 893This is needed for postfix integration.)</comment>
584</pre>
585<pre> 894</pre>
895
896<pre caption="Install mailman">
586 # <i>emerge mailman</i> 897# <i>emerge mailman</i>
587<codenote>This package is currently masked as well, so you'll need to unmask it or give </codenote> 898<comment>(This package is currently masked as well, so you'll need to unmask it or give
588<codenote>emerge an explicit path to the ebuild. Once it's installed, follow the directions</codenote> 899emerge an explicit path to the ebuild. Once it's installed, follow the directions
589<codenote>in the README.gentoo.gz</codenote> 900in the README.gentoo.gz *except* do not add your aliases to /etc/mail/aliases.
901We will instead be linking the entire alias db into postfix.)</comment>
590 902
591 # <i>nano -w /usr/share/doc/mailman-$ver/README.gentoo.gz</i> 903# <i>zless /usr/share/doc/mailman-$ver/README.gentoo.gz</i>
592</pre> 904</pre>
905
906<pre caption="Setting defaults: Mailman/Defaults.py">
907# <i> nano -w /var/mailman/Mailman/Defaults.py</i>
908<comment>(Change the values below to reflect your primary domain, virtuals will be set next.)</comment>
909DEFAULT_EMAIL_HOST = 'domain.com'
910DEFAULT_URL_HOST = 'www.domain.com'
911</pre>
912
593<pre caption="mailman config: mm_cfg.py"> 913<pre caption="mailman config: mm_cfg.py">
594 # <i>nano -w /var/mailman/Mailman/mm_cfg.py</i> 914# <i>nano -w /var/mailman/Mailman/mm_cfg.py</i>
595 MTA = "Postfix" 915MTA = "Postfix"
596 POSTFIX_STYLE_VIRTUAL_DOMAINS = ['virt-domain.com', 'virt.domain2.com'] 916POSTFIX_STYLE_VIRTUAL_DOMAINS = ['virt-domain.com', 'virt.domain2.com']
597 add_virtualhost('www.virt.domain.com', 'virt.domain.com') 917add_virtualhost('www.virt.domain.com', 'virt.domain.com')
598 add_virtualhost('www.virt.domain2.com', 'virt.domain2.com') 918add_virtualhost('www.virt.domain2.com', 'virt.domain2.com')
599<codenote>This is required for your virtual domains for mailman to function.</codenote> 919<comment>(This is required for your virtual domains for mailman to function.)</comment>
600</pre>
601<pre> 920</pre>
921
922<pre caption="And last but not least">
602<codenote>Once that's finished, add your first list.</codenote> 923<comment>(Once that's finished, add your first list.)</comment>
603 924
604 # <i>su mailman</i> 925# <i>su mailman</i>
605 # <i>cd ~</i> 926# <i>cd ~</i>
606 # <i>bin/newlist test</i> 927# <i>bin/newlist test</i>
607 Enter the email of the person running the list: your@email.address 928Enter the email of the person running the list: <i>your@email.address</i>
608 Initial test password: 929Initial test password:
609 Hit enter to continue with test owner notification... 930Hit enter to continue with test owner notification...
610 <codenote>Virtual domain lists may be specified with</codenote> 931<comment>(Virtual domain lists may be specified with
611 <codenote>list@domain.com style list names</codenote> 932list@domain.com style list names.)</comment>
612 # <i>bin/genaliases</i> 933# <i>bin/genaliases</i>
613 <codenote>Now that your aliases have been generated,</codenote> 934<comment>(Now that your aliases have been generated,
614 <codenote>verify that they were added successfully.</codenote> 935verify that they were added successfully.)</comment>
615 936
616 # <i>nano -w data/aliases</i> 937# <i>nano -w data/aliases</i>
617 # STANZA START: test 938# STANZA START: test
618 # CREATED: 939# CREATED:
619 test: "|/var/mailman/mail/mailman post test" 940test: "|/var/mailman/mail/mailman post test"
620 test-admin: "|/var/mailman/mail/mailman admin test" 941test-admin: "|/var/mailman/mail/mailman admin test"
621 test-bounces: "|/var/mailman/mail/mailman bounces test" 942test-bounces: "|/var/mailman/mail/mailman bounces test"
622 test-confirm: "|/var/mailman/mail/mailman confirm test" 943test-confirm: "|/var/mailman/mail/mailman confirm test"
623 test-join: "|/var/mailman/mail/mailman join test" 944test-join: "|/var/mailman/mail/mailman join test"
624 test-leave: "|/var/mailman/mail/mailman leave test" 945test-leave: "|/var/mailman/mail/mailman leave test"
625 test-owner: "|/var/mailman/mail/mailman owner test" 946test-owner: "|/var/mailman/mail/mailman owner test"
626 test-request: "|/var/mailman/mail/mailman request test" 947test-request: "|/var/mailman/mail/mailman request test"
627 test-subscribe: "|/var/mailman/mail/mailman subscribe test" 948test-subscribe: "|/var/mailman/mail/mailman subscribe test"
628 test-unsubscribe: "|/var/mailman/mail/mailman unsubscribe test" 949test-unsubscribe: "|/var/mailman/mail/mailman unsubscribe test"
629 # STANZA END: test 950# STANZA END: test
630 951
631 # <i>/etc/init.d/mailman start</i> 952# <i>/etc/init.d/mailman start</i>
632 # <i>rc-update add mailman default</i> 953# <i>rc-update add mailman default</i>
633 <codenote>To start mailman at once and on every reboot</codenote> 954<comment>(To start mailman at once and on every reboot.)</comment>
634</pre> 955</pre>
635 956
636<pre caption="Adding mailman alias support to postfix"> 957<pre caption="Adding mailman alias support to postfix">
637 # <i>nano -w /etc/postfix/main.cf</i> 958# <i>nano -w /etc/postfix/main.cf</i>
638 owner_request_special = no 959owner_request_special = no
639 recipient_delimiter = + 960recipient_delimiter = +
640 <codenote>Read README.POSTFIX.gz for details on this</codenote> 961<comment>(Read README.POSTFIX.gz for details on this.)</comment>
641 962
642 alias_maps = 963alias_maps =
643 hash:/var/mailman/data/aliases, 964 hash:/var/mailman/data/aliases,
644 mysql:/etc/postfix/mysql-aliases.cf 965 mysql:/etc/postfix/mysql-aliases.cf
645 966
646 virtual_alias_maps = 967virtual_alias_maps =
647 hash:/var/mailman/data/virtual-mailman, 968 hash:/var/mailman/data/virtual-mailman,
648 mysql:/etc/postfix/mysql-virtual.cf 969 mysql:/etc/postfix/mysql-virtual.cf
649 <codenote>This adds mailman alias file support to postfix</codenote> 970<comment>(This adds mailman alias file support to postfix
650 <codenote>You may of course use the mysql tables for this,</codenote> 971You may of course use the mysql tables for this,
651 <codenote>but I hate doing that by hand.</codenote> 972but I hate doing that by hand. Also, if you are not
973using virtual domains, adding the virtual alias maps
974to postfix may cause problems, be warned.)</comment>
975</pre>
976
977<p>
978You should now be able to setup mailing lists for any domain on your box. Last
979note on this, make sure you run all mailman commands as the user mailman (<c>su
980mailman</c>) or else the permissions will be wrong and you'll have to fix them.
981Read the mailman doc's for more information on setting up and managing mailman
982lists.
652</pre> 983</p>
653<p> You should now be able to setup mailing lists for any domain on your box. Last note on this, make sure you run all mailman commands as the user mailman (<c>su mailman</c>) or else the permissions will be wrong and you'll have to fix them. Read the mailman doc's for more information on setting up and managing mailman lists.</p> 984
654</body> 985</body>
986</section>
655</chapter> 987</chapter>
988
656<chapter> 989<chapter>
657<title>Content Filtering and Anti-Virus</title> 990<title>Content Filtering and Anti-Virus</title>
658<body><p>Coming soon...</p></body> 991<section>
992<body>
993
994<p>
995For content filtering and Anti-Virus, please consult our <uri
996link="/doc/en/mailfilter-guide.xml">mail filtering gateway guide</uri>.
997</p>
998
999</body>
1000</section>
659</chapter> 1001</chapter>
1002
660<chapter> 1003<chapter>
661<title>Wrap Up</title> 1004<title>Wrap Up</title>
1005<section>
662<body> 1006<body>
663<p>Ok, you're all set, edit <path>/etc/postfix/master.cf</path> and turn off verbose mode for production use. You'll probably also want to add the services to your startup routine to make sure everything comes back up on a reboot. Make sure to add all the services you're using - apache, mysql, saslauthd, postfix, courier-imapd, courier-imapd-ssl, courier-pop3d, and courier-pop3d-ssl are all up to your decision on what access you want to provide. I generally have all the services enabled.</p> 1007
1008<p>
1009Ok, you're all set, edit <path>/etc/postfix/master.cf</path> and turn off
1010verbose mode for production use. You'll probably also want to add the services
1011to your startup routine to make sure everything comes back up on a reboot. Make
1012sure to add all the services you're using - apache, mysql, saslauthd, postfix,
1013courier-imapd, courier-imapd-ssl, courier-pop3d, and courier-pop3d-ssl are all
1014up to your decision on what access you want to provide. I generally have all
1015the services enabled.
1016</p>
1017
664<pre caption="Wrap up" > 1018<pre caption="Wrap up">
665 # <i>postfix reload</i> 1019# <i>postfix reload</i>
666 # <i>rc-update add $service default</i> 1020# <i>rc-update add $service default</i>
667</pre> 1021</pre>
1022
668<p> 1023<p>
669<e>Have fun!</e> 1024<e>Have fun!</e>
670</p> 1025</p>
1026
671</body> 1027</body>
1028</section>
672</chapter> 1029</chapter>
1030
673<chapter> 1031<chapter>
674<title>Troubleshooting</title> 1032<title>Troubleshooting</title>
675<section> 1033<section>
676<title>Introduction</title> 1034<title>Introduction</title>
677<body> 1035<body>
678<p>Troubleshooting: This is a short troubleshooting guide for the set up we've detailed how to install here. It is not exhaustive, but meant as a place to get you started in figuring out problems. With a complicated setup such as this, it's imperative that you narrow down the problem to the particular component that is malfunctioning. In general I do that by following a few steps. Start from the base of the system and work your way up, ruling out components that work along the way until you discover which component is having the problem.</p> 1036
1037<p>
1038Troubleshooting: This is a short troubleshooting guide for the set up we've
1039detailed how to install here. It is not exhaustive, but meant as a place to get
1040you started in figuring out problems. With a complicated setup such as this,
1041it's imperative that you narrow down the problem to the particular component
1042that is malfunctioning. In general I do that by following a few steps. Start
1043from the base of the system and work your way up, ruling out components that
1044work along the way until you discover which component is having the problem.
1045</p>
1046
679</body> 1047</body>
680</section>
681<section> 1048</section>
1049<section>
682<title>Step 1: Check your config files.</title> 1050<title>Step 1: Check your config files</title>
683<body> 1051<body>
684<p>Typos are killers, especially when dealing with authentication systems. Scan your config's and mailsql database for typo's. You can debug all you want, but if you're not passing the right information back and forth to your mail system, it's not going to work. If you make a change to a config file for a service, make sure you restart that service so that the config change gets picked up.</p> 1052
685<pre> 1053<p>
1054Typos are killers, especially when dealing with authentication systems. Scan
1055your config's and mailsql database for typo's. You can debug all you want, but
1056if you're not passing the right information back and forth to your mail system,
1057it's not going to work. If you make a change to a config file for a service,
1058make sure you restart that service so that the config change gets picked up.
1059</p>
1060
1061<pre caption="How to restart a service">
686 # <i>/etc/init.d/service restart</i> 1062# <i>/etc/init.d/service restart</i>
687</pre> 1063</pre>
1064
688</body> 1065</body>
689</section> 1066</section>
690<section> 1067<section>
691<title>Step 2: Are all the necessary services actually running?</title> 1068<title>Step 2: Are all the necessary services actually running?</title>
692<body> 1069<body>
693<p>If it's not running, start it up. It's awful hard to debug a service that isn't running. Sometimes a service will act like it's started but still not function. Sometimes, when a bad config is used, or a bad transmission comes into a mail component, the service will hang and keep the port from being used by another process. Sometimes you can detect this with netstat. Or, if you've been at it awhile, just take a break and reboot your box in the meantime. That will clear out any hung services. Then you can come back fresh and try it again.</p> 1070
694<pre> 1071<p>
1072If it's not running, start it up. It's awful hard to debug a service that isn't
1073running. Sometimes a service will act like it's started but still not function.
1074Sometimes, when a bad config is used, or a bad transmission comes into a mail
1075component, the service will hang and keep the port from being used by another
1076process. Sometimes you can detect this with netstat. Or, if you've been at it
1077awhile, just take a break and reboot your box in the meantime. That will clear
1078out any hung services. Then you can come back fresh and try it again.
1079</p>
1080
1081<pre caption="Checking the status of a service">
695 # <i>/etc/init.d/$service status</i> 1082# <i>/etc/init.d/$service status</i>
696 # <i>netstat -a | grep $service (or $port)</i> 1083# <i>netstat -a | grep $service (or $port)</i>
697</pre> 1084</pre>
1085
698</body> 1086</body>
699</section> 1087</section>
700<section> 1088<section>
701<title>Step 3: Are all the service using the current config's?</title> 1089<title>Step 3: Are all the service using the current config's?</title>
702<body> 1090<body>
703<p>If you've recently made a change to a config file, restart that service to make sure it's using the current version. Some of the components will dump their current config's to you, like postfix.</p> 1091
704<pre> 1092<p>
1093If you've recently made a change to a config file, restart that service to make
1094sure it's using the current version. Some of the components will dump their
1095current config's to you, like postfix.
1096</p>
1097
1098<pre caption="Some services can dump their current config">
705 # <i>apachectl fullstatus</i> (needs lynx installed) 1099# <i>apachectl fullstatus</i> (needs lynx installed)
706 # <i>apachectl configtest</i> (checks config sanity) 1100# <i>apachectl configtest</i> (checks config sanity)
707 # <i>postconf -n</i> (will tell you exactly what param's postfix is using) 1101# <i>postconf -n</i> (will tell you exactly what param's postfix is using)
708 # <i>/etc/init.d/$service restart</i> 1102# <i>/etc/init.d/$service restart</i>
709</pre> 1103</pre>
1104
710</body> 1105</body>
711</section>
712<section> 1106</section>
1107<section>
713<title>Step 4: Check the logs.</title> 1108<title>Step 4: Check the logs</title>
714<body> 1109<body>
715<p>Repeat after me, logs are my friend. My next troubleshooting stop is always the logs. Sometimes it's helpful to try a failed operation again then check the logs so that the error message is right at the bottom (or top depending on your logger) instead of buried in there somewhere. See if there is any information in your log that can help you diagnose the problem, or at the very least, figure out which component is having the problem.</p> 1110
716<pre> 1111<p>
1112Repeat after me, logs are my friend. My next troubleshooting stop is always the
1113logs. Sometimes it's helpful to try a failed operation again then check the
1114logs so that the error message is right at the bottom (or top depending on your
1115logger) instead of buried in there somewhere. See if there is any information
1116in your log that can help you diagnose the problem, or at the very least,
1117figure out which component is having the problem.
1118</p>
1119
1120<pre caption="Checking the logs">
717 # <i>kill -USR1 `ps -C metalog -o pid=`</i>(to turn off metalog buffering) 1121# <i>kill -USR1 `ps -C metalog -o pid=`</i>(to turn off metalog buffering)
718 # <i>nano -w /var/log/mail/current</i> 1122# <i>nano -w /var/log/mail/current</i>
719 # <i>cat /var/log/mysql/mysql.log</i> 1123# <i>cat /var/log/mysql/mysql.log</i>
720 # <i>tail /var/log/apache/error_log</i> 1124# <i>tail /var/log/apache/error_log</i>
1125</pre>
1126
1127<p>
1128You may also find the debug_peer parameters in main.cf helpful. Setting these
1129will increase log output over just verbose mode.
721</pre> 1130</p>
722<p>You may also find the debug_peer parameters in main.cf helpful. Setting these will increase log output over just verbose mode.</p> 1131
723<pre caption="adding debug_peer support"> 1132<pre caption="adding debug_peer support">
724 # <i>nano -w /etc/postfix/main.cf</i> 1133# <i>nano -w /etc/postfix/main.cf</i>
725 debug_peer_level = 5 1134debug_peer_level = 5
726 debug_peer_list = $host.domain.name 1135debug_peer_list = $host.domain.name
727 <codenote>Uncomment one of the suggested debugger</codenote> 1136<comment>(Uncomment one of the suggested debugger
728 <codenote>commands as well.</codenote> 1137commands as well.)</comment>
729</pre> 1138</pre>
1139
730</body> 1140</body>
731</section>
732<section> 1141</section>
1142<section>
733<title>Step 5: Talk to the service itself.</title> 1143<title>Step 5: Talk to the service itself</title>
734<body> 1144<body>
735<p>SMTP, IMAP, and POP3 all respond to telnet sessions. As we've seen earlier when we verified postfix's config. Sometimes it's helpful to open a telnet session to the service itself and see what's happening.</p> 1145
736<pre> 1146<p>
1147SMTP, IMAP, and POP3 all respond to telnet sessions. As we've seen earlier when
1148we verified postfix's config. Sometimes it's helpful to open a telnet session
1149to the service itself and see what's happening.
1150</p>
1151
1152<pre caption="Connect to a service with telnet">
737 # <i>telnet localhost $port</i> 1153# <i>telnet localhost $port</i>
738<codenote>SMTP is 25, IMAP is 143, POP3 is 110. You should receive at least an OK string,</codenote> 1154<comment>(SMTP is 25, IMAP is 143, POP3 is 110. You should receive at least an OK string,
739<codenote>letting you know that the service is running and ready to respond to requests.</codenote> 1155letting you know that the service is running and ready to respond to requests.)</comment>
740 1156
741 Trying 127.0.0.1... 1157Trying 127.0.0.1...
742 Connected to localhost. 1158Connected to localhost.
743 Escape character is '^]'. 1159Escape character is '^]'.
744 * OK Courier-IMAP ready. Copyright 1998-2002 Double Precision, Inc. See COPYING for distribution information. 1160* OK Courier-IMAP ready. Copyright 1998-2002 Double Precision, Inc.
745 </pre> 1161</pre>
1162
746</body> 1163</body>
747</section>
748<section> 1164</section>
1165<section>
749<title>Step 6: Sometimes only the big guns will give you the information you need: strace.</title> 1166<title>Step 6: Sometimes only the big guns will give you the information you need: strace</title>
750<body> 1167<body>
751<p>You should have this installed anyway. This is an invaluable tool for debugging software. You can start commands from the command line with strace and watch all the system calls as they happen. It often dumps a huge amount of information, so you'll either need to watch it realtime as you retry a failed transaction with the mail system, or dump the output to a file for review.</p> 1168
752<pre> 1169<p>
1170You should have this installed anyway. This is an invaluable tool for debugging
1171software. You can start commands from the command line with strace and watch
1172all the system calls as they happen. It often dumps a huge amount of
1173information, so you'll either need to watch it realtime as you retry a failed
1174transaction with the mail system, or dump the output to a file for review.
1175</p>
1176
1177<pre caption="Using strace">
753 # <i>emerge strace</i> 1178# <i>emerge strace</i>
754 # <i>strace $command</i> 1179# <i>strace $command</i>
755 # <i>strace -p `ps -C $service -o pid=`</i> 1180# <i>strace -p `ps -C $service -o pid=`</i>
756</pre> 1181</pre>
1182
757</body> 1183</body>
758</section> 1184</section>
759<section> 1185<section>
760<title>Step 7: Research</title> 1186<title>Step 7: Research</title>
761<body> 1187<body>
762<p>Once you have the information, if you can diagnose and fix the problem, great! If not, you'll probably need to go digging on the net for information that will help you fix it. Here's a list of sites you can check to see if your error has already been resolved. There's also a really good howto on setting up smtp-auth which contains some great debugging ideas.</p> 1188
1189<p>
1190Once you have the information, if you can diagnose and fix the problem, great!
1191If not, you'll probably need to go digging on the net for information that will
1192help you fix it. Here's a list of sites you can check to see if your error has
1193already been resolved. There's also a really good howto on setting up smtp-auth
1194which contains some great debugging ideas.
763<p> 1195</p>
1196
764<ul> 1197<ul>
765<li>
766<uri>http://forums.gentoo.org/</uri> - Great forums for gentoo users</li> 1198 <li><uri>http://forums.gentoo.org/</uri> - Great forums for gentoo users</li>
767<li> 1199 <li>
768<uri>http://bugs.gentoo.org/</uri> - Bugs database for gentoo - great place to look for specific errors</li> 1200 <uri>http://bugs.gentoo.org/</uri> - Bugs database for gentoo - great place
769<li> 1201 to look for specific errors
1202 </li>
770<uri>http://postfix.state-of-mind.de/</uri> - smtp-auth howto</li> 1203 <li><uri>http://postfix.state-of-mind.de/</uri> - smtp-auth howto</li>
771<li> 1204 <li>
772<uri>http://marc.theaimsgroup.com/?l=postfix-users</uri> - Postfix mailing lists - searchable</li> 1205 <uri>http://marc.theaimsgroup.com/?l=postfix-users</uri> - Postfix mailing
1206 lists - searchable
1207 </li>
773<li> 1208 <li>
774<uri>http://sourceforge.net/mailarchive/forum.php?forum_id=6705</uri> - Courier-imap mailing list archives - not searchable</li> 1209 <uri>http://sourceforge.net/mailarchive/forum.php?forum_id=6705</uri> -
1210 Courier-imap mailing list archives - not searchable
1211 </li>
775<li> 1212 <li>
776<uri>http://www.google.com/</uri> - If all else fails, there's always google, which has never failed me</li> 1213 <uri>http://www.google.com/</uri> - If all else fails, there's always
1214 google, which has never failed me
1215 </li>
1216 <li>
777<li>I also spend a lot of time on irc.freenode.net #gentoo. Irc is a great place to go for help.</li> 1217 I also spend a lot of time on irc.freenode.net #gentoo. Irc is a great
1218 place to go for help.
1219 </li>
778</ul> 1220</ul>
779</p> 1221
780</body> 1222</body>
781</section> 1223</section>
782</chapter> 1224</chapter>
783</guide> 1225</guide>
784

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.46

  ViewVC Help
Powered by ViewVC 1.1.20