A quick start to download and install MailerQ

Lets run MailerQ

Installing on Debian/Ubuntu based systems

wget https://packages.copernica.com/copernica.key
sudo apt-key add copernica.key
rm copernica.key
echo "deb https://packages.copernica.com/debian stable main" | sudo tee /etc/apt/sources.list.d/copernica.list
sudo apt-get update
sudo apt-get install mailerq

Installing on Red Hat based systems

To install MailerQ on a new version of CentOS, Red Hat or Fedora, enter the following instructions in your shell:

sudo wget https://packages.copernica.com/rpm/copernica.repo -O /etc/yum.repos.d/copernica.repo
sudo yum update
sudo yum install mailerq

Specific versions

We have more information provided if you want to download specific versions.

License file

To run MailerQ, you need a valid (free) license file. This file contains the list of IP addresses from which you are going to send out mail, and the features that should be enabled.

A free trail license file is valid for a period of one month.

Get a (free) license file

It is best to store your license file as "etc/mailerq/license.txt". If you store it in a different location, you have to update your config file.

Setting up RabbitMQ

MailerQ depends on RabbitMQ for message queueing. This means that before you can even start MailerQ, you first need a running RabbitMQ instance. We do not intend to write a full installation guide for RabbitMQ here, because the www.rabbitmq.com website has all the information you need, although other webpages are a bit more user friendly.

Installing RabbitMQ on Debian / Ubuntu

Here is a short example how to install RabbitMQ on Debian / Ubuntu. To install, execute the following commands.

echo 'deb http://www.rabbitmq.com/debian/ testing main' | sudo tee /etc/apt/sources.list.d/rabbitmq.list
wget -O- https://www.rabbitmq.com/rabbitmq-release-signing-key.asc | sudo apt-key add -
sudo apt-get update
sudo apt-get install rabbitmq-server

Installing on RPM-based Linux (RHEL, CentOS, Fedora, openSUSE)

First you need to install Erlang, the RabbitMQ runtime.

wget https://packages.erlang-solutions.com/erlang-solutions-1.0-1.noarch.rpm
sudo rpm -Uvh erlang-solutions-1.0-1.noarch.rpm
sudo yum install erlang erlang-nox

After that you can install RabbitMQ server. Use the following commands to install the latest version of RabbitMQ.

wget https://www.rabbitmq.com/releases/rabbitmq-server/v3.6.10-1/rabbitmq-server-3.6.10-1.noarch.rpm
sudo rpm --import https://www.rabbitmq.com/rabbitmq-release-signing-key.asc
sudo yum install rabbitmq-server-3.6.10-1.noarch.rpm

We do not intend to write a full installation guide for RabbitMQ here. However, we do have some tips, tricks and recommendations for setting up RabbitMQ with MailerQ.

Start MailerQ and connect RabbitMQ

MailerQ is configured via one central configuration file: "/etc/mailerq/config.txt". The most important ones are the address and login credentials of your RabbitMQ message broker, MailerQ Management Console and the address of your database.

To start RabbitMQ as an administrator, start the server for Debian using:

sudo service rabbitmq-server start

MailerQ listens on ports 25 and 80 to show the Management Console. Make sure to stop any apache, postfix or other process that's blocking these ports, although you can change the default easely in the config file.

# Management console configuration
www-port: 8485
www-password: mailerq

Within this configfile you can configure MailerQ, to change the Management Console password for example. Although all other config file settings have decent defaults, you might want to take a look at them.

After you connected MailerQ to RabbitMQ you can start MailerQ

sudo service mailerq start

Thats all!

Hello World example

Go to your localhost or localhost:8485 to access the MailerQ Management Console and send your first email with MailerQ!

The simplest example to send a message using MailerQ is via the cli:

echo -e "from: your_email@domain.com\nto: your_email@domain.com\nsubject: MailerQ example message\n\nHello World" | mailerq --extract-recipients --ignore-dot

If you are fast enough, you can track this message in the management console.


The MailerQ team