probesys38/agentj_relay repository overview

⁠AgentJ dockerized repository

This is the Docker stack to set up a fully functional AgentJ antispam system at a glance.

⁠Introduction

The AgentJ Docker stack is composed of the following services:

• db: a MariaDB instance, it keeps track of the mail headers and other information needed to manage the e-mails life cycle (sender, recipient, amavis id, ...)
• app: a Web UI that allows you to add and manage your domains and associated users as well as managing the incoming e-mails (block, release, white/black lists)
• smtp: a Postfix instance that will receive the e-mails and forward them to the amavis container (Amavis/ClamAV/Spamassassin service)
• amavis: a container running Amavis/Spamassassin and ClamAV services
• logspout + syslogng: a Syslog-NG instance that will collect and centralize logs from the other containers
• relay: an other Postfix instance, needed to avoid loops when forwarding the released or white-listed e-mails to their recipients(s)

⁠Get the sources

All you have to do is to clone the repository

git clone https://github.com/Probesys/agentj.git

then, cd to the cloned repository to configure a few variables:

cd agentj

⁠Configure

⁠Variables

Variables are defined in the .env.example. This file is just a template, you must copy and rename it to .env:

cp .env.example .env

Then the following runtime variables must be configured in the .env file:

⁠Network

The AgentJ antispam stack has its own Docker bridge and IPv4 subnet which defaults to 172.24.42.0/24 (configurable, see variables table above).

⁠Use

It is not recommended to launch the stack as root. We recommend you to create a dedicated docker user (make sure it belongs to the docker group). After you have set the above variables, you can start the stack with following commands:

docker-compose up -d

The Web UI will be available at http://hostname:8090⁠. The default login is admin and the default password is Sup3rZECR37.

⁠Details

⁠Volumes

When started, the AgentJ stack will create the following volumes:

• amavis : the Amavis databases
• applogs : the application logs (cron tasks)
• clamav : the ClamAV signatures database
• db : the MariaDB databases files
• logs: the log files from all containers, centralized by the syslogng container
• opendkim : DKIM signature and conf files
• postqueue : the mail queue

⁠Communication matrix

⁠Upgrade

Please read the dedicated documentation⁠ as well as releases notes before upgrading.

Generally speaking, the upgrade processes consists in the following:

docker-compose down
# Change VERSION variable in your `.nev` file
docker-compose up -d

⁠About

⁠License

This work is made available under the GNU Affero General Public License v3.0.

⁠Development

AgentJ is a Probesys⁠ project.