# Sophos Anti-Spam
Version: 6.0-stable
This is the documentation for the Sophos Anti-Spam add-on option.
The package consists of one service called *sasid* which can be used to scan messages for spam.
## Table of contents
* [Installation](#install)
* [Prerequisites](#install:prerequisites)
* [Distributions](#install:distributions)
* [Ubuntu](#install:ubuntu)
* [RHEL](#install:rhel)
* [Environment](#install:environment)
* [Startup](#install:startup)
* [Docker & K8s](#install:docker-k8s)
* [Upgrade](#upgrade)
* [Configuration](#config)
* [Daemon directives](#config:daemon-directives)
* [Engine directives](#config:engine-directives)
* [Integration](#integration)
* [Changelog](#changelog)
# Installation
## Prerequisites
Make sure you have followed the [instructions](https://docs.halon.io/manual/comp_install.html#installation) in our manual to add our package repository.
## Distributions
### Ubuntu
To install the .deb package use the following commands.
```console
# apt-get update
# apt-get install sasid
```
### RHEL
To install the .rpm package use the following commands.
```console
# yum install sasid
```
## Environment
To set the necessary environment variables use the following commands.
```console
# systemctl edit sasid
```
Add the following lines in the editor replacing the username and password with the provided credentials.
```default
[Service]
Environment="SASI_USER=username"
Environment="SASI_PASSWORD=password"
```
## Startup
When the initial [configuration](#config) is in place, the program can be started with:
```console
# systemctl start sasid
```
## Docker & K8s
For instructions on how to build a container image of the program as well as deploying it on K8s (Kubernetes),
see our [halon-docker](https://github.com/halon/halon-docker) GitHub repository.
# Upgrade
In order to upgrade the package, install the new package over the previous installed one (see the installation chapter).
After the upgrade the service will be stopped and requires to be manually started.
# Configuration
*sasid* loads the non-reloadable configuration from `/etc/sasid/sasid.conf`.
The default configuration file in `/opt/sasid/share/examples` can normally be used as a base:
```console
# cp /opt/sasid/share/examples/sasid.conf /etc/sasid/
# cp /opt/sasid/share/examples/sxl_client.conf /etc/sasid/
```
Below are some of the most important settings that can be configured.
## Daemon directives
### LISTENING_ADDR
The IP address to listen on. In the default configuration this is set to `127.0.0.1`.
### LISTENING_PORT
The port to listen on. In the default configuration this is set to `25315`.
## Engine directives
### SXL_ENABLE
Controls whether the SXL functionality is enabled or disabled.
# Integration
In order to integrate this program with our MTA, see our client library [here](https://github.com/halon-extras/sophos).
# Changelog
## 6.0.3
Released 2025-10-06
- **Imp** QR Code Parsing
- **Imp** HTTPS (SXL4 technology) used for some cloud lookups
> **Warning**
>
> If upgrading from the `5.X` release you need to copy `/opt/sasid/share/examples/sxl_client.conf` to `/etc/sasid` and then add `SXL_CLIENT_CONFIG_FILE = /etc/sasid/sxl_client.conf` to `/etc/sasid/sasid.conf`.