redis support for spamassassin AWL/TxRep
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
contrib
lib/Mail/SpamAssassin
t
.gitignore
.travis.yml
README.pod
dist.ini

README.pod

DESCRIPTION

RedisAWL implements a redis table for the spamassassin AWL/TxRep plugin.

INSTALLATION

To install the plugin from CPAN:

$ cpanm Mail::SpamAssassin::Plugin::RedisAWL

CONFIGURATION

Load the plugin in init.pre:

loadplugin Mail::SpamAssassin::Plugin::RedisAWL

If you're using the AWL plugin change the AWL datebase type to redis in local.cf:

auto_whitelist_factory Mail::SpamAssassin::RedisAddrList

If you're using the TxRep plugin use:

txrep_factory Mail::SpamAssassin::RedisAddrList

And you may have to configure the redis server and prefix:

auto_whitelist_redis_server 127.0.0.1:6379
auto_whitelist_redis_prefix awl_

PARAMETERS

auto_whitelist_redis_server

The redis server to use.

Default: 127.0.0.1:6379

auto_whitelist_redis_password (default: no password)

Set if you redis server requires a password.

auto_whitelist_redis_prefix

A prefix for AWL keys.

Default: awl_

auto_whitelist_redis_database (default: 0)

Will call SELECT to switch database after connect if set to a non-zero value.

Database 0 is the default in redis.

auto_whitelist_redis_expire (default: 0)

Add an expire timeout to entries in redis.

The default 0 means that no expire timeout is set.

Timeout must be set in seconds.

An entries expiration timeout will be updated whenever a new score is applied to it.

auto_whitelist_redis_debug (default: 0)

Turn on/off debug on the Redis connection.

CHECK YOUR CONFIGURATION

Scan a mail an check debug output for redis/awl messages:

$ spamassassin -D < /tmp/testmail 2>&1 | egrep -e 'auto-whitelist' -e 'redis'

Query redis for awl data:

$ redis-cli
redis 127.0.0.1:6379> keys awl_*
1)...
redis 127.0.0.1:6379> get awl_bla@blub.de|ip=1.2.3.4_score
"-5099"
redis 127.0.0.1:6379> get awl_bla@blub.de|ip=1.2.3.4_count
"1"