# Cyren IP Reputation Version: 4.5-stable This is the documentation for the Cyren IP Reputation add-on option. The package consists of one service called *ctipd* which can be used to classify IP addresses. ## 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) * [IPRep directives](#config:iprep-directives) * [HTTP directives](#config:http-directives) * [General directives](#config:general-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 ctipd ``` ### RHEL To install the .rpm package use the following commands. ```console $ yum install ctipd ``` ## Startup When the initial [configuration](#config) is in place, the program can be started with: ```console $ sudo systemctl start ctipd ``` ## 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 *ctipd* loads the non-reloadable configuration from `/etc/ctipd/ctipd.conf`. The default configuration file in `/opt/ctipd/share/examples` can normally be used as a base: ```console $ cp /opt/ctipd/share/examples/ctipd.conf /etc/ctipd/ ``` Below are some of the most important settings that can be configured. ## IPRep directives ### [IPRep]ServerAddress Should be `iprep%d.halon.ctmail.com` if you want to use the closest data center or `iprep%d-eu-halon.ctmail.com` if you only want to use EU data centers. ### [IPRep]LicenseKey Should be the license key that was provided by us. ## HTTP directives ### [HTTP]BindingAddress The IP address to listen on. In the default configuration this is set to `127.0.0.1`. ### [HTTP]Port The port to listen on. In the default configuration this is set to `8080`. ## General directives ### [General]RunAsUser The privdrop user ### [General]RunAsGroup The privdrop group # Integration In order to integrate this program with our MTA, see our client library [here](https://github.com/halon-extras/cyren).