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

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

  ViewVC Help
Powered by ViewVC 1.1.20