
Contents of the package, all based on the pollustop/ directory
   Required files:
      pollustop[.exe]              - binary file
      pollustop.sig                - signature file for integrity
      pollustop.settings.defaults  - default settings (DO NOT EDIT)
      convert_2.0_settings.pl      - Settings file conversion script to
                                     migrate your 2.0 settings file
      http/*                       - Templates for PolluStop WebAdmin. You can
                                     edit them if you want, but no support is
                                     provided for errors caused by modified
                                     files. PolluStop is not well protected
                                     against template syntax errors; if you
                                     introduce some, you may have to restart
                                     the filter.

   Documentation (not needed for execution):
      README                       - basic documentation of the filter
      HISTORY                      - pollustop change log
      TERMS                        - usage terms of the product
      INSTALL                      - this file.
      UPGRADE                      - instructions to install a newer version
      VERSION                      - version number of the package

   Pre-populated spam corpus (in a separate package).
      data/s.db72
      data/g.db72

   Other files and folders which will be created by PolluStop:
      data/pollustop.settings      - Current settings
      data/pollustop.statistics    - Stored statistics
      data/autobackup/s.db72
      data/autobackup/g.db72       - Auto backup (state n-1) of the database
      data/id/100.db64             - In-Memory MessageID database
      data/id/[000-0FF].db64       - On-Disk MessageID database
      data/tokens.list             - Tokens added to the database
      data/blacklist.data          - Blacklist entries
      data/whitelist.data          - Whitelist entries


File installation

   Extract the contents of the package in a subdirectory of the Communigate Pro
   Base folder. It is recommended creating a Filters subdirectory to regroup
   all filters together.

   You may have to set the correct rights and owner on the files. The binary
   file and the perl file should have exec rights for owner, the other files
   should have read/write rights for owner. Owner/group should be the same as
   Communigate Pro (root/mail or something else, depending on the system).
   Win32 users shoulnd't have to modify rights.

   When doing a new installation, you MAY use the pre-populated spam database
   if you don't have enough stored spam to train it by yourself. However, you
   MUST train the "good" part of the database with your own good mail.

   You MUST NOT use pollustop to filter mail when the database is not trained
   enough and properly trained, this will result as all messages being
   incorrectly tagged as spam.

   Non-Win32 versions of this filter may require gcc3 libraries. They are
   already installed on most systems and in the path. On some systems you may
   have to add the LD_LIBRARY_PATH environment variable in the Communigate Pro
   startup script or anywhere else suitable. Do this only if PolluStop refuses
   to start with a "missing library" message. If you don't have the required
   gcc3 libraries, visit http://www.niversoft.com/pollustop to see if a
   precompiled version of them is available. You can contact Niversoft to
   request a precompiled libraries package.

Helper setup

   In Communigate Pro WebAdmin, Settings/General/Helpers, create a helper entry
   with a name for the filter and the path relative to the Communigate Pro base
   folder (or the full path). Set the Log Level to All Info. Put timeout
   value to one or two minutes and auto-restart to 10 seconds.

Account setup

   Create an account for PolluStop. This account needs admin rights for CLI
   access to Communigate. It also need POP access for the "Dropbox" method.

   All messages sent directly to PolluStop will never reach it's INBOX, and
   messages dropped in the Drop mailbox will disappear within seconds. The
   drop boxes are black holes. Messages moved into them can not be restored.
   Teach your users to copy the messages instead of moving if they want to
   keep the messages.

Initial PolluStop setup

   Once the helper is running and the account is created, use the PolluStop
   WebAdmin interface to configure the filter:

   http://hostname:8001

   The default username and password are "pollustop" / "pollustop".

   8001 is the default listening port of PolluStop, and can be changed from
   the webadmin interface. If the port 8001 is not available on your system,
   you can specify an alternate port on the command line, for instance:
      pollustop/pollustop 8002

   PolluStop will try first with the port specified in the settings, and will
   use the alternate port ONLY if the first can't be used. You may want to
   check CGGPro logs if you have trouble accessing the web interface,
   The port number is printed in the logs each time PolluStop starts.

   Go to the Initial Setup page of the WebAdmin interface and follow the steps

   When you get a license, paste it in the License page of the PolluStop web
   administration. The license will be saved in the data subdirectory as
   pollustop.lic.

Please email info@niversoft.com for any question about PolluStop installation.
