Skip to content
sqall01 edited this page Jan 31, 2021 · 12 revisions

Installation

In this document the installation process of an AlertR instance is described.

Installing AlertR

Before you try to install an AlertR system, please read the Infrastructure article to see how the AlertR system looks like and to learn the basic terminology that is used by AlertR.

How to install an AlertR instance?

Since version 0.225, AlertR brings its own installation script. It can be used to download an arbitrary AlertR instance from this repository. The whole installation process is divided into five steps:

  • Download the AlertR install script from the repository (alertRinstall.py).

  • Install the needed dependencies for the AlertR instance you want to download. For this you can list all available AlertR instances by executing "./alertRinstaller.py -l". This will give you a list of dependencies that have to be satisfied before the chosen AlertR instance can be installed.

  • Download the chosen AlertR instance with the install script. This is done by executing "./alertRinstaller.py -i <chosen AlertR instance> -t <target directory>". For example, if you want to install the "AlertR Sensor Client Ping" to the directory "/home/alertr/client/ping" you have to execute "./alertRinstaller.py -i sensorClientPing -t /home/alertr/client/ping". Follow any further instructions given by the installation script.

  • Configure the downloaded AlertR instance. All configuration files are located in the "config/" directory of the AlertR instance. A template configuration file with detailed comments explains how to configure the AlertR instance. Check the Tutorials for a more detailed description how to set up an AlertR system. As a starting point, use the Server Tutorial and then add easy to use clients such as the AlertR Sensor Client Ping and AlertR Manager Client Console to your test configuration.

  • Optionally, you can use the provided init.d script to start the downloaded AlertR instance during boot time. Otherwise, you have to manually start the AlertR instance after any start up of the computer.

Clone this wiki locally