github.com/tiredofit/docker-spamassassin

About

This will build a Docker Image for Spamassassin - A message content scanner for spam.

Maintainer

• Dave Conroy

Table of Contents

• Introduction
  • Changelog
• Prerequisites
• Installation
• Quick Start
• Configuration
  • Data Volumes
  • Environment Variables
• Maintenance
  • Shell Access
  • References

Prerequisites and Assumptions

• This image doesn't do much on it's own, you must use a complemenary service to pass messages or data to it via port 783.

Installation

Build from Source

Clone this repository and build the image with docker build -t (imagename) .

Prebuilt Images

Builds of the image are available on Docker Hub

docker pull docker.io/tiredofit/spamassassin:(imagetag)

Builds of the image are also available on the Github Container Registry

docker pull ghcr.io/tiredofit/docker-spamassassin:(imagetag)

The following image tags are available along with their tagged release based on what's written in the Changelog:

Container OS	Tag
Alpine	:latest

Multi Architecture

Images are built primarily for amd64 architecture, and may also include builds for arm/v7, arm64 and others. These variants are all unsupported. Consider sponsoring my work so that I can work with various hardware. To see if this image supports multiple architecures, type docker manifest (image):(tag)

Configuration

Quick Start

• The quickest way to get started is using docker-compose. See the examples folder for a working compose.yml that can be modified for development or production use.

• Set various environment variables to understand the capabilities of this image.

• Map persistent storage for access to configuration and data files for backup.

Persistent Storage

The following directories are used for configuration and can be mapped for persistent storage.

Directory	Description
/logs/	Spamassassin Logs
/config/	Configuration
/data/	Volatile Data (Downloaded Patterns)

---

Environment Variables

Base Images used

This image relies on an Alpine Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash,curl,less,logrotate,nano,vim.

Be sure to view the following repositories to understand all the customizable options:

Image	Description
OS Base	Customized Image based on Alpine Linux

Parameter	Description	Default
CHILD_MAX	Max Children	5
CHILD_MAX_CONNECTIONS	Max connections per child	200
CHILD_MAX_SPARE	Max Spare Children	2
CHILD_MIN	Minimum Child Process	1
CHILD_MIN_SPARE	Minimum Spare Children	1
CONFIG_PATH	Config directory	/config/
DATA_PATH	Updates / Rulesets directory	/data/
ENABLE_LEARNING	Enable Learning/Reporting	TRUE
ENABLE_ROUND_ROBIN	Enable Roundrobin Forking for childs	FALSE
ENABLE_UPDATES	Enable Ruleset Updates	TRUE
LISTEN_PORT	TCP Listen Port	783
LOG_FILE	Log File	spamassassin.log
LOG_PATH	Log Logcation	/logs/
PID_FILE	PID File	spamassassin.pid
PID_PATH	PID Path	/var/run/spamassassin/
TIMEOUT_CHILD	Child Timeout in Seconds	300
TIMEOUT_IDENT	Ident Timeout in Seconds	5
TIMEOUT_TCP	TCP Timeout in Seconds	30
UPDATE_PERIOD	Cron Expression when to perform updates	15 23 * * *

Networking

Port	Description
783	Spamassassin Listening Port

Maintenance

Shell Access

For debugging and maintenance purposes you may want access the containers shell.

docker exec -it (whatever your container name is) bash

Support

These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.

Usage

• The Discussions board is a great place for working with the community on tips and tricks of using this image.
• Sponsor me for personalized support

Bugfixes

• Please, submit a Bug Report if something isn't working as expected. I'll do my best to issue a fix in short order.

Feature Requests

• Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
• Sponsor me regarding development of features.

Updates

• Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
• Sponsor me for up to date releases.

License

MIT. See LICENSE for more details.

References

• https://spamassassin.apache.org