Installation

System requirements

  • Distribution: Debian 10+

Minimum

  • CPU: x86_64, 4 cores, SSE 4.2
  • RAM: 4 Gb
  • HDD: 2 Gb

Recommended

  • CPU: x86_64, 4 cores, SSE 4.2
  • RAM: 16+ Gb
  • HDD: 1+ Tb

Installation procedure

Collector is distributed as Docker images stored on our server. To access them, contact us

You need access from the target machine to the distribution repositories.

Run commands as root.

1. Install support software

apt install -y tar wget

2. Install Docker and Docker Compose

Following the official installation documentation for your OS:

3. Download and unpack the necessary files

In the directory with MITIGATOR:

mkdir collector && cd collector
wget https://docs.mitigator.ru/v22.06/dist/collector/clickhouse.xml
wget https://docs.mitigator.ru/v22.06/dist/collector/docker-compose.yml
wget https://docs.mitigator.ru/v22.06/dist/collector/docker-compose.gateway.yml
wget https://docs.mitigator.ru/v22.06/dist/collector/init-db.sh
wget https://docs.mitigator.ru/v22.06/dist/collector/dashboard.json
wget https://docs.mitigator.ru/v22.06/dist/collector/dashboard.yml
wget https://docs.mitigator.ru/v22.06/dist/collector/datasources.yml
wget https://docs.mitigator.ru/v22.06/dist/collector/ipv4_dictionary.xml
wget https://docs.mitigator.ru/v22.06/dist/collector/location_dictionary.xml

4. Download GeoIP databases (optional)

Collector comes with several customized Grafana panels. Some of them use GeoIP. In order for them to work, you need to download the free database GeoLite2 in CSV format and unzip the files to the geolite2 directory :

collector/
    docker-compose.yml
    geolite2/
        GeoLite2-City-Blocks-IPv4.csv
        (Other GeoLite2 files)

Unpacked files need to be processed with the command:

find collector/geolite2 -name '*.csv' -exec sed -e "s|,\('[^,]\+\)|,\"\1\"|g" -i {} \;

5. Make sure the collector address is set

Make sure the correct variable is set in the .env file COLLECTOR_HOST_ADDRESS. Correct it if needed.

6. Log in to docker.mitigator.ru

docker login docker.mitigator.ru

7. Run Collector

cd collector
docker-compose up -d