A quick start to download and install MailerQ

Let's run MailerQ

Installation guide

MailerQ can run on multiple Linux distributions. Different distributions require slightly different installation process.

MailerQ supports two types of systems: Debian and Red Hat based systems. Supported versions of those systems are listed below. Choose system and version that applies to you and start installing MailerQ!

Installing MailerQ on Debian / Ubuntu based systems

You can run the following commands in your terminal to add our repository to your package manager, download and install MailerQ.

# Download and add the repository key
wget -qO - https://packages.mailerq.com/mailerq.key | sudo apt-key add -
# Add the MailerQ repository to apt
echo "deb https://packages.mailerq.com/debian stable main" | sudo tee /etc/apt/sources.list.d/mailerq.list
# Update the apt cache
sudo apt update
# Install the latest MailerQ
sudo apt install mailerq

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.

Get a (trial) license key

The MailerQ application has a special command line switch to get your valid license file. After you've installed MailerQ, and generated a license key on this website, run the following command to download the license:

sudo mailerq --fetch-license LICENSE_KEY

You have to replace LICENSE_KEY with your license key.

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

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. The most up-to-date guide to install RabbitMQ and its dependencies can be found here.

In short, this comes down to running the following commands:

curl -s https://packagecloud.io/install/repositories/rabbitmq/rabbitmq-server/script.deb.sh | sudo bash
sudo apt-get install rabbitmq-server

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 uses port 80 to show the Management Console. This is the default HTTP port. Any Apache or nginx servers will most likely use this port. You can stop them or you can adjust the HTTP port that MailerQ uses. Just modify the www-port variable in MailerQ config.

# Management console configuration
www-port: 8485

MailerQ also runs a SMTP server and it will try to use port 25 for it. That means that you have to stop any other SMTP servers before starting MailerQ (e.g. postfix). Alternatively, you can change MailerQ's SMTP port. Just modify the smtp-port variable in MailerQ config (e.g. 2525 will work just fine).

smtp-port: 2525

Within this config file 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.

Cheers,

The MailerQ team

Installing MailerQ on Red Hat based systems

You can enter the following commands in your terminal to add our repository to your package manager, download and install MailerQ.

# Add the MailerQ repository to yum
sudo wget https://packages.mailerq.com/rpm/mailerq.repo -O /etc/yum.repos.d/mailerq.repo
# Install the latest MailerQ
sudo yum install mailerq

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.

Get a (trial) license key

The MailerQ application has a special command line switch to get your valid license file. After you've installed MailerQ, and generated a license key on this website, run the following command to download the license:

sudo mailerq --fetch-license LICENSE_KEY

You have to replace LICENSE_KEY with your license key.

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

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. The most up-to-date guide to install RabbitMQ and its dependencies can be found here.

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 RPM-based systems using:

sudo systemctl enable rabbitmq-server
sudo systemctl start rabbitmq-server

MailerQ uses port 80 to show the Management Console. This is the default HTTP port. Any Apache or nginx servers will most likely use this port. You can stop them or you can adjust the HTTP port that MailerQ uses. Just modify the www-port variable in MailerQ config.

# Management console configuration
www-port: 8485

MailerQ also runs a SMTP server and it will try to use port 25 for it. That means that you have to stop any other SMTP servers before starting MailerQ (e.g. postfix). Alternatively, you can change MailerQ's SMTP port. Just modify the smtp-port variable in MailerQ config (e.g. 2525 will work just fine).

smtp-port: 2525

Within this config file 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 systemctl start mailerq

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.

Cheers,

The MailerQ team