File update-sa.sh.8.txt of Package update-sa

Overview Repositories Revisions Requests Users Attributes Meta

File update-sa.sh.8.txt of Package update-sa (Revision bb64fefa6efb088585dea3fbac6724fb)

Currently displaying revision bb64fefa6efb088585dea3fbac6724fb , Show latest

NAME
  update-sa.sh - update SpmaAssassin's ruleset
SYNOPSIS
  update-sa.sh
DESCRIPTION
  update-sa.sh will call sa-update with default and additional rules or
  sought rules only. It will log the update process and decide whether
  amavisd and/or postfix must be reloaded or restarted.

The main configuration happens in update-sa.conf. All channels
  (SpamAssassin's main update channel, too) must be listed in
  update-sa-channels.conf. All GPG-key-id of these channels must be
  listed in update-sa-keys.conf. Updates without GPG are not supported.
  update-sa.sh can download additional ruleset from an URL, check/lint
  them and store them in under $SITECONFIG. These URLs must be listed
  in update-sa-urls.conf.
OPTIONS
  --help        emit short usage message and bail out
  --version     ouput version information and exit
FILES
  /usr/sbin/update-sa.sh                         - bash script
  /etc/mail/spamassassin/update-sa.conf          - configuration file
  /etc/mail/spamassassin/update-sa-channels.conf  - channel list
  /etc/mail/spamassassin/update-sa-keys.conf      - key-id list
  /etc/mail/spamassassin/update-sa-urls.conf      - additional urls
OPTIONS
  Set the options update-sa.conf according to your needs.

SITECONFIG      path to spamassassin's main configuration directory
  CHANNEL_FILE    collect updates from all channels in this file
  CHANNEL_KEYS    GPG key-ids to the above configured update channels
  RULE_LIST       download additional rule updates from URLs in this file
  COMPILE         disable(0)/enable(1) ruleset compiling
  SA_LOG          write all logs to the following file

There shouldn't be any need to change the following options:

SOUGHT_CHANNEL  the name of the channel which shout be updated alone
  SOUGHT_KEY      the GPG key-id of the SOUGHT_CHANNEL
  HOST            hostname, used in the logfile
  SA_LIB          path where SpamAssassin stores its rules
  SA_CP_LIB       path where SpamAssassin keeps its compiled rules
  SA_UBIN         path to SpamAssassin's sa-update script
  SA_CBIN         path to SpamAssassin's sa-compile script
  AMAVISD         path to amavisd-new's init script

EXAMPLE
  Main configuration file (update-sa.conf) example:

SITECONFIG=/etc/mail/spamassassin
  CHANNEL_FILE=${SITECONFIG}/update-sa-channels.conf
  CHANNEL_KEYS=${SITECONFIG}/update-sa-keys.conf
  RULE_LIST=${SITECONFIG}/update-sa-urls.conf
  COMPILE=1
  SA_LOG=/var/log/update-sa.log

Channel configuration file (update-sa-channels.conf) example:

# list of channels
  updates.spamassassin.org
  sought.rules.yerp.org
  sa.zmi.at

GPG Key-id configuration file (update-sa-keys.conf) example:

# list of GPG Key-IDs
  5244EC45      # official sa-update key-id 
  6C6191E3      # sought key-id
  40F74481      # zmi key-id

Additional URLs configuration file (update-sa-urls.conf) example:

# Filename   URL
  malware_patrol.cf       http://www.malware.com.br/cgi/submit?action=list_sa

LICENSE
  update-sa.sh is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 3 of the License, or
  (at your option) any later version.

This program is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
  along with this program. If not, see http://www.gnu.org/licenses/.

REPORTING BUGS
  Report bugs to <projects@localside.net>

AUTHORS
  Stefan Jakobs

This manual page was written by Stefan Jakobs <projects@localside.net>

Places

File update-sa.sh.8.txt of Package update-sa (Revision bb64fefa6efb088585dea3fbac6724fb)

Places