BotGuard Virtual Appliance User Guide

This document guides you through the steps required to set up an on premise installation, configuration, and operation of your BotGuard Virtual Appliance. This guide does not cover setup of the operating system. We expect you to be familiar with the operating system itself, software installation and basic OS maintenance tasks. Should you need any assistance, please contact BotGuard Technical Support at support@botguard.net.

Consider Our Cloud Service

Since an operation on premise is a lot of work, requires technical knowledge and is error prone, we recommend the use of our hosted service at botguard.net. One reason why the use of our cloud service is easier is the fact that you do not have to worry about software updates and monitoring. Our instances are operationed and constantly monitored by our competent staff so you can concentrate on getting your work done.

 

Table Of Contents

  1. System Requirements



 

System Requirements

On premise installation can be implemented on a physical or a virtual server. The following hardware and software requirements need to be met:

  • 2 Xeon-class CPU cores
  • 1 GiB RAM
  • 15 GiB HDD
  • 1 network interface
  • Additional space for storing logs

This is a minimal hardware configuration enough to serve up to 500K hits / day. The network interface must have sufficient bandwidth to transmit traffic in the same volume as your external channel, since all external requests to your web server are mirrored to the installed instance of the BotGuard node.

Software Requirements

On the server on which the BotGuard node will be deployed, one of the supported operating systems should be installed with minimal configuration:

  • RedHat Enterprise Linux 7 / CentOS 7 / Oracle Linux 7
  • Debian 9 ("stretch") / Debian 10 ("buster")
  • Ubuntu 16.04 ("xenial") / Ubuntu 18.04 ("bionic")
  • SUSE Linux Enterprise Server 15

Only 64-bit (x86_64) operating systems are supported.

In addition to the operating system, Docker CE and Docker Compose should be installed on the server. The manufacturer’s website provides instructions for installing the Docker Engine on CentOS, Debian, and Ubuntu.

Network Environment Requirements

  • Direct connection to the internet, without using a proxy
  • Public IPv4 and IPv6 address if protected sites support IPv6
  • 2 domain names (subdomains are also suitable)
  • SSL/TLS certificate issued by a worldwide certificate authority for both domain names
  • IPv6-capable DNS name resolution service



 

Appendix 1. docker-compose.yml file example