
Contents of the package, all based on the pollustop/ directory
   Required files:
      pollustop[.exe]              - binary file
      pollustop.sig                - signature file for integrity
      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.lic           - License file
      data/pollustop.lck           - Lock file for IPC
      data/processing              - Last file processed bu PolluStop. If
                                     PolluStop fails while processing a file,
                                     it will skip it after restart to avoid
                                     crash loops.
      data/pollustop.settings      - Current settings
      data/pollustop.statistics    - Stored statistics
      data/pollustop.sqlite        - Black/Whitelist entries. Per-user settings
      data/tokens.list             - Tokens added to the database. This can be
                                     deleted, used only for troubleshooting the
                                     training.
      data/*.<date>                - automatic backups
      data-<date>                  - automatic backup of the data directory on
                                     major upgrades
      backup_v<version>            - automatic backup of the binary files on
                                     minor updates


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

   You can create an account for PolluStop's drop mailboxes and learn requests.
   This account needs IMAP access for the "Dropbox" method, no special right.

   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.

   Note you can also simply setup this account as an alias for postmaster or
   any other service account you may have.

Initial PolluStop setup

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

   http://hostname:8001

   Use your CGP username and password to enter. To see the full PolluStop
   admin interface, the account you use to enter must have the "Master" access
   right in CGP. Most people will prefer using the postmaster account and
   password to enter PolluStop webadmin.

   Subdomain administrator can also see some of the PolluStop settings. Any
   account with "Domain" and "BasicSettings" rights for a domain will see
   the per-domain settings for that domain. Normal user accounts will only
   see their own per-user settings.

   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 --httpd=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.

   PolluStop webadmin can be accessed using SSL or normal http, on the same
   port. However, even when it is accessed without SSL, the passwords
   are RSA-encrypted on the client side and sent encrypted. The authentication
   system also  produces a single-use token whch is encrypted with the
   password, protecting the password and preventing replay attacks. SSL must
   be configured in the General settings before use.

   PolluStop also allows the per-user settings page to be accessed from a
   pre-existing webmail session, using the session ID. This also allows a
   webmail skin to be modified to access PolluStop user settings.

   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.
