Getting started with MailerQ

To get MailerQ up and running on your own computer or on a server you need to take four simple steps:

That's all. After these steps you're ready to start MailerQ and inject emails. To start MailerQ, just enter mailerq on the command line and your MTA is running.

$ mailerq

MailerQ comes with a web based management console that you can use to monitor exactly what is happening, and to adjust all your delivery settings. The default location is http://your-server-name:8485.

System dependencies

MailerQ runs on Linux, so you need a Linux server or Linux computer to be able to start and run MailerQ. We distribute the software in binary form for Debian/Ubuntu based systems and for Red Hat based systems. Please drop us a message if you need a version for a different type of system.

The binary executable that you can download is statically linked against most libraries. This means that all the libraries required by MailerQ are embedded into the binary code, and that MailerQ runs straight out of the box with no need for you to fix all kinds of dependencies. However, when MailerQ starts, it does do a scan of your system to detect which libraries are available. If MailerQ happens to find out that one or more of the following libraries are available on your system, it does load them to use specific features from these libs:

libopenssl Used for TLS encryption, license checking and base64 encoding
libz Used for compression algorithms
libmagic Used to detect the mime-type of files
libuuid1 Used for generating globally unique identifiers
libidn Used for parsing international domain names
libxml2 Used for parsing and modifying XML/HTML code
libcurl Used to download resources from the internet
libimagemagick Used to find out the dimensions of images
libmysqlclient Used to connect to a mysql/mariadb database
libmariadbclient Used to connect to a mysql/mariadb database
libpq Used to to connect to a Postgresql database
libsqlite3 Used to process sqlite3 database files
libmongo-c-driver Used to connect to a MongoDB NoSQL server
libcouchbase Used to connect to a Couchbase server

From the above list, only the openssl, libz and libidn libraries are required. All other libraries are optional, and MailerQ can run without them. If a library is missing, MailerQ will either fall back on its own implementation, or will run without the features from the specific library.

Most of the MailerQ runtime settings are stored in a relational database. This means that you must have at least one of the mysql, mariadb, postgresql or sqlite3 libraries installed on your system.

Sqlite3 is a local solution. Mysql or Mariadb can run on a different servers, but then you need libmysqlclient on the mailerq box. Postgresql 9.5+ which can be on a different server too, but then you need libpq >= 9.5 to use it.