Installing Ellis

TL;DR:

pip install ellis

Requirements

Ellis requires a few things to be able to run.

Required softwares

• systemd >= 231
• Python >= 3.5.2
• python-systemd >= 231
• smtplibaio >= 2.0.1

Optional softwares

Depending on your needs and goals (and depending on the Actions you want to trigger), you might need the following:

• If you want to ban IP addresses using the provided ipset module:
  • ipset

Human skills

Setting up and configuring Ellis is not very complicated but still requires you to be able to:

• understand and edit a configuration file.
• gain sudo/root privileges.
• write a valid regular expressions (only if you want to write your own Rules).

Basic knowledge in either (or both) Python and systemd can definitely help, but is not required.

Installing

We recommend to install Ellis in its own dedicated environment.

$ mkdir -p /path/to/ellis
$ cd /path/to/ellis
$ virtualenv .
$ source bin/activate
(ellis) $ pip install ellis

This should be enough to download Ellis from PyPi and install it with its dependencies.

You can check that everything went well by running:

(ellis) $ ellis
There are no valid rules in the config file. Ellis can not run without rules.

If that's not the case, some error message should be able to help you.

Once Ellis is installed, you can go on and configure it.