Merge branch 'upstream'

[deb_pkgs/spamass-milter.git] / debian / README.Debian

diff --git a/debian/README.Debian b/debian/README.Debian
index b58575130ae9bb3d95c66187bded745e6247d003..aa73a346216f51fd77e10bf41cc1ad8fc2ba5852 100644 (file)
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -6,13 +6,16 @@ You will need to edit /etc/mail/sendmail.mc and add an
 INPUT_MAIL_FILTER line that connects to the spamass-milter socket.
 
 By default the spamass-milter socket is
-/var/run/sendmail/spamass.sock; so your INPUT_MAIL_FILTER should look
+/var/run/spamass/spamass.sock; so your INPUT_MAIL_FILTER should look
 something like:
 
  # spamassassin settings
  INPUT_MAIL_FILTER(`spamassassin',
          `S=local:/var/run/spamass/spamass.sock, F=,
          T=S:4m;R:4m;E:10m')dnl
+ define(`confMILTER_MACROS_CONNECT',`t, b, j, _, {daemon_name}, {if_name}, {if_addr}')dnl
+ define(`confMILTER_MACROS_HELO',`s, {tls_version}, {cipher}, {cipher_bits}, {cert_subject}, {cert_issuer}')dnl
+ define(`confMILTER_MACROS_ENVRCPT',`b, i, j, r, v, Z, _')dnl
 
 Briefly, the F=, tells sendmail to just pass the connection through if
 the milter fails. This is most likely the setting you want. If you
@@ -34,6 +37,13 @@ See http://www.sendmail.com/partner/resources/development/milter_api/installatio
 and http://www.sendmail.org/m4/adding_mailfilters.html#INPUT_MAIL_FILTER
 for more information on milters.
 
+If you are using the alias expansion method, -x, you will need to add
+spamass-milter to the smmsp group using:
+
+ adduser spamass-milter smmsp;
+
+This does not need to be done unless you are using alias expansion.
+
 --------------------------------------------------------------
   Integrating spamass-milter into your postfix installation
 --------------------------------------------------------------
@@ -44,14 +54,24 @@ that postfix connects to the spamass-milter socket. Something like:
   # spamass-milter configuration
   smtpd_milters = unix:/var/spool/postfix/spamass/spamass.sock
 
-should work. See http://www.postfix.org/MILTER_README.html or
+should work. Note, however, if you're using a chrooted version of
+postfix, you'll need the local path to the socket inside of the
+chroot. In recent versions of Debian the following should work:
+
+  # spamass-milter configuration
+  smtpd_milters = unix:/spamass/spamass.sock
+  # milter macros useful for spamass-milter
+  milter_connect_macros = j {daemon_name} v {if_name} _
+  milter_data_macros = j i {daemon_name} v {if_name} _
+
+See http://www.postfix.org/MILTER_README.html or
 /usr/share/doc/postfix/MILTER_README.gz (in postfix-doc) for
 information on how to set tempfail and the various timeouts that the
 sendmail configuration above uses.
 
-You'll also want to change /etc/default/spamass-milter to use the
-SOCKET above, and also enable RUNAS so that it runs as the same user
-that will be connecting to the socket.
+The defaults for spamass-milter adjust themselves so that no
+configuration in /etc/default/spamass-milter should be required.
+[However, if you are not doing so, see below.]
 
 -------------------------------------------------------------
   Adjusting how spamass-milter is started
@@ -59,7 +79,31 @@ that will be connecting to the socket.
 
 You can adjust how spamass-milter starts, and the options it calls
 spamc with by adjusting /etc/default/spamass-milter. OPTIONS is passed
-directly to spamass-milter by /etc/init.d/spamass-milter.
+directly to spamass-milter by /etc/init.d/spamass-milter. [Refer to
+spamass-milter(1) for details.]
+
+Other settings which may be of use:
+
+SOCKET sets the location of the socket; defaults to
+/var/run/spamass/spamass.sock unless you are running postfix, where it
+is set to /var/spool/postfix/spamass/spamass.sock.
+
+SOCKETOWNER is the owner of the socket, which defaults to root:root or
+postfix:postfix if you're running postfix.
+
+SOCKETMODE is the mode of the socket, which defaults to 0600 or 0660
+if you're running postfix.
+
+RUNAS controls the user which spamass-milter runs as; defaults to
+spamass-milter.
+
+If you want to use an inet socket for spamass-milter (like inet:9999
+or inet:9999@127.0.0.1), then you'll need to make the following
+configuration changes in /etc/default/spamass-milter:
+
+SOCKET="inet:9999@127.0.0.1"
+SOCKETMODE=""
+SOCKETOWNER=""
 
 -------------------------------------------------------------
 Debugging spamass-milter
@@ -90,4 +134,4 @@ q
 
 and send the results along with your bug report using reportbug.
 
- -- Don Armstrong <don@debian.org>, Tue,  2 Jan 2007 06:40:24 -0800
+ -- Don Armstrong <don@debian.org>, Fri, 28 Dec 2012 10:54:48 -0800