]> git.donarmstrong.com Git - deb_pkgs/spamass-milter.git/blob - debian/README.Debian
* Update milter_connect_macros_line (thanks to Marco d'Itri)
[deb_pkgs/spamass-milter.git] / debian / README.Debian
1 --------------------------------------------------------------
2   Integrating spamass-milter into your sendmail installation
3 --------------------------------------------------------------
4
5 You will need to edit /etc/mail/sendmail.mc and add an
6 INPUT_MAIL_FILTER line that connects to the spamass-milter socket.
7
8 By default the spamass-milter socket is
9 /var/run/spamass/spamass.sock; so your INPUT_MAIL_FILTER should look
10 something like:
11
12  # spamassassin settings
13  INPUT_MAIL_FILTER(`spamassassin',
14          `S=local:/var/run/spamass/spamass.sock, F=,
15          T=S:4m;R:4m;E:10m')dnl
16  define(`confMILTER_MACROS_CONNECT',`t, b, j, _, {daemon_name}, {if_name}, {if_addr}')dnl
17  define(`confMILTER_MACROS_HELO',`s, {tls_version}, {cipher}, {cipher_bits}, {cert_subject}, {cert_issuer}')dnl
18  define(`confMILTER_MACROS_ENVRCPT',`b, i, j, r, v, Z, _')dnl
19
20 Briefly, the F=, tells sendmail to just pass the connection through if
21 the milter fails. This is most likely the setting you want. If you
22 want to temporarily fail a connection, you can set F=T. You almost
23 definitely don't want to reject connections, but if necessary, you can
24 do that by setting F=R.
25
26 You may also need to adjust these timeout settings, as spamd can be
27 sluggish on a slow machine. S is the timeout for sending information
28 from the MTA to a filter. R is the timeout for reading a reply from
29 the filter. E is the overall timeout between sending end-of-message to
30 filter and waiting for the final acknowledgment.
31
32 The settings above seem to work well on a Celeron 466 that receives
33 around 1000 emails an hour. You may wish to adjust them according to
34 your needs.
35
36 See http://www.sendmail.com/partner/resources/development/milter_api/installation.html
37 and http://www.sendmail.org/m4/adding_mailfilters.html#INPUT_MAIL_FILTER
38 for more information on milters.
39
40 --------------------------------------------------------------
41   Integrating spamass-milter into your postfix installation
42 --------------------------------------------------------------
43
44 You need to edit /etc/postfix/main.cf and configure smptpd_milters so
45 that postfix connects to the spamass-milter socket. Something like:
46
47   # spamass-milter configuration
48   smtpd_milters = unix:/var/spool/postfix/spamass/spamass.sock
49
50 should work. Note, however, if you're using a chrooted version of
51 postfix, you'll need the local path to the socket inside of the
52 chroot. In recent versions of Debian the following should work:
53
54   # spamass-milter configuration
55   smtpd_milters = unix:/spamass/spamass.sock
56   # milter macros usefull for spamass-milter
57   milter_connect_macros = j {daemon_name} v {if_name} _
58
59 See http://www.postfix.org/MILTER_README.html or
60 /usr/share/doc/postfix/MILTER_README.gz (in postfix-doc) for
61 information on how to set tempfail and the various timeouts that the
62 sendmail configuration above uses.
63
64 The defaults for spamass-milter adjust themselves so that no
65 configuration in /etc/default/spamass-milter should be required.
66 [However, if you are not doing so, see below.]
67
68 -------------------------------------------------------------
69   Adjusting how spamass-milter is started
70 -------------------------------------------------------------
71
72 You can adjust how spamass-milter starts, and the options it calls
73 spamc with by adjusting /etc/default/spamass-milter. OPTIONS is passed
74 directly to spamass-milter by /etc/init.d/spamass-milter. [Refer to
75 spamass-milter(1) for details.]
76
77 Other settings which may be of use:
78
79 SOCKET sets the location of the socket; defaults to
80 /var/run/spamass/spamass.sock unless you are running postfix, where it
81 is set to /var/spool/postfix/spamass/spamass.sock.
82
83 SOCKETOWNER is the owner of the socket, which defaults to root:root or
84 postfix:postfix if you're running postfix.
85
86 SOCKETMODE is the mode of the socket, which defaults to 0600 or 0660
87 if you're running postfix.
88
89 RUNAS controls the user which spamass-milter runs as; defaults to
90 spamass-milter.
91
92 -------------------------------------------------------------
93 Debugging spamass-milter
94 -------------------------------------------------------------
95
96 As spamass-milter is still undergoing development, you may see bugs
97 from time to time.
98
99 If spamass-milter is segfaulting (SEGV or SIG 11) please build a
100 debugging version of the spamass-milter package and install it:
101
102 mkdir temp;
103 cd temp;
104 apt-get source spamass-milter;
105 apt-get build-dep spamass-milter;
106 cd spamass-milter-*;
107 DEB_BUILD_OPTIONS='nostrip' CXXFLAGS='-O0 -g' fakeroot debian/rules clean binary;
108 dpkg -i spamass-milter*.deb;
109
110 Then turn on coredumps (ulimit -c unlimited), and start spamass-milter
111 as usual (/etc/init.d/spamass-milter start).
112
113 When spamass-milter cores, run gdb on the core, ala:
114 gdb /usr/sbin/spamass-milter /foo/corefile.pid
115 thread apply all where
116 bt
117 q
118
119 and send the results along with your bug report using reportbug.
120
121  -- Don Armstrong <don@debian.org>, Mon,  5 Jan 2009 13:03:36 -0800