[svn-inject] Installing original source of spamass-milter
[deb_pkgs/spamass-milter.git] / README
1 $Id: README,v 1.4 2003/06/10 18:42:38 dnelson Exp $
2
3 Spamass-Milter, a small
4  - SpamAssassin Sendmail Mail Filter (Milter) Plugin 
5 -----------------------------------------------------
6
7 For information about Sendmail or SpamAssassin, please see 
8         http://www.sendmail.org
9         http://www.spamassassin.org
10
11
12 Installation instructions:
13 --------------------------
14
15 You need to have sendmail + sendmail's libmilter (available since
16 version 8.11, afaik, 8.12.+ recommended) installed. Depending on your
17 distribution you may need to recompile sendmail for this. 
18
19 Under Debian, "apt-get install libmilter-dev" should do the trick.
20
21 For more information, please refer to http://www.sendmail.org.
22
23 You will need to have SpamAssassin spamc & spamd installed &
24 configured.
25
26 BEFORE INSTALLING & TRYING TO USE THIS PROGRAM, PLEASE MAKE SURE THAT
27 SPAMC/SPAMD DOES EXACTLY WHAT YOU WANT; OTHERWISE YOU MIGHT RISK
28 LOSING MAIL.
29
30 Theoretically, "./configure ; make ; make install" (see INSTALL)
31 should do the trick. If it doesn't, you may be missing something or
32 the configuration may not be working for you. 
33
34
35 Configuration:
36 --------------
37
38 In contrib, you'll find a startup-script that should work almost out
39 of the box under Debian. Just modify the execution path to where you
40 put the spamass-milter binary and set the path of the socket to what
41 you want to use. YOU WILL MOST LIKELY HAVE TO EDIT THE VARIABLES ON
42 TOP OF THIS FILE.
43
44 Then start the daemon via /etc/init.d/spamass-milter start and make
45 sure it didn't crash/terminate immediately. If it does, there should
46 usually be syslog output. 
47
48 If you want to make this happen automatically, you can use the
49 update-rc.d command for this under Debian.
50
51
52 Now you need to make sendmail use the plugin. I always recommend
53 configuring sendmail through m4 & the sendmail.mc files. In this case
54 adding the lines
55
56 INPUT_MAIL_FILTER(`spamassassin', `S=local:/var/run/sendmail/spamass.sock, F=, T=C:15m;S:4m;R:4m;E:10m')dnl
57 define(`confMILTER_MACROS_CONNECT',`b, j, _, {daemon_name}, {if_name}, {if_addr}')dnl
58
59 should do the trick. Of course you need to modify the path of the
60 socket if you put another one into the startup script. The timeouts
61 have been increased somewhat because SpamAssassin may chew on it for a
62 little while on a slow machine.
63
64 Now recreate sendmail.cf, restart sendmail and experiment around a bit
65 with the setup to make sure it is working.
66
67
68 Q: Does this work for UUCP?
69
70 Yes, it does. At least for me. :-)
71
72
73 If you want, you might configure procmail to filter out the spam into
74 a separate mailbox or do other fancy things. The SpamAssassin homepage
75 will tell you more about it.
76
77 That should be it. Have fun watching the spam drip off your box. :)