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

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.60

  ViewVC Help
Powered by ViewVC 1.1.20