# Cyren Anti-Spam Version: 5.5-stable This is the documentation for the Cyren Anti-Spam add-on option. The package consists of two services, *ctasd* which can be used to scan inbound messages and *ctasd-o* which can be used to scan outbound messages. ## Table of contents * [Installation](#install) * [Prerequisites](#install:prerequisites) * [Distributions](#install:distributions) * [Ubuntu](#install:ubuntu) * [RHEL](#install:rhel) * [Startup](#install:startup) * [Docker & K8s](#install:docker-k8s) * [Upgrade](#upgrade) * [Configuration](#config) * [General directives](#config:general-directives) * [Connectivity directives](#config:connectivity-directives) * [HttpServer directives](#config:httpserver-directives) * [Security directives](#config:security-directives) * [Integration](#integration) # 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 ctasd ``` ### RHEL To install the .rpm package use the following commands. ```console $ yum install ctasd ``` ## Startup When the initial [configuration](#config) is in place, the program can be started with: ```console $ sudo systemctl start ctasd $ sudo systemctl start ctasd-o ``` ## 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 *ctasd* loads the non-reloadable configuration from `/etc/ctasd/ctasd.conf`. The default configuration file in `/opt/ctasd/share/examples` can normally be used as a base: ```console $ cp /opt/ctasd/share/examples/ctasd.conf /etc/ctasd/ ``` *ctasd-o* loads the non-reloadable configuration from `/etc/ctasd/ctasd-o.conf`. The default configuration file in `/opt/ctasd/share/examples` can normally be used as a base: ```console $ cp /opt/ctasd/share/examples/ctasd-o.conf /etc/ctasd/ ``` Below are some of the most important settings that can be configured. ## General directives ### [General]OutboundEnabled Should be `0` for *ctasd* and `1` for *ctasd-o*. ## Connectivity directives ### [Connectivity]Server_address Should be `resolver%d.halon.ctmail.com` if you want to use the closest data center or `resolver%d-eu-halon.ctmail.com` if you only want to use EU data centers. ### [Connectivity]License_key_code Should be the license key that was provided by us. ## HttpServer directives ### [HttpServer]BindingAddress The IP address to listen on. In the default configuration this is set to `127.0.0.1`. ### [HttpServer]Port The port to listen on. In the default configuration this is set to `8088` for *ctasd* and `8089` for *ctasd-o*. ## Security directives ### [Security]User The privdrop user ### [Security]Group The privdrop group # Integration In order to integrate this program with our MTA, see our client library [here](https://github.com/halon-extras/cyren).