"SfR Fresh" - the SfR Freeware/Shareware Archive

Member "bogom-1.9.2/README" of archive bogom-1.9.2.tar.gz:

As a special service "SfR Fresh" has tried to format the requested source page into HTML format using source code syntax highlighting with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. That can be also achieved for any archive member file by clicking within an archive contents listing on the first character of the file(path) respectively on the according byte size field. 
    1 bogom - simple sendmail milter to interface bogofilter
    2 Copyright (C) 2004-2007 Juan J. Martinez <jjm@usebox.net>
    3 
    4 
    5 Required
    6 --------
    7 
    8 This milter requires libmiter API for sendmail 8.13.x or later.
    9 Installing bogofilter is a good idea also.
   10 
   11 Bogom has been developed and tested with the following:
   12 
   13 	sendmail 8.13.0 and 8.14.1
   14 	bogofilter 0.92.8 (with BerkeleyDB 4.2.52)
   15 
   16 
   17 Build and Install
   18 -----------------
   19 
   20 This milter has been developed in OpenBSD, so you may need to tweak the
   21 Makefile in order to compile it in other systems.
   22 
   23 Check README.* files for specific notes.
   24 
   25 On most Linux and BSD based systems, simply try:
   26 
   27 $ make
   28 $ su
   29 # make install
   30 
   31 Bogom has been packaged for FreeBSD (mail/milter-bogom) and non officially for
   32 some Linux distributions.
   33 
   34 IMPORTANT: since 1.8.1+ the bogom binary is installed into $(PREFIX)/libexec,
   35            so be sure to remove $(PREFIX)/sbin/bogom from any previous
   36            installation.
   37 
   38 
   39 Unprivileged user
   40 -----------------
   41 
   42 When root starts bogom, the program drops its privileges to another user. It's
   43 a good idea you create a new user to run the milter. By default bogofilter user
   44 is expected.
   45 
   46 # mkdir /var/spool/bogofilter
   47 
   48 Configure bogofilter with:
   49 
   50 bogofilter_dir=/var/spool/bogofilter
   51 
   52 ... and create your intial words database. 
   53 
   54 After that, setup the environment with:
   55 
   56 # chown -R bogofilter:bogofilter /var/spool/bogofilter
   57 # chmod 700 /var/spool/bogofilter
   58 # chmod 600 /var/spool/bogofilter/wordlist.db
   59 
   60 
   61 Custom installation step by step
   62 --------------------------------
   63 
   64 bogom provides some defaults, but don't have to stick into them. 
   65 
   66 Here follows a 'step by step' quickstart to configure bogom and bogofilter.
   67 
   68 + Install bogofilter
   69 + Install bogom
   70 + Create the '_bogom' user and group
   71 + Create the directories and apply permissions:
   72 
   73 # mkdir -p /var/run/bogom && chown _bogom:_bogom /var/run/bogom
   74 # mkdir -p /var/db/bogofilter && chown _bogom:_bogom /var/db/bogofilter
   75 
   76 + Copy the example bogofilter.cf file into /etc and edit it:
   77 
   78 bogofilter_dir=/var/db/bogofilter
   79 
   80 + Setup bogofilter database. About 500 messages of spam/ham will be nice:
   81 
   82 # su _bogom -c "bogofilter -s < spam.mbox"
   83 # su _bogom -c "bogofilter -n < ham.mbox"
   84 
   85 (use su with -m option if _bogom user doesn't have shell account)
   86 
   87 + Install the example conf file at /etc/bogom.conf and edit it. At least
   88 you should set up:
   89 
   90 user "_bogom"
   91 pidfile "/var/run/bogom/bogom.pid"
   92 connection "unix:/var/run/bogom/milter.sock"
   93 
   94 + Add to your sendmail mc file:
   95 
   96 INPUT_MAIL_FILTER(`bogom',\
   97 `S=unix:/var/run/bogom/milter.sock, T=S:30s;R:1m')
   98 
   99 (rebuild and install the cf file)
  100 
  101 + Add bogom to your rc or init.d scripts
  102 + Restart sendmail
  103 + Exec bogom or reboot the system
  104 
  105 
  106 * EOF *
  107