Knowledge Base » Documentation MailCleaner »

Vote

Installation of MailCleaner options or add-ons

MailCleaner Support
Added over 5 years ago

Introduction

In order to make your MailCleaner options installation easier, we provided an interactive script you can found in your MailCleaner nodes at: /usr/mailcleaner/install/install_options.sh.

The install_options script is on Github at: https://github.com/MailCleaner/MailCleaner/blob/master/install/install_options.sh

Supported options

Currently, we support the installation of the following options:

  • ESET
  • SpamHaus
  • MessageSniffer

Installation

To install an option, make sure you have the licenses provided by our sales department for the corresponding option. Keep this information confidential and do not share it.

To install an option, simply run the script with the option of your choice, all in lowercase. For example: /usr/mailcleaner/install/install_options.sh --spamhaus

Here is the license information requested interactively after launching the script:
* ESET:
You will need your ESET MSP username (email address) and password, as well as your 9-character license key. You will be asked to create the former from a ESET email with the subject "Invitation to ESET MSP Administrator". You will receive the latter from your MailCleaner sales representative. For more detailed installation instructions, see here
* SpamHaus:
A private token (which will allows your MailCleaner's to query the SpamHaus RBLs)
* MessageSniffer:
License ID and Auth code

Conditions

You need to be using latest patch level and to have registered your appliance. For Community Edition users, the option to allow the reporting of anonymous statistics must be activated, and the necessary ports must be open on your firewall.

RBL Configuration

For RBLs configuration when installed, please refer to: https://support.mailcleaner.net/boards/3/topics/54-how-to-set-up-rbls

Troubleshooting

If you're facing any issues during the installation, please contact us :

Please provide these details when contacting us:

  • The output of the script
  • The log file created into your MailCleaner at /tmp/mc_install_options.log