view release on metacpan or  search on metacpan

lib/CPANPLUS/Dist/Slackware/Plugin/Mail/SpamAssassin.pm  view on Meta::CPAN

    my $readme = $plugin->_readme_slackware_addendum;
    my $readmefile = catfile( $docdir, 'README.SLACKWARE' );
    spurt( $readmefile, { append => 1 }, $readme ) or return;

    my @docfiles = qw(
        INSTALL
        ldap
        NOTICE
        PACKAGING
        procmailrc.example
        sample-nonspam.txt
        sample-spam.txt
        sql
        TRADEMARK
        UPGRADE
        USAGE
    );

    my $fail = 0;
    for my $docfile (@docfiles) {
        if ( !run( [ '/bin/cp', '-R', $docfile, $docdir ] ) ) {
            ++$fail;
        }
    }

    return ( $fail ? 0 : 1 );
}

sub _readme_slackware_addendum {
    my $plugin = shift;

    return <<'END_README';

Optional modules
----------------

See the INSTALL file for a list of modules that SpamAssassin can optionally
utilize.  Among the optional packages are:

* perl-Encode-Detect
* perl-IO-Socket-IP
* perl-Geo-IP
* perl-Mail-SPF
* perl-Net-Patricia
* perl-ldap
* perl-libwww

Downloading the SpamAssassin ruleset
------------------------------------

After installing SpamAssassin, you need to download and install the
SpamAssassin ruleset using "sa-update".  See the README file for details.  If
you don't want to run "sa-update" as root, create a dedicated account and a
required directory before you run "sa-update".  Example:

    useradd -u 400 -r -U -c "User for SpamAssassin rule updates" \
        -m -d /var/lib/spamassassin sa-update

    mkdir -m 700 /etc/mail/spamassassin/sa-update-keys
    chown sa-update:sa-update /etc/mail/spamassassin/sa-update-keys

    su sa-update -c /usr/bin/sa-update

If "re2c", which is available at slackbuilds.org, is installed, the ruleset
can be compiled into native code to speed up SpamAssassin's operation:

    su sa-update -c /usr/bin/sa-compile

The compiled rules are loaded if the Rule2XSBody plugin is enabled in
SpamAssassin's configuration.

If you want to keep the ruleset up-to-date, create a weekly or monthly cron
job that runs a shell script like the following one:

    #!/bin/sh
    if su sa-update -c /usr/bin/sa-update; then
        if [ -x /usr/bin/re2c ]; then
            su sa-update -c /usr/bin/sa-compile >/dev/null 2>&1
        fi
        if [ -f /var/run/spamd.pid ]; then
            kill -HUP $(cat /var/run/spamd.pid)
        fi
    fi

Running the SpamAssassin daemon
-------------------------------

To enable spamd, add the execute permissions to the /etc/rc.d/rc.spamd init
script with the chmod command.  Also, make sure that the daemon is enabled in
/etc/spamassassin.conf.

Run spamd without root privileges if per-user configuration files are not
needed.  First create a dedicated account.  Example:

    useradd -u 401 -r -U -c "User for SpamAssassin daemon" \
        -m -d /var/lib/spamd spamd

Then set the following options in /etc/spamassassin.conf:

    OPTIONS="-u spamd -x"

On a busy server, you might have to add options like "--min-children",
"--max-children", "--min-spare" and "--max-spare".  See the spamd manual page
for a complete list of options.

Finally run spamd:

    /etc/rc.d/rc.spamd start
END_README
}

1;
__END__

=head1 NAME

CPANPLUS::Dist::Slackware::Plugin::Mail::SpamAssassin - Add an init script and documentation

=head1 VERSION